API reference › Check-ins

Get one provider's sign-in / sign-out record on an assignment or a shift

GET /v1/assignment-shift/provider/check-in

Scope
check_ins:read

Admin may read any provider's record; a scheduler may too when their module permissions give them Read on Assignments (assignmentId) or Shifts (shiftId). A service provider may read only their own (userId is their own id) on a work item they are assigned to. Every other role gets 403. Send assignmentId or shiftId, not both. data is an empty record (all keys null) when nothing has been recorded yet; signInSignOutRequired is always set.

Parameters

Query parameters

NameTypeDescription
assignmentIdstring

Required without shiftId; not with shiftId

Example ASG-VQM5KW.

shiftIdstring

Required without assignmentId; not with assignmentId

Example SFT-1A2B3C.

userId requiredstring

The provider whose record is read

Example SPR-4EVTY9.

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

Example request

Shell
curl "https://api.fetchfido.ai/v1/assignment-shift/provider/check-in?userId=SPR-4EVTY9" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 The record

The record

JSON
{
  "success": true,
  "message": "Get Provider Check Ins.",
  "data": {
    "id": 12,
    "assignmentId": "ASG-VQM5KW",
    "shiftId": null,
    "signInDate": "2026-10-01",
    "signInTime": "13:15:00",
    "signOutDate": "2026-10-01",
    "signOutTime": "15:30:00",
    "status": "pending",
    "timesLocked": false,
    "signInSignOutRequired": true,
    "scheduledSignIn": {
      "date": "2026-10-01",
      "time": "09:00:00"
    },
    "scheduledSignOut": {
      "date": "2026-10-01",
      "time": "17:00:00"
    }
  }
}
Response fields (19)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Get Provider Check Ins..

dataobject
data.idinteger or null

Example 12.

data.assignmentIdstring or null

Example ASG-VQM5KW.

data.shiftIdstring or null
data.signInDatestring (date) or null

Example 2026-10-01.

data.signInTimestring or null

Example 13:15:00.

data.signOutDatestring (date) or null

Example 2026-10-01.

data.signOutTimestring or null

Example 15:30:00.

data.statusstring or null

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

data.timesLockedboolean

True when a service provider can no longer change or clear the times: an admin or scheduler has written the record, or it is approved. False for a rejected record, which the provider can resubmit (it goes to pending)

Example false.

data.signInSignOutRequiredboolean

The work item's require_verified_time_documentation (Require verified time records): when true the times are required and cannot be cleared

Example true.

data.scheduledSignInobject or null

Where the sign-in opens when nothing is saved: the scheduled start (the provider's own assigned slot for partial coverage), in the work item's time zone

data.scheduledSignIn.datestring

Example 2026-10-01.

data.scheduledSignIn.timestring

Example 09:00:00.

data.scheduledSignOutobject or null

Where the sign-out opens when nothing is saved: the scheduled end (the next day for work past midnight)

data.scheduledSignOut.datestring

Example 2026-10-01.

data.scheduledSignOut.timestring

Example 17:00:00.

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

Not admin, not a scheduler with Read on the work item's module, and not the assigned provider reading their own record

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

Validation error: missing or unknown work item or provider, or both assignmentId and shiftId sent

JSON
{
  "status": "error",
  "message": "An unexpected error occurred — please try again.",
  "errors": {
    "userId": [
      "The provider is required."
    ]
  }
}
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.

500 Server error

Server error

JSON
{
  "success": false,
  "message": "An unexpected error occurred — please try again."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred — please try again..