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.

Path Parameters

cohortId
string
required

cohortId identifier

Body

application/json
businessOrganizationId
string<uuid>

Business organization id (kind = BUSINESS) — Fluide Business ID (FBI) for tenants already on Fluide.

invitedEmail
string<email>

Invite by email when the business is not on Fluide yet; queues a join link to fluide-admin.

businessCompanyId
string<uuid>

Optional company id under the business.

inviteMessage
string
Maximum string length: 1000
scopeOperations
boolean

Operations data scope flag.

scopeFinancials
boolean

Financials data scope flag.

scopeFacs
boolean

FACS data scope flag.

scopeHr
boolean

HR module scope (defaults from operations when omitted).

scopePayroll
boolean

Payroll module scope (defaults from operations when omitted).

scopeAccounting
boolean

Accounting / books scope (defaults from financials when omitted).

scopeInsurance
boolean

Insurance / benefits reads (reserved).

Response

Invite — created

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