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

companyId
string<uuid>
engagementId
string<uuid>
vmOrgId
string<uuid>
module
enum<string>
Available options:
HR,
PAYROLL,
BOOKS,
PAY
from
string
to
string
actorUserId
string<uuid>
delegatedOnly
boolean
page
number
Required range: x >= 1
limit
number
Required range: 1 <= x <= 100

Response

Successful response

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