Get a list of agents in a workspace

get

https://app.asana.com/api/1.0/workspaces/{workspace_gid}/agents

Returns the compact records of agents (AI Teammates) configured. Use opt_fields to request additional fields in the workspace.

📘
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

workspace_gid

string

required

Globally unique identifier for the workspace or organization.

Query Params

limit

integer

1 to 100

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

offset

string

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.

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

opt_pretty

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

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully retrieved the requested workspace's agents.

400This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again.

401A valid authentication token was not provided with the request, so the API could not associate a user with the request.

403The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to.

404Either the request method and path supplied do not specify a known action in the API, or the object specified by the request does not exist.

500There was a problem on Asana’s end. In the event of a server error the response body should contain an error phrase. These phrases can be used by Asana support to quickly look up the incident that caused the server error. Some errors are due to server load, and will not supply an error phrase.