Internal services
List internal services
Returns the plannable assignments not attached to an order, cursor-paginated.
internal-services:readinternal-services:read- 120/min
- Server annotation: Read-only
- Server annotation: Idempotent
Result
generated from the schema
Filter by status, type, project and an overlap window (overlapsFrom/overlapsTo: assignments whose period overlaps it). Sorted by start date. Creation and update date filters and filtering by assigned resource are not available on this listing.
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: up to 3 comma-separated fields, each with a leading "-" for descending (e.g. "-updatedAt,name"). Sortable fields: startDate, endDate, title, status, createdAt, updatedAt. Defaults to "startDate". 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 status: active, completed or cancelled.
Available options: active, completed, cancelled
Filter by type: crew (personnel), fleet (vehicles) or general.
Available options: crew, fleet, general
Filter by associated project.
Limits: min length 1, max length 100
Start of the overlap window: returns assignments whose period overlaps [overlapsFrom, overlapsTo]. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.
End of the overlap window: returns assignments whose period overlaps [overlapsFrom, overlapsTo]. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.
Set it to true to include pagination., the number of results that match the filters across all pages. Off by default.
Result
On success the result carries structuredContent with data and meta. These are the attributes of data.
Show the attributes of data
Unique assignment identifier.
Assignment title.
Status: active, completed or cancelled.
Start in ISO 8601 UTC.
End in ISO 8601 UTC.
Associated project; null if not applicable.
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/internal-services.
Related pages
Link to this section: Related pagesInternal services
List internal services
Returns the plannable assignments not attached to an order, cursor-paginated.
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?