Skip to main content
GET
/
purchase_orders
Retrieve all purchase orders, filter by query
curl --request GET \
  --url https://api.zivio.net/api/v3/purchase_orders \
  --header 'X-API-Key: <api-key>' \
  --header 'zivio-tenant-id: <api-key>'
{
  "purchase_orders": [
    {
      "id": "23",
      "external_provider": "External Service",
      "external_id": "EX67868",
      "po_number": "EX67868",
      "version": 123,
      "status": "<string>",
      "owners": {
        "job": "2",
        "supplier": "2"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.zivio.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required
​
zivio-tenant-id
string
header
required

Query Parameters

​
status
string

Filter by a status, one of pending, issued, cancelled, disconnected, issued_pending_revision

​
created
string

Date range [YYYY-MM-DD+TO+YYYY-MM-DD] to search based on created timestamp for object.

​
updated
string

Date range [YYYY-MM-DD+TO+YYYY-MM-DD] to search based on updated timestamp for object.

​
sort
string

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

​
page
integer

Paginate results when number of results exceeds limit

​
limit
integer

Number of results returned per request

Response

ok

​
purchase_orders
object[]