Skip to content

User API โ€‹

Get Me โ€‹

prolog
GET API_BASE/users/me

Authorization Required โ€‹

OAuthAPIKey
YesYes

Response โ€‹

json
{
  "data": UserObject,
  "ts": 1723923923
}

Update Me โ€‹

prolog
PUT API_BASE/users/me

Authorization Required โ€‹

OAuthAPIKey
YesYes

Request Body โ€‹

json
{
  "name": "John Wick",
  "bio": "...",
  "avatar_image_url": "https://...",
  "social_ids": [
    {
      "name": "twitter",
      "value": "john_wick"
    }
  ]
}

Response โ€‹

json
{
  "data": UserObject,
  "ts": 1723923923
}

Update Email โ€‹

prolog
PUT API_BASE/users/me/email

Authorization Required โ€‹

OAuthAPIKey
YesYes

Request Body โ€‹

json
{
  "email": "new@example.com",
  "code": "123456"
}

Response โ€‹

json
{
  "data": UserObject,
  "ts": 1723923923
}

Update Options โ€‹

prolog
PUT API_BASE/users/me/options

Authorization Required โ€‹

OAuthAPIKey
YesYes

Request Body โ€‹

json
{
  "options": {
    "language": "en"
  }
}

Response โ€‹

json
{
  "data": UserObject,
  "ts": 1723923923
}

Get User โ€‹

prolog
GET API_BASE/users/:user_id

Parameters โ€‹

ParameterTypeDescription
user_idintThe ID of the user

Response โ€‹

json
{
  "data": UserObject,
  "ts": 1723923923
}

Query Users โ€‹

prolog
GET API_BASE/users/query

Authorization Required โ€‹

OAuthAPIKey
YesYes

Query Parameters โ€‹

ParameterTypeDescription
emailstringThe email of the user

Response โ€‹

json
{
  "data": [UserObject],
  "ts": 1723923923
}