List active hubs
Returns a paginated list of all active hubs, optionally filtered by hub ID and sorted by a chosen column.
Prerequisites
- Authentication and setup: A valid access token.
Endpoint
Section titled “Endpoint”POST /api/assethub/v1/hubsBase URL: the API3 REST host for your region. See Base URLs.
Headers: Authorization: Bearer ACCESS_TOKEN, Content-Type: application/json.
Request
Section titled “Request”| Parameter | Type | Required | Description |
|---|---|---|---|
hub_ids |
string[] | Optional | List of hub IDs to filter by. Any array of hub_id strings. |
skip |
int32 | Optional | Number of hubs to skip for pagination. Must be 0 or more. |
limit |
int32 | Optional | Maximum number of hubs to return for pagination. Must be from 1 to 100. Default: 100. |
order_by.field |
string | Required if order_by is used |
Column to order by. One of title, updated_at, created_at, created_by, hub_type, hub_id. |
order_by.order |
string | Required if order_by is used |
Sort direction. ASC or DESC. |
Request example
Section titled “Request example”{ "skip": 0, "limit": 2}Response
Section titled “Response”| Field | Type | Description |
|---|---|---|
total_hubs_count |
int | Total number of hubs. |
hub_details[].id |
string | Hub unique identifier. |
hub_details[].title |
string | Hub name. |
hub_details[].description |
string | Hub description. Present only if the hub has a description. |
hub_details[].last_updated_at |
string | Epoch in seconds. |
Response example
Section titled “Response example”{ "total_hubs_count": 312, "hub_details": [ { "id": "123456789012345101", "title": "134123", "last_updated_at": "1751011672" }, { "id": "123456789012345102", "title": "312", "last_updated_at": "1751011668" } ]}- Validation:
fieldandorderare both required iforder_byis used. - Behavior: Invalid
hub_idsare silently ignored. No error is returned. - Behavior: If
skipresults in an empty page, thehub_detailskey may be missing entirely.