Workspace memberships

This object determines if a user is a member of a workspace.


WorkspaceMembershipCompact

PropertyTypeDescription
gidstringGlobally unique identifier of the resource, as a string.
resource_typestringThe base type of this resource.
userobject

Full object requires scope: users:read

A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks.
user.gidstringGlobally unique identifier of the resource, as a string.
user.resource_typestringThe base type of this resource.
user.namestringRead-only except when same user as requester. The user's name.
workspaceobjectA workspace is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.
workspace.gidstringGlobally unique identifier of the resource, as a string.
workspace.resource_typestringThe base type of this resource.
workspace.namestringThe name of the workspace.

Example JSON for WorkspaceMembershipCompact:

{
  "gid": "12345",
  "resource_type": "workspace_membership",
  "user": {
    "gid": "12345",
    "resource_type": "user",
    "name": "Greg Sanchez"
  },
  "workspace": {
    "gid": "12345",
    "resource_type": "workspace",
    "name": "My Company Workspace"
  }
}

WorkspaceMembership

PropertyTypeDescription
gidstringGlobally unique identifier of the resource, as a string.
resource_typestringThe base type of this resource.
userobject

Full object requires scope: users:read

A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks.
user.gidstringGlobally unique identifier of the resource, as a string.
user.resource_typestringThe base type of this resource.
user.namestringRead-only except when same user as requester. The user's name.
workspaceobjectA workspace is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.
workspace.gidstringGlobally unique identifier of the resource, as a string.
workspace.resource_typestringThe base type of this resource.
workspace.namestringThe name of the workspace.
user_task_listobjectA user task list represents the tasks assigned to a particular user. It provides API access to a user’s My tasks view in Asana.
user_task_list.gidstringGlobally unique identifier of the resource, as a string.
user_task_list.resource_typestringThe base type of this resource.
user_task_list.namestringThe name of the user task list.
user_task_list.ownerobjectThe owner of the user task list, i.e. the person whose My Tasks is represented by this resource.
user_task_list.owner.gidstringGlobally unique identifier of the resource, as a string.
user_task_list.owner.resource_typestringThe base type of this resource.
user_task_list.owner.namestringRead-only except when same user as requester. The user's name.
user_task_list.workspaceobjectThe workspace in which the user task list is located.
user_task_list.workspace.gidstringGlobally unique identifier of the resource, as a string.
user_task_list.workspace.resource_typestringThe base type of this resource.
user_task_list.workspace.namestringThe name of the workspace.
is_activebooleanIndicates 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.
is_adminbooleanReflects if this user is an admin of the workspace.
is_guestbooleanReflects if this user is a guest of the workspace.
is_view_onlybooleanReflects if this user has view only license in the workspace.
vacation_datesobjectContains 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.
vacation_dates.start_onstringThe day on which the user's vacation in this workspace starts. This is a date with YYYY-MM-DD format.
vacation_dates.end_onstringThe 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.
created_atstring (date-time)The time at which this resource was created.

Example JSON for WorkspaceMembership:

{
  "gid": "12345",
  "resource_type": "workspace_membership",
  "user": {
    "gid": "12345",
    "resource_type": "user",
    "name": "Greg Sanchez"
  },
  "workspace": {
    "gid": "12345",
    "resource_type": "workspace",
    "name": "My Company Workspace"
  },
  "user_task_list": {
    "gid": "12345",
    "resource_type": "user_task_list",
    "name": "My tasks in My Workspace",
    "owner": {
      "gid": "12345",
      "resource_type": "user",
      "name": "Greg Sanchez"
    },
    "workspace": {
      "gid": "12345",
      "resource_type": "workspace",
      "name": "My Company Workspace"
    }
  },
  "is_active": true,
  "is_admin": true,
  "is_guest": true,
  "is_view_only": true,
  "vacation_dates": {
    "start_on": "2022-11-05",
    "end_on": "2022-11-07"
  },
  "created_at": "2012-02-22T02:06:58.147Z"
}
Asana Home
Asana helps you manage projects, focus on what's important, and organize work in one place for seamless collaboration.
© 2023 Asana, Inc.