List Orgs
curl --request GET \
--url https://api.zivio.net/api/v4/orgs \
--header 'Authorization: Bearer <token>' \
--header 'zivio-tenant-id: <api-key>'import requests
url = "https://api.zivio.net/api/v4/orgs"
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/orgs', 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/orgs",
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/orgs"
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))
}HttpResponse<String> response = Unirest.get("https://api.zivio.net/api/v4/orgs")
.header("Authorization", "Bearer <token>")
.header("zivio-tenant-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zivio.net/api/v4/orgs")
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{
"orgs": [
{
"id": 101,
"uuid": "Example uuid",
"external_ref": "Example external_ref",
"name": "Acme Corporation",
"is_external_client": true,
"is_supplier": true,
"supplier_id": 501,
"url": "Example url",
"linkedin_url": "Example linkedin_url",
"billing_email": "Example billing_email",
"address": null,
"invoice_address": null,
"payment_terms_in_days": 30,
"cis_contractor": null,
"financial_year_end_day": 101,
"financial_year_end_month": 101,
"time_zone": "Example time_zone",
"ai_services": true,
"scopeiq_share_ai_usage": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"settings": {
"default_fee_methodology": null,
"cis_contractor": false,
"payment_terms_in_days": null
},
"archived_at": "2024-01-16T10:30:00+00:00",
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00",
"cost_centers": [
{
"id": 101,
"org_id": 501,
"name": "Acme Corporation",
"code": "Example code",
"external_ref": "Example external_ref",
"is_active": true,
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00"
},
{
"id": 102,
"org_id": 502,
"name": "Global Services Ltd",
"code": "Example code",
"external_ref": "Example external_ref",
"is_active": true,
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
}
],
"org_units": [
{
"id": 101,
"org_id": 501,
"parent_id": 501,
"name": "Acme Corporation",
"unit_type": 101,
"external_ref": "Example external_ref",
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00"
},
{
"id": 102,
"org_id": 502,
"parent_id": 502,
"name": "Global Services Ltd",
"unit_type": 102,
"external_ref": "Example external_ref",
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
}
],
"org_users": [
{
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
{
"id": 102,
"first_name": "Jane",
"last_name": "Smith",
"email": "user2@example.com",
"org_id": 502,
"org_name": "Global Services Ltd"
}
]
},
{
"id": 102,
"uuid": "Example uuid",
"external_ref": "Example external_ref",
"name": "Global Services Ltd",
"is_external_client": true,
"is_supplier": true,
"supplier_id": 502,
"url": "Example url",
"linkedin_url": "Example linkedin_url",
"billing_email": "Example billing_email",
"address": null,
"invoice_address": null,
"payment_terms_in_days": 30,
"cis_contractor": null,
"financial_year_end_day": 102,
"financial_year_end_month": 102,
"time_zone": "Example time_zone",
"ai_services": true,
"scopeiq_share_ai_usage": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"settings": {
"default_fee_methodology": null,
"cis_contractor": false,
"payment_terms_in_days": null
},
"archived_at": "2024-01-17T10:30:00+00:00",
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00",
"cost_centers": [
{
"id": 102,
"org_id": 502,
"name": "Global Services Ltd",
"code": "Example code",
"external_ref": "Example external_ref",
"is_active": true,
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
},
{
"id": 103,
"org_id": 503,
"name": "Global Services Ltd",
"code": "Example code",
"external_ref": "Example external_ref",
"is_active": true,
"created_at": "2024-01-18T10:30:00+00:00",
"updated_at": "2024-01-18T10:30:00+00:00"
}
],
"org_units": [
{
"id": 102,
"org_id": 502,
"parent_id": 502,
"name": "Global Services Ltd",
"unit_type": 102,
"external_ref": "Example external_ref",
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
},
{
"id": 103,
"org_id": 503,
"parent_id": 503,
"name": "Global Services Ltd",
"unit_type": 103,
"external_ref": "Example external_ref",
"created_at": "2024-01-18T10:30:00+00:00",
"updated_at": "2024-01-18T10:30:00+00:00"
}
],
"org_users": [
{
"id": 102,
"first_name": "Jane",
"last_name": "Smith",
"email": "user2@example.com",
"org_id": 502,
"org_name": "Global Services Ltd"
},
{
"id": 103,
"first_name": "Jane",
"last_name": "Smith",
"email": "user3@example.com",
"org_id": 503,
"org_name": "Global Services Ltd"
}
]
}
]
}Orgs
List Orgs
Retrieve a paginated list of orgs. 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/orgs?filter[name]=active
# Multiple values (implicit IN)
GET /api/v4/orgs?filter[name]=draft,pending
# With explicit operator
GET /api/v4/orgs?filter[created_at][gte]=2024-01-01
# Range query
GET /api/v4/orgs?filter[supplier_id][between]=10,100
# Multiple filters (AND)
GET /api/v4/orgs?filter[name]=active&filter[supplier_id][gte]=10
Available Attributes
| Attribute | Type | Operators | Permitted Values |
|---|---|---|---|
| ai_services | boolean | eq, not_eq | - |
| archived_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| billing_email | string | eq, not_eq, in, not_in, like, not_like | - |
| cis_contractor | boolean | eq, not_eq | - |
| created_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| external_ref | string | eq, not_eq, in, not_in, like, not_like | - |
| financial_year_end_day | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| financial_year_end_month | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| is_external_client | boolean | eq, not_eq | - |
| is_supplier | boolean | eq, not_eq | - |
| linkedin_url | string | eq, not_eq, in, not_in, like, not_like | - |
| name | string | eq, not_eq, in, not_in, like, not_like | - |
| payment_terms_in_days | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| scopeiq_share_ai_usage | 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 | - |
| updated_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| url | string | eq, not_eq, in, not_in, like, not_like | - |
| uuid | string | eq, not_eq, in, not_in, like, not_like | - |
Custom Fields
This resource supports custom field filtering using cf[key] syntax:
# Equality
GET /api/v4/orgs?cf[priority]=high
# With operator
GET /api/v4/orgs?cf[department][in]=engineering,design
# Check existence
GET /api/v4/orgs?cf[priority][exists]=
# Negation
GET /api/v4/orgs?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/orgs?or[1][name]=pending&or[2][name]=active
# Complex OR (name=pending AND supplier_id>=10) OR (name=active)
GET /api/v4/orgs?or[1][name]=pending&or[1][supplier_id][gte]=10&or[2][name]=active
Sorting
Use sort[<attribute>] to order results. Default direction is ascending.
# Ascending (implicit)
GET /api/v4/orgs?sort[created_at]=
# Descending
GET /api/v4/orgs?sort[created_at]=desc
# Combined with filters
GET /api/v4/orgs?filter[name]=active&sort[created_at]=desc
GET
/
orgs
List Orgs
curl --request GET \
--url https://api.zivio.net/api/v4/orgs \
--header 'Authorization: Bearer <token>' \
--header 'zivio-tenant-id: <api-key>'import requests
url = "https://api.zivio.net/api/v4/orgs"
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/orgs', 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/orgs",
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/orgs"
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))
}HttpResponse<String> response = Unirest.get("https://api.zivio.net/api/v4/orgs")
.header("Authorization", "Bearer <token>")
.header("zivio-tenant-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zivio.net/api/v4/orgs")
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{
"orgs": [
{
"id": 101,
"uuid": "Example uuid",
"external_ref": "Example external_ref",
"name": "Acme Corporation",
"is_external_client": true,
"is_supplier": true,
"supplier_id": 501,
"url": "Example url",
"linkedin_url": "Example linkedin_url",
"billing_email": "Example billing_email",
"address": null,
"invoice_address": null,
"payment_terms_in_days": 30,
"cis_contractor": null,
"financial_year_end_day": 101,
"financial_year_end_month": 101,
"time_zone": "Example time_zone",
"ai_services": true,
"scopeiq_share_ai_usage": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"settings": {
"default_fee_methodology": null,
"cis_contractor": false,
"payment_terms_in_days": null
},
"archived_at": "2024-01-16T10:30:00+00:00",
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00",
"cost_centers": [
{
"id": 101,
"org_id": 501,
"name": "Acme Corporation",
"code": "Example code",
"external_ref": "Example external_ref",
"is_active": true,
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00"
},
{
"id": 102,
"org_id": 502,
"name": "Global Services Ltd",
"code": "Example code",
"external_ref": "Example external_ref",
"is_active": true,
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
}
],
"org_units": [
{
"id": 101,
"org_id": 501,
"parent_id": 501,
"name": "Acme Corporation",
"unit_type": 101,
"external_ref": "Example external_ref",
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00"
},
{
"id": 102,
"org_id": 502,
"parent_id": 502,
"name": "Global Services Ltd",
"unit_type": 102,
"external_ref": "Example external_ref",
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
}
],
"org_users": [
{
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
{
"id": 102,
"first_name": "Jane",
"last_name": "Smith",
"email": "user2@example.com",
"org_id": 502,
"org_name": "Global Services Ltd"
}
]
},
{
"id": 102,
"uuid": "Example uuid",
"external_ref": "Example external_ref",
"name": "Global Services Ltd",
"is_external_client": true,
"is_supplier": true,
"supplier_id": 502,
"url": "Example url",
"linkedin_url": "Example linkedin_url",
"billing_email": "Example billing_email",
"address": null,
"invoice_address": null,
"payment_terms_in_days": 30,
"cis_contractor": null,
"financial_year_end_day": 102,
"financial_year_end_month": 102,
"time_zone": "Example time_zone",
"ai_services": true,
"scopeiq_share_ai_usage": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"settings": {
"default_fee_methodology": null,
"cis_contractor": false,
"payment_terms_in_days": null
},
"archived_at": "2024-01-17T10:30:00+00:00",
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00",
"cost_centers": [
{
"id": 102,
"org_id": 502,
"name": "Global Services Ltd",
"code": "Example code",
"external_ref": "Example external_ref",
"is_active": true,
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
},
{
"id": 103,
"org_id": 503,
"name": "Global Services Ltd",
"code": "Example code",
"external_ref": "Example external_ref",
"is_active": true,
"created_at": "2024-01-18T10:30:00+00:00",
"updated_at": "2024-01-18T10:30:00+00:00"
}
],
"org_units": [
{
"id": 102,
"org_id": 502,
"parent_id": 502,
"name": "Global Services Ltd",
"unit_type": 102,
"external_ref": "Example external_ref",
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
},
{
"id": 103,
"org_id": 503,
"parent_id": 503,
"name": "Global Services Ltd",
"unit_type": 103,
"external_ref": "Example external_ref",
"created_at": "2024-01-18T10:30:00+00:00",
"updated_at": "2024-01-18T10:30:00+00:00"
}
],
"org_users": [
{
"id": 102,
"first_name": "Jane",
"last_name": "Smith",
"email": "user2@example.com",
"org_id": 502,
"org_name": "Global Services Ltd"
},
{
"id": 103,
"first_name": "Jane",
"last_name": "Smith",
"email": "user3@example.com",
"org_id": 503,
"org_name": "Global Services Ltd"
}
]
}
]
}Authorizations
OAuth 2.0 client credentials. The access token from POST /oauth/token is sent as a bearer token. Request only the scopes you need.
Your Zivio organisation identifier. The regional API endpoints serve every Zivio organisation, so each request must identify yours.
Query Parameters
Page number for pagination
Number of results per page (max 100)
Required range:
x <= 100Filterable attributes:
integer (operators: eq, not_eq, in, not_in, gt, gte, lt, lte, between): financial_year_end_day, financial_year_end_month, id, payment_terms_in_days, supplier_id datetime (operators: eq, not_eq, gt, gte, lt, lte, between): archived_at, created_at, updated_at string (operators: eq, not_eq, in, not_in, like, not_like): billing_email, external_ref, linkedin_url, name, time_zone, url, uuid boolean (operators: eq, not_eq): ai_services, cis_contractor, is_external_client, is_supplier, scopeiq_share_ai_usage
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 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.
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 matchcf[department][in]=eng,design- matches anycf[priority][not_eq]=low- not equalcf[notes][contains]=urgent- contains textcf[legacy_field][exists]=- field exists (value ignored)cf[deprecated][not_exists]=- field does not exist
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 results by attribute. Direction defaults to ascending.
Syntax: sort[<attribute>]= (ascending) or sort[<attribute>]=desc (descending)
Sortable attributes: ai_services, archived_at, billing_email, cis_contractor, created_at, external_ref, financial_year_end_day, financial_year_end_month, id, is_external_client, is_supplier, linkedin_url, name, payment_terms_in_days, scopeiq_share_ai_usage, supplier_id, time_zone, updated_at, url, uuid
Examples:
- Ascending:
sort[created_at]=orsort[created_at]=asc - Descending:
sort[created_at]=desc
Response
List of orgs
Show child attributes
Show child attributes