Request

Response

    List groups in account
    GET

    v1/accounts/{accountId}/groups

    Lists all groups in the specified account. Note, currently only one group is supported per account, with a matching group ID to the account ID. (reserved for future enhancement to support multiple groups.)

    Resource Information
    Method and URI
    GET
     https://developer.api.autodesk.com/parameters/v1/accounts/{accountId}/groups
    Authentication Context
    user context required
    Required OAuth Scopes
    data:read
    Data Format
    JSON

    Request

    Headers
    Authorization*
    string
    		Must be Bearer <token>, where <token> is obtained via a three-legged OAuth flow.
    Region
    string
    		The region the account’s data is provisioned in. Currently supports US, EMEA, and AUS. Default is US.
    * Required

    Request

    URI Parameters
    accountId
    string: UUID or string: b.UUID
    		The Autodesk Construction Cloud account ID.

    Response

    HTTP Status Code Summary
    200
    OK
    		Successful retrieval of all groups within an account.
    400
    Bad Request
    		The request could not be understood by the server due to malformed syntax.
    401
    Unauthorized
    		Request has not been applied because it lacks valid authentication credentials for the target resource.
    403
    Forbidden
    		The server understood the request but refuses to authorize it.
    404
    Not Found
    		The resource cannot be found.
    406
    Not Acceptable
    		The server cannot produce a response matching the list of acceptable values defined in the request.
    410
    		Access to the target resource is no longer available.
    429
    Too Many Requests
    		User has sent too many requests in a given amount of time.
    500
    Internal Server Error
    		An unexpected error occurred on the server.
    503
    Service Unavailable
    		Server is not ready to handle the request.

    Response

    Body Structure (200)
    Expand all
    pagination
    object
    		The information for paginating records returned by the endpoint.
    offset
    int
    		Offset from the start of the collection to the first entry in the page. Zero based.
    limit
    int
    		Determines the maximum number of objects that MAY be returned. A query MAY return fewer than the value of limit due to filtering or other reasons.
    totalResults
    int
    		The total number of results that match the query irrespective of limit.
    nextUrl
    string
    		Link that will return the next page of data. If not included, this is the last page of data.
    results
    array: object
    id
    string
    		Identifier of the group. It must contain only alphanumeric characters or underscores and must have a length of at least 2 characters and no more than 64 characters.
    title
    string
    		A human-friendly group title.
    description
    string
    		A short description of the group.
    createdBy
    string
    		User that created the group.
    createdAt
    string
    		A Time ISO 8601 Timestamp in UTC Timezone, indicating when the group was created.
    updatedBy
    string
    		User that last modified the details of the group.
    updatedAt
    string
    		A Time ISO 8601 Timestamp in UTC Timezone, indicating when the group was modified most recently.

    Example

    Successful retrieval of all groups within an account (200).

    Request

    curl -v 'https://developer.api.autodesk.com/parameters/v1/accounts/009777bb-e1e5-4577-9800-0789677e4616/groups' \
  -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'

    Response

    {
  "pagination": {
    "offset": 0,
    "limit": 20,
    "totalResults": 1
  },
  "results": [
    {
      "id": "009777bb-e1e5-4577-9800-0789677e4616",
      "title": "Default Group",
      "description": "Contains collections for this account",
      "createdBy": "GB82ZDWDRBMUV38U",
      "createdAt": "2023-05-13T00:19:40+0000",
      "updatedBy": "4V4WKQJGGQ7N",
      "updatedAt": "2023-10-20T15:36:15+0000"
    }
  ]
}
    Show More