List and search shared tickets

Access is restricted to shared mailboxes belonging to the authenticated customer.
Personal mailboxes and merged tickets are excluded; archived tickets remain accessible.
Reading does not change the ticket status, mark it as read, send mail or create a draft.
An inaccessible ticket and a missing ticket both return 404, including on sub-resources.

List responses contain data and pagination; detail responses return the ticket directly.
Without q, tickets are ordered by creation ID. With q, they are ordered by relevance,
then last message date and public ID. Emails are ordered oldest first, with ID as a tie-breaker.
Participants include archived participants so previous exchanges remain understandable.

Emails contain public, non-draft message text, quoted text, author, To/Cc recipients, direction,
sending status and date. Internal notes and drafts are excluded. HTML, attachments, inline images,
Bcc and generated download URLs are not exposed. Message text comes from the current record;
an email delivered without a text alternative exposes text derived from its HTML.
Ticket details contain active business references in context (type, public ID and role).
There is no separate description field: the conversation is available through /messages.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1
Defaults to 1

One-based page number.

integer
1 to 100
Defaults to 10

Items per page. Values above 100 are capped.

string
length ≥ 3

Uses the in-app matching rules for reference, subject, linked profile names, email, phone
and public email text. Every term must match, possibly in different fields. Recognized
references, emails and phone numbers use their specialized matching rules.
All list filters combine with q. Example: ?q=fuite&status=new,open&limit=20.
Search indexing is asynchronous; recent changes may take time to become searchable.
Current database records are returned, never search-index excerpts.
Maximum 65536 candidate tickets after access restrictions and filters; at most 10000
results can be paginated. Exceeding either limit returns 400: narrow the mailbox,
date or business filters. Results are not silently truncated. Search outages return 503.

string

Comma-separated statuses: new, open, pending_external, snoozed, solved, closed. Filters are cumulative; an unknown ID returns no matching tickets.

string

Comma-separated ticket natures: business, other. Filters are cumulative; an unknown ID returns no matching tickets.

string

Public ID of a shared mailbox. Filters are cumulative; an unknown ID returns no matching tickets.

string

Public ID of the assigned user. Filters are cumulative; an unknown ID returns no matching tickets.

string

Public profile ID attached to a ticket participant, including archived participants. Filters are cumulative; an unknown ID returns no matching tickets.

string

Public leasing contract ID referenced by an active ticket business link. Filters are cumulative; an unknown ID returns no matching tickets.

date

Inclusive creation-date lower bound, YYYY-MM-DD, in the application time zone. Filters are cumulative; an unknown ID returns no matching tickets.

date

Inclusive creation-date upper bound, YYYY-MM-DD, in the application time zone. Filters are cumulative; an unknown ID returns no matching tickets.

Headers
string

Use 1 for pagination.next instead of totals; null means the last page.

Responses

400

Invalid date, pagination or search limits

401

Missing or invalid Bearer credentials

429

Customer rate limit exceeded; retry according to Retry-After

503

Search temporarily unavailable

Language
Credentials
Bearer
pk_...:sk_...
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json