Introduction - Flip Docs

The Flip API gives you programmatic access to manage products and related catalogue data in your organisation. Requests and responses use JSON.

Base URL

https://api.flipapp.app/functions/v1/api

Endpoint pages in this reference use paths like /api/products relative to /functions/v1.

Authentication

Integrators typically authenticate with an API key. Include it on every request:

curl "https://api.flipapp.app/functions/v1/api/products" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept-Version: 1.0"

Header	Required	Purpose
`x-api-key`	Yes (for API key auth)	Your organisation API key. The key is bound to one organisation.
`Accept-Version`	Recommended	API version. Use `1.0`. Defaults to `1.0` if omitted.
`Content-Type`	For JSON bodies	`application/json`

Getting an API key

Sign in to Flip.
Open Organisation settings → API keys.
Create a key or copy an existing one.
Treat the key like a password — don’t commit it or share it in public channels.

App sessions can also call the API with a Bearer JWT and must send x-organization-id for the active organisation. API keys do not need that header — the organisation comes from the key.

Response envelope

Successful and failed responses share a common shape:

{
  "success": true,
  "data": {},
  "meta": {},
  "error": null
}

Field	When present
`success`	Always — `true` or `false`
`data`	On success — the resource or list
`meta`	On paginated lists — `page`, `limit`, `total`, `total_pages`
`error`	On failure — message and error code

Products

Start with the core product endpoints:

List products

Paginated product list with search and filters.

Get a product

Full product detail, territories, sales rights, and collateral.

Create a product

Create a product, optionally with prices, contributors, and collateral.

Update a product

Partial updates with nested sync for related records.

​Base URL

​Authentication

​Getting an API key

​Response envelope

​Products

List products

Get a product

Create a product

Update a product

Base URL

Authentication

Getting an API key

Response envelope

Products