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
| Name | Type | Description |
|---|---|---|
assignmentId | string | Required without shiftId; not with shiftId Example |
shiftId | string | Required without assignmentId; not with assignmentId Example |
userId required | string | The provider whose record is read Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
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
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.id | integer or null | Example |
data.assignmentId | string or null | Example |
data.shiftId | string or null | |
data.signInDate | string (date) or null | Example |
data.signInTime | string or null | Example |
data.signOutDate | string (date) or null | Example |
data.signOutTime | string or null | Example |
data.status | string or null | One of: |
data.timesLocked | boolean | 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 |
data.signInSignOutRequired | boolean | The work item's require_verified_time_documentation (Require verified time records): when true the times are required and cannot be cleared Example |
data.scheduledSignIn | object 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.date | string | Example |
data.scheduledSignIn.time | string | Example |
data.scheduledSignOut | object or null | Where the sign-out opens when nothing is saved: the scheduled end (the next day for work past midnight) |
data.scheduledSignOut.date | string | Example |
data.scheduledSignOut.time | string | Example |
401 Not signed in
Missing, invalid or expired API key.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
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
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
422 Validation failed
Validation error: missing or unknown work item or provider, or both assignmentId and shiftId sent
{
"status": "error",
"message": "An unexpected error occurred — please try again.",
"errors": {
"userId": [
"The provider is required."
]
}
}Response fields (3)
| Field | Type | Description |
|---|---|---|
status | string | Example |
message | string | Example |
errors | object |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
500 Server error
Server error
{
"success": false,
"message": "An unexpected error occurred — please try again."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |