GET
/
users
curl --request GET \
  --url https://api.sandbox.goteal.co/users \
  --header 'X-API-KEY: <api-key>'
{
  "pagination": {
    "offset": 75,
    "limit": 25,
    "count": 14,
    "total_count": 89,
    "ordered_by": "created_at"
  },
  "users": [
    {
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2019-05-17T00:00:00.000Z",
      "name": "John Smith",
      "email": "john.smith@company.com"
    }
  ]
}

Authorizations

X-API-KEY
string
headerrequired

Query Parameters

orederd_by
enum<string>
default: created_at

The field of the user to order by

Available options:
name,
email,
created_at
offset
integer
default: 0

The offset to start at

limit
integer
default: 20

The number of items to return

Response

200 - application/json
pagination
object
users
object[]