List Teams
GET
teams
Retrieves a list of teams that you currently administer. You administer a team if you currently hold the primary administrator, secondary administrator, or SSO administrator role on it. The role is checked on every request. The list is returned in pages. An unknown team and a team that you don’t administer produce the same generic permission error, so the response never reveals whether a team exists.
This operation has a rate limit of 60 calls per minute per APS client ID.
Resource Information
| Method and URI | GET https://developer.api.autodesk.com/team-admin/v1/teams |
| Authentication Context | User-delegated only (accepts only three-legged access tokens) |
| Required OAuth Scopes | tmadmapi:team: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. |
| X-Request-Id string | An optional identifier used to trace the API request across services and logs. Accepts 1–128 ASCII letters, digits, periods, underscores, or hyphens. Leading and trailing whitespace is removed. Valid identifiers are returned in the X-Request-Id response header. If omitted or invalid, a new identifier is generated. The header may be absent from some error responses. |
* Required
Request
Query String Parameters
| limit int | The maximum number of results to return per page. Accepts values from 1 to 100; values outside this range are rejected. When using a cursor to retrieve additional pages, keep the limit value unchanged. The default is 50. |
| cursor string | A token used to retrieve the next page of results. Omit this parameter for the first page. For subsequent pages, use the pagination.cursor value from the previous response and URL-encode it. Keep the same operation, caller, filters, and limit throughout pagination. Do not modify or generate the cursor yourself. Invalid or mismatched cursors return 400, while expired cursors return 410. If a cursor expires, restart pagination without a cursor. |
| teamId string | The ID of a single team to return. When specified, the list contains only that team. You must currently administer the team; an ID that doesn’t exist, or that you don’t administer, produces the same generic permission error. |
Response
HTTP Status Code Summary
| 200 OK | The list of teams was successfully retrieved. |
| 400 Bad Request | The request could not be processed due to invalid or malformed data. Check the request parameters, body format, required fields, and pagination cursor before retrying. |
| 401 Unauthorized | The request could not be authenticated because the access token is missing, invalid, or expired. Obtain a new access token and retry the request. |
| 403 Forbidden | The request was valid but lacked the necessary permissions. The access token does not hold a required scope, or you do not administer the target team. Verify your scopes and team administrator role before sending the request again. The response does not reveal whether the resource exists. An ineligible team or selected product returns problem type https://developer.api.autodesk.com/problems/team-not-eligible, title Team not eligible, and detail “This team is not eligible for Public API access.” or “The selected product is not eligible for Public API access.” |
| 410 | The pagination cursor has expired. Restart the sequence by sending the request without a cursor. |
| 429 Too Many Requests | A request rate limit was exceeded. Wait for the number of seconds in the Retry-After header before retrying. |
| 500 Internal Server Error | An unexpected error occurred in the service. Retry the request later. If the problem persists, contact support and include the request ID. |
| 502 | The API could not complete the request. Retry later. If the problem persists, contact support with the request ID when available. |
| 503 Service Unavailable | The API is temporarily unavailable. Wait for Retry-After when provided before retrying. For a write, check the user or assignment before retrying because the change may have completed. If the problem persists, contact support with the request ID when available. |
| 504 | The request did not complete in time. For a read, retry later. For a write, check the user or assignment before retrying because the change may have completed. |
Response
Header (200)
| X-Request-Id string | An identifier used to trace the API request across services and logs. Returns the valid identifier provided in the request header or a newly generated identifier if the request header was missing or invalid. May be omitted from some error responses. |
Response
Header (429)
| Retry-After integer | The number of seconds to wait before retrying the request. |
| X-Request-Id string | An identifier used to trace the API request across services and logs. Returns the valid identifier provided in the request header or a newly generated identifier if the request header was missing or invalid. May be omitted from some error responses. |
| X-RateLimit-Limit integer | The team’s shared request allowance per UTC minute, when rate-limit processing has completed. |
| X-RateLimit-Remaining integer | The number of requests remaining in the team’s shared allowance, when rate-limit processing has completed. |
| X-RateLimit-Reset integer | The time, in UTC epoch seconds, at which the team’s allowance resets, when rate-limit processing has completed. |
Response
Header (503)
| Retry-After integer | The minimum number of seconds to wait before retrying, when provided. |
Response
Body Structure (200)
Expand all
| data array: object | An array of objects where each object represents a team that you administer. |
| id string | Unique identifier for the team. Use this value as the team-id URI parameter in API requests to access this team’s data. Store and reuse the value without parsing, deriving, or constructing it.
Max length: 256 |
| name string | The display name of the team. This is the human-readable name that should be shown to users when presenting team options. |
| pagination object | Contains pagination metadata for navigating through large result sets. |
| cursor string | The token to retrieve the next page of results. When null, this is the final page. Pass it as the cursor query parameter in the next request. |
| hasMore boolean | true: Another page of results is available. Pass pagination.cursor in the next request to retrieve it.
|
Response
Body Structure (401 403)
| messages string | A message describing the outcome of the request |
Example
The list of teams was successfully retrieved.
Request
curl -v 'https://developer.api.autodesk.com/team-admin/v1/teams?teamId=100001' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"data": [
{
"id": "100001",
"name": "Example Engineering"
}
],
"pagination": {
"cursor": "OPAQUE_CURSOR_FROM_RESPONSE",
"hasMore": true
}
}
Show More