Ir al contenido
Aymar Agents

Get Ticket

Ver como Markdown
GET
/public/v1/tickets/{ticket_id}
curl --request GET \
  --url https://api.aymaragents.com/public/v1/tickets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'X-API-Key: <X-API-Key>'

Return a single ticket with its embedded comment thread (SPEC_API_PUBLICA.md §2.5).

Foreign/unknown ticketId -> 404.

Permiso necesario: tenant:tickets.read

Authorizations

Sección titulada «Authorizations»

Parameters

Sección titulada «Parameters»

Path Parameters

Sección titulada «Path Parameters»
ticket_id
required
Ticket Id
string format: uuid

Responses

Sección titulada «Responses»

200

Sección titulada «200»

Successful Response

Media typeapplication/json
PublicTicketOut

A single ticket with its embedded comment thread – same shape as the internal TicketOut (nothing curated away: every field here is already an id/status/text a third party legitimately needs to track its own ticket).

object
id
required
Id
string
customerId
Any of:
string
leadId
Any of:
string
conversationId
Any of:
string
subject
required
Subject
string
status
required
Status
string
createdBy
required
Createdby
string
assignedTo
Any of:
string
createdAt
required
Createdat
string
updatedAt
required
Updatedat
string
comments
Comments
Array<object>
PublicTicketCommentOut

One comment in a ticket’s thread – same shape as the internal TicketCommentOut.

object
id
required
Id
string
authorUserId
required
Authoruserid
string
body
required
Body
string
createdAt
required
Createdat
string

Examplegenerated

{
  "id": "example",
  "customerId": "example",
  "leadId": "example",
  "conversationId": "example",
  "subject": "example",
  "status": "example",
  "createdBy": "example",
  "assignedTo": "example",
  "createdAt": "example",
  "updatedAt": "example",
  "comments": [
    {
      "id": "example",
      "authorUserId": "example",
      "body": "example",
      "createdAt": "example"
    }
  ]
}

422

Sección titulada «422»

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object

Examplegenerated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}