> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getprimo.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get all tickets
> Return a paginated list of tickets for your company.
Key: ReadScope: Company
## OpenAPI
````yaml https://api.getprimo.com/openapi.json get /tickets
openapi: 3.1.1
info:
title: Public API - BETA
description: Read docs on https://docs.getprimo.com/
version: '1.0'
contact: {}
servers:
- url: https://api.getprimo.com
security:
- apikey: []
tags: []
paths:
/tickets:
get:
tags:
- Tickets
summary: Get all tickets
description: Return a paginated list of tickets for your company.
operationId: getTickets
parameters:
- name: page
required: false
in: query
description: Page number
schema:
minimum: 1
maximum: 9007199254740991
default: 1
type: number
- name: perPage
required: false
in: query
description: Number of items per page (max 100)
schema:
minimum: 1
maximum: 100
default: 50
type: number
- name: status
required: false
in: query
schema:
type: string
enum:
- PENDING
- IN_PROGRESS
- COMPLETED
- CANCELLED
- name: priority
required: false
in: query
schema:
type: string
enum:
- LOW
- MEDIUM
- HIGH
- name: searchTerm
required: false
in: query
description: Filter tickets by title
schema:
type: string
minLength: 1
- name: assigneeEmployeeId
required: false
in: query
description: Filter by assignee employee ID
schema:
type: string
- name: sortBy
required: false
in: query
schema:
enum:
- status
- priority
- reference
- title
- tasksCount
type: string
- name: sortDirection
required: false
in: query
schema:
enum:
- ASC
- DESC
type: string
responses:
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GetTickets_Output'
components:
schemas:
GetTickets_Output:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
reference:
type: string
title:
type: string
status:
type: string
enum:
- PENDING
- IN_PROGRESS
- COMPLETED
- CANCELLED
priority:
anyOf:
- type: string
enum:
- LOW
- MEDIUM
- HIGH
- type: 'null'
assignee:
anyOf:
- anyOf:
- type: object
properties:
type:
type: string
const: EMAIL
email:
type: string
required:
- type
- email
additionalProperties: false
- type: object
properties:
type:
type: string
const: EMPLOYEE
employeeId:
type: string
required:
- type
- employeeId
additionalProperties: false
- type: object
properties:
type:
type: string
const: EXTERNAL_ADMIN
userId:
type: string
required:
- type
- userId
additionalProperties: false
- type: 'null'
requester:
description: Who the ticket was opened on behalf of (its creator)
anyOf:
- type: object
properties:
type:
type: string
const: EMPLOYEE
employeeId:
type: string
required:
- type
- employeeId
additionalProperties: false
- type: object
properties:
type:
type: string
const: EXTERNAL_ADMIN
userId:
type: string
required:
- type
- userId
additionalProperties: false
- type: object
properties:
type:
type: string
const: EMAIL
email:
type: string
required:
- type
- email
additionalProperties: false
- type: object
properties:
type:
type: string
const: PRIMO
required:
- type
additionalProperties: false
- type: object
properties:
type:
type: string
const: API
required:
- type
additionalProperties: false
- type: object
properties:
type:
type: string
const: SLACK_USER
name:
type: string
required:
- type
- name
additionalProperties: false
dueDate:
anyOf:
- type: string
format: date-time
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))$
- type: 'null'
createdAt:
type: string
format: date-time
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:
type: string
format: date-time
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:
description: Ids of the tags attached to this ticket
type: array
items:
type: string
tasks:
type: array
items:
type: object
properties:
id:
type: string
ticketId:
type: string
title:
type: string
status:
type: string
enum:
- PENDING
- IN_PROGRESS
- COMPLETED
- CANCELLED
isManuallyCompletable:
type: boolean
description: >-
Whether a human (not only the system) may complete this
task
isAdminManaged:
type: boolean
description: >-
Whether only an admin may assign this task or change its
status
assignee:
anyOf:
- anyOf:
- type: object
properties:
type:
type: string
const: EMAIL
email:
type: string
required:
- type
- email
additionalProperties: false
- type: object
properties:
type:
type: string
const: EMPLOYEE
employeeId:
type: string
required:
- type
- employeeId
additionalProperties: false
- type: object
properties:
type:
type: string
const: EXTERNAL_ADMIN
userId:
type: string
required:
- type
- userId
additionalProperties: false
- type: 'null'
tagIds:
type: array
description: Ids of the tags attached to this task
items:
type: string
required:
- id
- ticketId
- title
- status
- isManuallyCompletable
- isAdminManaged
- assignee
- tagIds
additionalProperties: false
required:
- id
- reference
- title
- status
- priority
- assignee
- requester
- dueDate
- createdAt
- updatedAt
- tagIds
- tasks
additionalProperties: false
pagination:
type: object
properties:
totalElements:
type: integer
minimum: 0
maximum: 9007199254740991
totalPages:
type: integer
minimum: 0
maximum: 9007199254740991
page:
type: integer
minimum: 1
maximum: 9007199254740991
perPage:
type: integer
minimum: 1
maximum: 100
required:
- totalElements
- totalPages
- page
- perPage
additionalProperties: false
required:
- data
- pagination
additionalProperties: false
securitySchemes:
apikey:
scheme: bearer
bearerFormat: API key
type: http
description: >-
Use your Primo API key in the Authorization header as `Bearer
`.
````