Get filterable attributes for Projects
curl --request GET \
--url https://api.zivio.net/api/v4/projects/help \
--header 'Authorization: Bearer <token>' \
--header 'zivio-tenant-id: <api-key>'import requests
url = "https://api.zivio.net/api/v4/projects/help"
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/projects/help', 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/projects/help",
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/projects/help"
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/projects/help")
.header("Authorization", "Bearer <token>")
.header("zivio-tenant-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zivio.net/api/v4/projects/help")
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{
"model": "Project",
"endpoint": "api/v4/projects",
"attributes": {
"id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[id]=123"
},
"created_at": {
"type": "datetime",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[created_at][gte]=2024-01-01T00:00:00Z"
},
"updated_at": {
"type": "datetime",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[updated_at][gte]=2024-01-01T00:00:00Z"
},
"description": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[description][like]=search_term"
},
"rate": {
"type": "money",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[rate][lt]=10000000"
},
"client_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[client_id]=123"
},
"title": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[title][like]=search_term"
},
"fee": {
"type": "decimal",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[fee][gte]=0.045"
},
"duration": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[duration][like]=search_term"
},
"bids_count": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[bids_count]=123"
},
"state": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in"
],
"example": "filter[state]=in_progress"
},
"hired_at": {
"type": "datetime",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[hired_at][gte]=2024-01-01T00:00:00Z"
},
"type": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[type][like]=search_term"
},
"start_date": {
"type": "date",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[start_date]=2024-12-31"
},
"visibility": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[visibility][like]=search_term"
},
"talent_pool_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[talent_pool_id]=123"
},
"approved": {
"type": "boolean",
"operators": [
"eq",
"not_eq"
],
"example": "filter[approved]=true"
},
"posting_type": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[posting_type][like]=search_term"
},
"skill_category_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[skill_category_id]=123"
},
"skill_subcategory_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[skill_subcategory_id]=123"
},
"skill_category_tier3_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[skill_category_tier3_id]=123"
},
"budget": {
"type": "money",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[budget][lt]=10000000"
},
"cancellation_reason_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[cancellation_reason_id]=123"
},
"cancellation_other_reason": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[cancellation_other_reason][like]=search_term"
},
"cancelled_by_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[cancelled_by_id]=123"
},
"cancelled_at": {
"type": "datetime",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[cancelled_at][gte]=2024-01-01T00:00:00Z"
},
"due_on": {
"type": "datetime",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[due_on][gte]=2024-01-01T00:00:00Z"
},
"location_type": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[location_type][like]=search_term"
},
"custom_location": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[custom_location][like]=search_term"
},
"markup": {
"type": "decimal",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[markup][gte]=0.045"
},
"ended_at": {
"type": "datetime",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[ended_at][gte]=2024-01-01T00:00:00Z"
},
"reject_reason": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[reject_reason][like]=search_term"
},
"quality_score_allocation_percentage": {
"type": "decimal",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[quality_score_allocation_percentage][gte]=0.045"
},
"cost_score_allocation_percentage": {
"type": "decimal",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[cost_score_allocation_percentage][gte]=0.045"
},
"submission_deadline": {
"type": "datetime",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[submission_deadline][gte]=2024-01-01T00:00:00Z"
},
"submission_deadline_time_zone": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[submission_deadline_time_zone][like]=search_term"
},
"target_cost": {
"type": "money",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[target_cost][lt]=10000000"
},
"award_type": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in"
],
"example": "filter[award_type]=direct_award"
},
"additional_notes": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[additional_notes][like]=search_term"
},
"client_org_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[client_org_id]=123"
},
"current_approval_level": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[current_approval_level]=123"
},
"fee_methodology": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in"
],
"example": "filter[fee_methodology]=markup"
},
"original_rate": {
"type": "money",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[original_rate][lt]=10000000"
},
"original_budget": {
"type": "money",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[original_budget][lt]=10000000"
},
"submitted_at": {
"type": "datetime",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[submitted_at][gte]=2024-01-01T00:00:00Z"
},
"supplier_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[supplier_id]=123"
},
"is_template": {
"type": "boolean",
"operators": [
"eq",
"not_eq"
],
"example": "filter[is_template]=true"
},
"payment_terms_in_days": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[payment_terms_in_days]=123"
},
"administrator_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[administrator_id]=123"
},
"approved_at": {
"type": "datetime",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[approved_at][gte]=2024-01-01T00:00:00Z"
},
"auto_close_at": {
"type": "datetime",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[auto_close_at][gte]=2024-01-01T00:00:00Z"
},
"is_parent": {
"type": "boolean",
"operators": [
"eq",
"not_eq"
],
"example": "filter[is_parent]=true"
},
"is_child": {
"type": "boolean",
"operators": [
"eq",
"not_eq"
],
"example": "filter[is_child]=true"
},
"completed_by_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[completed_by_id]=123"
},
"time_zone": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[time_zone][like]=search_term"
},
"halted_comment": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[halted_comment][like]=search_term"
},
"bid_round": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[bid_round]=123"
},
"fee_schedule_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[fee_schedule_id]=123"
},
"client_payment_terms_in_days": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[client_payment_terms_in_days]=123"
},
"risk_level_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[risk_level_id]=123"
},
"closed_by_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[closed_by_id]=123"
},
"closed_at": {
"type": "datetime",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[closed_at][gte]=2024-01-01T00:00:00Z"
},
"client_billing_contact_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[client_billing_contact_id]=123"
},
"original_due_on": {
"type": "datetime",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[original_due_on][gte]=2024-01-01T00:00:00Z"
},
"estimated_savings": {
"type": "money",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[estimated_savings][lt]=10000000"
},
"projected_recognized_savings": {
"type": "money",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[projected_recognized_savings][lt]=10000000"
},
"bafo_submission_deadline": {
"type": "datetime",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[bafo_submission_deadline][gte]=2024-01-01T00:00:00Z"
},
"location_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[location_id]=123"
},
"award_suppliers": {
"type": "json",
"operators": [
"eq",
"not_eq"
],
"example": "filter[award_suppliers]=value"
},
"project_matches_count": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[project_matches_count]=123"
},
"original_project_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[original_project_id]=123"
}
},
"operators": {
"eq": {
"description": "Equal to (default when no operator specified)",
"usage": "filter[<attribute>]=value"
},
"not_eq": {
"description": "Not equal to",
"usage": "filter[<attribute>][not_eq]=value"
},
"gt": {
"description": "Greater than",
"usage": "filter[<attribute>][gt]=value"
},
"gte": {
"description": "Greater than or equal to",
"usage": "filter[<attribute>][gte]=value"
},
"lt": {
"description": "Less than",
"usage": "filter[<attribute>][lt]=value"
},
"lte": {
"description": "Less than or equal to",
"usage": "filter[<attribute>][lte]=value"
},
"between": {
"description": "Between two values (inclusive)",
"usage": "filter[<attribute>][between]=min,max"
},
"in": {
"description": "Matches any of the provided values (implicit when value contains comma)",
"usage": "filter[<attribute>]=val1,val2,val3"
},
"not_in": {
"description": "Does not match any of the provided values",
"usage": "filter[<attribute>][not_in]=val1,val2,val3"
},
"like": {
"description": "Contains text (case-insensitive)",
"usage": "filter[<attribute>][like]=text"
},
"not_like": {
"description": "Does not contain text",
"usage": "filter[<attribute>][not_like]=text"
}
},
"sorting": {
"description": "Sort results by an attribute",
"usage": "sort[<attribute>]=asc or sort[<attribute>]=desc",
"default": "asc"
}
}{
"error": "invalid_token",
"error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
}{
"error": "insufficient_scope",
"error_description": "The request requires higher privileges than provided by the access token",
"required_scope": "projects:read",
"provided_scopes": [
"welcome:read"
]
}Projects
Get filterable attributes for Projects
Returns metadata about available filter attributes, operators, and usage examples.
GET
/
projects
/
help
Get filterable attributes for Projects
curl --request GET \
--url https://api.zivio.net/api/v4/projects/help \
--header 'Authorization: Bearer <token>' \
--header 'zivio-tenant-id: <api-key>'import requests
url = "https://api.zivio.net/api/v4/projects/help"
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/projects/help', 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/projects/help",
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/projects/help"
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/projects/help")
.header("Authorization", "Bearer <token>")
.header("zivio-tenant-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zivio.net/api/v4/projects/help")
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{
"model": "Project",
"endpoint": "api/v4/projects",
"attributes": {
"id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[id]=123"
},
"created_at": {
"type": "datetime",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[created_at][gte]=2024-01-01T00:00:00Z"
},
"updated_at": {
"type": "datetime",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[updated_at][gte]=2024-01-01T00:00:00Z"
},
"description": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[description][like]=search_term"
},
"rate": {
"type": "money",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[rate][lt]=10000000"
},
"client_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[client_id]=123"
},
"title": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[title][like]=search_term"
},
"fee": {
"type": "decimal",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[fee][gte]=0.045"
},
"duration": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[duration][like]=search_term"
},
"bids_count": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[bids_count]=123"
},
"state": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in"
],
"example": "filter[state]=in_progress"
},
"hired_at": {
"type": "datetime",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[hired_at][gte]=2024-01-01T00:00:00Z"
},
"type": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[type][like]=search_term"
},
"start_date": {
"type": "date",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[start_date]=2024-12-31"
},
"visibility": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[visibility][like]=search_term"
},
"talent_pool_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[talent_pool_id]=123"
},
"approved": {
"type": "boolean",
"operators": [
"eq",
"not_eq"
],
"example": "filter[approved]=true"
},
"posting_type": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[posting_type][like]=search_term"
},
"skill_category_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[skill_category_id]=123"
},
"skill_subcategory_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[skill_subcategory_id]=123"
},
"skill_category_tier3_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[skill_category_tier3_id]=123"
},
"budget": {
"type": "money",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[budget][lt]=10000000"
},
"cancellation_reason_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[cancellation_reason_id]=123"
},
"cancellation_other_reason": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[cancellation_other_reason][like]=search_term"
},
"cancelled_by_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[cancelled_by_id]=123"
},
"cancelled_at": {
"type": "datetime",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[cancelled_at][gte]=2024-01-01T00:00:00Z"
},
"due_on": {
"type": "datetime",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[due_on][gte]=2024-01-01T00:00:00Z"
},
"location_type": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[location_type][like]=search_term"
},
"custom_location": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[custom_location][like]=search_term"
},
"markup": {
"type": "decimal",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[markup][gte]=0.045"
},
"ended_at": {
"type": "datetime",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[ended_at][gte]=2024-01-01T00:00:00Z"
},
"reject_reason": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[reject_reason][like]=search_term"
},
"quality_score_allocation_percentage": {
"type": "decimal",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[quality_score_allocation_percentage][gte]=0.045"
},
"cost_score_allocation_percentage": {
"type": "decimal",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[cost_score_allocation_percentage][gte]=0.045"
},
"submission_deadline": {
"type": "datetime",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[submission_deadline][gte]=2024-01-01T00:00:00Z"
},
"submission_deadline_time_zone": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[submission_deadline_time_zone][like]=search_term"
},
"target_cost": {
"type": "money",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[target_cost][lt]=10000000"
},
"award_type": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in"
],
"example": "filter[award_type]=direct_award"
},
"additional_notes": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[additional_notes][like]=search_term"
},
"client_org_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[client_org_id]=123"
},
"current_approval_level": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[current_approval_level]=123"
},
"fee_methodology": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in"
],
"example": "filter[fee_methodology]=markup"
},
"original_rate": {
"type": "money",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[original_rate][lt]=10000000"
},
"original_budget": {
"type": "money",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[original_budget][lt]=10000000"
},
"submitted_at": {
"type": "datetime",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[submitted_at][gte]=2024-01-01T00:00:00Z"
},
"supplier_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[supplier_id]=123"
},
"is_template": {
"type": "boolean",
"operators": [
"eq",
"not_eq"
],
"example": "filter[is_template]=true"
},
"payment_terms_in_days": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[payment_terms_in_days]=123"
},
"administrator_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[administrator_id]=123"
},
"approved_at": {
"type": "datetime",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[approved_at][gte]=2024-01-01T00:00:00Z"
},
"auto_close_at": {
"type": "datetime",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[auto_close_at][gte]=2024-01-01T00:00:00Z"
},
"is_parent": {
"type": "boolean",
"operators": [
"eq",
"not_eq"
],
"example": "filter[is_parent]=true"
},
"is_child": {
"type": "boolean",
"operators": [
"eq",
"not_eq"
],
"example": "filter[is_child]=true"
},
"completed_by_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[completed_by_id]=123"
},
"time_zone": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[time_zone][like]=search_term"
},
"halted_comment": {
"type": "string",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"like",
"not_like"
],
"example": "filter[halted_comment][like]=search_term"
},
"bid_round": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[bid_round]=123"
},
"fee_schedule_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[fee_schedule_id]=123"
},
"client_payment_terms_in_days": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[client_payment_terms_in_days]=123"
},
"risk_level_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[risk_level_id]=123"
},
"closed_by_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[closed_by_id]=123"
},
"closed_at": {
"type": "datetime",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[closed_at][gte]=2024-01-01T00:00:00Z"
},
"client_billing_contact_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[client_billing_contact_id]=123"
},
"original_due_on": {
"type": "datetime",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[original_due_on][gte]=2024-01-01T00:00:00Z"
},
"estimated_savings": {
"type": "money",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[estimated_savings][lt]=10000000"
},
"projected_recognized_savings": {
"type": "money",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[projected_recognized_savings][lt]=10000000"
},
"bafo_submission_deadline": {
"type": "datetime",
"operators": [
"eq",
"not_eq",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[bafo_submission_deadline][gte]=2024-01-01T00:00:00Z"
},
"location_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[location_id]=123"
},
"award_suppliers": {
"type": "json",
"operators": [
"eq",
"not_eq"
],
"example": "filter[award_suppliers]=value"
},
"project_matches_count": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[project_matches_count]=123"
},
"original_project_id": {
"type": "integer",
"operators": [
"eq",
"not_eq",
"in",
"not_in",
"gt",
"gte",
"lt",
"lte",
"between"
],
"example": "filter[original_project_id]=123"
}
},
"operators": {
"eq": {
"description": "Equal to (default when no operator specified)",
"usage": "filter[<attribute>]=value"
},
"not_eq": {
"description": "Not equal to",
"usage": "filter[<attribute>][not_eq]=value"
},
"gt": {
"description": "Greater than",
"usage": "filter[<attribute>][gt]=value"
},
"gte": {
"description": "Greater than or equal to",
"usage": "filter[<attribute>][gte]=value"
},
"lt": {
"description": "Less than",
"usage": "filter[<attribute>][lt]=value"
},
"lte": {
"description": "Less than or equal to",
"usage": "filter[<attribute>][lte]=value"
},
"between": {
"description": "Between two values (inclusive)",
"usage": "filter[<attribute>][between]=min,max"
},
"in": {
"description": "Matches any of the provided values (implicit when value contains comma)",
"usage": "filter[<attribute>]=val1,val2,val3"
},
"not_in": {
"description": "Does not match any of the provided values",
"usage": "filter[<attribute>][not_in]=val1,val2,val3"
},
"like": {
"description": "Contains text (case-insensitive)",
"usage": "filter[<attribute>][like]=text"
},
"not_like": {
"description": "Does not contain text",
"usage": "filter[<attribute>][not_like]=text"
}
},
"sorting": {
"description": "Sort results by an attribute",
"usage": "sort[<attribute>]=asc or sort[<attribute>]=desc",
"default": "asc"
}
}{
"error": "invalid_token",
"error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
}{
"error": "insufficient_scope",
"error_description": "The request requires higher privileges than provided by the access token",
"required_scope": "projects:read",
"provided_scopes": [
"welcome:read"
]
}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.

