Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
User

user.search

Searches for users by email address.

Returns an array containing the user if found, or an empty array if no user with the given email exists.

Requires the organizationRead permission.

post/user.search

Request body

emailstring email required

The email address to search for

Example request

{
  "email": "test@ashbyhq.com"
}

Response

Responses from the user.search endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d",
      "firstName": "Jane",
      "lastName": "Smith",
      "email": "jane.smith@example.com",
      "globalRole": "Elevated Access",
      "isEnabled": true,
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "managerId": "7f8e9d6c-5b4a-4e2d-9c0b-9a8f7e6d5c4b"
    }
  ]
}