This object determines if a user is a member of a workspace.
WorkspaceMembershipCompact
Property | Type | Description |
---|---|---|
gid | string | Globally unique identifier of the resource, as a string. |
resource_type | string | The base type of this resource. |
user | object | A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks. |
user.gid | string | Globally unique identifier of the resource, as a string. |
user.resource_type | string | The base type of this resource. |
user.name | string | Read-only except when same user as requester. The user’s name. |
workspace | object | A workspace is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace. |
workspace.gid | string | Globally unique identifier of the resource, as a string. |
workspace.resource_type | string | The base type of this resource. |
workspace.name | string | The 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
Property | Type | Description |
---|---|---|
gid | string | Globally unique identifier of the resource, as a string. |
resource_type | string | The base type of this resource. |
user | object | A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks. |
user.gid | string | Globally unique identifier of the resource, as a string. |
user.resource_type | string | The base type of this resource. |
user.name | string | Read-only except when same user as requester. The user’s name. |
workspace | object | A workspace is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace. |
workspace.gid | string | Globally unique identifier of the resource, as a string. |
workspace.resource_type | string | The base type of this resource. |
workspace.name | string | The name of the workspace. |
user_task_list | object | A 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.gid | string | Globally unique identifier of the resource, as a string. |
user_task_list.resource_type | string | The base type of this resource. |
user_task_list.name | string | The name of the user task list. |
user_task_list.owner | object | The owner of the user task list, i.e. the person whose My Tasks is represented by this resource. |
user_task_list.owner.gid | string | Globally unique identifier of the resource, as a string. |
user_task_list.owner.resource_type | string | The base type of this resource. |
user_task_list.owner.name | string | Read-only except when same user as requester. The user’s name. |
user_task_list.workspace | object | The workspace in which the user task list is located. |
user_task_list.workspace.gid | string | Globally unique identifier of the resource, as a string. |
user_task_list.workspace.resource_type | string | The base type of this resource. |
user_task_list.workspace.name | string | The name of the workspace. |
is_active | boolean | Reflects if this user still a member of the workspace. |
is_admin | boolean | Reflects if this user is an admin of the workspace. |
is_guest | boolean | Reflects if this user is a guest of the workspace. |
is_view_only | boolean | Reflects if this user has view only license in the workspace. |
vacation_dates | object | 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. |
vacation_dates.start_on | string | The day on which the user's vacation in this workspace starts. This is a date with YYYY-MM-DD format. |
vacation_dates.end_on | string | 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. |
created_at | string (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"
}