Authorizations
Session cookie authentication for production deployments. The session token is automatically set as an HTTP-only, secure cookie.
Path Parameters
Workspace ID
Body
application/json
Authentication
Session
User Management
- GETGet Current User Profile
- PATCHUpdate User Profile
- GETGet User's Organization Memberships
- GETGet User's Workspace Memberships
- GETGet User's Email Addresses
- POSTAdd Email Address
- DELRemove Email Address
- POSTPrepare Email Verification
- POSTVerify Email Address
- POSTMake Email Primary
- GETGet User's Phone Numbers
- POSTAdd Phone Number
- DELRemove Phone Number
- POSTSend Phone Verification SMS
- POSTVerify Phone Number with OTP
- POSTSet Phone Number as Primary
- POSTGenerate New TOTP Authenticator
- POSTVerify TOTP Authenticator Setup
- DELDelete TOTP Authenticator
- POSTGenerate Backup Codes
- POSTRegenerate Backup Codes
- POSTUpload Profile Picture
- POSTUpdate Password
- DELRemove Password
- GETGet Active Sessions
- PATCHSign Out from Specific Session
- DELDisconnect Social Connection
- DELDelete User Account
Organizations
- POSTCreate Organization
- DELDelete Organization
- PATCHUpdate Organization
- DELLeave Organization
- GETGet Organization Members
- DELRemove Organization Member
- PUTAdd Member Role
- DELRemove Member Role
- GETGet Organization Invitations
- POSTInvite Member to Organization
- DELCancel Organization Invitation
- GETGet Organization Roles
- POSTCreate Organization Role
- DELDelete Organization Role
- GETGet Organization Domains
- POSTAdd Organization Domain
- POSTVerify Organization Domain
- DELDelete Organization Domain
- GETGet Organization Billing Addresses
- POSTAdd Organization Billing Address
- PUTUpdate Organization Billing Address
- DELDelete Organization Billing Address
Workspaces
Invite Member to Workspace
Add a member to the workspace by user ID or email. Requires workspace admin permissions.
POST
/
workspaces
/
{id}
/
members
Invite Member to Workspace
Copy
curl --request POST \
--url https://{deploymentHost}/workspaces/{id}/members \
--header 'Content-Type: application/json' \
--data '{
"user_id": "<string>",
"email": "[email protected]",
"role": "member"
}'Copy
{
"status": 200,
"message": "",
"data": {
"member": {
"id": "member_987654321",
"user": {
"id": "user_789123456",
"first_name": "Jane",
"last_name": "Smith",
"email": "[email protected]",
"profile_image_url": "https://cdn.acme.com/avatars/jane.jpg"
},
"role": "member",
"joined_at": "2024-01-15T19:30:00Z"
}
},
"session": {
"signin_attempts": [],
"signins": [
{
"id": "signin_987654321",
"user_id": "user_456789123",
"created_at": "2024-01-01T12:00:00Z"
}
],
"signup_attempts": [],
"active_signin": {
"id": "signin_987654321",
"user_id": "user_456789123",
"created_at": "2024-01-01T12:00:00Z"
}
},
"errors": []
}Previous
Remove Member from WorkspaceRemove a member from the workspace. Requires workspace admin permissions or being the member themselves.
Next
⌘I
Invite Member to Workspace
Copy
curl --request POST \
--url https://{deploymentHost}/workspaces/{id}/members \
--header 'Content-Type: application/json' \
--data '{
"user_id": "<string>",
"email": "[email protected]",
"role": "member"
}'Copy
{
"status": 200,
"message": "",
"data": {
"member": {
"id": "member_987654321",
"user": {
"id": "user_789123456",
"first_name": "Jane",
"last_name": "Smith",
"email": "[email protected]",
"profile_image_url": "https://cdn.acme.com/avatars/jane.jpg"
},
"role": "member",
"joined_at": "2024-01-15T19:30:00Z"
}
},
"session": {
"signin_attempts": [],
"signins": [
{
"id": "signin_987654321",
"user_id": "user_456789123",
"created_at": "2024-01-01T12:00:00Z"
}
],
"signup_attempts": [],
"active_signin": {
"id": "signin_987654321",
"user_id": "user_456789123",
"created_at": "2024-01-01T12:00:00Z"
}
},
"errors": []
}