Skip to content

Asana: Workspace memberships schemas

6 Asana schemas with complete fields and constraints.

← Workspace memberships operations · All schemas

Get a workspace membership — response body — data

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get a workspace membership — response body — data data — sdk__Workspace Membership Response

Referenced models: Get a workspace membership — response body — data data — sdk__Workspace Membership Response

Get a workspace membership — response body — data data vacation dates end on, start on

FieldTypePresenceDescription and constraints
$objectRoot*Deprecated:* Use the [`/ooo_entries`](/reference/getoooentries) endpoints instead. Contains keys `start_on` and `end_on` for the vacation dates for the user in this workspace. If `start_on` is null, the entire `vacation_dates` object will be null. If `end_on` is before today, the entire `vacation_dates` object will be null.
Read only: true
start_onstringOptional*Deprecated:* Use the [`/ooo_entries`](/reference/getoooentries) endpoints instead. The day on which the user's vacation in this workspace starts. This is a date with `YYYY-MM-DD` format.
end_onJSONOptional
end_on (anyOf 1)stringAlternative*Deprecated:* Use the [`/ooo_entries`](/reference/getoooentries) endpoints instead. The day on which the user's vacation in this workspace ends, or null if there is no end date. This is a date with `YYYY-MM-DD` format.
end_on (anyOf 2)nullAlternative

Get a workspace membership — response body — data data — Workspace Membership Response

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get workspace memberships for a user — response body — data, next page data item
$ (allOf 2)objectAll variants apply
$ (allOf 2).user_task_listModelOptionalExpand Get a user task list — response body — data data — User Task List Compact
The user's "My tasks" in the workspace.
Read only: true
$ (allOf 2).is_activebooleanOptionalIndicates whether the user is currently associated with the workspace. Returns `true` for users who have joined the workspace or have been invited but not yet accepted.
Read only: true
$ (allOf 2).is_adminbooleanOptionalReflects if this user is an admin of the workspace.
Read only: true
$ (allOf 2).is_guestbooleanOptionalReflects if this user is a guest of the workspace.
Read only: true
$ (allOf 2).is_view_onlybooleanOptionalReflects if this user has view only license in the workspace.
Read only: true
$ (allOf 2).vacation_datesJSONOptional
$ (allOf 2).vacation_dates (anyOf 1)ModelAlternativeExpand Get a workspace membership — response body — data data vacation dates end on, start on
$ (allOf 2).vacation_dates (anyOf 2)nullAlternative
$ (allOf 2).created_atstringOptionalThe time at which this resource was created.
Format: date-time
Read only: true

Referenced models: Get a user task list — response body — data data — User Task List Compact, Get workspace memberships for a user — response body — data, next page data item, Get a workspace membership — response body — data data vacation dates end on, start on

Get a workspace membership — response body — data data — sdk__Workspace Membership Response

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
This object determines if a user is a member of a workspace.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
userModelOptionalExpand Get an OOO entry — response body — data data user
workspaceModelOptionalExpand Get a tag — response body — data data workspace
user_task_listobjectOptionalA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A user task list represents the tasks assigned to a particular user. It provides API access to a user’s [My tasks](https://asana.com/guide/help/fundamentals/my-tasks) view in Asana.
Read only: true
user_task_list.gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
user_task_list.resource_typestringOptionalThe base type of this resource.
Read only: true
user_task_list.namestringOptionalThe name of the user task list.
user_task_list.ownerJSONOptionalThe owner of the user task list, i.e. the person whose My Tasks is represented by this resource.
Read only: true
user_task_list.owner (allOf 1)ModelAll variants applyExpand Get an OOO entry — response body — data data user
user_task_list.workspaceJSONOptionalThe workspace in which the user task list is located.
Read only: true
user_task_list.workspace (allOf 1)ModelAll variants applyExpand Get a tag — response body — data data workspace
is_activebooleanOptionalIndicates whether the user is currently associated with the workspace. Returns `true` for users who have joined the workspace or have been invited but not yet accepted.
Read only: true
is_adminbooleanOptionalReflects if this user is an admin of the workspace.
Read only: true
is_guestbooleanOptionalReflects if this user is a guest of the workspace.
Read only: true
is_view_onlybooleanOptionalReflects if this user has view only license in the workspace.
Read only: true
vacation_datesJSONOptional
vacation_dates (anyOf 1)ModelAlternativeExpand Get a workspace membership — response body — data data vacation dates end on, start on
vacation_dates (anyOf 2)nullAlternative
created_atstringOptionalThe time at which this resource was created.
Format: date-time
Read only: true

Referenced models: Get an OOO entry — response body — data data user, Get a workspace membership — response body — data data vacation dates end on, start on, Get a tag — response body — data data workspace

Get workspace memberships for a user — response body — data, next page

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get a workspace membership — response body — data data — sdk__Workspace Membership 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 workspace membership — response body — data data — sdk__Workspace Membership Response

Get workspace memberships for a user — response body — data, next page data item

FieldTypePresenceDescription and constraints
$objectRootThis object determines if a user is a member of a workspace.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
userModelOptionalExpand Get users in a team — response body — data data item
workspaceModelOptionalExpand Update a workspace — request body — body data

Referenced models: Get users in a team — response body — data data item, Update a workspace — request body — body data

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.