Sign in
Agents

Get an agent

Returns the complete record for a single agent (AI Teammate).

get/agents/{agent_gid}

Request

  • Base URL: https://app.asana.com/api/1.0
  • URL: https://app.asana.com/api/1.0/agents/{agent_gid}
  • 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)

Query parameters

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 the requested agent.

Example response

{
  "data": {
    "gid": "12345",
    "resource_type": "agent",
    "resource_subtype": "asana_teammate",
    "name": "Developer Blog Writer",
    "workspace": {
      "gid": "12345",
      "resource_type": "workspace",
      "name": "My Company Workspace"
    },
    "photo": {
      "image_21x21": "https://...",
      "image_27x27": "https://...",
      "image_36x36": "https://...",
      "image_60x60": "https://...",
      "image_128x128": "https://...",
      "image_1024x1024": "https://..."
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.