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.

Query Parameters

role
enum<string>

business filters by businessOrgId = active org (caller must be in BUSINESS org). vm filters by virtualManagerOrgId = active org (caller must be PARTNER + VIRTUAL_MANAGER subtype). compliance filters by virtualManagerOrgId = active org (caller must be PARTNER + COMPLIANCE_EXPERT subtype); the virtualManagerOrgId column is the generic "partner-side org id" — see engagement.ts schema docs.

Defaults to whichever side the caller belongs to (rejects ambiguity).

Available options:
business,
vm,
compliance
status
enum<string>
Available options:
PENDING,
ACTIVE,
COMPLETED,
TERMINATED,
CANCELLED
companyId
string<uuid>
engagementType
enum<string>
Available options:
HR,
PAYROLL,
BOOKS,
PAY

Response

List

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