v2/hubs/{hubId}/collections
Lists collections with optional filtering and pagination
Resource Information
| Method and URI | GET https://api.aps.autodesk.com/content-catalog/v2/hubs/{hubId}/collections |
| Authentication Context | user context required |
| Required OAuth Scopes | data:read |
| Data Format | JSON |
Request
Headers
| Authorization* string | Must be Bearer <token>, where <token> is a three-legged access token obtained via an
Authorization Code flow
or a Secure Service Account flow.
The Secure Service Account (SSA) flow is designed for headless server-to-server operations. While it functions like a two-legged flow (no user interaction), it is classified as three-legged because it preserves user context. |
| Region string | Region identifier for API routing. Defaults to US if not provided. |
Request
URI Parameters
| hubId string | Hub ID to filter collections for |
Request
Query String Parameters
| filter string | RSQL filter expression to filter collections.
Supported operators: - == (equals), != (not equals) - =in=(v1,v2,…) (value in list), =out=(v1,v2,…) (value not in list) - =lt=, =gt=, =le=, =ge= (date fields only — NOT supported on id) - ; (AND), , (OR) - * wildcard on string fields only — NOT supported on id Supported fields: - id: Filter by collection ID (UUID format, uppercase). Only ==, !=, =in=, =out= are supported; wildcards and range operators are rejected with HTTP 400. - name: Filter by collection name (supports wildcards: *) - description: Filter by collection description - isChannelSubscription: Filter by channel subscription status (true/false). Only ==, !=, =in=, =out= are supported; wildcards and range operators are rejected with HTTP 400. - createdAt: Filter by creation date (supports range operators) - updatedAt: Filter by last update date (supports range operators) - createdBy: Filter by the user who created the collection - updatedBy: Filter by the user who last updated the collection Restrictions: - id predicates cannot be combined with other fields inside an OR expression (e.g., id==A,name==foo is rejected). Use id=in=(…) to OR multiple ids. This applies at any nesting depth, so name==x;(description==y,id==A) is rejected too. - An id inclusion predicate (id== or id=in=) cannot be combined with any other predicate (e.g., id=in=(A,B);name==foo is rejected with HTTP 400). Filter by id alone, or filter by non-id fields without an id inclusion. (id!= / id=out= exclusions may be combined with other fields.) Parentheses do not change this: name==x;(description==y;id==A) is rejected on the same grounds. - Repeated id inclusion predicates are AND-ed, so they narrow each other rather than accumulating: id=in=(A,B);id=in=(B,C) returns only B, and id==A;id==B returns an empty list because no collection can be both. - Each =in= / =out= list is limited to 100 values. Pagination notes: - For exclusion filters (id!=, id=out=), the returned page may contain fewer items than limit because the limit is consumed at the database level before in-memory exclusion. Follow nextCursorState to retrieve further pages. - For inclusion filters (id==, id=in=), limit and sort are applied to the looked-up collections before the page is returned, and nextCursorState pages through the remainder — an id=in=(…) of 80 ids with limit=10 returns 10 ordered items and a cursor, not 80. Examples: - name==*Project* - Collections with “Project” in name - isChannelSubscription==true - Channel subscription collections only - isChannelSubscription==false - Private (non-channel) collections only - name==*Design*;isChannelSubscription==false - Private collections with “Design” in name - name==A,name==B - Collections named A OR B (OR expression) - id==3F2504E0-4F89-11D3-9A0C-0305E82C3301 - Lookup a single collection by id - id=in=(3F2504E0-4F89-11D3-9A0C-0305E82C3301,A122B37C-D8CD-497C-9DF3-24971A4C17BB) - Lookup multiple collections by id - id!=3F2504E0-4F89-11D3-9A0C-0305E82C3301 - Exclude a single collection by id - name==*Design*;id!=3F2504E0-4F89-11D3-9A0C-0305E82C3301 - All “Design” collections except one |
| sort string | Sort order for collections. Prefix with - for descending. Currently supported values: name, -name, updatedAt, -updatedAt. Default: name (alphabetical by collection name). |
| limit int | Maximum number of collections to return (default: 20, max: 100) |
| cursorState string | The opaque data describing the pagination state to the server. |
Response
HTTP Status Code Summary
| 200 OK | Collections retrieved successfully |
| 400 Bad Request | The server was unable to process the request. The syntax of the request is malformed or the request is missing a required header. Do not repeat the request without fixing the issue. The response body may indicate what is wrong with the request. |
| 403 Forbidden | Unauthorized |
| 500 Internal Server Error | An unexpected error occurred on the server, preventing it from completing your request. Please try again later. If the issue persists, contact the support team for assistance. |
Response
Body Structure (200)
| results array: object | List of collections |
| id string | Unique identifier for the collection (UUID format, uppercase) |
| hubId string | Hub (account) that owns this collection (UUID format, uppercase) |
| name string | Display name for the collection (stored as Name in GraphQL)
Max length: 255 |
| description string | Detailed description of the collection
Max length: 2000 |
| createdBy string | User ID who created this collection |
| createdAt datetime: ISO 8601 | Creation timestamp |
| updatedAt datetime: ISO 8601 | Last update timestamp |
| updatedBy string | User ID who last updated this collection |
| channelSubscription object | For future use. Identifies the publisher channel this collection is subscribed to. Both fields are required and must be valid UUIDs. This object is invariant — when provided, both fields must be present. If the created collection is not a channel subscription, this field must be null. |
| channelId string: UUID | The publisher’s channel (collection) ID |
| publisherId string: UUID | The publisher’s hub (company) ID |
| groupAssignments object | Groups assigned to different permission levels for a collection. Each field is an array of group IDs (UUIDs or special identifiers like “-ACCOUNT-UUID” for company-wide access). |
| readGroups array: string | Group IDs with read access to this collection |
| editGroups array: string | Group IDs with edit access to this collection |
| uploadGroups array: string | Group IDs with upload access to this collection |
| downloadInsertGroups array: string | Group IDs with download/insert access to this collection |
| permissions object | Current user’s resolved permissions for this collection. This field is read-only and computed server-side based on the user’s group memberships. For admin users, all permissions are true. |
| canRead boolean | Whether the current user can view this collection |
| canDownloadInsert boolean | Whether the current user can download/insert content from this collection |
| canUpload boolean | Whether the current user can upload content to this collection |
| canEdit boolean | Whether the current user can edit this collection’s metadata |
| pagination object | Pagination information for cursor-based navigation |
| limit int | The limit value used by the server in the response |
| cursorState string | CursorState from the request |
| nextUrl string | Link that will return the next page of data. Null if this is the last page |
| nextCursorState string | The cursorState parameter for requesting the next page. Intended for clients that build request URLs programmatically instead of using nextUrl. Null if this is the last page |
Example
Collections retrieved successfully
Request
curl -v 'https://developer.api.autodesk.com/content-catalog/v2/hubs/A122B37C-D8CD-497C-9DF3-24971A4C17BB/collections?filter=name==*Project*&sort=-updatedAt&limit=20&cursorState=AMMAEACAtgALYWRzay53aXBkZXYNZnMuZmlsZS5hZGRlZAZmb2xk' \
-H 'Authorization: '
Response
{
"results": [
{
"id": "C652DFB6-2A4B-4AFC-8572-892DCCC3577F",
"hubId": "A122B37C-D8CD-497C-9DF3-24971A4C17BB",
"name": "Air Handler Units",
"description": "Approved Air Handler Units for hospital projects.",
"createdBy": "7VYJW2XPP7DJQGZW",
"createdAt": "2024-01-29T10:30:00.000Z",
"updatedAt": "2024-02-05T09:15:00.000Z",
"updatedBy": "7VYJW2XPP7DJQGZW",
"channelSubscription": null,
"groupAssignments": {
"readGroups": [
"A122B37C-D8CD-497C-9DF3-24971A4C17BB",
"6A10A175-3374-4586-BADB-182D40747ECC"
],
"editGroups": [
"A122B37C-D8CD-497C-9DF3-24971A4C17BB"
],
"uploadGroups": [
"A122B37C-D8CD-497C-9DF3-24971A4C17BB"
],
"downloadInsertGroups": [
"A122B37C-D8CD-497C-9DF3-24971A4C17BB"
]
},
"permissions": {
"canRead": true,
"canDownloadInsert": true,
"canUpload": true,
"canEdit": true
}
}
],
"pagination": {
"limit": 20,
"cursorState": "eyJxYyI6Im...",
"nextUrl": "https://api.aps.autodesk.com/content-catalog/v2/...",
"nextCursorState": "eyJxYyI6Im..."
}
}