Check in to an event
Workforce module
POST/workforce-events/{id}/check-inworkforceEvents.checkIn
Checks the caller in, or another invitee when the caller organizes the event, from an hour before the start to the end. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
- Requires the capability schedule.timeline.read.
- OAuth scopes: schedule.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the workforce event. |
Request body: EventCheckInRequest
| Field | Type | Required | Description |
|---|---|---|---|
| membership_id | string (uuid) | No | Invitee to check in; the caller by default. |
| method | "Self" | "Organizer" | "Scan" | No | How. |
{
"membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"method": "Self"
}Response 200: EventCheckIn
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the event check in. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Person who created the row; null for seed, platform or system writes. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Person who last updated the row; null for seed, platform or system writes. |
| workforce_event_id | string (uuid) | Yes | Identifier of the event. |
| membership_id | string (uuid) | Yes | Identifier of the attendee. |
| check_in_method | "Self" | "Organizer" | "Scan" | Yes | How they were checked in. |
| checked_in_at | string (date-time) | Yes | When they checked in. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"workforce_event_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"check_in_method": "Self",
"checked_in_at": "2026-10-08T14:30:00Z"
}Code samples
curl -X POST "$XOS_BASE_URL/workforce-events/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/check-in" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"membership_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","method":"Self"}'const { data } = await xos.workforceEvents.checkIn("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"method": "Self"
});response = xos.workforce_events.check_in("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "method": "Self"})xos workforce-events check-in 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"membership_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","method":"Self"}'