List Users

get/public/v1/users

get/public/v1/users

curl --request GET \
  --url 'https://api.app.astalty.com.au/public/v1/users' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Response

{
  "data": [
    {
      "id": "u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john.doe@example.com",
      "status": "active",
      "employment_title": "Service Manager"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 0,
    "total": 0,
    "allowed_sorts": [
      "string"
    ]
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Query parameters

filter[status]string
Filter by user status. Comma-separate to combine values. One of: active, deactivated, invited, restricted.
Example:active
filter[contact_number]string
Partial match across both the phone and mobile numbers.
Example:0412
filter[employment_title]string
Partial match on the employment title. Comma-separate to combine values.
Example:Service Manager
page[size]integer
Number of results per page. Minimum 1, maximum 100.
Default:25
page[number]integer
The page number to retrieve. Use the last_page value from the meta response to determine the total number of pages available.
Default:1

Response

200application/json

Paginated set of UserResource

dataobject[]required
▶Show 6 child attributesHide child attributes
- idstringrequired
  Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
- first_namestringrequired
  Example:John
- last_namestringrequired
  Example:Doe
- emailstringrequired
  Example:john.doe@example.com
- statusenum<string>required
  Available options:activedeactivatedinvitedrestricted
- employment_titlestring | nullrequired
  Example:Service Manager
metaobjectrequired
▶Show 5 child attributesHide child attributes
- current_pageintegerrequired≥ 1
- last_pageintegerrequired≥ 1
- per_pageintegerrequired≥ 0
  Number of items shown per page.
- totalintegerrequired≥ 0
  Total number of items being paginated.
- allowed_sortsstring[]required
  The list of allowed sorts for this endpoint.

Errors

401Unauthenticated
403Authorization error

Command Palette

Authorization

Query parameters

Response

Errors