Asana: Get multiple allocations
Asana allocations.getAllocations: arguments, response, policy and SDK examples.
← Allocations operations · Get started
Operation asana.getallocations
Provider route: GET /allocations. 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["allocations"]["getAllocations"]>[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.allocations.getAllocations(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.allocations.get_allocations(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.opt_pretty | boolean | Optional | |
query.parent | string | Optional | |
query.assignee | string | Optional | |
query.workspace | string | 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: assignee, assignee.name, created_by, created_by.name, effort, effort.type, effort.value, end_date, offset, parent, parent.name, parent.resource_subtype, path, resource_subtype, start_date, uri |
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 an allocation — response body — data data — Allocation Response |
$ (allOf 1).next_page | Model | Optional | Expand Get goals — response body — data, next page next page |
$ (allOf 2) | Model | All variants apply | Expand Get multiple allocations — response body — data, next page |
Referenced models: Get goals — response body — data, next page next page, Get an allocation — response body — data data — Allocation Response, Get multiple allocations — response body — data, next page
Schemas
Section titled “Schemas”1 more schema is linked from the tables above, on the schema pages.
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 an allocation — response body — data data — Allocation Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get an allocation — response body — data data effort, end date, gid, resource type, start date |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).assignee | JSON | Optional | |
$ (allOf 2).assignee (allOf 1) | Model | All variants apply | Expand Get users in a team — response body — data data item |
$ (allOf 2).assignee (allOf 2) | object | All variants apply | The user or placeholder assigned to the allocation. |
$ (allOf 2).assignee (allOf 2).name | string | Optional | The name of allocation resource. |
$ (allOf 2).created_by | Model | Optional | Expand Get users in a team — response body — data data item The user who created the allocation. |
$ (allOf 2).parent | Model | Optional | Expand Search projects in a workspace — response body — data data item The project the allocation is on. |
$ (allOf 2).resource_subtype | string | Optional | The subtype of the allocation. |
Referenced models: Get an allocation — response body — data data effort, end date, gid, resource type, start date, Search projects in a workspace — response body — data data item, Get users in a team — response body — data data item
Get multiple allocations — 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 allocation — response body — data data — sdk__Allocation 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 allocation — response body — data data — sdk__Allocation Response
Get an allocation — response body — data data effort, end date, gid, resource type, start date
| 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 |
start_date | string | Optional | The localized day on which the allocation starts. Format: date |
end_date | string | Optional | The localized day on which the allocation ends. Format: date |
effort | JSON | Optional | |
effort (anyOf 1) | object | Alternative | The amount of time associated with the allocation, represented as a percentage or number of hours. |
effort (anyOf 1).type | string | Optional | The units used for tracking effort on an allocation, either "hours" or "percent". Known values: hours, percent |
effort (anyOf 1).value | JSON | Optional | |
effort (anyOf 1).value (anyOf 1) | number | Alternative | The numeric effort value on the allocation. |
effort (anyOf 1).value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
effort (anyOf 2) | null | Alternative |
Search projects in a workspace — response body — data data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *project* represents a prioritized list of tasks in Asana or a board with columns of tasks represented as cards. It exists in a single workspace or organization and is accessible to a subset of users in that workspace or organization, depending on its permissions. |
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 | Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer. |
resource_subtype | string | Optional | The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. Known values: default_project, custom |
Get users in a team — response body — data data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks. |
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 | *Read-only except when same user as requester*. The user's name. |
Get an allocation — response body — data data — sdk__Allocation 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 |
start_date | string | Optional | The localized day on which the allocation starts. Format: date |
end_date | string | Optional | The localized day on which the allocation ends. Format: date |
effort | JSON | Optional | |
effort (anyOf 1) | object | Alternative | The amount of time associated with the allocation, represented as a percentage or number of hours. |
effort (anyOf 1).type | string | Optional | The units used for tracking effort on an allocation, either "hours" or "percent". Known values: hours, percent |
effort (anyOf 1).value | JSON | Optional | |
effort (anyOf 1).value (anyOf 1) | number | Alternative | The numeric effort value on the allocation. |
effort (anyOf 1).value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
effort (anyOf 2) | null | Alternative | |
assignee | Model | Optional | Expand Get an allocation — response body — data data assignee |
created_by | Model | Optional | Expand Get an OOO entry — response body — data data user |
parent | Model | Optional | Expand Get a rate — response body — data data parent |
resource_subtype | string | Optional | The subtype of the allocation. |
Referenced models: Get an allocation — response body — data data assignee, Get an OOO entry — response body — data data user, Get a rate — response body — data data parent
Get an allocation — response body — data data assignee
| 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 *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks. The user or placeholder assigned to the allocation. |
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 allocation resource. |
Get an OOO entry — response body — data data user
| 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 *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks. |
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 | *Read-only except when same user as requester*. The user's name. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: asana.getallocations. Catalog operation: asana:getAllocations. 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.