API reference

Support

Support tickets and the public contact form.

5 operationsBase URL https://packetexchange.io/api/v1Postman collection

List your support tickets

GET/api/v1/tickets

Access: API key. Full-access keys only; not reachable by scoped keys.
Rate limit: 100 requests per second (the default)

Response 200

Field	Type	Description
`data`required	object[]	-
`id`requireddata[].id	string (uuid)	-
`userId`requireddata[].userId	string (uuid) \| null	-
`guestEmail`requireddata[].guestEmail	string \| null	-
`category`requireddata[].category	string	Ticket category, e.g. billing_dispute, technical_support, other
`subject`requireddata[].subject	string	-
`status`requireddata[].status	string	-One of `open`, `in_progress`, `resolved`, `closed`
`relatedRouteId`requireddata[].relatedRouteId	string (uuid) \| null	-
`relatedPurchaseId`requireddata[].relatedPurchaseId	string (uuid) \| null	-
`assignedTo`requireddata[].assignedTo	string (uuid) \| null	-
`createdAt`requireddata[].createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`resolvedAt`requireddata[].resolvedAt	string (date-time) \| null	ISO-8601 timestamp (UTC)

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Open a support ticket

POST/api/v1/tickets

Access: API key. Full-access keys only; not reachable by scoped keys.
Rate limit: 100 requests per second (the default)

The message becomes the first entry in the thread and support is alerted.

Request body (application/json)

Field	Type	Description
`subject`required	string	-max 200 chars
`message`required	string	-max 5000 chars
`category`	string	-max 50 chars

Response 200

Field	Type	Description
`data`required	object	Same fields as SupportTicket, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/tickets" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "subject": "<subject>",
  "message": "Hello from Acme"
}'

Run it here with a test key.

Get a support ticket with its messages

GET/api/v1/tickets/{id}

Access: API key. Full-access keys only; not reachable by scoped keys.
Rate limit: 100 requests per second (the default)

Internal staff notes are never included.

Parameters

Name	In	Type	Description
`id`required	path	string	-

Response 200

Field	Type	Description
`data`required	object	-
`id`requireddata.id	string (uuid)	-
`userId`requireddata.userId	string (uuid) \| null	-
`guestEmail`requireddata.guestEmail	string \| null	-
`category`requireddata.category	string	Ticket category, e.g. billing_dispute, technical_support, other
`subject`requireddata.subject	string	-
`status`requireddata.status	string	-One of `open`, `in_progress`, `resolved`, `closed`
`relatedRouteId`requireddata.relatedRouteId	string (uuid) \| null	-
`relatedPurchaseId`requireddata.relatedPurchaseId	string (uuid) \| null	-
`assignedTo`requireddata.assignedTo	string (uuid) \| null	-
`createdAt`requireddata.createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`resolvedAt`requireddata.resolvedAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`messages`requireddata.messages	object[]	-
`id`requireddata.messages[].id	string (uuid)	-
`authorId`requireddata.messages[].authorId	string (uuid) \| null	-
`message`requireddata.messages[].message	string	-
`createdAt`requireddata.messages[].createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`authorName`data.messages[].authorName	string \| null	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Reply to a support ticket

POST/api/v1/tickets/{id}/messages

Access: API key. Full-access keys only; not reachable by scoped keys.
Rate limit: 100 requests per second (the default)

Replying to a resolved ticket reopens it.

Parameters

Name	In	Type	Description
`id`required	path	string	-

Request body (application/json)

Field	Type	Description
`message`required	string	-max 5000 chars

Response 200

Field	Type	Description
`data`required	object	-
`id`requireddata.id	string (uuid)	-
`authorId`requireddata.authorId	string (uuid) \| null	-
`message`requireddata.message	string	-
`createdAt`requireddata.createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`ticketId`requireddata.ticketId	string (uuid)	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/tickets/<id>/messages" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "message": "Hello from Acme"
}'

Run it here with a test key.

Contact support without an account

POST/api/v1/support/tickets

Access: Key optional. A key or token personalises the answer.
Rate limit: 5 requests per hour

The public contact form. When a valid credential is sent the ticket is filed on that account instead of as a guest ticket; an invalid credential is ignored, never refused.

Request body (application/json)

Field	Type	Description
`subject`required	string	-max 200 chars
`message`required	string	-max 5000 chars
`email`required	string (email)	-max 254 chars

Response 200

Field	Type	Description
`data`required	object	-
`id`requireddata.id	string (uuid)	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/support/tickets" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "subject": "<subject>",
  "message": "Hello from Acme",
  "email": "you@example.com"
}'

Run it here with a test key.