Skip to main content
POST
Add User To Project

Authorizations

Authorization
string
header
required

Aspect API key (sk_...) in Authorization header. 'Bearer ' optional.

Path Parameters

project_id
string<uuid>
required

Body

application/json

Add a person to a project. If the email has no Aspect account yet, the person is invited.

email
string
required

Email of the user to add to project

role
enum<string>
default:editor

no_access is only for workspace Members, to block them from this project.

Available options:
full_access,
editor,
commenter,
downloader,
viewer,
no_access
purchase_seat
boolean
default:false

Buy a seat if none is free (prorated, charged now). Ignored when a seat is free. Only when the person is new to the workspace and you're a workspace admin.

Response

Successful Response

API response schema for a user with project access.

id
string<uuid>
required

User ID

first_name
string
required

User's first name

last_name
string
required

User's last name

email
string
required

User's email address

role
enum<string>
required

User's effective role on this project

Available options:
full_access,
editor,
commenter,
downloader,
viewer,
no_access
workspace_role
enum<string>
required

User's workspace role

Available options:
owner,
member,
member_limited
has_explicit_permission
boolean
required

True when the role was set on this project directly. False when it comes from the project's default role or workspace ownership.

avatar_url
string | null

User's avatar URL