Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Access token JWT. Use as Authorization: Bearer . In the API playground, paste the JWT only.

X-Fluide-Api-Key
string
header
default:fl_dev_your_key
required

Developer API key (fl_dev_...). Required on every API call with a machine access token.

X-Fluide-Client-Id
string
header
default:fluide-developer
required

First-party client audience. Must match the fluide_client_id claim on the JWT. Use fluide-developer for Connect.

Headers

authorization
string
required
X-Workspace-Id
string<uuid>

Partner / ISV only: UUID of the workspace that owns the client company. Required together with X-Acting-Company-Id when scoping product APIs to a merchant. See /getting-started/multi-tenancy.

X-Acting-Company-Id
string<uuid>

Partner / ISV only: UUID of the client company to act on. Must belong to the workspace in X-Workspace-Id.

Query Parameters

q
string

Free-text search (endpoint-specific)

Maximum string length: 200
page
number
default:1

Page number (1-indexed)

Required range: x >= 1
limit
number
default:5000

Max rows to export

Required range: 1 <= x <= 10000
companyId
string<uuid>

Filter invoices for a specific company in the tenant

format
enum<string>
default:csv
Available options:
csv,
xlsx,
pdf
statusFilter
enum<string>
Available options:
ALL,
DRAFT,
POSTED,
SENT,
PARTIALLY_PAID,
PAID,
OVERDUE,
CANCELLED
startDate
string

Filter issueDate on/after (ISO date)

endDate
string

Filter issueDate on/before (ISO date)

Response

Export invoices (csv/xlsx/pdf) with optional status and

success
boolean
required

Whether the request succeeded

Example:

true

message
string
required

Human-readable outcome message (localized when i18n is configured)

Example:

"Operation completed successfully"

data
object

Endpoint-specific payload