Collections
List collections
Returns the tree the catalog is organized by as a FLAT list: every node with its parentId, its full path and its depth, so the tree is rebuilt in one pass.
collections:readcollections:read- 120/min
- Server annotation: Read-only
- Server annotation: Idempotent
Result
generated from the schema
Filter by what the collections group (entityType) or by parent collection. Sorted by path.
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: path, name, order, depth, itemCount, createdAt, updatedAt. Defaults to "path". 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 what the collections group: item, space, vehicle, staff or service.
Available options: item, space, vehicle, staff, service
Filter by entityType, 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, space, vehicle, staff, service
Limits: min 1 items, max 50 items
Filter by parent collection: only its direct children are returned.
Limits: min length 1
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 identifier of the collection.
Collection name.
Full name from the top-level collection, with the levels joined by " > ".
What the collection groups: item, space, vehicle, staff or service.
Available options: item, space, vehicle, staff, service
Identifier of the parent collection; null for a top-level collection.
Levels above it: 0 for a top-level collection, 1 for its children, and so on.
Display order among its siblings.
Entities directly in this collection, without counting its sub-collections.
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/collections.
Related pages
Link to this section: Related pagesCollections
List collections
Returns the tree the catalog is organized by as a FLAT list: every node with its
parentId, its fullpathand itsdepth, so the tree is rebuilt in one pass.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?