Skip to main content
GET
Retrieve support tickets
OAuth2 scopes required: read:support-ticket. See Scopes for OAuth apps.

Authorizations

Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Query Parameters

page
integer
default:1

The page number to retrieve (1-indexed).

Required range: x >= 1
Example:

1

size
integer
default:15

The number of items per page (max 20).

Required range: 1 <= x <= 20
Example:

15

status
enum<string>

Filter by ticket status. Current ticket status.

Available options:
action_required,
carrier_reminder_sent,
carrier_update_received,
claim_paid,
closed,
communicated_to_carrier,
customer_documents_requested,
customer_reminder_sent,
delayed,
delivered_scan_received,
delivery_confirmation_rejected,
delivery_confirmation_requested,
documents_forwarded_to_carrier,
escalated,
escalated_ava,
hold,
manually_solved,
new_scan_received,
pending,
processing,
smart_refund_available,
smart_refund_update,
solved,
solved_by_automation,
unknown,
waiting_for_carrier,
waiting_for_customer,
waiting_for_scan
parcel_id
integer

Filter by Sendcloud parcel ID.

Example:

12345

carrier
string

Filter by carrier code.

Example:

"postnl"

tracking_number
string

Filter by parcel tracking number. Parcel tracking number

Example:

"3SABCD1234567"

created_after
string<date-time>

Filter tickets created on or after this date (ISO 8601).

Example:

"2026-01-01T00:00:00Z"

created_before
string<date-time>

Filter tickets created on or before this date (ISO 8601).

Example:

"2026-12-31T23:59:59Z"

Response

OK

total
integer
required

Total number of tickets across all pages.

Example:

42

page
integer
required

Current page number.

Example:

1

pages
integer
required

Total number of pages.

Example:

3

size
integer
required

Number of items per page.

Example:

15

items
Support ticket · object[]
required