Skip to main content
GET
/
api
/
v1
/
engagements
cURL
curl -sS -X GET "$FLUIDE_BASE_URL/api/v1/engagements"
{
  "success": true,
  "message": "Operation completed successfully",
  "data": {}
}

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