Incidents
List incidents
Returns the incidents of the account, cursor-paginated: broken, lost or malfunctioning material with its repair status.
incidents:readincidents:read- 120/min
- May need an add-on
- Server annotation: Read-only
- Server annotation: Idempotent
Result
generated from the schema
Filter by status, nature, scope, priority, severity, availability impact, affected resource, order, project, assignee, creation date and target resolution date. Sorted by creation date, newest first; sort accepts a single field. Repair costs, resolution notes and whether the cost is charged to the client are not published. Behind the incidence add-on: without it, 402.
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
Sort order: a single field, with a leading "-" for descending (e.g. "-updatedAt"). Sortable fields: createdAt, updatedAt, dueDate, identifier, title, status, priority. 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 lifecycle status: draft, open, waiting, repairing, complete or lost.
Available options: draft, open, waiting, repairing, complete, lost
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, open, waiting, repairing, complete, lost
Limits: min 1 items, max 50 items
Filter by nature: damage, loss, malfunction, cosmetic, theft or custom.
Available options: damage, loss, malfunction, cosmetic, theft, custom
Filter by type, 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: damage, loss, malfunction, cosmetic, theft, custom
Limits: min 1 items, max 50 items
Filter by what it affects: item, serializedItem, space, kit, vehicle or custom.
Available options: item, serializedItem, space, kit, vehicle, custom
Filter by scope, 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: item, serializedItem, space, kit, vehicle, custom
Limits: min 1 items, max 50 items
Filter by priority: urgent, high, medium, low or none.
Available options: urgent, high, medium, low, none
Filter by priority, 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: urgent, high, medium, low, none
Limits: min 1 items, max 50 items
Filter by severity: low, high or blocking.
Available options: low, high, blocking
Filter by severity, 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: low, high, blocking
Limits: min 1 items, max 50 items
Filter by availability impact: "true" only incidents that remove the material from the available pool, "false" only those that do not. Omit it to apply no filter.
Filter by affected item.
Limits: min length 1, max length 100
Filter by affected physical unit.
Limits: min length 1, max length 100
Filter by affected space.
Limits: min length 1, max length 100
Filter by affected vehicle.
Limits: min length 1, max length 100
Filter by the order in which it was detected.
Limits: min length 1, max length 100
Filter by associated project.
Limits: min length 1, max length 100
Filter by assigned staff member (the same identifier that assigneeStaffIds takes when writing).
Limits: min length 1, 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, due.
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 incident identifier.
Human-readable incident number.
Short title of the incident.
Description; null if it has none.
Nature: damage, loss, malfunction, cosmetic, theft or custom.
What it affects: item, serializedItem, space, kit, vehicle or custom.
Available options: item, serializedItem, space, kit, vehicle, custom
Lifecycle status: draft, open, waiting, repairing, complete or lost.
Priority: urgent, high, medium, low or none.
Declared severity.
true when the incident removes the material from the available pool.
Affected units in bulk stock; null when not applicable.
Affected item; null if not applicable.
Affected physical unit; null if not applicable.
Affected space; null if not applicable.
Affected vehicle; null if not applicable.
Order in which it was detected; null if not applicable.
Associated project; null if not applicable.
Target resolution date in ISO 8601 UTC; null if it has none.
Comments the incident has.
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.
Sample prompts
List the open incidents and which items they affect.
The same operation by REST
This tool runs GET /api/v1/incidents.
Related pages
Link to this section: Related pagesIncidents
List incidents
Returns the incidents of the account, cursor-paginated: broken, lost or malfunctioning material with its repair status.
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?