curl --request GET \
--url https://api.zivio.net/api/v4/milestones \
--header 'Authorization: Bearer <token>' \
--header 'zivio-tenant-id: <api-key>'import requests
url = "https://api.zivio.net/api/v4/milestones"
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/milestones', 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/milestones",
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/milestones"
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/milestones")
.header("Authorization", "Bearer <token>")
.header("zivio-tenant-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zivio.net/api/v4/milestones")
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{
"milestones": [
{
"id": 101,
"title": "Website Redesign Project",
"status": "submitted",
"client_suggested": false,
"close_project": false,
"comments": "Additional information and context for this record.",
"details": "Additional information and context for this record.",
"due_on": "2024-01-16",
"project_summary": "Website Redesign Project - Complete redesign of corporate website with modern UX",
"mandatory": false,
"notes": "Additional information and context for this record.",
"original_id": 501,
"original_rate": {
"cents": 150000,
"currency": "GBP"
},
"purchase_order_line_id": 501,
"rate": {
"cents": 150000,
"currency": "GBP"
},
"submitted_at": "2024-01-16T10:30:00+00:00",
"interim_valuation_date": "2024-01-16T10:30:00+00:00",
"tiered_markup_fee": {
"cents": 150000,
"currency": "GBP"
},
"children": [
201,
202
],
"parents": [
201,
202
],
"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",
"project_id": 501,
"final_claim": "false",
"delivered_on": "2024-01-16",
"approved_by": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"rejected_by": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"level_1_approved_by": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
}
},
{
"id": 102,
"title": "Mobile App Development",
"status": "approved",
"client_suggested": false,
"close_project": false,
"comments": "Additional information and context for this record.",
"details": "Additional information and context for this record.",
"due_on": "2024-01-17",
"project_summary": "Website Redesign Project - Complete redesign of corporate website with modern UX",
"mandatory": false,
"notes": "Additional information and context for this record.",
"original_id": 502,
"original_rate": {
"cents": 300000,
"currency": "GBP"
},
"purchase_order_line_id": 502,
"rate": {
"cents": 300000,
"currency": "GBP"
},
"submitted_at": "2024-01-17T10:30:00+00:00",
"interim_valuation_date": "2024-01-17T10:30:00+00:00",
"tiered_markup_fee": {
"cents": 300000,
"currency": "GBP"
},
"children": [
202,
203
],
"parents": [
202,
203
],
"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",
"project_id": 502,
"final_claim": "true",
"delivered_on": "2024-01-17",
"approved_by": {
"id": 102,
"first_name": "Jane",
"last_name": "Smith",
"email": "user2@example.com",
"org_id": 502,
"org_name": "Global Services Ltd"
},
"rejected_by": {
"id": 102,
"first_name": "Jane",
"last_name": "Smith",
"email": "user2@example.com",
"org_id": 502,
"org_name": "Global Services Ltd"
},
"level_1_approved_by": {
"id": 102,
"first_name": "Jane",
"last_name": "Smith",
"email": "user2@example.com",
"org_id": 502,
"org_name": "Global Services Ltd"
}
}
]
}List Milestones
Retrieve a paginated list of milestones. 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/milestones?filter[status]=open
# Multiple values (implicit IN)
GET /api/v4/milestones?filter[status]=open,approved
# With explicit operator
GET /api/v4/milestones?filter[created_at][gte]=2024-01-01
# Range query
GET /api/v4/milestones?filter[rate][between]=1000000,5000000
# Multiple filters (AND)
GET /api/v4/milestones?filter[status]=open&filter[rate][gte]=1000000
Available Attributes
| Attribute | Type | Operators | Permitted Values |
|---|---|---|---|
| active | boolean | eq | true, false |
| approved_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| approved_by_id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| client_suggested | boolean | eq, not_eq | - |
| close_project | boolean | eq, not_eq | - |
| comments | string | eq, not_eq, in, not_in, like, not_like | - |
| created_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| delivered_on | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| details | string | eq, not_eq, in, not_in, like, not_like | - |
| due_on | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| final_claim | boolean | eq, not_eq | true, false |
| id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| interim_valuation_date | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| level_1_approved_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| level_1_approved_by_id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| mandatory | boolean | eq, not_eq | - |
| notes | string | eq, not_eq, in, not_in, like, not_like | - |
| original_id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| original_rate | money | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| overdue | boolean | eq | true, false |
| project_id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| purchase_order_line_id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| rate | money | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| rate_ccy | string | eq, not_eq, in, not_in, like, not_like | - |
| rejected_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| rejected_by_id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| status | string | eq, not_eq, in, not_in | open, submitted, approved, rejected, change_requested, on_hold, draft, cancelled, level_1_approved, closed |
| submitted_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| tiered_markup_fee | money | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| title | string | eq, not_eq, in, not_in, like, not_like | - |
| updated_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
Custom Fields
This resource supports custom field filtering using cf[key] syntax:
# Equality
GET /api/v4/milestones?cf[priority]=high
# With operator
GET /api/v4/milestones?cf[department][in]=engineering,design
# Check existence
GET /api/v4/milestones?cf[priority][exists]=
# Negation
GET /api/v4/milestones?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/milestones?or[1][status]=submitted&or[2][status]=open
# Complex OR (status=submitted AND rate>=1000000) OR (status=open)
GET /api/v4/milestones?or[1][status]=submitted&or[1][rate][gte]=1000000&or[2][status]=open
Sorting
Use sort[<attribute>] to order results. Default direction is ascending.
# Ascending (implicit)
GET /api/v4/milestones?sort[created_at]=
# Descending
GET /api/v4/milestones?sort[created_at]=desc
# Combined with filters
GET /api/v4/milestones?filter[status]=open&sort[created_at]=desc
curl --request GET \
--url https://api.zivio.net/api/v4/milestones \
--header 'Authorization: Bearer <token>' \
--header 'zivio-tenant-id: <api-key>'import requests
url = "https://api.zivio.net/api/v4/milestones"
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/milestones', 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/milestones",
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/milestones"
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/milestones")
.header("Authorization", "Bearer <token>")
.header("zivio-tenant-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zivio.net/api/v4/milestones")
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{
"milestones": [
{
"id": 101,
"title": "Website Redesign Project",
"status": "submitted",
"client_suggested": false,
"close_project": false,
"comments": "Additional information and context for this record.",
"details": "Additional information and context for this record.",
"due_on": "2024-01-16",
"project_summary": "Website Redesign Project - Complete redesign of corporate website with modern UX",
"mandatory": false,
"notes": "Additional information and context for this record.",
"original_id": 501,
"original_rate": {
"cents": 150000,
"currency": "GBP"
},
"purchase_order_line_id": 501,
"rate": {
"cents": 150000,
"currency": "GBP"
},
"submitted_at": "2024-01-16T10:30:00+00:00",
"interim_valuation_date": "2024-01-16T10:30:00+00:00",
"tiered_markup_fee": {
"cents": 150000,
"currency": "GBP"
},
"children": [
201,
202
],
"parents": [
201,
202
],
"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",
"project_id": 501,
"final_claim": "false",
"delivered_on": "2024-01-16",
"approved_by": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"rejected_by": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"level_1_approved_by": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
}
},
{
"id": 102,
"title": "Mobile App Development",
"status": "approved",
"client_suggested": false,
"close_project": false,
"comments": "Additional information and context for this record.",
"details": "Additional information and context for this record.",
"due_on": "2024-01-17",
"project_summary": "Website Redesign Project - Complete redesign of corporate website with modern UX",
"mandatory": false,
"notes": "Additional information and context for this record.",
"original_id": 502,
"original_rate": {
"cents": 300000,
"currency": "GBP"
},
"purchase_order_line_id": 502,
"rate": {
"cents": 300000,
"currency": "GBP"
},
"submitted_at": "2024-01-17T10:30:00+00:00",
"interim_valuation_date": "2024-01-17T10:30:00+00:00",
"tiered_markup_fee": {
"cents": 300000,
"currency": "GBP"
},
"children": [
202,
203
],
"parents": [
202,
203
],
"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",
"project_id": 502,
"final_claim": "true",
"delivered_on": "2024-01-17",
"approved_by": {
"id": 102,
"first_name": "Jane",
"last_name": "Smith",
"email": "user2@example.com",
"org_id": 502,
"org_name": "Global Services Ltd"
},
"rejected_by": {
"id": 102,
"first_name": "Jane",
"last_name": "Smith",
"email": "user2@example.com",
"org_id": 502,
"org_name": "Global Services Ltd"
},
"level_1_approved_by": {
"id": 102,
"first_name": "Jane",
"last_name": "Smith",
"email": "user2@example.com",
"org_id": 502,
"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)
x <= 100Filterable attributes:
integer (operators: eq, not_eq, in, not_in, gt, gte, lt, lte, between): approved_by_id, id, level_1_approved_by_id, original_id, project_id, purchase_order_line_id, rejected_by_id datetime (operators: eq, not_eq, gt, gte, lt, lte, between): approved_at, created_at, delivered_on, due_on, interim_valuation_date, level_1_approved_at, rejected_at, submitted_at, updated_at string (operators: eq, not_eq, in, not_in, like, not_like): comments, details, notes, rate_ccy, status (one of: open = open and not yet submitted to client; submitted = submitted to client; approved = fully approved. final state.; rejected = rejected by client; change_requested = change requested by client; on_hold = on hold. not currently active.; draft = saved by supplier, not yet submitted to client; cancelled = cancelled by client; level_1_approved = passed first-level approval, awaiting final approval; closed = closed by client), title money (operators: eq, not_eq, in, not_in, gt, gte, lt, lte, between): original_rate, rate, tiered_markup_fee boolean (operators: eq, not_eq): active (one of: true = in flight — status open, submitted, rejected, change_requested or level_1_approved; false = finalised or not in flight — status approved, cancelled, closed, draft or on_hold), client_suggested, close_project, final_claim (one of: true = supplier declared this the final claim; the milestone is settled at the claimed amount (which may be less than the original) with no remainder; false = interim claim; the unclaimed remainder was split off into a new milestone), mandatory, overdue (one of: true = active milestone (open, submitted, rejected, change_requested or level_1_approved) whose due date has passed; false = not overdue — either not active, or due on/after today)
Note: money values are in minor currency units (e.g. pence for GBP). Use 1000000 for £10,000.00.
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: active, approved_at, approved_by_id, client_suggested, close_project, comments, created_at, delivered_on, details, due_on, final_claim, id, interim_valuation_date, level_1_approved_at, level_1_approved_by_id, mandatory, notes, original_id, original_rate, overdue, project_id, purchase_order_line_id, rate, rate_ccy, rejected_at, rejected_by_id, status, submitted_at, tiered_markup_fee, title, updated_at
Examples:
- Ascending:
sort[created_at]=orsort[created_at]=asc - Descending:
sort[created_at]=desc
Response
List of milestones
Show child attributes
Show child attributes