Skip to content

Get a ticket with its whole thread

GET
/products/{productId}/tickets/{id}
curl --request GET \
--url https://api.motenya.app/v1/products/example/tickets/example \
--header 'Authorization: Bearer <token>'

Requires tickets:read.

productId
required
string
>= 1 characters <= 64 characters
id
required
string
>= 1 characters <= 64 characters

Success

Media typeapplication/json
object
ticket
required
object
id
required
string
>= 1 characters <= 64 characters
productId
required
string
>= 1 characters <= 64 characters
number
required
integer
subject
required
string | null
status
required
string
Allowed values: OPEN PENDING SOLVED CLOSED
priority
required
string
Allowed values: LOW NORMAL HIGH URGENT
source
required
string
Allowed values: EMAIL HELP_CENTER WIDGET
channelId
required
string | null
requester
required
object
id
required
string
>= 1 characters <= 64 characters
email
required
string
name
required
string | null
contactId
required

The CRM contact; null for a lead.

string | null
>= 1 characters <= 64 characters
storeIds
required
Array<string>
assigneeUserId
required
string | null
tags
required
Array<string>
mergedIntoTicketId
required
string | null
>= 1 characters <= 64 characters
createdAt
required
string
updatedAt
required
string
lastActivityAt
required
string
key
additional properties
messages
required
Array<object>

REPLY adds sendState and sendError; EVENT adds change, merge and automatedReason.

object
id
required
string
>= 1 characters <= 64 characters
kind
required
string
Allowed values: CUSTOMER REPLY NOTE EVENT
fromAddress
required
string | null
fromName
required
string | null
authorUserId
required

The teammate, or apikey:<id> for a key.

string | null
subject
required
string | null
bodyText
required
string | null
bodyHtml
required
string | null
attachments
required
Array<object>
object
id
required
string
>= 1 characters <= 64 characters
filename
required
string | null
contentType
required
string
size
required
integer
key
additional properties
createdAt
required
string
key
additional properties
previousTicket
required
object
id
required
string
>= 1 characters <= 64 characters
number
required
integer
subject
required
string | null
mergedInto
required
object
id
required
string
>= 1 characters <= 64 characters
number
required
integer
subject
required
string | null

Example

{
"ticket": {
"status": "OPEN",
"priority": "LOW",
"source": "EMAIL"
},
"messages": [
{
"kind": "CUSTOMER"
}
]
}

Invalid request

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Missing, invalid, revoked or expired API key

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Missing scope, API turned off, published article without publish scope, or account suspended

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Not found, or outside the knowledge bases this key may use

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Slug or translation already exists

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Rejected by validation (e.g. unknown language or category)

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Rate limited; see Retry-After

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Internal error