Services
List services
Returns the sellable services of the catalogue, cursor-paginated: personnel, transport and work days that do not come from inventory, with their requirements and tags.
services:readservices:read- 120/min
- Server annotation: Read-only
- Server annotation: Idempotent
Result
generated from the schema
Filter by type, collection and a single tag. Sorted by name; sort accepts a single field. Costs and the internal name are not published; creation and update date filters 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: a single field, with a leading "-" for descending (e.g. "-updatedAt"). Sortable fields: name, serviceType, defaultQty, createdAt, updatedAt. Defaults to "name". 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 type: crew (personnel), fleet (vehicles) or general.
Available options: crew, fleet, general
Filter by identifier of the collection the service belongs to.
Limits: min length 1, max length 100
Filter by collectionId, 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 tag identifier: services that carry that tag.
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.
Result
On success the result carries structuredContent with data and meta. These are the attributes of data.
Show the attributes of data
Unique service identifier.
Service name as the customer sees it.
Type: crew (personnel), fleet (vehicles) or general.
Description; null if it has none.
Quantity added to an order by default.
Whether it appears as a plannable service.
Whether its amount counts towards the document total.
Path of the collection it belongs to; null if it is in none.
Resources needed to provide it.
Show child attributesHide child attributes
What is needed to provide it: personnel or vehicle.
Available options: personnel, vehicle
How many are needed.
Limits: min 1
Tags the assigned resource must have. E.g.: "Carné C".
Limits: max 20 items, each max length 100
Creation date in ISO 8601 UTC; null if not recorded.
Last modification date in ISO 8601 UTC; null if not recorded.
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/services.
Related pages
Link to this section: Related pagesServices
List services
Returns the sellable services of the catalogue, cursor-paginated: personnel, transport and work days that do not come from inventory, with their requirements and tags.
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?