curl --request GET \
--url https://api.zivio.net/api/v4/reviews \
--header 'Authorization: Bearer <token>' \
--header 'zivio-tenant-id: <api-key>'import requests
url = "https://api.zivio.net/api/v4/reviews"
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/reviews', 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/reviews",
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/reviews"
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/reviews")
.header("Authorization", "Bearer <token>")
.header("zivio-tenant-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zivio.net/api/v4/reviews")
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{
"reviews": [
{
"id": 101,
"external_id": "EXT-1001",
"provider": "Example provider",
"reviewer_name": "Example reviewer_name",
"job_title": "Example job_title",
"role": "Example role",
"overall_rating": 1500,
"recommended": true,
"positive_feedback": "Example positive_feedback",
"negative_feedback": "Example negative_feedback",
"comments": "Additional information and context for this record.",
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00",
"supplier_external_id": 501,
"review_component_scores": [
{
"review_id": 501,
"review_component_id": 501,
"score": 1500
},
{
"review_id": 502,
"review_component_id": 502,
"score": 1500
}
]
},
{
"id": 102,
"external_id": "EXT-1002",
"provider": "Example provider",
"reviewer_name": "Example reviewer_name",
"job_title": "Example job_title",
"role": "Example role",
"overall_rating": 1500,
"recommended": true,
"positive_feedback": "Example positive_feedback",
"negative_feedback": "Example negative_feedback",
"comments": "Additional information and context for this record.",
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00",
"supplier_external_id": 502,
"review_component_scores": [
{
"review_id": 502,
"review_component_id": 502,
"score": 1500
},
{
"review_id": 503,
"review_component_id": 503,
"score": 1500
}
]
}
]
}List Reviews
Retrieve a paginated list of reviews. 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/reviews?filter[provider]=active
# Multiple values (implicit IN)
GET /api/v4/reviews?filter[provider]=draft,pending
# With explicit operator
GET /api/v4/reviews?filter[created_at][gte]=2024-01-01
# Range query
GET /api/v4/reviews?filter[external_id][between]=10,100
# Multiple filters (AND)
GET /api/v4/reviews?filter[provider]=active&filter[external_id][gte]=10
Available Attributes
| Attribute | Type | Operators | Permitted Values |
|---|---|---|---|
| comments | string | eq, not_eq, in, not_in, like, not_like | - |
| created_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| external_id | 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 | - |
| job_title | string | eq, not_eq, in, not_in, like, not_like | - |
| negative_feedback | string | eq, not_eq, in, not_in, like, not_like | - |
| overall_rating | decimal | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| positive_feedback | string | eq, not_eq, in, not_in, like, not_like | - |
| provider | string | eq, not_eq, in, not_in, like, not_like | - |
| recommended | boolean | eq, not_eq | - |
| reviewer_name | string | eq, not_eq, in, not_in, like, not_like | - |
| role | string | eq, not_eq, in, not_in, like, not_like | - |
| updated_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
OR Conditions
Use or[group] to combine filter groups with OR logic. Filters within a group are ANDed:
# Simple OR
GET /api/v4/reviews?or[1][provider]=pending&or[2][provider]=active
# Complex OR (provider=pending AND external_id>=10) OR (provider=active)
GET /api/v4/reviews?or[1][provider]=pending&or[1][external_id][gte]=10&or[2][provider]=active
Sorting
Use sort[<attribute>] to order results. Default direction is ascending.
# Ascending (implicit)
GET /api/v4/reviews?sort[created_at]=
# Descending
GET /api/v4/reviews?sort[created_at]=desc
# Combined with filters
GET /api/v4/reviews?filter[provider]=active&sort[created_at]=desc
curl --request GET \
--url https://api.zivio.net/api/v4/reviews \
--header 'Authorization: Bearer <token>' \
--header 'zivio-tenant-id: <api-key>'import requests
url = "https://api.zivio.net/api/v4/reviews"
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/reviews', 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/reviews",
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/reviews"
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/reviews")
.header("Authorization", "Bearer <token>")
.header("zivio-tenant-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zivio.net/api/v4/reviews")
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{
"reviews": [
{
"id": 101,
"external_id": "EXT-1001",
"provider": "Example provider",
"reviewer_name": "Example reviewer_name",
"job_title": "Example job_title",
"role": "Example role",
"overall_rating": 1500,
"recommended": true,
"positive_feedback": "Example positive_feedback",
"negative_feedback": "Example negative_feedback",
"comments": "Additional information and context for this record.",
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00",
"supplier_external_id": 501,
"review_component_scores": [
{
"review_id": 501,
"review_component_id": 501,
"score": 1500
},
{
"review_id": 502,
"review_component_id": 502,
"score": 1500
}
]
},
{
"id": 102,
"external_id": "EXT-1002",
"provider": "Example provider",
"reviewer_name": "Example reviewer_name",
"job_title": "Example job_title",
"role": "Example role",
"overall_rating": 1500,
"recommended": true,
"positive_feedback": "Example positive_feedback",
"negative_feedback": "Example negative_feedback",
"comments": "Additional information and context for this record.",
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00",
"supplier_external_id": 502,
"review_component_scores": [
{
"review_id": 502,
"review_component_id": 502,
"score": 1500
},
{
"review_id": 503,
"review_component_id": 503,
"score": 1500
}
]
}
]
}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)
x <= 100Filterable attributes:
integer (operators: eq, not_eq, in, not_in, gt, gte, lt, lte, between): external_id, 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): comments, job_title, negative_feedback, positive_feedback, provider, reviewer_name, role decimal (operators: eq, not_eq, in, not_in, gt, gte, lt, lte, between): overall_rating boolean (operators: eq, not_eq): recommended
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.
Sort results by attribute. Direction defaults to ascending.
Syntax: sort[<attribute>]= (ascending) or sort[<attribute>]=desc (descending)
Sortable attributes: comments, created_at, external_id, id, job_title, negative_feedback, overall_rating, positive_feedback, provider, recommended, reviewer_name, role, updated_at
Examples:
- Ascending:
sort[created_at]=orsort[created_at]=asc - Descending:
sort[created_at]=desc
Response
List of reviews
Show child attributes
Show child attributes

