Asana: Get a list of agents in a workspace
Asana agents.getAgentsForWorkspace: arguments, response, policy and SDK examples.
← Agents operations · Get started
Operation asana.getagentsforworkspace
Provider route: GET /workspaces/{workspace_gid}/agents. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/asana with npm, or alter-sdk-asana with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { AsanaIntegration } from "@alter-ai/asana";
async function execute(input: Parameters<AsanaIntegration["agents"]["getAgentsForWorkspace"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new AsanaIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.agents.getAgentsForWorkspace(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_asana import AsanaIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = AsanaIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.agents.get_agents_for_workspace(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.workspace_gid | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.opt_pretty | boolean | Optional | |
query.limit | integer | Optional | Minimum: 1 Maximum: 100 |
query.offset | string | Optional | |
query.opt_fields | array | Optional | |
query.opt_fields[] | string | Each item | One of: behavior_guidance, description, name, offset, path, photo, photo.image_1024x1024, photo.image_128x128, photo.image_21x21, photo.image_27x27, photo.image_36x36, photo.image_60x60, resource_subtype, uri, workspace |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | object | All variants apply | |
$ (allOf 1).data | array | Optional | |
$ (allOf 1).data[] | Model | Each item | Expand Get a list of agents in a workspace — response body — data, next page data item |
$ (allOf 1).next_page | Model | Optional | Expand Get goals — response body — data, next page next page |
$ (allOf 2) | Model | All variants apply | Expand Get a list of agents in a workspace — response body — data, next page |
Referenced models: Get goals — response body — data, next page next page, Get a list of agents in a workspace — response body — data, next page data item, Get a list of agents in a workspace — response body — data, next page
Schemas
Section titled “Schemas”Get goals — response body — data, next page next page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | *Conditional*. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed. |
$ (anyOf 1).offset | string | Optional | Pagination offset for the request. Read only: true |
$ (anyOf 1).path | string | Optional | A relative path containing the query parameters to fetch for next_page Read only: true |
$ (anyOf 1).uri | string | Optional | A full uri containing the query parameters to fetch for next_page Format: uri Read only: true |
$ (anyOf 2) | null | Alternative |
Get a list of agents in a workspace — response body — data, next page data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
resource_subtype | string | Optional | The subtype of the agent. `asana_teammate` is an Asana-built teammate. Known values: asana_teammate Read only: true |
name | string | Optional | The display name of the agent. Read only: true |
Get a list of agents in a workspace — response body — data, next page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Get an agent — response body — data data — sdk__Agent Response |
next_page | Model | Optional | Expand Get goals — response body — data, next page next page |
Referenced models: Get goals — response body — data, next page next page, Get an agent — response body — data data — sdk__Agent Response
Get an agent — response body — data data — sdk__Agent Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
resource_subtype | string | Optional | The subtype of the agent. `asana_teammate` is an Asana-built teammate. Known values: asana_teammate Read only: true |
name | string | Optional | The display name of the agent. Read only: true |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | A brief description of what the agent does. Read only: true |
description (anyOf 2) | null | Alternative | |
behavior_guidance | JSON | Optional | |
behavior_guidance (anyOf 1) | string | Alternative | A description of the agent's behavior. Read only: true |
behavior_guidance (anyOf 2) | null | Alternative | |
workspace | JSON | Optional | The workspace this agent is instantiated within. Read only: true |
workspace (allOf 1) | Model | All variants apply | Expand Get a tag — response body — data data workspace |
workspace (allOf 2) | object | All variants apply | |
photo | JSON | Optional | |
photo (anyOf 1) | Model | Alternative | Expand Get an agent — response body — data data photo image 1024x1024, image 128x128, image 21x21, image 27x27, image 36x36, image 60x60 |
photo (anyOf 2) | null | Alternative |
Referenced models: Get an agent — response body — data data photo image 1024x1024, image 128x128, image 21x21, image 27x27, image 36x36, image 60x60, Get a tag — response body — data data workspace
Get an agent — response body — data data photo image 1024x1024, image 128x128, image 21x21, image 27x27, image 36x36, image 60x60
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A map of the agent's avatar image in various sizes, or null if no photo is set. Read only: true |
image_21x21 | string | Optional | PNG image at 21x21 pixels. Format: uri |
image_27x27 | string | Optional | PNG image at 27x27 pixels. Format: uri |
image_36x36 | string | Optional | PNG image at 36x36 pixels. Format: uri |
image_60x60 | string | Optional | PNG image at 60x60 pixels. Format: uri |
image_128x128 | string | Optional | PNG image at 128x128 pixels. Format: uri |
image_1024x1024 | string | Optional | JPEG image at 1024x1024 pixels. Format: uri |
Get a tag — response body — data data workspace
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the workspace. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: asana.getagentsforworkspace. Catalog operation: asana:getAgentsForWorkspace. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.