List Users

List users. Filters: organization (UUID or name), email, search.

GET /api/v1/users

List Users

cURL

curl --request GET \
  --url https://{tenant_id}.api.useago.com/api/v1/users \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://{tenant_id}.api.useago.com/api/v1/users"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://{tenant_id}.api.useago.com/api/v1/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "data": [
    {
      "id": "<string>",
      "email": "<string>",
      "object": "user",
      "first_name": "",
      "last_name": "",
      "is_customer": true,
      "email_domain": "<string>",
      "organization": {},
      "created_at": "<string>",
      "permissions": [
        {
          "id": "<string>",
          "name": "<string>",
          "display_name": "<string>"
        }
      ]
    }
  ],
  "has_more": true,
  "total": 123,
  "object": "list"
}

Authorizations

X-API-Key · string · header · required

Query Parameters

page · integer · default: 1

page_size · integer · default: 50

organization · string | null

email · string | null

search · string | null

Response

200 - application/json

OK

data · UserOut · object[] · required

Show child attributes

has_more · boolean · required

total · integer · required

object · string · default: list