Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.opt_prettybooleanOptional
query.parentstringOptional
query.assigneestringOptional
query.workspacestringOptional
query.limitintegerOptionalMinimum: 1
Maximum: 100
query.offsetstringOptional
query.opt_fieldsarrayOptional
query.opt_fields[]stringEach itemOne 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 media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)objectAll variants apply
$ (allOf 1).dataarrayOptional
$ (allOf 1).data[]ModelEach itemExpand Get an allocation — response body — data data — Allocation Response
$ (allOf 1).next_pageModelOptionalExpand Get goals — response body — data, next page next page
$ (allOf 2)ModelAll variants applyExpand 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

1 more schema is linked from the tables above, on the schema pages.

Get goals — response body — data, next page next page
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternative*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).offsetstringOptionalPagination offset for the request.
Read only: true
$ (anyOf 1).pathstringOptionalA relative path containing the query parameters to fetch for next_page
Read only: true
$ (anyOf 1).uristringOptionalA full uri containing the query parameters to fetch for next_page
Format: uri
Read only: true
$ (anyOf 2)nullAlternative
Get an allocation — response body — data data — Allocation Response
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get an allocation — response body — data data effort, end date, gid, resource type, start date
$ (allOf 2)objectAll variants apply
$ (allOf 2).assigneeJSONOptional
$ (allOf 2).assignee (allOf 1)ModelAll variants applyExpand Get users in a team — response body — data data item
$ (allOf 2).assignee (allOf 2)objectAll variants applyThe user or placeholder assigned to the allocation.
$ (allOf 2).assignee (allOf 2).namestringOptionalThe name of allocation resource.
$ (allOf 2).created_byModelOptionalExpand Get users in a team — response body — data data item
The user who created the allocation.
$ (allOf 2).parentModelOptionalExpand Search projects in a workspace — response body — data data item
The project the allocation is on.
$ (allOf 2).resource_subtypestringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get an allocation — response body — data data — sdk__Allocation Response
next_pageModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
start_datestringOptionalThe localized day on which the allocation starts.
Format: date
end_datestringOptionalThe localized day on which the allocation ends.
Format: date
effortJSONOptional
effort (anyOf 1)objectAlternativeThe amount of time associated with the allocation, represented as a percentage or number of hours.
effort (anyOf 1).typestringOptionalThe units used for tracking effort on an allocation, either "hours" or "percent".
Known values: hours, percent
effort (anyOf 1).valueJSONOptional
effort (anyOf 1).value (anyOf 1)numberAlternativeThe numeric effort value on the allocation.
effort (anyOf 1).value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
effort (anyOf 2)nullAlternative
Search projects in a workspace — response body — data data item
FieldTypePresenceDescription and constraints
$objectRootA *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.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalName 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_subtypestringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRootA *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptional*Read-only except when same user as requester*. The user's name.
Get an allocation — response body — data data — sdk__Allocation Response
FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
start_datestringOptionalThe localized day on which the allocation starts.
Format: date
end_datestringOptionalThe localized day on which the allocation ends.
Format: date
effortJSONOptional
effort (anyOf 1)objectAlternativeThe amount of time associated with the allocation, represented as a percentage or number of hours.
effort (anyOf 1).typestringOptionalThe units used for tracking effort on an allocation, either "hours" or "percent".
Known values: hours, percent
effort (anyOf 1).valueJSONOptional
effort (anyOf 1).value (anyOf 1)numberAlternativeThe numeric effort value on the allocation.
effort (anyOf 1).value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
effort (anyOf 2)nullAlternative
assigneeModelOptionalExpand Get an allocation — response body — data data assignee
created_byModelOptionalExpand Get an OOO entry — response body — data data user
parentModelOptionalExpand Get a rate — response body — data data parent
resource_subtypestringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRootA 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.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of allocation resource.
Get an OOO entry — response body — data data user
FieldTypePresenceDescription and constraints
$objectRootA 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.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptional*Read-only except when same user as requester*. The user's name.

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.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.