v1

latestOpenAPI 3.1.02026-07-222392081.7 MB

Users

List users

Retrieve existing users.

get/v1/users

Query parameters

takenumber nullable

skipnumber nullable

first_namestring

first_name__notstring

first_name__isNullstring

first_name__isNotNullstring

first_name__equalsstring

first_name__containsstring

first_name__startsWithstring

first_name__endWithstring

last_namestring

last_name__notstring

last_name__isNullstring

last_name__isNotNullstring

last_name__equalsstring

last_name__containsstring

last_name__startsWithstring

last_name__endWithstring

emailstring

email__notstring

email__isNullstring

email__isNotNullstring

email__equalsstring

email__containsstring

email__startsWithstring

email__endWithstring

Response

Example response

{
  "meta": {
    "total": 1,
    "taken": 1
  },
  "data": [
    {
      "id": "usr_DKL4Xcb5VSa8CQ",
      "email": "john@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "role_id": "rol_DKL4Xcb5VSa8CQ"
    }
  ]
}