Skip to contents

Returns the user records for all users in all workspaces and organizations accessible to the authenticated user. Accepts an optional workspace ID parameter. Results are sorted by user ID.

Usage

asn_get_users(limit, offset, opt_fields, team, workspace)

Arguments

limit

(optional) (integer scalar) Results per page. The number of objects to return per page. The value must be between 1 and 100.

offset

(optional) (character scalar) 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

(optional) (list) Defines fields to return. Some requests return compact representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options.

team

(optional) (character scalar) The team ID to filter users on.

workspace

(optional) (character scalar) The workspace or organization ID to filter users on.

Value

A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks.

PropertyClassDescription
gidcharacter scalarGlobally unique identifier of the resource, as a string.
resource_typecharacter scalarThe base type of this resource.
namecharacter scalarRead-only except when same user as requester. The user’s name.