Get an agent

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


📘

Early Access

Agent endpoints are in early access and the interface is subject to change. To call them, your request must opt-in using the Asana-Enable: ai_teammate_actorsheader option. Review this guide for more information on Asana-Enable headers.

During early access, agent identifiers returned from these endpoints can only be used as input on the create and update task endpoints, specifically to set the assignee field to an AI Teammate. Support for using agent GIDs in other fields and endpoints will be added in subsequent releases.

Path Params
string
required

Globally unique identifier for the agent.

Query Params
opt_fields
array of strings

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.

opt_fields
boolean

Provides “pretty” output.
Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json