Request

Response

    List Assignments
    GET

    teams/{team-id}/assignments

    Retrieves a list of product assignments on the team. Direct assignments and assignments inherited through a group or the team are both returned; assignmentType identifies the effective assignment. Each user and product pair appears once; assignments to hidden or unsupported products are omitted from all results. Product IDs match the supported pools returned by the List Product Pools operation. A filter for an unsupported product returns an empty list. All matching assignments are returned in one response without pagination. Assignment changes may appear in team-wide results after a delay.

    This operation shares the team’s allowance of 60 calls per UTC minute with all other team-specific operations.

    Resource Information

    Method and URI
    GET
    https://developer.api.autodesk.com/team-admin/v1/teams/{team-id}/assignments
    Authentication Context
    User-delegated only (accepts only three-legged access tokens)
    Required OAuth Scopes
    tmadmapi:team-products:read 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

    URI Parameters

    team-id
    string
    The ID of the team on which to perform this operation. Use the id value returned by the List Teams operation.

    Request

    Query String Parameters

    productId
    string
    The ID of a product. When specified, only assignments for that product are returned.
    userId
    string
    The ID of a user on the team. When specified, only assignments held by that user are returned. A user who is not currently on the team has no assignments in this response.

    Response

    HTTP Status Code Summary

    200
    OK
    The list of assignments 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.”
    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.
    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 (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 product assignment held by a user on the team.
    userId
    string
    Unique identifier for the user. Use this value as the user-id URI parameter in API requests to access this user’s data. Do not parse, derive, or construct it.

    Max length: 256

    email
    string
    The email address of the assigned user.
    teamId
    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

    productId
    string
    An opaque product identifier returned by the List Product Pools operation. The same value identifies the product in pools and assignments. Use it as productId when creating, removing, or filtering assignments. Store and reuse it without parsing, deriving, or constructing it.

    Max length: 128

    productName
    string
    The marketing name of the product. null when the name cannot be resolved.
    assignmentType
    enum:string
    The way the user holds the product assignment. When a user holds the same product in more than one way, the value reflects the first match in the order listed below. Possible values:
    • TEAM - The user inherits the product from an assignment made to the whole team.
    • DIRECT - The product is assigned directly to the user. This is the only value you can create or remove.
    • GROUP - The user inherits the product through a group.

    Response

    Body Structure (401 403)

    messages
    string
    A message describing the outcome of the request

    Example

    The list of assignments was successfully retrieved.

    Request

    curl -v 'https://developer.api.autodesk.com/team-admin/v1/teams/100001/assignments?productId=prod_8f3a1c9d7b2e&userId=US1234567890' \
      -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
    

    Response

    {
      "data": [
        {
          "userId": "US1234567890",
          "email": "ada.lovelace@example.com",
          "teamId": "100001",
          "productId": "prod_8f3a1c9d7b2e",
          "productName": "Example Product Premium",
          "assignmentType": "DIRECT"
        }
      ]
    }
    
    Show More