Skip to content

Get an event check in

Workforce module

GET/event-check-ins/{id}eventCheckIns.get

Attendance of an event, one per attendee. Returns one event check in with its `ETag`. A event check in the caller may not see returns 404.

  • Requires the capability schedule.timeline.read.
  • OAuth scopes: schedule.
  • Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

eventCheckIns.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the event check in.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Response 200: EventCheckIn

eventCheckIns.get: EventCheckIn
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the event check in.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesPerson who created the row; null for seed, platform or system writes.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesPerson who last updated the row; null for seed, platform or system writes.
workforce_event_idstring (uuid)YesIdentifier of the event.
membership_idstring (uuid)YesIdentifier of the attendee.
check_in_method"Self" | "Organizer" | "Scan"YesHow they were checked in.
checked_in_atstring (date-time)YesWhen 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 GET "$XOS_BASE_URL/event-check-ins/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.eventCheckIns.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.event_check_ins.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos event-check-ins get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f