Authorizations
Session cookie authentication for production deployments. The session token is automatically set as an HTTP-only, secure cookie.
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
User Management
Get User's Workspace Memberships
Retrieve all workspaces the current user has access to across all organizations.
GET
/
me
/
workspace-memberships
Get User's Workspace Memberships
Copy
curl --request GET \
--url https://{deploymentHost}/me/workspace-membershipsCopy
{
"status": 200,
"message": "",
"data": [
{
"id": "ws_membership_123456789",
"workspace": {
"id": "workspace_987654321",
"name": "Development Team",
"slug": "dev-team",
"organization": {
"id": "org_123456789",
"name": "Acme Corporation",
"slug": "acme-corp"
}
},
"permissions": [
"read",
"write"
],
"created_at": "2024-01-01T00:00:00Z"
},
{
"id": "ws_membership_987654321",
"workspace": {
"id": "workspace_456789123",
"name": "Marketing Team",
"slug": "marketing-team",
"organization": {
"id": "org_123456789",
"name": "Acme Corporation",
"slug": "acme-corp"
}
},
"permissions": [
"read"
],
"created_at": "2024-01-05T00:00: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
Get User's Email AddressesRetrieve all email addresses associated with the current user's account, including verification status.
Next
⌘I
Get User's Workspace Memberships
Copy
curl --request GET \
--url https://{deploymentHost}/me/workspace-membershipsCopy
{
"status": 200,
"message": "",
"data": [
{
"id": "ws_membership_123456789",
"workspace": {
"id": "workspace_987654321",
"name": "Development Team",
"slug": "dev-team",
"organization": {
"id": "org_123456789",
"name": "Acme Corporation",
"slug": "acme-corp"
}
},
"permissions": [
"read",
"write"
],
"created_at": "2024-01-01T00:00:00Z"
},
{
"id": "ws_membership_987654321",
"workspace": {
"id": "workspace_456789123",
"name": "Marketing Team",
"slug": "marketing-team",
"organization": {
"id": "org_123456789",
"name": "Acme Corporation",
"slug": "acme-corp"
}
},
"permissions": [
"read"
],
"created_at": "2024-01-05T00:00: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": []
}