Skip to content

Asana: Get multiple users

Asana users.getUsers: arguments, response, policy and SDK examples.

← Users operations · Get started

Operation asana.getusers

Provider route: GET /users. 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["users"]["getUsers"]>[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.users.getUsers(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.users.get_users(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.workspacestringOptional
query.teamstringOptional
query.opt_prettybooleanOptional
query.limitintegerOptionalMinimum: 1
Maximum: 100
query.offsetstringOptional
query.opt_fieldsarrayOptional
query.opt_fields[]stringEach itemOne of: custom_fields, custom_fields.date_value, custom_fields.date_value.date, custom_fields.date_value.date_time, custom_fields.display_value, custom_fields.enabled, custom_fields.enum_options, custom_fields.enum_options.color, custom_fields.enum_options.enabled, custom_fields.enum_options.name, custom_fields.enum_value, custom_fields.enum_value.color, custom_fields.enum_value.enabled, custom_fields.enum_value.name, custom_fields.id_prefix, custom_fields.input_restrictions, custom_fields.is_formula_field, custom_fields.is_lookup_field, custom_fields.multi_enum_values, custom_fields.multi_enum_values.color, custom_fields.multi_enum_values.enabled, custom_fields.multi_enum_values.name, custom_fields.name, custom_fields.number_value, custom_fields.representation_type, custom_fields.text_value, custom_fields.type, email, name, offset, path, photo, photo.image_1024x1024, photo.image_128x128, photo.image_21x21, photo.image_27x27, photo.image_36x36, photo.image_60x60, uri, workspaces, workspaces.name

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 users in a team — response body — data data item
$ (allOf 1).next_pageModelOptionalExpand Get goals — response body — data, next page next page
$ (allOf 2)ModelAll variants applyExpand Get multiple users — response body — data, next page

Referenced models: Get goals — response body — data, next page next page, Get users in a team — response body — data data item, Get multiple users — response body — data, next page

4 more schemas are 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 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 multiple users — response body — data, next page
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get a user — response body — data data — sdk__User Response
next_pageModelOptionalExpand Get goals — response body — data, next page next page

Referenced models: Get goals — response body — data, next page next page, Get a user — response body — data data — sdk__User Response

Get a user — response body — data data — sdk__User Response
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.
emailstringOptionalThe user's email address.
Format: email
Read only: true
photoJSONOptional
photo (anyOf 1)ModelAlternativeExpand Get a user — response body — data data photo image 1024x1024, image 128x128, image 21x21, image 27x27, image 36x36, image 60x60
photo (anyOf 2)nullAlternative
workspacesarrayOptionalWorkspaces and organizations this user may access.
Note\: The API will only return workspaces and organizations that also contain the authenticated user.
Read only: true
workspaces[]ModelEach itemExpand Get a tag — response body — data data workspace
custom_fieldsarrayOptionalArray of Custom Fields.
custom_fields[]ModelEach itemExpand Get a goal — response body — data data custom fields item

Referenced models: Get a goal — response body — data data custom fields item, Get a user — 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 a goal — response body — data data custom fields item
FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
Custom Fields store the metadata that is used in order to add user-specified information to tasks in Asana. Be sure to reference the [custom fields](/reference/custom-fields) developer documentation for more information about how custom fields relate to various resources in Asana.

Users in Asana can [lock custom fields](https://asana.com/guide/help/premium/custom-fields#gl-lock-fields), which will make them read-only when accessed by other users. Attempting to edit a locked custom field will return HTTP error code `403 Forbidden`.
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 the custom field.
typestringOptional*Deprecated: new integrations should prefer the resource_subtype field.* The type of the custom field. Must be one of the given values.

Known values: text, enum, multi_enum, number, date, people, reference
Read only: true
enum_optionsarrayOptional*Conditional*. Only relevant for custom fields of type `enum` or `multi_enum`. This array specifies the possible values which an `enum` custom field can adopt. To modify the enum options, refer to [working with enum options](/reference/createenumoptionforcustomfield).
enum_options[]ModelEach itemExpand Get a custom field — response body — data data enum options item
enabledbooleanOptional*Conditional*. This field applies only to [custom field values](/docs/custom-fields-guide#/accessing-custom-field-values-on-tasks-or-projects) and is not available for [custom field definitions](/docs/custom-fields-guide#/accessing-custom-field-definitions).
Determines if the custom field is enabled or not. For more details, see the [Custom Fields documentation](/docs/custom-fields-guide#/enabled-and-disabled-values).
Read only: true
representation_typestringOptionalThis field tells the type of the custom field.
Known values: text, enum, multi_enum, number, date, people, formula, custom_id, reference
Read only: true
id_prefixJSONOptional
id_prefix (anyOf 1)stringAlternativeThis field is the unique custom ID string for the custom field.
id_prefix (anyOf 2)nullAlternative
input_restrictionsarrayOptional
input_restrictions[]stringEach item*Conditional*. Only relevant for custom fields of type `reference`. This array of strings reflects the allowed types of objects that can be written to a `reference` custom field value.
Known values: task, project, portfolio, goal
is_formula_fieldbooleanOptional*Conditional*. This flag describes whether a custom field is a formula custom field.
is_lookup_fieldbooleanOptional*Conditional*. This flag describes whether a custom field is a lookup custom field.
date_valueJSONOptional
date_value (anyOf 1)ModelAlternativeExpand Get a custom field — response body — data data date value date, date time
date_value (anyOf 2)nullAlternative
enum_valueJSONOptional
enum_value (anyOf 1)ModelAlternativeExpand Get a custom field — response body — data data enum value color, enabled, gid, name, resource type
enum_value (anyOf 2)nullAlternative
multi_enum_valuesarrayOptional*Conditional*. Only relevant for custom fields of type `multi_enum`. This object is the chosen values of a `multi_enum` custom field.
multi_enum_values[]ModelEach itemExpand Get a custom field — response body — data data enum options item
number_valueJSONOptional
number_value (anyOf 1)JSONAlternative
number_value (anyOf 1) (anyOf 1)numberAlternative*Conditional*. This number is the value of a `number` custom field.
number_value (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
number_value (anyOf 2)nullAlternative
text_valueJSONOptional
text_value (anyOf 1)stringAlternative*Conditional*. This string is the value of a `text` custom field.
text_value (anyOf 2)nullAlternative
display_valueJSONOptional
display_value (anyOf 1)stringAlternativeA string representation for the value of the custom field. Integrations that don't require the underlying type should use this field to read values. Using this field will future-proof an app against new custom field types.
Read only: true
display_value (anyOf 2)nullAlternative

Referenced models: Get a custom field — response body — data data date value date, date time, Get a custom field — response body — data data enum options item, Get a custom field — response body — data data enum value color, enabled, gid, name, resource type

Get a tag — response body — data data workspace
FieldTypePresenceDescription and constraints
$objectRootA 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.
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 the workspace.

SDK function policy ID: asana.getusers. Catalog operation: asana:getUsers. 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.

Required provider scopes: ["users:read"]

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.