Repair tickets
List repair tickets
Returns the repair tickets of the account, cursor-paginated: what broke, on which order it came back broken and what the customer is quoted to fix it.
repair-tickets:readrepair-tickets:read- 120/min
- May need an add-on
- Server annotation: Read-only
- Server annotation: Idempotent
Result
generated from the schema
Amounts are sale amounts to the customer; the repair cost is not published.
Arguments
Page size (1-500). Defaults to 50.
Limits: min 1, max 500
Opaque cursor of the page to return. Pass the value of pagination. from the previous response; treat it as opaque.
Limits: max length 200
Free-text search on the ticket number and the notes.
Limits: min length 1, max length 200
Sort order: up to 3 comma-separated fields, each with a leading "-" for descending (e.g. "-updatedAt,name"). Sortable fields: createdAt, updatedAt, date, status, total. Defaults to "-createdAt". Ties are broken by id, so the order is stable across pages, and a cursor is bound to the sort it was issued with.
Limits: max length 200
Filter by ticket status: draft, sent, partially_converted, fully_invoiced or closed.
Available options: draft, sent, partially_converted, fully_invoiced, closed
Filter by status, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.
Available options: draft, sent, partially_converted, fully_invoiced, closed
Limits: min 1 items, max 50 items
Filter by identifier of the order the ticket comes from.
Limits: min length 1, max length 100
Filter by orderId, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.
Limits: min 1 items, max 50 items, each min length 1, each max length 100
Filter by identifier of the client responsible for the repair.
Limits: min length 1, max length 100
Filter by contactId, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.
Limits: min 1 items, max 50 items, each min length 1, each max length 100
Set it to true to include pagination., the number of results that match the filters across all pages. Off by default.
Date filters by field. A bare day (YYYY-MM-DD) is read in the business timezone; an ISO 8601 instant with offset is applied as is by gte, lte, gt and lt, while on widens it to the whole business day that contains it. Fields: created, updated.
Show child attributesHide child attributes
Show child attributesHide child attributes
From this day or instant, inclusive.
Up to this day or instant, inclusive.
Strictly after; a bare day means after the end of that day.
Strictly before; a bare day means before the start of that day.
Exactly that day; an instant means the whole business day that contains it.
Show child attributesHide child attributes
From this day or instant, inclusive.
Up to this day or instant, inclusive.
Strictly after; a bare day means after the end of that day.
Strictly before; a bare day means before the start of that day.
Exactly that day; an instant means the whole business day that contains it.
Result
On success the result carries structuredContent with data and meta. These are the attributes of data.
Show the attributes of data
Unique ticket identifier.
Ticket number, for example "RT-2026-0001".
Issue date in ISO 8601 UTC.
Status of the ticket in its lifecycle.
Available options: draft, sent, partially_converted, fully_invoiced, closed
Identifier of the order it comes from; null if it was created standalone.
Number of the order it comes from; null if it was created standalone.
Identifier of the responsible client; null if none has been assigned.
Name of the responsible client; null if not resolved.
Sum of the lines before taxes, as a decimal string "1234.50".
Limits: pattern ^-?\d+\.\d{2}$
Tax total, as a decimal string "1234.50".
Limits: pattern ^-?\d+\.\d{2}$
Total including taxes, as a decimal string "1234.50".
Limits: pattern ^-?\d+\.\d{2}$
Number of lines in the ticket.
General remarks; null if it has none.
Creation date in ISO 8601 UTC.
Last modification date in ISO 8601 UTC.
An error is a result with isError: true and the problem in content[0].; there is no structuredContent. See Errors.
The same operation by REST
This tool runs GET /api/v1/repair-tickets.
Related pages
Link to this section: Related pagesRepair tickets
List repair tickets
Returns the repair tickets of the account, cursor-paginated: what broke, on which order it came back broken and what the customer is quoted to fix it.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with
isError: trueand the problem in the first text block. Branch on itscode.
Was this page helpful?