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

Path Parameters

id
string
required

Body

application/json

The body is of type object.

Response

200 - application/json
organizationId
string
required
companyId
string
required
name
string
required
isDefault
boolean
required
frequency
object
required
periodRules
object
required
includedEmployeeIds
string[] | null
required
employeeFilterRules
object
required
approvalPolicySnapshot
object | null
required
groupValidatorSnapshot
object | null
required
metadata
object
required
id
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
deletedAt
string<date-time>