Request

Response

    Retrieves a group.
    GET

    v1/accounts/{accountId}/groups/{groupId}

    Returns the details of the specified group, including details of your access level to this group. Note, currently only one group is supported per hub, with a matching group ID to the hub 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/{groupId}
    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 hub’s data is provisioned in. Currently supports US, EMEA, AUS, IND, DEU, JPN, CAN, and GBR. Default is US.
    * Required

    Request

    URI Parameters

    accountId
    string: UUID or string: b.UUID
    The Autodesk Forma hub ID.
    groupId
    string
    The group ID. Currently, only one group is supported, and group id is equal to hub id. (Supporting multiple groups is considered for future enhancement).

    Response

    HTTP Status Code Summary

    200
    OK
    Successful retrieval of the group’s details.
    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. This may occur if fetching a group that the user does not have access to.
    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
    id
    string
    The group ID.
    title
    string
    The group title.
    description
    string
    The group description.
    permissions
    object
    Permission level of the user calling this endpoint.
    write
    boolean
    User can edit contents.
    read
    boolean
    User can view contents.
    admin
    boolean
    User can view and change all permissions. Reserved for internal usage.

    Example

    Successful retrieval of the group’s details (200).

    Request

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

    Response

    {
      "id": "009777bb-e1e5-4577-9800-0789677e4616",
      "title": "Default Group",
      "description": "",
      "permissions": {
        "read": true,
        "write": true,
        "admin": false
      }
    }
    
    Show More