List Bids
curl --request GET \
--url https://api.zivio.net/api/v4/bids \
--header 'Authorization: Bearer <token>' \
--header 'zivio-tenant-id: <api-key>'import requests
url = "https://api.zivio.net/api/v4/bids"
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/bids', 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/bids",
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/bids"
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/bids")
.header("Authorization", "Bearer <token>")
.header("zivio-tenant-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zivio.net/api/v4/bids")
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{
"bids": [
{
"id": 101,
"rate": {
"cents": 150000,
"currency": "GBP"
},
"fee": "1500.00",
"proposal": "Example proposal",
"supplier": {
"id": 101,
"name": "Acme Corporation",
"email": "user1@example.com",
"vetting_status": "PASSED",
"tax_number": "Example tax_number",
"tax_registered": true
},
"user": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"version": 101,
"status": "submitted",
"managed_bid": true,
"bafo": true,
"submitted_at": "2024-01-16T10:30:00+00:00",
"read_at": "2024-01-16T10:30:00+00:00",
"shortlisted_at": "2024-01-16T10:30:00+00:00",
"selected_at": "2024-01-16T10:30:00+00:00",
"hours": 101,
"eliminated": true,
"hired": true,
"total_score": "1500.00",
"quality_score": "1500.00",
"cost_score_auto": "1500.00",
"cost_score_override": "1500.00",
"source": "Example source",
"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": 101,
"title": "Website Redesign Project",
"description": "Complete redesign of corporate website with modern UX"
},
"bid_milestones": [
{
"id": 101,
"bid_id": 501,
"title": "Website Redesign Project",
"details": "Additional information and context for this record.",
"rate": {
"cents": 150000,
"currency": "GBP"
},
"due_on": "2024-01-16",
"mandatory": false,
"client_suggested": false,
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00"
},
{
"id": 102,
"bid_id": 502,
"title": "Mobile App Development",
"details": "Additional information and context for this record.",
"rate": {
"cents": 300000,
"currency": "GBP"
},
"due_on": "2024-01-17",
"mandatory": false,
"client_suggested": false,
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
}
],
"line_item_proposals": [
{
"id": 101,
"item_type": "service",
"name": "Acme Corporation",
"manufacturer_name": "Example manufacturer_name",
"manufacturer_part_number": "Example manufacturer_part_number",
"quantity": "1500.00",
"price": {
"cents": 150000,
"currency": "GBP"
},
"uom": {
"id": 101,
"name": "Acme Corporation",
"code": "Example code",
"active": true
},
"net_total_price": null,
"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_line_item": {
"id": 101,
"name": "Acme Corporation",
"manufacturer_name": "Example manufacturer_name",
"manufacturer_part_number": "Example manufacturer_part_number",
"uom": null,
"item": null,
"item_type": "service",
"price": {
"cents": 150000,
"currency": "GBP"
},
"quantity": "1500.00",
"net_total_price": null,
"quantity_delivered": null,
"quantity_undelivered": null,
"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
}
},
{
"id": 102,
"item_type": "item",
"name": "Global Services Ltd",
"manufacturer_name": "Example manufacturer_name",
"manufacturer_part_number": "Example manufacturer_part_number",
"quantity": "1500.00",
"price": {
"cents": 300000,
"currency": "GBP"
},
"uom": {
"id": 102,
"name": "Global Services Ltd",
"code": "Example code",
"active": true
},
"net_total_price": null,
"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_line_item": {
"id": 102,
"name": "Global Services Ltd",
"manufacturer_name": "Example manufacturer_name",
"manufacturer_part_number": "Example manufacturer_part_number",
"uom": null,
"item": null,
"item_type": "item",
"price": {
"cents": 300000,
"currency": "GBP"
},
"quantity": "1500.00",
"net_total_price": null,
"quantity_delivered": null,
"quantity_undelivered": null,
"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
}
}
]
},
{
"id": 102,
"rate": {
"cents": 300000,
"currency": "GBP"
},
"fee": "1500.00",
"proposal": "Example proposal",
"supplier": {
"id": 102,
"name": "Global Services Ltd",
"email": "user2@example.com",
"vetting_status": "FAILED",
"tax_number": "Example tax_number",
"tax_registered": true
},
"user": {
"id": 102,
"first_name": "Jane",
"last_name": "Smith",
"email": "user2@example.com",
"org_id": 502,
"org_name": "Global Services Ltd"
},
"version": 102,
"status": "superseded",
"managed_bid": true,
"bafo": true,
"submitted_at": "2024-01-17T10:30:00+00:00",
"read_at": "2024-01-17T10:30:00+00:00",
"shortlisted_at": "2024-01-17T10:30:00+00:00",
"selected_at": "2024-01-17T10:30:00+00:00",
"hours": 102,
"eliminated": true,
"hired": true,
"total_score": "1500.00",
"quality_score": "1500.00",
"cost_score_auto": "1500.00",
"cost_score_override": "1500.00",
"source": "Example source",
"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": 102,
"title": "Mobile App Development",
"description": "Native iOS and Android application"
},
"bid_milestones": [
{
"id": 102,
"bid_id": 502,
"title": "Mobile App Development",
"details": "Additional information and context for this record.",
"rate": {
"cents": 300000,
"currency": "GBP"
},
"due_on": "2024-01-17",
"mandatory": false,
"client_suggested": false,
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
},
{
"id": 103,
"bid_id": 503,
"title": "Mobile App Development",
"details": "Additional information and context for this record.",
"rate": {
"cents": 450000,
"currency": "GBP"
},
"due_on": "2024-01-18",
"mandatory": false,
"client_suggested": false,
"created_at": "2024-01-18T10:30:00+00:00",
"updated_at": "2024-01-18T10:30:00+00:00"
}
],
"line_item_proposals": [
{
"id": 102,
"item_type": "item",
"name": "Global Services Ltd",
"manufacturer_name": "Example manufacturer_name",
"manufacturer_part_number": "Example manufacturer_part_number",
"quantity": "1500.00",
"price": {
"cents": 300000,
"currency": "GBP"
},
"uom": {
"id": 102,
"name": "Global Services Ltd",
"code": "Example code",
"active": true
},
"net_total_price": null,
"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_line_item": {
"id": 102,
"name": "Global Services Ltd",
"manufacturer_name": "Example manufacturer_name",
"manufacturer_part_number": "Example manufacturer_part_number",
"uom": null,
"item": null,
"item_type": "item",
"price": {
"cents": 300000,
"currency": "GBP"
},
"quantity": "1500.00",
"net_total_price": null,
"quantity_delivered": null,
"quantity_undelivered": null,
"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
}
},
{
"id": 103,
"item_type": "service",
"name": "Global Services Ltd",
"manufacturer_name": "Example manufacturer_name",
"manufacturer_part_number": "Example manufacturer_part_number",
"quantity": "1500.00",
"price": {
"cents": 450000,
"currency": "GBP"
},
"uom": {
"id": 103,
"name": "Global Services Ltd",
"code": "Example code",
"active": true
},
"net_total_price": null,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-18T10:30:00+00:00",
"updated_at": "2024-01-18T10:30:00+00:00",
"project_line_item": {
"id": 103,
"name": "Global Services Ltd",
"manufacturer_name": "Example manufacturer_name",
"manufacturer_part_number": "Example manufacturer_part_number",
"uom": null,
"item": null,
"item_type": "service",
"price": {
"cents": 450000,
"currency": "GBP"
},
"quantity": "1500.00",
"net_total_price": null,
"quantity_delivered": null,
"quantity_undelivered": null,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-18T10:30:00+00:00",
"updated_at": "2024-01-18T10:30:00+00:00",
"project_id": 503
}
}
]
}
]
}Bids
List Bids
Retrieve a paginated list of bids. 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/bids?filter[status]=draft
# Multiple values (implicit IN)
GET /api/v4/bids?filter[status]=draft,superseded
# With explicit operator
GET /api/v4/bids?filter[created_at][gte]=2024-01-01
# Range query
GET /api/v4/bids?filter[rate][between]=1000000,5000000
# Multiple filters (AND)
GET /api/v4/bids?filter[status]=draft&filter[rate][gte]=1000000
Available Attributes
| Attribute | Type | Operators | Permitted Values |
|---|---|---|---|
| bafo | boolean | eq, not_eq | - |
| cost_score_auto | decimal | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| cost_score_override | decimal | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| created_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| eliminated | boolean | eq, not_eq | - |
| fee | decimal | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| hired | boolean | eq, not_eq | - |
| hours | 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 | - |
| managed_bid | boolean | eq, not_eq | - |
| project_id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| proposal | string | eq, not_eq, in, not_in, like, not_like | - |
| quality_score | decimal | 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 | - |
| read_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| selected | boolean | eq | true, false |
| selected_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| shortlisted | boolean | eq | true, false |
| shortlisted_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| source | string | eq, not_eq, in, not_in, like, not_like | - |
| status | string | eq, not_eq, in, not_in | draft, submitted, superseded, withdrawn |
| submitted_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| supplier_id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| total_score | decimal | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| updated_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| user_id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| version | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
Custom Fields
This resource supports custom field filtering using cf[key] syntax:
# Equality
GET /api/v4/bids?cf[priority]=high
# With operator
GET /api/v4/bids?cf[department][in]=engineering,design
# Check existence
GET /api/v4/bids?cf[priority][exists]=
# Negation
GET /api/v4/bids?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/bids?or[1][status]=submitted&or[2][status]=draft
# Complex OR (status=submitted AND rate>=1000000) OR (status=draft)
GET /api/v4/bids?or[1][status]=submitted&or[1][rate][gte]=1000000&or[2][status]=draft
Sorting
Use sort[<attribute>] to order results. Default direction is ascending.
# Ascending (implicit)
GET /api/v4/bids?sort[created_at]=
# Descending
GET /api/v4/bids?sort[created_at]=desc
# Combined with filters
GET /api/v4/bids?filter[status]=draft&sort[created_at]=desc
GET
/
bids
List Bids
curl --request GET \
--url https://api.zivio.net/api/v4/bids \
--header 'Authorization: Bearer <token>' \
--header 'zivio-tenant-id: <api-key>'import requests
url = "https://api.zivio.net/api/v4/bids"
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/bids', 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/bids",
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/bids"
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/bids")
.header("Authorization", "Bearer <token>")
.header("zivio-tenant-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zivio.net/api/v4/bids")
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{
"bids": [
{
"id": 101,
"rate": {
"cents": 150000,
"currency": "GBP"
},
"fee": "1500.00",
"proposal": "Example proposal",
"supplier": {
"id": 101,
"name": "Acme Corporation",
"email": "user1@example.com",
"vetting_status": "PASSED",
"tax_number": "Example tax_number",
"tax_registered": true
},
"user": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"version": 101,
"status": "submitted",
"managed_bid": true,
"bafo": true,
"submitted_at": "2024-01-16T10:30:00+00:00",
"read_at": "2024-01-16T10:30:00+00:00",
"shortlisted_at": "2024-01-16T10:30:00+00:00",
"selected_at": "2024-01-16T10:30:00+00:00",
"hours": 101,
"eliminated": true,
"hired": true,
"total_score": "1500.00",
"quality_score": "1500.00",
"cost_score_auto": "1500.00",
"cost_score_override": "1500.00",
"source": "Example source",
"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": 101,
"title": "Website Redesign Project",
"description": "Complete redesign of corporate website with modern UX"
},
"bid_milestones": [
{
"id": 101,
"bid_id": 501,
"title": "Website Redesign Project",
"details": "Additional information and context for this record.",
"rate": {
"cents": 150000,
"currency": "GBP"
},
"due_on": "2024-01-16",
"mandatory": false,
"client_suggested": false,
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00"
},
{
"id": 102,
"bid_id": 502,
"title": "Mobile App Development",
"details": "Additional information and context for this record.",
"rate": {
"cents": 300000,
"currency": "GBP"
},
"due_on": "2024-01-17",
"mandatory": false,
"client_suggested": false,
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
}
],
"line_item_proposals": [
{
"id": 101,
"item_type": "service",
"name": "Acme Corporation",
"manufacturer_name": "Example manufacturer_name",
"manufacturer_part_number": "Example manufacturer_part_number",
"quantity": "1500.00",
"price": {
"cents": 150000,
"currency": "GBP"
},
"uom": {
"id": 101,
"name": "Acme Corporation",
"code": "Example code",
"active": true
},
"net_total_price": null,
"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_line_item": {
"id": 101,
"name": "Acme Corporation",
"manufacturer_name": "Example manufacturer_name",
"manufacturer_part_number": "Example manufacturer_part_number",
"uom": null,
"item": null,
"item_type": "service",
"price": {
"cents": 150000,
"currency": "GBP"
},
"quantity": "1500.00",
"net_total_price": null,
"quantity_delivered": null,
"quantity_undelivered": null,
"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
}
},
{
"id": 102,
"item_type": "item",
"name": "Global Services Ltd",
"manufacturer_name": "Example manufacturer_name",
"manufacturer_part_number": "Example manufacturer_part_number",
"quantity": "1500.00",
"price": {
"cents": 300000,
"currency": "GBP"
},
"uom": {
"id": 102,
"name": "Global Services Ltd",
"code": "Example code",
"active": true
},
"net_total_price": null,
"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_line_item": {
"id": 102,
"name": "Global Services Ltd",
"manufacturer_name": "Example manufacturer_name",
"manufacturer_part_number": "Example manufacturer_part_number",
"uom": null,
"item": null,
"item_type": "item",
"price": {
"cents": 300000,
"currency": "GBP"
},
"quantity": "1500.00",
"net_total_price": null,
"quantity_delivered": null,
"quantity_undelivered": null,
"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
}
}
]
},
{
"id": 102,
"rate": {
"cents": 300000,
"currency": "GBP"
},
"fee": "1500.00",
"proposal": "Example proposal",
"supplier": {
"id": 102,
"name": "Global Services Ltd",
"email": "user2@example.com",
"vetting_status": "FAILED",
"tax_number": "Example tax_number",
"tax_registered": true
},
"user": {
"id": 102,
"first_name": "Jane",
"last_name": "Smith",
"email": "user2@example.com",
"org_id": 502,
"org_name": "Global Services Ltd"
},
"version": 102,
"status": "superseded",
"managed_bid": true,
"bafo": true,
"submitted_at": "2024-01-17T10:30:00+00:00",
"read_at": "2024-01-17T10:30:00+00:00",
"shortlisted_at": "2024-01-17T10:30:00+00:00",
"selected_at": "2024-01-17T10:30:00+00:00",
"hours": 102,
"eliminated": true,
"hired": true,
"total_score": "1500.00",
"quality_score": "1500.00",
"cost_score_auto": "1500.00",
"cost_score_override": "1500.00",
"source": "Example source",
"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": 102,
"title": "Mobile App Development",
"description": "Native iOS and Android application"
},
"bid_milestones": [
{
"id": 102,
"bid_id": 502,
"title": "Mobile App Development",
"details": "Additional information and context for this record.",
"rate": {
"cents": 300000,
"currency": "GBP"
},
"due_on": "2024-01-17",
"mandatory": false,
"client_suggested": false,
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
},
{
"id": 103,
"bid_id": 503,
"title": "Mobile App Development",
"details": "Additional information and context for this record.",
"rate": {
"cents": 450000,
"currency": "GBP"
},
"due_on": "2024-01-18",
"mandatory": false,
"client_suggested": false,
"created_at": "2024-01-18T10:30:00+00:00",
"updated_at": "2024-01-18T10:30:00+00:00"
}
],
"line_item_proposals": [
{
"id": 102,
"item_type": "item",
"name": "Global Services Ltd",
"manufacturer_name": "Example manufacturer_name",
"manufacturer_part_number": "Example manufacturer_part_number",
"quantity": "1500.00",
"price": {
"cents": 300000,
"currency": "GBP"
},
"uom": {
"id": 102,
"name": "Global Services Ltd",
"code": "Example code",
"active": true
},
"net_total_price": null,
"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_line_item": {
"id": 102,
"name": "Global Services Ltd",
"manufacturer_name": "Example manufacturer_name",
"manufacturer_part_number": "Example manufacturer_part_number",
"uom": null,
"item": null,
"item_type": "item",
"price": {
"cents": 300000,
"currency": "GBP"
},
"quantity": "1500.00",
"net_total_price": null,
"quantity_delivered": null,
"quantity_undelivered": null,
"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
}
},
{
"id": 103,
"item_type": "service",
"name": "Global Services Ltd",
"manufacturer_name": "Example manufacturer_name",
"manufacturer_part_number": "Example manufacturer_part_number",
"quantity": "1500.00",
"price": {
"cents": 450000,
"currency": "GBP"
},
"uom": {
"id": 103,
"name": "Global Services Ltd",
"code": "Example code",
"active": true
},
"net_total_price": null,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-18T10:30:00+00:00",
"updated_at": "2024-01-18T10:30:00+00:00",
"project_line_item": {
"id": 103,
"name": "Global Services Ltd",
"manufacturer_name": "Example manufacturer_name",
"manufacturer_part_number": "Example manufacturer_part_number",
"uom": null,
"item": null,
"item_type": "service",
"price": {
"cents": 450000,
"currency": "GBP"
},
"quantity": "1500.00",
"net_total_price": null,
"quantity_delivered": null,
"quantity_undelivered": null,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-18T10:30:00+00:00",
"updated_at": "2024-01-18T10:30:00+00:00",
"project_id": 503
}
}
]
}
]
}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): hours, id, project_id, supplier_id, user_id, version datetime (operators: eq, not_eq, gt, gte, lt, lte, between): created_at, read_at, selected_at, shortlisted_at, submitted_at, updated_at money (operators: eq, not_eq, in, not_in, gt, gte, lt, lte, between): rate string (operators: eq, not_eq, in, not_in, like, not_like): proposal, rate_ccy, source, status (one of: draft = saved by supplier, not yet submitted to client; submitted = submitted to client, pending a decision; superseded = replaced by a newer version of this bid; withdrawn = withdrawn by the supplier) decimal (operators: eq, not_eq, in, not_in, gt, gte, lt, lte, between): cost_score_auto, cost_score_override, fee, quality_score, total_score boolean (operators: eq, not_eq): bafo, eliminated, hired, managed_bid, selected (one of: true = selected as a preferred supplier by the client (selected_at is set); false = not selected as a preferred supplier), shortlisted (one of: true = on the project shortlist (shortlisted_at is set); false = not shortlisted)
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: bafo, cost_score_auto, cost_score_override, created_at, eliminated, fee, hired, hours, id, managed_bid, project_id, proposal, quality_score, rate, rate_ccy, read_at, selected, selected_at, shortlisted, shortlisted_at, source, status, submitted_at, supplier_id, total_score, updated_at, user_id, version
Examples:
- Ascending:
sort[created_at]=orsort[created_at]=asc - Descending:
sort[created_at]=desc
Response
List of bids
Show child attributes
Show child attributes