Partner API v2 Overview
Welcome to the Partner API v2 documentation. This API allows you to integrate with Utopi's partner platform.
Getting Started
Before you begin, make sure you have:
- Valid API credentials
- Understanding of our authentication process
- Basic knowledge of REST APIs
Quick Links
API Reference
Browse the API reference documentation using the sidebar navigation to explore all available endpoints organised by functionality.
Base URL
The root address used for all API requests. Combine this with specific endpoints to access data or perform actions.
https://partner-api.utopi.io/v2/
Headers
All requests must include the following header(s):
| Header | In | Type | Required | Notes |
|---|---|---|---|---|
SiteId | header | string | yes | Utopi Site context (subset of Operator). |
Authorization | header | string | yes | Bearer access token from the auth flow. |
Error Handling
All API errors follow the RFC 7807 Problem Details specification, providing structured error information to help with debugging and integration.
HTTP Status Codes
| Code | Description | Notes |
|---|---|---|
| 200 | OK | Request succeeded |
| 400 | Bad Request | Invalid or missing parameters |
| 401 | Unauthorised | Missing or invalid credentials |
| 403 | Forbidden | No access to resource |
| 404 | Not Found | Resource does not exist |
| 429 | Too Many Requests | Rate limit exceeded |
| 500 | Internal Server Error | Unexpected error – contact support |
For detailed error response structure, examples, and troubleshooting guidance, see our comprehensive Error Codes Reference.
Support
If you need help, please contact your technical contact or support@utopi.co.uk.