User

Get user data for a user id

get

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

or

nullOptional

404

Not found

422

Validation Error

application/json

get

/user

HTTPcURLJavaScriptPython

GET /user HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "email": "text",
  "name": "text",
  "onboarding_status": "text",
  "avatar_url": "text",
  "last_accessed": "2026-03-09T12:56:28.725Z",
  "occupation": "text",
  "company": "text",
  "referral_source": "text",
  "phone_number": "text",
  "used_desktop_app": true,
  "client_metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "is_shade_admin": true,
  "created_at": "2026-03-09T12:56:28.725Z",
  "total_roots": 1,
  "plan_status": "incomplete",
  "plan": "free",
  "asset_limit": 1,
  "total_indexed": 1,
  "total_storage": 1
}

Modify user data

put

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

emailany ofOptional

stringOptional

or

nullOptional

nameany ofOptional

stringOptional

or

nullOptional

onboarding_statusany ofOptional

stringOptional

or

nullOptional

avatar_urlany ofOptional

stringOptional

or

nullOptional

last_accessedany ofOptional

string · date-timeOptional

or

nullOptional

occupationany ofOptional

stringOptional

or

nullOptional

companyany ofOptional

stringOptional

or

nullOptional

referral_sourceany ofOptional

stringOptional

or

nullOptional

phone_numberany ofOptional

stringOptional

or

nullOptional

used_desktop_appany ofOptional

booleanOptional

or

nullOptional

client_metadataany ofOptional

or

nullOptional

idstring · uuidRequired

is_shade_adminbooleanRequired

created_atstring · date-timeRequired

total_rootsintegerRequired

plan_statusstring · enumRequiredPossible values:

planstring · enumRequiredPossible values:

asset_limitintegerRequired

total_indexedintegerRequired

total_storageintegerRequired

404

Not found

422

Validation Error

application/json

put

/user

HTTPcURLJavaScriptPython

PUT /user HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 340

{
  "user": {
    "email": "text",
    "name": "text",
    "onboarding_status": "text",
    "avatar_url": "text",
    "last_accessed": "2026-03-09T12:56:28.725Z",
    "occupation": "text",
    "company": "text",
    "referral_source": "text",
    "phone_number": "text",
    "used_desktop_app": true,
    "client_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "email": "text",
  "name": "text",
  "onboarding_status": "text",
  "avatar_url": "text",
  "last_accessed": "2026-03-09T12:56:28.725Z",
  "occupation": "text",
  "company": "text",
  "referral_source": "text",
  "phone_number": "text",
  "used_desktop_app": true,
  "client_metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "is_shade_admin": true,
  "created_at": "2026-03-09T12:56:28.725Z",
  "total_roots": 1,
  "plan_status": "incomplete",
  "plan": "free",
  "asset_limit": 1,
  "total_indexed": 1,
  "total_storage": 1
}

Create an avatar for a user

post

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

extensionstring · enumRequired

The extension type of the avatar

Possible values:

sizeanyRequired

Size of the avatar

Responses

200

Successful Response

application/json

Other propertiesanyOptional

404

Not found

422

Validation Error

application/json

post

/user/profile/avatar/upload-url

HTTPcURLJavaScriptPython

POST /user/profile/avatar/upload-url HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "extension": "png",
  "size": null,
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Confirm uploading an avatar for a user

post

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

download_urlanyRequired

The download url

Responses

200

Successful Response

application/json

anyOptional

404

Not found

422

Validation Error

application/json

post

/user/profile/avatar/complete

HTTPcURLJavaScriptPython

POST /user/profile/avatar/complete HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "download_url": null,
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Create user for share to perform actions with

post

Body

application/json

namestringRequired

The name of the user

emailstringRequired

The email of the user

Responses

200

Successful Response

application/json

emailany ofOptional

stringOptional

or

nullOptional

nameany ofOptional

stringOptional

or

nullOptional

onboarding_statusany ofOptional

stringOptional

or

nullOptional

avatar_urlany ofOptional

stringOptional

or

nullOptional

last_accessedany ofOptional

string · date-timeOptional

or

nullOptional

occupationany ofOptional

stringOptional

or

nullOptional

companyany ofOptional

stringOptional

or

nullOptional

referral_sourceany ofOptional

stringOptional

or

nullOptional

phone_numberany ofOptional

stringOptional

or

nullOptional

used_desktop_appany ofOptional

booleanOptional

or

nullOptional

client_metadataany ofOptional

or

nullOptional

idstring · uuidRequired

is_shade_adminbooleanRequired

created_atstring · date-timeRequired

total_rootsintegerRequired

plan_statusstring · enumRequiredPossible values:

planstring · enumRequiredPossible values:

asset_limitintegerRequired

total_indexedintegerRequired

total_storageintegerRequired

404

Not found

422

Validation Error

application/json

post

/user/share

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "email": "text"
}

{
  "email": "text",
  "name": "text",
  "onboarding_status": "text",
  "avatar_url": "text",
  "last_accessed": "2026-03-09T12:56:28.725Z",
  "occupation": "text",
  "company": "text",
  "referral_source": "text",
  "phone_number": "text",
  "used_desktop_app": true,
  "client_metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "is_shade_admin": true,
  "created_at": "2026-03-09T12:56:28.725Z",
  "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

stringOptional

or

nullOptional

404

Not found

get

/user/auth-token

HTTPcURLJavaScriptPython

GET /user/auth-token HTTP/1.1
Accept: */*

text