Skip to navigation
API Referencecollection.v1DeviceCollectionService

ListCollections

View as Markdown
Lists all collections for the organization

ListCollectionsRequest

Request
This endpoint expects an object.
typeenum

Filter by collection type (optional, returns all types if unspecified)

Allowed values:
page_sizeinteger

Maximum number of collections to return (0 = server default)

page_tokenstring
Pagination cursor from a previous response
sortobject

Sort configuration (defaults to name ascending). Supported fields: SORT_FIELD_NAME, SORT_FIELD_DEVICE_COUNT.

error_component_typeslist of enums

Filter by collections containing devices with open errors of these component types. When non-empty, only collections with at least one device having an open error matching any of the specified component types are returned.

zoneslist of strings

Filter by rack zones. Only valid when type is RACK. When non-empty, only racks in any of the specified zones are returned.

ListCollectionsResponse

Response
This endpoint returns an object.
collectionslist of objects
List of collections ordered by label
next_page_tokenstring
Cursor for the next page, empty if no more results
total_countinteger
Total number of collections matching the request filters