Endpoints
- Welcome
- Bank Accounts
- Bids
- EOIs
- EOI Responses
- Invoices
- Job Approvals
- Jobs
- Milestones
- Offers
- Orgs
- Purchase Orders
- Sales Invoices
- Sales Milestones
- Skill Categories
- Skill Taxonomies
- Skills
- Suppliers
- Supplier Lists
- Users
- Variation Orders
Retrieve all projects, filter by query
curl --request GET \
--url https://api.zivio.net/api/v3/jobs \
--header 'X-API-Key: <api-key>' \
--header 'zivio-tenant-id: <api-key>'
{
"jobs": [
{
"id": "2606",
"title": "My Project",
"description": "My Description",
"status": "new",
"supplier_defined_milestones": "true",
"start_date": "2023-12-25",
"due_on": "2023-12-25",
"submission_deadline": "2023-11-07T05:31:56Z",
"bafo_submission_deadline": "2023-11-07T05:31:56Z",
"budget": "500000.00",
"fee": "15.00",
"markup": "4.75",
"ccy": "GBP",
"original_budget": "500000.00",
"rate": "500000.00",
"original_rate": "500000.00",
"award_type": "competition",
"visibility": "public",
"external_id": "ABC-101202",
"is_child": "false",
"is_parent": "false",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"location": {
"type": "location",
"code": "aa-1234",
"name": "London Offices",
"address": {
"line1": "123 Main Street",
"line2": "Suite 200",
"city": "London",
"region": "London",
"postcode": "W1 1AA",
"country_code": "GB"
}
},
"custom_fields": {
"key": "value"
},
"milestones": [
{
"id": "66",
"client_suggested": "true",
"title": "Title of Milestone",
"details": "Details of Milestone",
"rate": "1500.00",
"ccy": "GBP",
"due_on": "2023-11-07T05:31:56Z",
"notes": "some notes relating to the milestone",
"comments": "some comments relating to the milestone",
"job_id": "2669",
"job_summary": "summary of miestone",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"status": "open",
"approved_at": "2023-11-07T05:31:56Z",
"approved_by": {
"id": "7158",
"first_name": "Jack",
"last_name": "Jones",
"email": "jack_jones@example.com",
"business_unit": "Public Private Partnerships",
"division": "Infastructure",
"department": "Housing",
"org_name": "Organisation Ltd",
"org_id": "567",
"vetting_status": "PASSED",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"custom_fields": {
"key": "value"
},
"has_oversight": "true"
},
"children": [
"124"
],
"parents": [
"14"
],
"custom_fields": {
"key": "value"
}
}
],
"job_line_items": [
{
"id": "66",
"job_id": "6",
"item_type": "item",
"name": "Server",
"manufacturer_name": "Dell",
"manufacturer_part_number": "X15",
"quantity": "10.0",
"quantity_delivered": "0.0",
"quantity_undelivered": "10.0",
"price": "500.00",
"price_ccy": "GBP",
"uom": "<string>",
"net_total_price": "5000.00",
"net_total_price_ccy": "GBP",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"custom_fields": {
"key": "value"
}
}
],
"administrator": {
"id": "7158",
"first_name": "Jack",
"last_name": "Jones",
"email": "jack_jones@example.com",
"org_name": "Organisation Ltd",
"org_id": "567",
"business_unit": "Public Private Partnerships",
"division": "Infastructure",
"department": "Infastructure",
"vetting_status": "PASSED",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"custom_fields": {
"key": "value"
},
"has_oversight": "true"
},
"client": {
"id": "7158",
"first_name": "Jack",
"last_name": "Jones",
"email": "jack_jones@example.com",
"org_name": "Organisation Ltd",
"org_id": "567",
"business_unit": "Public Private Partnerships",
"division": "Infastructure",
"department": "Infastructure",
"vetting_status": "PASSED",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"custom_fields": {
"key": "value"
},
"has_oversight": "true"
},
"client_org": {
"id": "7158",
"name": "Company Ltd",
"is_external_client": "true",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"supplier": {
"id": "77",
"name": "Company Inc",
"email": "jack_jones@companyinc.com",
"vetting_status": "PASSED",
"tax_number": "9876543234",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"cost_centers": [
{
"cost_center_id": "303",
"job_id": "2606",
"allocation_percentage": "100.0",
"name": "Cost Centre Name",
"code": "Cost Centre Code",
"admin_custom_fields": {
"key": "Field Name",
"value": "Field Value"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"job_screening_questions": [
{
"id": "66",
"key": "Screening Question",
"control_type": "string",
"values": "less than 10 employees, less than 50 employees, more than 50 employees",
"value_conversion_type": "to_s",
"mandatory": "true",
"hint": "please select number of team members.",
"order": "0"
}
]
}
]
}
Query Parameters
Filter by a status, [draft, pending, new, halted, in_progress, work_completed, cancelled, closed]
Date range [YYYY-MM-DD+TO+YYYY-MM-DD] to search based on created timestamp for object.
Date range [YYYY-MM-DD+TO+YYYY-MM-DD] to search based on updated timestamp for object.
Date range [YYYY-MM-DD+TO+YYYY-MM-DD] to search based on updated timestamp for object.
use supplier's ID to filter response
use client's Org ID to filter response
Results are sorted by created desc as default. Ordering may be specified, available options are ['created', 'updated'], which can be combined in a comma separated list, e.g. updated:desc,created:asc
Paginate results when number of results exceeds limit
Number of results returned per request
Response
ok
The response is of type object
.
curl --request GET \
--url https://api.zivio.net/api/v3/jobs \
--header 'X-API-Key: <api-key>' \
--header 'zivio-tenant-id: <api-key>'
{
"jobs": [
{
"id": "2606",
"title": "My Project",
"description": "My Description",
"status": "new",
"supplier_defined_milestones": "true",
"start_date": "2023-12-25",
"due_on": "2023-12-25",
"submission_deadline": "2023-11-07T05:31:56Z",
"bafo_submission_deadline": "2023-11-07T05:31:56Z",
"budget": "500000.00",
"fee": "15.00",
"markup": "4.75",
"ccy": "GBP",
"original_budget": "500000.00",
"rate": "500000.00",
"original_rate": "500000.00",
"award_type": "competition",
"visibility": "public",
"external_id": "ABC-101202",
"is_child": "false",
"is_parent": "false",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"location": {
"type": "location",
"code": "aa-1234",
"name": "London Offices",
"address": {
"line1": "123 Main Street",
"line2": "Suite 200",
"city": "London",
"region": "London",
"postcode": "W1 1AA",
"country_code": "GB"
}
},
"custom_fields": {
"key": "value"
},
"milestones": [
{
"id": "66",
"client_suggested": "true",
"title": "Title of Milestone",
"details": "Details of Milestone",
"rate": "1500.00",
"ccy": "GBP",
"due_on": "2023-11-07T05:31:56Z",
"notes": "some notes relating to the milestone",
"comments": "some comments relating to the milestone",
"job_id": "2669",
"job_summary": "summary of miestone",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"status": "open",
"approved_at": "2023-11-07T05:31:56Z",
"approved_by": {
"id": "7158",
"first_name": "Jack",
"last_name": "Jones",
"email": "jack_jones@example.com",
"business_unit": "Public Private Partnerships",
"division": "Infastructure",
"department": "Housing",
"org_name": "Organisation Ltd",
"org_id": "567",
"vetting_status": "PASSED",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"custom_fields": {
"key": "value"
},
"has_oversight": "true"
},
"children": [
"124"
],
"parents": [
"14"
],
"custom_fields": {
"key": "value"
}
}
],
"job_line_items": [
{
"id": "66",
"job_id": "6",
"item_type": "item",
"name": "Server",
"manufacturer_name": "Dell",
"manufacturer_part_number": "X15",
"quantity": "10.0",
"quantity_delivered": "0.0",
"quantity_undelivered": "10.0",
"price": "500.00",
"price_ccy": "GBP",
"uom": "<string>",
"net_total_price": "5000.00",
"net_total_price_ccy": "GBP",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"custom_fields": {
"key": "value"
}
}
],
"administrator": {
"id": "7158",
"first_name": "Jack",
"last_name": "Jones",
"email": "jack_jones@example.com",
"org_name": "Organisation Ltd",
"org_id": "567",
"business_unit": "Public Private Partnerships",
"division": "Infastructure",
"department": "Infastructure",
"vetting_status": "PASSED",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"custom_fields": {
"key": "value"
},
"has_oversight": "true"
},
"client": {
"id": "7158",
"first_name": "Jack",
"last_name": "Jones",
"email": "jack_jones@example.com",
"org_name": "Organisation Ltd",
"org_id": "567",
"business_unit": "Public Private Partnerships",
"division": "Infastructure",
"department": "Infastructure",
"vetting_status": "PASSED",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"custom_fields": {
"key": "value"
},
"has_oversight": "true"
},
"client_org": {
"id": "7158",
"name": "Company Ltd",
"is_external_client": "true",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"supplier": {
"id": "77",
"name": "Company Inc",
"email": "jack_jones@companyinc.com",
"vetting_status": "PASSED",
"tax_number": "9876543234",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"cost_centers": [
{
"cost_center_id": "303",
"job_id": "2606",
"allocation_percentage": "100.0",
"name": "Cost Centre Name",
"code": "Cost Centre Code",
"admin_custom_fields": {
"key": "Field Name",
"value": "Field Value"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"job_screening_questions": [
{
"id": "66",
"key": "Screening Question",
"control_type": "string",
"values": "less than 10 employees, less than 50 employees, more than 50 employees",
"value_conversion_type": "to_s",
"mandatory": "true",
"hint": "please select number of team members.",
"order": "0"
}
]
}
]
}