Skip to main content
GET
/
users
Retrieve all users, filter by query
curl --request GET \
  --url https://api.zivio.net/api/v3/users \
  --header 'X-API-Key: <api-key>' \
  --header 'zivio-tenant-id: <api-key>'
{
  "users": [
    {
      "id": "66",
      "first_name": "Lorna",
      "last_name": "Lawless",
      "email": "lorna@example.com",
      "org_name": "Example Org",
      "org_id": "186",
      "business_unit": "Resident Services",
      "division": "Environment & Streetscene",
      "department": "Housing",
      "vetting_status": "PASSED",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "custom_fields": {
        "key": "value"
      },
      "has_oversight": "true"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.zivio.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required
​
zivio-tenant-id
string
header
required

Query Parameters

​
q
string

Query string. Match by first_name, last_name or email.

​
created
string

Date range [YYYY-MM-DD+TO+YYYY-MM-DD] to search based on created timestamp for object.

​
updated
string

Date range [YYYY-MM-DD+TO+YYYY-MM-DD] to search based on updated timestamp for object.

​
sort
string

Results are sorted by created desc as default. Ordering may be specified, available options are ['created', 'updated'], which can be combined in a comma separated list, e.g. updated:desc,created:asc

​
limit
integer

Number of results returned per request

​
page
integer

Paginate results when number of results exceeds limit

Response

ok

​
users
object[]