Get user by external id

GET 
/:customer_id/admin/users-by-external-id/:external_id

Get all users associated to an external id. External id does not have a unique constraint so several users can have the same external id.

Request

Path Parameters

customer_id Customer Idrequired

Id of the tenant

external_id External Idrequired

External ID of the user

Responses

200

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

users object[]required
Array [
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
]

Example (from schema)

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

400

Validation error

application/json

Schema

Schema

message Messagerequired
errors undefined[]nullablerequired

Example (from schema)

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

Loading...