Get User by Email - Answering Agent

GET

users

by-email

Get User by Email

curl --request GET \
  --url https://playground.answeringagent.com/api/v1/users/by-email \
  --header 'X-API-KEY: <api-key>'

{
  "id": 123,
  "external_id": "<string>",
  "email": "jsmith@example.com",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "organizations": [
    {
      "id": 123,
      "name": "<string>"
    }
  ]
}

Authorizations

X-API-KEY

string

header

required

Query Parameters

string<email>

required

Response

User object returned.

integer

Internal user ID

external_id

string

External identifier provided by the reseller

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

Show child attributes

Logout UserLogout a user by invalidating all their authentication tokens. This forces the user to log in again on their next request.

Get User by Email

curl --request GET \
  --url https://playground.answeringagent.com/api/v1/users/by-email \
  --header 'X-API-KEY: <api-key>'

{
  "id": 123,
  "external_id": "<string>",
  "email": "jsmith@example.com",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "organizations": [
    {
      "id": 123,
      "name": "<string>"
    }
  ]
}