Skip to main content
POST
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

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.

Body

application/json
organizationId
string<uuid>
required
requestedByUserId
string<uuid>
required
sourceService
string
required
Required string length: 2 - 64
Example:

"fluide-crm"

jobKind
string
required
Required string length: 2 - 64
Example:

"DATA_IMPORT_PARSE"

correlationId
string
required
Required string length: 8 - 64
requestPayload
object

Response

201 - application/json
organizationId
string
required
requestedByUserId
string
required
sourceService
string
required

e.g. fluide-books

jobKind
string
required

e.g. STATEMENT_EXPORT_BUNDLE, GENERIC_BYTES

correlationId
string
required

Idempotency key from producer (e.g. books statement_export.id)

status
enum<string>
required
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED,
CANCELLED
requestPayload
object
required
resultFileIds
string[] | null
required
errorMessage
string | null
required
id
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
deletedAt
string<date-time>