Skip to main content
GET
/
users
/
{external_id}
Get User by External ID
curl --request GET \
  --url https://playground.answeringagent.com/api/v1/users/{external_id} \
  --header 'X-API-KEY: <api-key>'
{
  "id": 123,
  "external_id": "<string>",
  "email": "[email protected]",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "organizations": [
    {
      "id": 123,
      "name": "<string>",
      "role": "owner"
    }
  ]
}

Authorizations

X-API-KEY
string
header
required

Path Parameters

external_id
string
required

Response

User object returned.

id
integer

Internal user ID

external_id
string

External identifier provided by the reseller

email
string<email>

User's email address

name
string

User's display name

created_at
string<date-time>

When the user was created

updated_at
string<date-time>

When the user was last updated

organizations
object[]

Organizations this user belongs to with their role