> ## Documentation Index
> Fetch the complete documentation index at: https://docs.oration.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Search tickets
> Filter, sort, and paginate tickets with the query builder.
Search tickets in your workspace. Send filters in the request body — this endpoint uses the same query builder as the dashboard, so you can filter on any ticket column with operators like `eq`, `in`, `gte`, and `lte`.
Workspace scope is applied for you. You never need to filter by `workspaceId`.
## Request body
Column filters. Keys are ticket field names; values are operator objects.
**Examples:** `{ "statusId": { "eq": "..." } }`, `{ "priority": { "in": ["high", "urgent"] } }`, `{ "updatedAt": { "gte": "2026-01-01T00:00:00.000Z" } }`
`limit` — max rows per page (default 25, max 100). `offset` — rows to skip.
Sort instructions, e.g. `[{ "column": "updatedAt", "direction": "desc" }]`.
Optional list of columns to return. Omit to get full ticket rows.
## Response
Matching ticket rows (full or partial if `select` is set).
`true` if more results exist beyond this page. Increment `offset` by `limit` to fetch the next page.
## Examples
```bash cURL theme={null}
curl --request POST \
--url https://www.oration.ai/api/v2/tickets/search \
--header 'x-api-key: your-api-key-here' \
--header 'x-workspace-id: your-workspace-id-here' \
--header 'Content-Type: application/json' \
--data '{
"filters": { "statusId": { "eq": "b2c3d4e5-f6a7-8901-bcde-f12345678901" } },
"pagination": { "limit": 25, "offset": 0 },
"sort": [{ "column": "updatedAt", "direction": "desc" }]
}'
```
```bash cURL theme={null}
curl --request POST \
--url https://www.oration.ai/api/v2/tickets/search \
--header 'x-api-key: your-api-key-here' \
--header 'x-workspace-id: your-workspace-id-here' \
--header 'Content-Type: application/json' \
--data '{
"filters": { "source": { "eq": "api" } },
"pagination": { "limit": 50, "offset": 0 }
}'
```
```bash cURL theme={null}
curl --request POST \
--url https://www.oration.ai/api/v2/tickets/search \
--header 'x-api-key: your-api-key-here' \
--header 'x-workspace-id: your-workspace-id-here' \
--header 'Content-Type: application/json' \
--data '{
"filters": {
"updatedAt": {
"gte": "2026-03-01T00:00:00.000Z",
"lte": "2026-03-31T23:59:59.999Z"
}
},
"pagination": { "limit": 25, "offset": 0 }
}'
```
Without `select`, each item in `data` is a full ticket row. With `select`, only the requested columns are returned.
Large workspaces: keep `limit` at 25–100 and page with `offset` until `hasNextPage` is `false`. Tighter filters (status, assignee, dates) keep each page fast.
## OpenAPI
````yaml POST /tickets/search
openapi: 3.1.0
info:
title: Oration API
description: Rest API for Oration AI
version: 1.0.0
servers:
- url: https://www.oration.ai/api/v2
security: []
tags:
- name: auth
- name: users
- name: posts
- name: tickets
externalDocs:
url: https://docs.oration.ai
paths:
/tickets/search:
post:
operationId: edge-workspaces-ticket-filteredList
parameters:
- in: header
name: x-api-key
schema:
type: string
minLength: 1
required: true
- in: header
name: x-workspace-slug
schema:
type: string
required: true
- in: header
name: x-workspace-id
schema:
type: string
format: uuid
pattern: >-
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
required: true
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
filters:
type: object
properties:
workspaceId:
type: object
properties:
eq:
type: string
ne:
anyOf:
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
iLike:
type: string
notILike:
type: string
like:
type: string
notLike:
type: string
ticketNumber:
type: object
properties:
eq:
type: number
ne:
anyOf:
- type: number
- type: array
items:
type: number
in:
type: array
items:
type: number
notIn:
type: array
items:
type: number
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
gt:
type: number
gte:
type: number
lt:
type: number
lte:
type: number
ticketTypeId:
type: object
properties:
eq:
type: string
ne:
anyOf:
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
iLike:
type: string
notILike:
type: string
like:
type: string
notLike:
type: string
title:
type: object
properties:
eq:
type: string
ne:
anyOf:
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
iLike:
type: string
notILike:
type: string
like:
type: string
notLike:
type: string
description:
type: object
properties:
eq:
type: string
ne:
anyOf:
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
iLike:
type: string
notILike:
type: string
like:
type: string
notLike:
type: string
summary:
type: object
properties:
eq:
type: string
ne:
anyOf:
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
iLike:
type: string
notILike:
type: string
like:
type: string
notLike:
type: string
source:
type: object
properties:
eq:
type: string
enum:
- email
- chat_widget
- voice
- whatsapp
- sms
- customer_portal
- form
- manual
- api
- slack
- microsoft_teams
- instagram
- discord
- telegram
ne:
anyOf:
- type: string
enum:
- email
- chat_widget
- voice
- whatsapp
- sms
- customer_portal
- form
- manual
- api
- slack
- microsoft_teams
- instagram
- discord
- telegram
- type: array
items:
type: string
enum:
- email
- chat_widget
- voice
- whatsapp
- sms
- customer_portal
- form
- manual
- api
- slack
- microsoft_teams
- instagram
- discord
- telegram
in:
type: array
items:
type: string
enum:
- email
- chat_widget
- voice
- whatsapp
- sms
- customer_portal
- form
- manual
- api
- slack
- microsoft_teams
- instagram
- discord
- telegram
notIn:
type: array
items:
type: string
enum:
- email
- chat_widget
- voice
- whatsapp
- sms
- customer_portal
- form
- manual
- api
- slack
- microsoft_teams
- instagram
- discord
- telegram
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
iLike:
type: string
notILike:
type: string
like:
type: string
notLike:
type: string
statusId:
type: object
properties:
eq:
type: string
ne:
anyOf:
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
iLike:
type: string
notILike:
type: string
like:
type: string
notLike:
type: string
priority:
type: object
properties:
eq:
type: string
enum:
- urgent
- high
- medium
- low
ne:
anyOf:
- type: string
enum:
- urgent
- high
- medium
- low
- type: array
items:
type: string
enum:
- urgent
- high
- medium
- low
in:
type: array
items:
type: string
enum:
- urgent
- high
- medium
- low
notIn:
type: array
items:
type: string
enum:
- urgent
- high
- medium
- low
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
iLike:
type: string
notILike:
type: string
like:
type: string
notLike:
type: string
customerId:
type: object
properties:
eq:
type: string
ne:
anyOf:
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
iLike:
type: string
notILike:
type: string
like:
type: string
notLike:
type: string
createdByUserId:
type: object
properties:
eq:
type: string
ne:
anyOf:
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
iLike:
type: string
notILike:
type: string
like:
type: string
notLike:
type: string
assigneeUserId:
type: object
properties:
eq:
type: string
ne:
anyOf:
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
iLike:
type: string
notILike:
type: string
like:
type: string
notLike:
type: string
assignedTeamId:
type: object
properties:
eq:
type: string
ne:
anyOf:
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
iLike:
type: string
notILike:
type: string
like:
type: string
notLike:
type: string
ownerUserId:
type: object
properties:
eq:
type: string
ne:
anyOf:
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
iLike:
type: string
notILike:
type: string
like:
type: string
notLike:
type: string
ownerTeamId:
type: object
properties:
eq:
type: string
ne:
anyOf:
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
iLike:
type: string
notILike:
type: string
like:
type: string
notLike:
type: string
conversationId:
type: object
properties:
eq:
type: string
ne:
anyOf:
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
iLike:
type: string
notILike:
type: string
like:
type: string
notLike:
type: string
parentTicketId:
type: object
properties:
eq:
type: string
ne:
anyOf:
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
iLike:
type: string
notILike:
type: string
like:
type: string
notLike:
type: string
mergedIntoTicketId:
type: object
properties:
eq:
type: string
ne:
anyOf:
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
iLike:
type: string
notILike:
type: string
like:
type: string
notLike:
type: string
splitFromTicketId:
type: object
properties:
eq:
type: string
ne:
anyOf:
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
iLike:
type: string
notILike:
type: string
like:
type: string
notLike:
type: string
flowId:
type: object
properties:
eq:
type: string
ne:
anyOf:
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
iLike:
type: string
notILike:
type: string
like:
type: string
notLike:
type: string
agentId:
type: object
properties:
eq:
type: string
ne:
anyOf:
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
iLike:
type: string
notILike:
type: string
like:
type: string
notLike:
type: string
firstResponseAt:
type: object
properties:
eq:
anyOf:
- type: string
- type: string
ne:
anyOf:
- type: string
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
gt:
type: string
gte:
type: string
lt:
type: string
lte:
type: string
isBetween:
type: string
isRelativeToToday:
type: number
resolvedAt:
type: object
properties:
eq:
anyOf:
- type: string
- type: string
ne:
anyOf:
- type: string
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
gt:
type: string
gte:
type: string
lt:
type: string
lte:
type: string
isBetween:
type: string
isRelativeToToday:
type: number
closedAt:
type: object
properties:
eq:
anyOf:
- type: string
- type: string
ne:
anyOf:
- type: string
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
gt:
type: string
gte:
type: string
lt:
type: string
lte:
type: string
isBetween:
type: string
isRelativeToToday:
type: number
snoozedUntil:
type: object
properties:
eq:
anyOf:
- type: string
- type: string
ne:
anyOf:
- type: string
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
gt:
type: string
gte:
type: string
lt:
type: string
lte:
type: string
isBetween:
type: string
isRelativeToToday:
type: number
lastCustomerActivityAt:
type: object
properties:
eq:
anyOf:
- type: string
- type: string
ne:
anyOf:
- type: string
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
gt:
type: string
gte:
type: string
lt:
type: string
lte:
type: string
isBetween:
type: string
isRelativeToToday:
type: number
lastAgentActivityAt:
type: object
properties:
eq:
anyOf:
- type: string
- type: string
ne:
anyOf:
- type: string
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
gt:
type: string
gte:
type: string
lt:
type: string
lte:
type: string
isBetween:
type: string
isRelativeToToday:
type: number
isShared:
type: object
properties:
eq:
type: boolean
ne:
anyOf:
- type: boolean
- type: array
items:
type: boolean
in:
type: array
items:
type: boolean
notIn:
type: array
items:
type: boolean
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
id:
type: object
properties:
eq:
type: string
ne:
anyOf:
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
iLike:
type: string
notILike:
type: string
like:
type: string
notLike:
type: string
createdAt:
type: object
properties:
eq:
anyOf:
- type: string
- type: string
ne:
anyOf:
- type: string
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
gt:
type: string
gte:
type: string
lt:
type: string
lte:
type: string
isBetween:
type: string
isRelativeToToday:
type: number
updatedAt:
type: object
properties:
eq:
anyOf:
- type: string
- type: string
ne:
anyOf:
- type: string
- type: string
- type: array
items:
type: string
in:
type: array
items:
type: string
notIn:
type: array
items:
type: string
isNull:
type: boolean
isNotNull:
type: boolean
isEmpty:
type: boolean
isNotEmpty:
type: boolean
gt:
type: string
gte:
type: string
lt:
type: string
lte:
type: string
isBetween:
type: string
isRelativeToToday:
type: number
pagination:
type: object
properties:
limit:
type: number
minimum: 1
offset:
type: number
minimum: 0
sort:
type: array
items:
type: object
properties:
field:
type: string
enum:
- workspaceId
- ticketNumber
- ticketTypeId
- title
- description
- summary
- source
- statusId
- priority
- customerId
- createdByUserId
- assigneeUserId
- assignedTeamId
- ownerUserId
- ownerTeamId
- conversationId
- parentTicketId
- mergedIntoTicketId
- splitFromTicketId
- flowId
- agentId
- firstResponseAt
- resolvedAt
- closedAt
- snoozedUntil
- lastCustomerActivityAt
- lastAgentActivityAt
- isShared
- id
- createdAt
- updatedAt
direction:
type: string
enum:
- asc
- desc
required:
- field
- direction
select:
type: object
properties:
workspaceId:
type: boolean
ticketNumber:
type: boolean
ticketTypeId:
type: boolean
title:
type: boolean
description:
type: boolean
summary:
type: boolean
source:
type: boolean
statusId:
type: boolean
priority:
type: boolean
customerId:
type: boolean
createdByUserId:
type: boolean
assigneeUserId:
type: boolean
assignedTeamId:
type: boolean
ownerUserId:
type: boolean
ownerTeamId:
type: boolean
conversationId:
type: boolean
parentTicketId:
type: boolean
mergedIntoTicketId:
type: boolean
splitFromTicketId:
type: boolean
flowId:
type: boolean
agentId:
type: boolean
firstResponseAt:
type: boolean
resolvedAt:
type: boolean
closedAt:
type: boolean
snoozedUntil:
type: boolean
lastCustomerActivityAt:
type: boolean
lastAgentActivityAt:
type: boolean
isShared:
type: boolean
id:
type: boolean
createdAt:
type: boolean
updatedAt:
type: boolean
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
workspaceId:
type: string
format: uuid
pattern: >-
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
ticketNumber:
type: integer
minimum: -2147483648
maximum: 2147483647
ticketTypeId:
type: string
format: uuid
pattern: >-
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
title:
type: string
description:
anyOf:
- type: string
- type: 'null'
summary:
anyOf:
- type: string
- type: 'null'
source:
type: string
enum:
- email
- chat_widget
- voice
- whatsapp
- sms
- customer_portal
- form
- manual
- api
- slack
- microsoft_teams
- instagram
- discord
- telegram
statusId:
type: string
format: uuid
pattern: >-
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
priority:
type: string
enum:
- urgent
- high
- medium
- low
customerId:
anyOf:
- type: string
format: uuid
pattern: >-
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
- type: 'null'
createdByUserId:
anyOf:
- type: string
format: uuid
pattern: >-
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
- type: 'null'
assigneeUserId:
anyOf:
- type: string
format: uuid
pattern: >-
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
- type: 'null'
assignedTeamId:
anyOf:
- type: string
format: uuid
pattern: >-
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
- type: 'null'
ownerUserId:
anyOf:
- type: string
format: uuid
pattern: >-
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
- type: 'null'
ownerTeamId:
anyOf:
- type: string
format: uuid
pattern: >-
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
- type: 'null'
conversationId:
anyOf:
- type: string
format: uuid
pattern: >-
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
- type: 'null'
parentTicketId:
anyOf:
- type: string
format: uuid
pattern: >-
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
- type: 'null'
mergedIntoTicketId:
anyOf:
- type: string
format: uuid
pattern: >-
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
- type: 'null'
splitFromTicketId:
anyOf:
- type: string
format: uuid
pattern: >-
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
- type: 'null'
flowId:
anyOf:
- type: string
format: uuid
pattern: >-
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
- type: 'null'
agentId:
anyOf:
- type: string
format: uuid
pattern: >-
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
- type: 'null'
firstResponseAt:
anyOf:
- type: string
- type: 'null'
resolvedAt:
anyOf:
- type: string
- type: 'null'
closedAt:
anyOf:
- type: string
- type: 'null'
snoozedUntil:
anyOf:
- type: string
- type: 'null'
lastCustomerActivityAt:
anyOf:
- type: string
- type: 'null'
lastAgentActivityAt:
anyOf:
- type: string
- type: 'null'
isShared:
type: boolean
id:
type: string
format: uuid
pattern: >-
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
createdAt:
type: string
updatedAt:
type: string
additionalProperties: false
metadata:
type: object
properties:
hasNextPage:
type: boolean
required:
- hasNextPage
additionalProperties: false
required:
- data
- metadata
additionalProperties: false
'400':
description: Invalid input data
content:
application/json:
schema:
$ref: '#/components/schemas/error.BAD_REQUEST'
'401':
description: Authorization not provided
content:
application/json:
schema:
$ref: '#/components/schemas/error.UNAUTHORIZED'
'403':
description: Insufficient access
content:
application/json:
schema:
$ref: '#/components/schemas/error.FORBIDDEN'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
security:
- Authorization: []
components:
schemas:
error.BAD_REQUEST:
type: object
properties:
message:
type: string
description: The error message
example: Invalid input data
code:
type: string
description: The error code
example: BAD_REQUEST
issues:
description: An array of issues that were responsible for the error
example: []
type: array
items:
type: object
properties:
message:
type: string
required:
- message
additionalProperties: false
required:
- message
- code
additionalProperties: false
title: Invalid input data error (400)
description: The error information
example:
code: BAD_REQUEST
message: Invalid input data
issues: []
error.UNAUTHORIZED:
type: object
properties:
message:
type: string
description: The error message
example: Authorization not provided
code:
type: string
description: The error code
example: UNAUTHORIZED
issues:
description: An array of issues that were responsible for the error
example: []
type: array
items:
type: object
properties:
message:
type: string
required:
- message
additionalProperties: false
required:
- message
- code
additionalProperties: false
title: Authorization not provided error (401)
description: The error information
example:
code: UNAUTHORIZED
message: Authorization not provided
issues: []
error.FORBIDDEN:
type: object
properties:
message:
type: string
description: The error message
example: Insufficient access
code:
type: string
description: The error code
example: FORBIDDEN
issues:
description: An array of issues that were responsible for the error
example: []
type: array
items:
type: object
properties:
message:
type: string
required:
- message
additionalProperties: false
required:
- message
- code
additionalProperties: false
title: Insufficient access error (403)
description: The error information
example:
code: FORBIDDEN
message: Insufficient access
issues: []
error.INTERNAL_SERVER_ERROR:
type: object
properties:
message:
type: string
description: The error message
example: Internal server error
code:
type: string
description: The error code
example: INTERNAL_SERVER_ERROR
issues:
description: An array of issues that were responsible for the error
example: []
type: array
items:
type: object
properties:
message:
type: string
required:
- message
additionalProperties: false
required:
- message
- code
additionalProperties: false
title: Internal server error error (500)
description: The error information
example:
code: INTERNAL_SERVER_ERROR
message: Internal server error
issues: []
securitySchemes:
Authorization:
type: http
scheme: bearer
````