API reference › Check-ins

List provider sign-ins and sign-outs for a date range

GET /v1/check-ins

Scope
check_ins:read

One row per assigned provider slot on every assignment and shift whose dates reach into the range (from to to, inclusive, by the work item's own dates), with that provider's sign-in and sign-out on the work item when one is recorded. A provider who holds two slots on one work item appears twice, with the same sign-in and sign-out on both rows; a provider with no check-in yet appears with signIn, signOut, status and duration empty. Dates and times are wall-clock values in the work item's time zone (timeZone); each moment also carries its UTC offset in at. Rows are sorted by date, then work item, provider and slot. An admin sees everything; a scheduler sees the kinds its Assignments and Shifts access allows; a service provider sees only their own rows. Requests, deleted work items and providers who are not assigned are not listed. Names and signature images are not part of the response.

Parameters

Query parameters

NameTypeDescription
fromstring (date)

First day to include (YYYY-MM-DD). Required unless updated_since is sent, and then with to.

Example 2026-10-01.

tostring (date)

Last day to include (YYYY-MM-DD). Required unless updated_since is sent, and then with from. Not before from.

Example 2026-10-31.

userIdstring

Only this provider's rows.

Example SPR-4EVTY9.

workIdstring

Only this assignment's or shift's rows. An id starting ASG- is an assignment, one starting SFT- a shift.

Example ASG-VQM5KW.

statusstring

Only rows whose check-in has this status. Rows with no check-in are left out.

One of: pending, approved, rejected. Example approved.

updated_sincestring

Only rows that changed at or after this moment: the provider's check-in, the provider row (assigned, or removed: providerStatus canceled, withdrawn, un_assigned or declined), the slot, or the work item itself. Work items deleted in the window come back with deletedAt set. With it, from and to become optional. ISO 8601 date-time with a time zone (for example 2026-10-22T06:00:00Z) or a date (YYYY-MM-DD, taken as 00:00 UTC). meta.asOf is the moment the list was read; use it as the next updated_since. Keep the meta.asOf of the first page of a pull: every page reports its own, and the first one is the moment the pull began. Start each pull a few minutes before the previous meta.asOf: a change committed while a list was being read can carry a time just before it, and a row returned twice is harmless.

Example 2026-10-22T06:00:00Z.

pageinteger

Page number (default: 1).

Example 1.

perPageinteger

Rows per page (default: 25, at most 100).

Example 25.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Example request

Shell
curl "https://api.fetchfido.ai/v1/check-ins" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Check-ins retrieved successfully

Check-ins retrieved successfully.

JSON
{
  "success": true,
  "message": "Check-ins retrieved successfully.",
  "data": [
    {
      "workItemType": "assignment",
      "assignmentId": "ASG-VQM5KW",
      "shiftId": null,
      "userId": "SPR-4EVTY9",
      "slotId": "214",
      "timeZone": "America/New_York",
      "scheduledStart": {
        "date": "2026-10-01",
        "time": "13:00:00",
        "at": "2026-10-01T13:00:00-04:00"
      },
      "scheduledEnd": {
        "date": "2026-10-01",
        "time": "15:30:00",
        "at": "2026-10-01T15:30:00-04:00"
      },
      "signIn": {
        "date": "2026-10-01",
        "time": "13:15:00",
        "at": "2026-10-01T13:15:00-04:00"
      },
      "signOut": {
        "date": "2026-10-01",
        "time": "15:30:00",
        "at": "2026-10-01T15:30:00-04:00"
      },
      "status": "approved",
      "duration": 2.25,
      "providerStatus": "assigned",
      "providerRowId": 661,
      "providerRowUpdatedAt": "2026-10-23T06:00:00Z",
      "deletedAt": "string"
    }
  ],
  "meta": {
    "currentPage": 1,
    "lastPage": 3,
    "perPage": 25,
    "total": 61,
    "asOf": "2026-10-23T06:00:00Z"
  }
}
Response fields (37)

4 top-level fields; 2 hold nested fields, listed below.

FieldTypeDescription
successboolean

Example true.

messagestring

Example Check-ins retrieved successfully..

dataarray of object (28 nested)
metaobject (5 nested)

Nested fields

data 28 fields
FieldTypeDescription
data[].workItemTypestring

One of: assignment, shift. Example assignment.

data[].assignmentIdstring or null

Example ASG-VQM5KW.

data[].shiftIdstring or null
data[].userIdstring

The provider.

Example SPR-4EVTY9.

data[].slotIdstring or null

The provider's assigned slot; empty when the provider is not tied to a slot.

Example 214.

data[].timeZonestring

The work item's time zone. Every date and time on the row is a wall-clock value in it.

Example America/New_York.

data[].scheduledStartobject or null

The slot's own start, else the work item's.

data[].scheduledStart.datestring (date)

Example 2026-10-01.

data[].scheduledStart.timestring

Example 13:00:00.

data[].scheduledStart.atstring (date-time)

Example 2026-10-01T13:00:00-04:00.

data[].scheduledEndobject or null

The slot's own end, else the work item's; the next day for work that runs past midnight.

data[].scheduledEnd.datestring (date)

Example 2026-10-01.

data[].scheduledEnd.timestring

Example 15:30:00.

data[].scheduledEnd.atstring (date-time)

Example 2026-10-01T15:30:00-04:00.

data[].signInobject or null

Empty until the provider signs in.

data[].signIn.datestring (date)

Example 2026-10-01.

data[].signIn.timestring

Example 13:15:00.

data[].signIn.atstring (date-time)

Example 2026-10-01T13:15:00-04:00.

data[].signOutobject or null

Empty until the provider signs out.

data[].signOut.datestring (date)

Example 2026-10-01.

data[].signOut.timestring

Example 15:30:00.

data[].signOut.atstring (date-time)

Example 2026-10-01T15:30:00-04:00.

data[].statusstring or null

The check-in's review status; empty when there is no check-in.

One of: pending, approved, rejected. Example approved.

data[].durationnumber (float) or null

Hours between sign-in and sign-out; empty until both are recorded.

Example 2.25.

data[].providerStatusstring

Only with updated_since: the provider row's status. Anything but assigned means the provider left the job.

One of: assigned, canceled, withdrawn, un_assigned, declined. Example assigned.

data[].providerRowIdinteger

Only with updated_since: the id of the provider row. A provider can have a canceled row and an assigned row on the same slot; this tells them apart. Unique only together with workItemType: assignment and shift provider rows count their ids separately.

Example 661.

data[].providerRowUpdatedAtstring (date-time)

Only with updated_since: when the provider row last changed (UTC, ending in Z).

Example 2026-10-23T06:00:00Z.

data[].deletedAtstring (date-time) or null

Only with updated_since: when the work item was deleted (UTC, ending in Z), or empty while it exists.

meta 5 fields
FieldTypeDescription
meta.currentPageinteger

Example 1.

meta.lastPageinteger

Example 3.

meta.perPageinteger

Example 25.

meta.totalinteger

Example 61.

meta.asOfstring (date-time)

Only with updated_since: the moment the list was read; use it as the next updated_since. Take it from the first page of a pull; every page reports its own.

Example 2026-10-23T06:00:00Z.

401 Not signed in

Missing, invalid or expired API key.

JSON
{
  "success": false,
  "message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
  "errors": null,
  "code": "API_KEY_MISSING"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

The caller is not an admin, a scheduler with Read on Assignments or Shifts (and on the kind of the work id), or a service provider asking for their own rows.

JSON
{
  "success": false,
  "message": "You don't have permission to access this endpoint. This API key is missing the 'check_ins:read' scope.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'check_ins:read' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

422 Validation failed

A date is missing or malformed, to is before from, or workId does not start with ASG- or SFT-.

JSON
{
  "status": "error",
  "message": "An unexpected error occurred — please try again.",
  "errors": {
    "to": [
      "The to date cannot be before the from date."
    ]
  }
}
Response fields (3)
FieldTypeDescription
statusstring

Example error.

messagestring

Example An unexpected error occurred — please try again..

errorsobject
429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "success": false,
  "message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
  "errors": null,
  "code": "RATE_LIMITED"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.