Add a user to a workspace or organization

Add a user to a workspace or organization.
The user can be referenced by their globally unique user ID or their email address. Returns the full user record for the invited user.

{ "data": { "gid": "12345", "resource_type": "task", "name": "Greg Sanchez", "email": "gsanchez@example.com", "photo": { "image_1024x1024": "https://...", "image_128x128": "https://...", "image_21x21": "https://...", "image_27x27": "https://...", "image_36x36": "https://...", "image_60x60": "https://..." }, "workspaces": [ { "gid": "12345", "resource_type": "task", "name": "My Company Workspace" } ] } }

Request

Path Params

workspace_gid

string

required

Body Params application/json

data

object (WorkspaceAddUserRequest)

optional

A user identification object for specification with the addUser/removeUser endpoints.

user

string

optional

A string identifying a user. This can either be the string "me", an email, or the gid of a user.

Example:

12345

Examples

Responses

🟢200The user was added successfully to the workspace or organization.

application/json

Body

data

object (UserResponse)

optional

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

string <email>

read-onlyoptional

The user's email address.

Example:

gsanchez@example.com

photo

object | null

read-onlyoptional

A map of the user’s profile photo in various sizes, or null if no photo is set. Sizes provided are 21, 27, 36, 60, 128, and 1024. All images are in PNG format, except for 1024 (which is in JPEG format).

Example:

{"image_1024x1024":"https://...","image_128x128":"https://...","image_21x21":"https://...","image_27x27":"https://...","image_36x36":"https://...","image_60x60":"https://..."}

workspaces

array[object (WorkspaceCompact) {3}]

read-onlyoptional

Workspaces and organizations this user may access.
Note: The API will only return workspaces and organizations that also contain the authenticated user.

gid

string

read-onlyoptional

Globally unique identifier of the resource, as a string.

Example:

12345

resource_type

string

read-onlyoptional

The base type of this resource.

Example:

task

name

string

optional

Read-only except when same user as requester. The user’s name.

Example:

Greg Sanchez

🟠400400

🟠401401

🟠403403

🟠404404

🔴500500