projects/{projectId}/collections
Retrieves information about all the collections in a project. You can use GET sheets to return all the sheets associated with a specific collection.
For more information about Sheets collections, see the Help documentation.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/construction/sheets/v1/projects/{projectId}/collections |
Authentication Context | user context optional |
Required OAuth Scopes | data:read |
Data Format | JSON |
Request
Headers
Authorization* string | Must be Bearer <token> , where <token> is obtained via either a two-legged or three-legged OAuth flow. |
x-user-id string | The ID of the user on whose behalf the API request is made. This header is optional when using a 2-legged OAuth2, but required if using 2-legged OAuth2 with user impersonation.
When using 2-legged OAuth2 without user impersonation, your app has access to all users defined by the administrator in the SaaS integrations UI. However, when user impersonation is enabled, the API call is restricted to act only on behalf of the specified user. This header is not relevant for 3-legged OAuth2. You can use either the user’s ACC ID (id), or their Autodesk ID (autodeskId). |
Request
URI Parameters
projectId string: UUID | The ID of the project. Use the Data Management API to retrieve the project ID. For more information, see the Retrieve a Project ID tutorial. You can use a project ID either with a “b.” prefix or without a “b.” prefix. For instance, a project ID of “b.a4be0c34a-4ab7” can also be referred to as “a4be0c34a-4ab7”. |
Request
Query String Parameters
offset int | The starting point for the results, specified by item number. The default value is 0 . For example, use offset=3 to start the results from the third item. |
limit int | The number of results to return in the response. |
Response
HTTP Status Code Summary
200 OK | Successfully retrieved the collections data. |
400 Bad Request | The request parameters are invalid.
Sample error code and message:
|
401 Unauthorized | The provided bearer token is invalid.
Sample error code and message:
|
403 Forbidden | The user or service associated with the bearer token does not have permission to perform this operation.
Sample error code and messages:
|
404 Not Found | The requested resource (e.g., project, account, user, sheet, or collection) does not exist.
Sample error code and messages:
|
500 Internal Server Error | An unexpected error occurred on the server.
Sample error code and messages:
|
Response
Body Structure (200)
results array: object | The list of collections. |
id string: UUID | The unique identifier of the collection. |
name string | The name of the collection. This corresponds to the Name column in the ACC Sheets Collections Settings UI. |
createdAt datetime: ISO 8601 | The date and time the collection was created. |
createdBy string | The Autodesk ID of the user who created the collection. |
createdByName string | The name of the user who created the collection. |
updatedAt datetime: ISO 8601 | The date and time the collection was last updated. |
updatedBy string | The Autodesk ID of the user who last updated the collection. |
updatedByName string | The name of the user who last updated the collection. |
pagination object | Pagination information for paged data. |
limit int | The number of results to return in the response. |
offset int | The item number from which the results begin. |
previousUrl string | The URL for the previous page of results. |
nextUrl string | The URL for the next page of results. |
totalResults int | The total number of results available. |
Example
Successfully retrieved the collections data.
Request
curl -v 'https://developer.api.autodesk.com/construction/sheets/v1/projects/9ba6681e-1952-4d54-aac4-9de6d9858dd4/collections' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"results": [
{
"id": "619ef887-974f-45e4-9775-461e6a62d784",
"name": "Group 1",
"createdAt": "2024-11-04T08:12:23.041Z",
"createdBy": "45GPJ4KAX789",
"createdByName": "John Smith",
"updatedAt": "2024-11-04T08:12:23.041Z",
"updatedBy": "45GPJ4KAX789",
"updatedByName": "John Smith"
}
],
"pagination": {
"limit": 100,
"offset": 0,
"previousUrl": "",
"nextUrl": "",
"totalResults": 1
}
}