List Users

curl --request GET \
  --url https://api.zivio.net/api/v4/users \
  --header 'Authorization: Bearer <token>' \
  --header 'zivio-tenant-id: <api-key>'

import requests

url = "https://api.zivio.net/api/v4/users"

headers = {
    "Authorization": "Bearer <token>",
    "zivio-tenant-id": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'zivio-tenant-id': '<api-key>'}
};

fetch('https://api.zivio.net/api/v4/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.zivio.net/api/v4/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "zivio-tenant-id: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.zivio.net/api/v4/users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("zivio-tenant-id", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.zivio.net/api/v4/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["zivio-tenant-id"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "users": [
    {
      "id": 101,
      "first_name": "Demo",
      "last_name": "User",
      "email": "user1@example.com",
      "org_name": "Acme Corporation",
      "org_id": 501,
      "business_unit": null,
      "division": null,
      "department": null,
      "has_oversight": true,
      "vetting_status": "PASSED",
      "custom_fields": {
        "department": "Engineering",
        "priority": "high",
        "cost_code": "CC-001"
      },
      "created_at": "2024-01-16T10:30:00+00:00",
      "updated_at": "2024-01-16T10:30:00+00:00"
    },
    {
      "id": 102,
      "first_name": "Jane",
      "last_name": "Smith",
      "email": "user2@example.com",
      "org_name": "Global Services Ltd",
      "org_id": 502,
      "business_unit": null,
      "division": null,
      "department": null,
      "has_oversight": true,
      "vetting_status": "FAILED",
      "custom_fields": {
        "department": "Engineering",
        "priority": "high",
        "cost_code": "CC-001"
      },
      "created_at": "2024-01-17T10:30:00+00:00",
      "updated_at": "2024-01-17T10:30:00+00:00"
    }
  ]
}

Users

List Users

Retrieve a paginated list of users. Use filters to narrow results.

Filtering

Use the filter[<attribute>] parameter to filter results. Multiple filters are combined with AND logic.

Basic Examples

# Equality (implicit)
GET /api/v4/users?filter[vetting_status]=NOT REGISTERED

# Multiple values (implicit IN)
GET /api/v4/users?filter[vetting_status]=NOT REGISTERED,FAILED

# With explicit operator
GET /api/v4/users?filter[created_at][gte]=2024-01-01

# Range query
GET /api/v4/users?filter[org_id][between]=10,100

# Multiple filters (AND)
GET /api/v4/users?filter[vetting_status]=NOT REGISTERED&filter[org_id][gte]=10

Available Attributes

Attribute	Type	Operators	Permitted Values
base_currency	string	`eq`, `not_eq`, `in`, `not_in`, `like`, `not_like`	-
created_at	datetime	`eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between`	-
email	string	`eq`, `not_eq`, `in`, `not_in`, `like`, `not_like`	-
first_name	string	`eq`, `not_eq`, `in`, `not_in`, `like`, `not_like`	-
has_oversight	boolean	`eq`, `not_eq`	-
id	integer	`eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between`	-
last_name	string	`eq`, `not_eq`, `in`, `not_in`, `like`, `not_like`	-
linkedin_url	string	`eq`, `not_eq`, `in`, `not_in`, `like`, `not_like`	-
org_id	integer	`eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between`	-
sso_only	boolean	`eq`, `not_eq`	-
supplier_id	integer	`eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between`	-
time_zone	string	`eq`, `not_eq`, `in`, `not_in`, `like`, `not_like`	-
uid	string	`eq`, `not_eq`, `in`, `not_in`, `like`, `not_like`	-
updated_at	datetime	`eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between`	-
vetting_status	string	`eq`, `not_eq`, `in`, `not_in`	`NOT REGISTERED`, `PASSED`, `FAILED`, `PENDING`

Custom Fields

This resource supports custom field filtering using cf[key] syntax:

# Equality
GET /api/v4/users?cf[priority]=high

# With operator
GET /api/v4/users?cf[department][in]=engineering,design

# Check existence
GET /api/v4/users?cf[priority][exists]=

# Negation
GET /api/v4/users?cf[priority][not_eq]=low

OR Conditions

Use or[group] to combine filter groups with OR logic. Filters within a group are ANDed:

# Simple OR
GET /api/v4/users?or[1][vetting_status]=PASSED&or[2][vetting_status]=NOT REGISTERED

# Complex OR (vetting_status=PASSED AND org_id>=10) OR (vetting_status=NOT REGISTERED)
GET /api/v4/users?or[1][vetting_status]=PASSED&or[1][org_id][gte]=10&or[2][vetting_status]=NOT REGISTERED

Sorting

Use sort[<attribute>] to order results. Default direction is ascending.

# Ascending (implicit)
GET /api/v4/users?sort[created_at]=

# Descending
GET /api/v4/users?sort[created_at]=desc

# Combined with filters
GET /api/v4/users?filter[vetting_status]=NOT REGISTERED&sort[created_at]=desc

GET

users

List Users

curl --request GET \
  --url https://api.zivio.net/api/v4/users \
  --header 'Authorization: Bearer <token>' \
  --header 'zivio-tenant-id: <api-key>'

import requests

url = "https://api.zivio.net/api/v4/users"

headers = {
    "Authorization": "Bearer <token>",
    "zivio-tenant-id": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'zivio-tenant-id': '<api-key>'}
};

fetch('https://api.zivio.net/api/v4/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.zivio.net/api/v4/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "zivio-tenant-id: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.zivio.net/api/v4/users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("zivio-tenant-id", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.zivio.net/api/v4/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["zivio-tenant-id"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "users": [
    {
      "id": 101,
      "first_name": "Demo",
      "last_name": "User",
      "email": "user1@example.com",
      "org_name": "Acme Corporation",
      "org_id": 501,
      "business_unit": null,
      "division": null,
      "department": null,
      "has_oversight": true,
      "vetting_status": "PASSED",
      "custom_fields": {
        "department": "Engineering",
        "priority": "high",
        "cost_code": "CC-001"
      },
      "created_at": "2024-01-16T10:30:00+00:00",
      "updated_at": "2024-01-16T10:30:00+00:00"
    },
    {
      "id": 102,
      "first_name": "Jane",
      "last_name": "Smith",
      "email": "user2@example.com",
      "org_name": "Global Services Ltd",
      "org_id": 502,
      "business_unit": null,
      "division": null,
      "department": null,
      "has_oversight": true,
      "vetting_status": "FAILED",
      "custom_fields": {
        "department": "Engineering",
        "priority": "high",
        "cost_code": "CC-001"
      },
      "created_at": "2024-01-17T10:30:00+00:00",
      "updated_at": "2024-01-17T10:30:00+00:00"
    }
  ]
}

Authorizations

Authorization

string

header

required

OAuth 2.0 client credentials. The access token from POST /oauth/token is sent as a bearer token. Request only the scopes you need.

zivio-tenant-id

string

header

required

Your Zivio organisation identifier. The regional API endpoints serve every Zivio organisation, so each request must identify yours.

Query Parameters

page

integer

default:1

Page number for pagination

limit

integer

default:20

Number of results per page (max 100)

Required range: x <= 100

filter[<attribute>]

object

Filterable attributes:

integer (operators: eq, not_eq, in, not_in, gt, gte, lt, lte, between): id, org_id, supplier_id datetime (operators: eq, not_eq, gt, gte, lt, lte, between): created_at, updated_at string (operators: eq, not_eq, in, not_in, like, not_like): base_currency, email, first_name, last_name, linkedin_url, time_zone, uid, vetting_status (one of: NOT REGISTERED, PASSED, FAILED, PENDING) boolean (operators: eq, not_eq): has_oversight, sso_only

Note: like is a case-insensitive substring match — pass the bare term (filter[title][like]=redesign). Do not add % wildcards; they are not needed.

or[group]

object

OR condition groups. Filters within a group are ANDed; groups are ORed.

Syntax: or[group_key][<attribute>]=value or or[group_key][<attribute>][operator]=value

Examples:

Simple OR: or[1][state]=draft&or[2][state]=pending
Complex: or[1][state]=draft&or[1][budget][gte]=50000&or[2][state]=closed
With custom fields: or[1][cf][priority]=high&or[2][state]=pending

Group keys can be any string (1, 2, a, b, etc.) - they just need to be unique.

cf[key]

object

Custom field filters using concise syntax.

Syntax:

Equality: cf[key]=value
With operator: cf[key][operator]=value

Operators: eq (default), not_eq, in, not_in, contains, not_contains, exists, not_exists

Examples:

cf[priority]=high - exact match
cf[department][in]=eng,design - matches any
cf[priority][not_eq]=low - not equal
cf[notes][contains]=urgent - contains text
cf[legacy_field][exists]= - field exists (value ignored)
cf[deprecated][not_exists]= - field does not exist

or[group][cf][key]

object

Custom field filters within OR condition groups.

Syntax: or[group][cf][key]=value or or[group][cf][key][operator]=value

Example: or[1][cf][priority]=high&or[2][state]=pending

sort[<attribute>]

object

Sort results by attribute. Direction defaults to ascending.

Syntax: sort[<attribute>]= (ascending) or sort[<attribute>]=desc (descending)

Sortable attributes: base_currency, created_at, email, first_name, has_oversight, id, last_name, linkedin_url, org_id, sso_only, supplier_id, time_zone, uid, updated_at, vetting_status

Examples:

Ascending: sort[created_at]= or sort[created_at]=asc
Descending: sort[created_at]=desc

Response

List of users

users

object[]

Show child attributes

Authentication

Welcome

Bids

Eois

Eoi Responses

Invoices

Milestones

Offers

Projects

Supplier Lists

Suppliers

Variation Orders

Users

Skill Taxonomies

Tax Types

Bank Accounts

Raw Scorecard Entries

Reviews

Supplier Users

Orgs

Purchase Orders

Notes

Tasks

List Users

Filtering

Basic Examples

Available Attributes

Custom Fields

OR Conditions

Sorting

Authorizations

Query Parameters

Response