Create a ticket

curl --request POST \
  --url https://api.getprimo.com/tickets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "assigneeEmployeeId": "<string>",
  "dueDate": "2023-11-07T05:31:56Z",
  "tagIds": [
    "<string>"
  ],
  "requester": {
    "type": "EMPLOYEE",
    "employeeId": "<string>"
  },
  "wakeDate": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.getprimo.com/tickets"

payload = {
    "title": "<string>",
    "assigneeEmployeeId": "<string>",
    "dueDate": "2023-11-07T05:31:56Z",
    "tagIds": ["<string>"],
    "requester": {
        "type": "EMPLOYEE",
        "employeeId": "<string>"
    },
    "wakeDate": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: '<string>',
    assigneeEmployeeId: '<string>',
    dueDate: '2023-11-07T05:31:56Z',
    tagIds: ['<string>'],
    requester: {type: 'EMPLOYEE', employeeId: '<string>'},
    wakeDate: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.getprimo.com/tickets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getprimo.com/tickets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'assigneeEmployeeId' => '<string>',
    'dueDate' => '2023-11-07T05:31:56Z',
    'tagIds' => [
        '<string>'
    ],
    'requester' => [
        'type' => 'EMPLOYEE',
        'employeeId' => '<string>'
    ],
    'wakeDate' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getprimo.com/tickets"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"assigneeEmployeeId\": \"<string>\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"requester\": {\n    \"type\": \"EMPLOYEE\",\n    \"employeeId\": \"<string>\"\n  },\n  \"wakeDate\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getprimo.com/tickets")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"assigneeEmployeeId\": \"<string>\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"requester\": {\n    \"type\": \"EMPLOYEE\",\n    \"employeeId\": \"<string>\"\n  },\n  \"wakeDate\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getprimo.com/tickets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"assigneeEmployeeId\": \"<string>\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"requester\": {\n    \"type\": \"EMPLOYEE\",\n    \"employeeId\": \"<string>\"\n  },\n  \"wakeDate\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "reference": "<string>",
  "title": "<string>",
  "status": "PENDING",
  "priority": "LOW",
  "assignee": {
    "type": "EMAIL",
    "email": "<string>"
  },
  "requester": {
    "type": "EMPLOYEE",
    "employeeId": "<string>"
  },
  "dueDate": "2023-11-07T05:31:56Z",
  "wakeDate": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "tagIds": [
    "<string>"
  ],
  "aiAgentId": "<string>",
  "tasks": [
    {
      "id": "<string>",
      "ticketId": "<string>",
      "title": "<string>",
      "status": "PENDING",
      "priority": "LOW",
      "dueDate": "2023-11-07T05:31:56Z",
      "scheduleDate": "2023-11-07T05:31:56Z",
      "wakeDate": "2023-11-07T05:31:56Z",
      "isManuallyCompletable": true,
      "isAdminManaged": true,
      "assignee": {
        "type": "EMAIL",
        "email": "<string>"
      },
      "tagIds": [
        "<string>"
      ],
      "aiAgentId": "<string>",
      "type": "<string>",
      "intentId": "<string>"
    }
  ],
  "comments": [
    {
      "id": "<string>",
      "text": "<string>",
      "creator": {
        "type": "EMPLOYEE",
        "employeeId": "<string>"
      },
      "visibility": "INTERNAL",
      "taskId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "relatedObjects": [
    {
      "linkId": "<string>",
      "relatedType": "DEVICE",
      "relatedId": "<string>",
      "resolved": true
    }
  ]
}

Tickets

Create a ticket

Create a ticket for your company. Only title is required, and there is no description field on creation: set the ticket description afterwards with updateTicket, or post the details with createTicketComment. Link the device, employee or other records it concerns with linkTicketRelatedObject. To open the ticket later rather than now (an onboarding step that must not start before a date), the system agent passes wakeDate (not with requester): the ticket sleeps, hidden from everyone and from getTickets, then wakes as an ordinary pending ticket on that date. Keep its id: getTicket returns it to the agent that created it. To delay work on an existing ticket instead, use scheduleTask.

POST

tickets

Create a ticket

curl --request POST \
  --url https://api.getprimo.com/tickets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "assigneeEmployeeId": "<string>",
  "dueDate": "2023-11-07T05:31:56Z",
  "tagIds": [
    "<string>"
  ],
  "requester": {
    "type": "EMPLOYEE",
    "employeeId": "<string>"
  },
  "wakeDate": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.getprimo.com/tickets"

payload = {
    "title": "<string>",
    "assigneeEmployeeId": "<string>",
    "dueDate": "2023-11-07T05:31:56Z",
    "tagIds": ["<string>"],
    "requester": {
        "type": "EMPLOYEE",
        "employeeId": "<string>"
    },
    "wakeDate": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: '<string>',
    assigneeEmployeeId: '<string>',
    dueDate: '2023-11-07T05:31:56Z',
    tagIds: ['<string>'],
    requester: {type: 'EMPLOYEE', employeeId: '<string>'},
    wakeDate: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.getprimo.com/tickets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getprimo.com/tickets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'assigneeEmployeeId' => '<string>',
    'dueDate' => '2023-11-07T05:31:56Z',
    'tagIds' => [
        '<string>'
    ],
    'requester' => [
        'type' => 'EMPLOYEE',
        'employeeId' => '<string>'
    ],
    'wakeDate' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getprimo.com/tickets"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"assigneeEmployeeId\": \"<string>\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"requester\": {\n    \"type\": \"EMPLOYEE\",\n    \"employeeId\": \"<string>\"\n  },\n  \"wakeDate\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getprimo.com/tickets")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"assigneeEmployeeId\": \"<string>\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"requester\": {\n    \"type\": \"EMPLOYEE\",\n    \"employeeId\": \"<string>\"\n  },\n  \"wakeDate\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getprimo.com/tickets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"assigneeEmployeeId\": \"<string>\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"requester\": {\n    \"type\": \"EMPLOYEE\",\n    \"employeeId\": \"<string>\"\n  },\n  \"wakeDate\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "reference": "<string>",
  "title": "<string>",
  "status": "PENDING",
  "priority": "LOW",
  "assignee": {
    "type": "EMAIL",
    "email": "<string>"
  },
  "requester": {
    "type": "EMPLOYEE",
    "employeeId": "<string>"
  },
  "dueDate": "2023-11-07T05:31:56Z",
  "wakeDate": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "tagIds": [
    "<string>"
  ],
  "aiAgentId": "<string>",
  "tasks": [
    {
      "id": "<string>",
      "ticketId": "<string>",
      "title": "<string>",
      "status": "PENDING",
      "priority": "LOW",
      "dueDate": "2023-11-07T05:31:56Z",
      "scheduleDate": "2023-11-07T05:31:56Z",
      "wakeDate": "2023-11-07T05:31:56Z",
      "isManuallyCompletable": true,
      "isAdminManaged": true,
      "assignee": {
        "type": "EMAIL",
        "email": "<string>"
      },
      "tagIds": [
        "<string>"
      ],
      "aiAgentId": "<string>",
      "type": "<string>",
      "intentId": "<string>"
    }
  ],
  "comments": [
    {
      "id": "<string>",
      "text": "<string>",
      "creator": {
        "type": "EMPLOYEE",
        "employeeId": "<string>"
      },
      "visibility": "INTERNAL",
      "taskId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "relatedObjects": [
    {
      "linkId": "<string>",
      "relatedType": "DEVICE",
      "relatedId": "<string>",
      "resolved": true
    }
  ]
}

Key: Write Scope: Company

Authorizations

Authorization

string

header

required

Use your Primo API key in the Authorization header as Bearer <API_KEY>.

Body

application/json

title

string

required

Minimum string length: 1

assigneeEmployeeId

string

priority

enum<string> | null

Available options:

LOW,

MEDIUM,

HIGH

dueDate

string<date-time> | null

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

tagIds

string[]

Ids of the tags to attach to the ticket

requester

object

Open the ticket on behalf of an employee or email. Defaults to the API key / connected user.

Option 1
Option 2

Show child attributes

wakeDate

string<date-time>

Create the ticket asleep until this date/time (ISO 8601): nobody sees it until then, and it wakes as an ordinary pending ticket. System agent only. Must be in the future and within 365 days from now.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Response

default - application/json

string

required

reference

string

required

title

string

required

status

enum<string>

required

Available options:

PENDING,

IN_PROGRESS,

COMPLETED,

CANCELLED,

SCHEDULED,

LOADING,

SLEEPING

priority

enum<string> | null

required

Available options:

LOW,

MEDIUM,

HIGH

assignee

object

required

Option 1
Option 2
Option 3

Show child attributes

requester

object

required

Who the ticket was opened on behalf of (its creator)

Show child attributes

dueDate

string<date-time> | null

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

wakeDate

string<date-time> | null

required

Wake-up date of a SLEEPING ticket, which nobody sees until then; null on any other status

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

createdAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

updatedAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

tagIds

string[]

required

Ids of the tags attached to this ticket

aiAgentId

string | null

required

Id of the AI agent handling it; null when no agent is on it

tasks

object[]

required

Show child attributes

comments

object[]

required

Show child attributes

Get started

API Reference

Create a ticket

Authorizations

Body

Response