Get user

GET 
/:customer_id/users/:uid

Get user

Request

Path Parameters

customer_id Customer Idrequired

Id of the tenant

uid uuidrequired

Id of the user

Responses

200

Successful response

application/json

Schema

Schema

uid uuidrequired

User id

created_at date-timerequired

User creation date

external_id External Idnullablerequired

Optional external id assigned upon creation

alias Aliasnullablerequired

Optional alias

customer_id Customer Idrequired

Tenant id

last_active_utc date-timenullablerequired

Last active date

last_active_local_time date-timenullablerequired

Last active date

first_active_utc date-timenullablerequired

First active date

first_active_local_time date-timenullablerequired

First active date

utc_offset Utc Offsetnullablerequired

User's timezone offset in minutes

groups string[]required
settings objectrequired

Example (from schema)

{
  "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "2024-12-03T11:32:12.406Z",
  "external_id": "string",
  "alias": "string",
  "customer_id": "string",
  "last_active_utc": "2024-12-03T11:32:12.406Z",
  "last_active_local_time": "2024-12-03T11:32:12.406Z",
  "first_active_utc": "2024-12-03T11:32:12.406Z",
  "first_active_local_time": "2024-12-03T11:32:12.406Z",
  "utc_offset": 0,
  "groups": [
    "string"
  ],
  "settings": {}
}

400

Validation error

application/json

Schema

Schema

message Messagerequired
errors undefined[]nullablerequired

Example (from schema)

{
  "message": "string",
  "errors": [
    null
  ]
}

Loading...