Skip to main content

​
The Zivio API

The Zivio API gives you programmatic access to your projects, suppliers, bids, invoices and approvals — everything you manage in the Zivio platform. It authenticates with OAuth 2.0, grants access through fine-grained scopes, and comes with an MCP server so AI assistants can query your Zivio data directly.

Quickstart

Get a token and make your first request.

Authentication

The client credentials flow in detail.

Scopes

Every scope and what it unlocks.

MCP server

Connect Claude or ChatGPT to Zivio.

​
Base URLs

Use the global endpoint unless you have been allocated a specific data region. These endpoints serve every Zivio organisation, so every request must identify yours with the zivio-tenant-id header — including the token request. See Identifying your organisation.

​
Conventions

  • Money is in minor currency units. 1000000 is £10,000.00. This applies to request bodies, responses and filter values alike.
  • List endpoints are paginated with page and limit (default 20, maximum 100).
  • Every resource exposes a /help endpoint — for example GET /projects/help — which returns the filterable attributes, valid operators and enum values for that resource. It is the fastest way to discover what you can query without leaving your terminal.
  • Errors share one envelope across every non-2xx response. See Errors.
  • zivio-tenant-id is required on every request to the endpoints above, and is checked before authentication.

​
Where to go next

1

Get running

The Quickstart takes you from credentials to your first response.
2

Choose your access

Scopes lists everything you can request, so you can ask for the narrowest set your integration needs.
3

Query what you need

Filtering and pagination covers the query syntax the list endpoints share.
Already built against an older version of the Zivio API? See Migrating from v3.