Feexa Partner API

Base URL

url

https://api.feexa.co.uk/partner/v1

The Feexa Partner API is organized around REST. It uses predictable, resource-oriented URLs, accepts JSON request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

You can use the Partner API in test mode without affecting live business data or payment flows. The API key you use to authenticate the request determines whether the request runs in live mode or test mode. Keys prefixed with fk_live_ operate on production data; keys prefixed with fk_test_ are for development and integration testing.

The Partner API does not support bulk updates. You can create, read, update, or delete one resource per request. To change multiple records, send separate requests for each object.

Every request is scoped to a single business. Your API key resolves the business automatically — do not pass business_id in paths or bodies. Available endpoints and write permissions may differ by account, plan, and key scope as we release new versions and tailor functionality.

Quick start

Generate an API key in the Feexa owner app (Settings → Integrations → API Keys).
Send the key on every request: Authorization: Bearer fk_live_…
Use HTTPS only. All responses are JSON.
Business scope is automatic — never send business_id in the body.

HTTP methods

We use standard HTTP verbs. Not every resource supports every method — some are read-only (for example transactions and payouts), while others allow create and partial update via PATCH.

Method	Usage
GET	Retrieve a single resource or a paginated list.
POST	Create a new resource. Returns 201 Created on success.
PATCH	Partial update. Send only the fields you want to change.
DELETE	Remove or deactivate a resource where supported.

Conventions

• UUID primary keys on all resources
• Timestamps in ISO 8601 (UTC)
• Money amounts as decimal numbers in the resource currency (e.g. 45.00)
• List endpoints return { data: [], pagination: {} }
• Single resource returns { data: {} }
• Errors return { error: { code, message } }
• API version is fixed in the URL path (/partner/v1)

Rate limits

600 requests / minute per API key

Short bursts up to 120 requests / 10 seconds

When you exceed a limit, the API responds with 429 Too Many Requests and a Retry-After header. Back off and retry after the indicated interval.

Resources

Each endpoint exposes a business-scoped resource in Feexa — customers, invoices, bookings, payments, and more. Select an endpoint from the left sidebar to see parameters, request bodies, response shapes, and copy-paste examples.