Skip to main content
POST
/
api
/
v1
/
hr
/
employees
/
{id}
/
onboarding
cURL
curl -sS -X POST "$FLUIDE_BASE_URL/api/v1/hr/employees/string/onboarding" \
  -H "Authorization: Bearer $FLUIDE_ACCESS_TOKEN" \
  -H "X-Fluide-Api-Key: $FLUIDE_API_KEY" \
  -H "X-Fluide-Client-Id: fluide-developer" \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "success": true,
  "message": "Operation completed successfully",
  "data": {}
}

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

​
id
string
required

id identifier

Body

application/json
​
itemKey
string
required
​
done
boolean
required

Legacy flag; kept in sync with status (DONE/SKIPPED => true).

​
label
string
​
status
enum<string>
Available options:
PENDING,
IN_PROGRESS,
BLOCKED,
DONE,
SKIPPED
​
dueDate
string

ISO date (YYYY-MM-DD)

​
completedByUserId
string<uuid>

Defaults to the authenticated user when transitioning to a terminal status.

​
evidenceFileRef
string
Maximum string length: 1024
​
notes
string
​
blockingReason
string
Maximum string length: 512
​
metadata
object

Response

Create onboarding — 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