Go to websiteBook a demoTrust center

User

Get user data for a user id

get
Responses
200

Successful Response

application/json
Responseany of
or
nullOptional
get
GET /user HTTP/1.1
Host: 
Accept: */*

{
  "email": "text",
  "name": "text",
  "onboarding_status": "text",
  "avatar_url": "text",
  "last_accessed": "2025-08-11T14:38:06.770Z",
  "occupation": "text",
  "company": "text",
  "referral_source": "text",
  "phone_number": "text",
  "used_desktop_app": true,
  "client_metadata": {},
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "is_shade_admin": true,
  "created_at": "2025-08-11T14:38:06.770Z",
  "total_roots": 1,
  "plan_status": "incomplete",
  "plan": "free",
  "asset_limit": 1,
  "total_indexed": 1,
  "total_storage": 1
}

Modify user data

put
Body
Responses
200

Successful Response

application/json
put
PUT /user HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 258

{
  "user": {
    "email": "text",
    "name": "text",
    "onboarding_status": "text",
    "avatar_url": "text",
    "last_accessed": "2025-08-11T14:38:06.770Z",
    "occupation": "text",
    "company": "text",
    "referral_source": "text",
    "phone_number": "text",
    "used_desktop_app": true,
    "client_metadata": {}
  }
}
{
  "email": "text",
  "name": "text",
  "onboarding_status": "text",
  "avatar_url": "text",
  "last_accessed": "2025-08-11T14:38:06.770Z",
  "occupation": "text",
  "company": "text",
  "referral_source": "text",
  "phone_number": "text",
  "used_desktop_app": true,
  "client_metadata": {},
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "is_shade_admin": true,
  "created_at": "2025-08-11T14:38:06.770Z",
  "total_roots": 1,
  "plan_status": "incomplete",
  "plan": "free",
  "asset_limit": 1,
  "total_indexed": 1,
  "total_storage": 1
}

Create user for share to perform actions with

post
Body
namestringRequired

The name of the user

emailstringRequired

The email of the user

Responses
200

Successful Response

application/json
post
POST /user/share HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "text",
  "email": "text"
}
{
  "email": "text",
  "name": "text",
  "onboarding_status": "text",
  "avatar_url": "text",
  "last_accessed": "2025-08-11T14:38:06.770Z",
  "occupation": "text",
  "company": "text",
  "referral_source": "text",
  "phone_number": "text",
  "used_desktop_app": true,
  "client_metadata": {},
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "is_shade_admin": true,
  "created_at": "2025-08-11T14:38:06.770Z",
  "total_roots": 1,
  "plan_status": "incomplete",
  "plan": "free",
  "asset_limit": 1,
  "total_indexed": 1,
  "total_storage": 1
}

Generate custom token for user auth

get
Responses
200

Successful Response

application/json
Responseany of
stringOptional
or
nullOptional
get
GET /user/auth-token HTTP/1.1
Host: 
Accept: */*

text
PreviousWorkspacesNextBilling