Sign in
Roles

Get multiple roles

Changed on

<b>Required scope: </b><code>roles:read</code>

Returns all RBAC roles for a workspace.

get/roles

Request

  • Base URL: https://app.asana.com/api/1.0
  • URL: https://app.asana.com/api/1.0/roles
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.asana.com/-/oauth_authorize, token URL https://app.asana.com/-/oauth_token, scopes: roles:read)

Query parameters

limitinteger

Results per page. The number of objects to return per page. The value must be between 1 and 100.

offsetstring

Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request.

workspacestring required

The workspace or organization to filter roles on.

archivedboolean

Only return projects whose archived field takes on the value of this parameter.

opt_fieldsstring[]

This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide.

Response

Successfully retrieved roles.

Example response

{
  "data": [
    {
      "gid": "12345",
      "resource_type": "role",
      "name": "Developer",
      "description": "This role has exclusive access to create app and PAT tokens."
    }
  ],
  "next_page": {
    "offset": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9",
    "path": "/tasks/12345/attachments?limit=2&offset=eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9",
    "uri": "https://app.asana.com/api/1.0/tasks/12345/attachments?limit=2&offset=eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9"
  }
}

Changes

  • bcb4f889e1a2Revision changes
    • info

      added the enum value permissions.create_and_edit_ai_teammates to the property items/ of the query request parameter opt_fields