For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Home Guides API Reference

Home Guides API Reference

API Reference

API Reference collection.v1 DeviceCollectionService

ListCollectionMembers

||View as Markdown|

Example request

1 {
2   "collection_id": 42,
3   "page_size": 42,
4   "page_token": "example"
5 }

Example response

1 {
2   "members": [
3     {
4       "member_details": {
5         "rack": {
6           "slot_position": {
7             "row": 42,
8             "column": 42
9           }
10         }
11       },
12       "device_identifier": "example",
13       "added_at": {
14         "seconds": 42,
15         "nanos": 42
16       }
17     }
18   ],
19   "next_page_token": "example"
20 }

Lists members of a collection

ListCollectionMembersRequest

Request

This endpoint expects an object.

collection_idlong

ID of the collection to list members for

page_sizeinteger

Maximum number of members to return (default: all)

page_tokenstring

Pagination cursor from a previous response

ListCollectionMembersResponse

Response

This endpoint returns an object.

memberslist of objects

List of members ordered by when they were added (newest first)

next_page_tokenstring

Cursor for the next page, empty if no more results