API reference › Shifts › Calendar
Retrieve details of a shift for calendar
GET /v1/schedule/calendar/shifts/{id}
- Scope
schedule:read shifts:read
Fetches the details of a shift, based on the provided shift ID. For a service provider who holds only part of a partial-coverage job, myTime and myConvertedTime carry their own covered hours (same format as time and convertedTime, separate runs joined with ', '); they are null for everyone else. Each serviceProviders entry adds coveredTime, the hours that provider holds, or null when they hold the whole job.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
id required | string | Unique identifier of the assignment Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/schedule/calendar/shifts/{id}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Shift details retrieved successfully
Shift details retrieved successfully
{
"success": true,
"data": {
"id": "SFT-MNP4PJ",
"title": "Example title",
"shiftBlock": {
"id": 1,
"label": "Example label",
"startTime": "09:00:00",
"endTime": "09:00:00"
},
"client": {
"id": "SPR-FG543C",
"name": "Example name",
"image": "https://cdn.example.com/image.png",
"onlineStatus": "online"
},
"assignClient": [],
"assignClientLocation": [],
"scheduleType": "one_time",
"locationType": "string",
"start": "2026-01-15",
"end": "2026-01-15",
"convertedStart": "2026-01-15 09:00 AM",
"convertedEnd": "2026-01-15 09:00 AM",
"convertedStartDate": "2026-01-15",
"convertedEndDate": "2026-01-15",
"day": "string",
"convertedDay": "string",
"endDay": "string",
"convertedEndDay": "string",
"date": "2026-01-15",
"convertedDate": "2026-01-15",
"time": "09:00:00",
"convertedTime": "09:00:00",
"userTimezone": "America/New_York",
"formateStartTime": "09:00:00",
"formateEndTime": "09:00:00",
"formateStartDate": "2026-01-15",
"formateEndDate": "2026-01-15",
"assignmentTimezone": "America/New_York",
"userDateTooltip": "Jan 15, 2026 9:00 AM – 11:00 AM",
"onsite": {
"onsiteType": "string"
},
"remote": {
"remoteType": "string",
"remoteMeetingLink": "https://example.com",
"remoteMeetingPlatform": "Virtual link provided",
"onDemandLink": "https://example.com",
"onDemandAccessInstructions": "string"
},
"serviceTypes": {
"id": 1,
"label": "Example label"
},
"serviceProviders": "string",
"groupedProvider": "string",
"status": {
"id": 1,
"label": "Example label"
},
"statusMethod": "string",
"assignmentMethod": "string",
"dontAskMeAgain": "string",
"parentId": "string",
"redirectTo": "shifts",
"confirmedTimeSlots": "string",
"restrictedActionButtons": [],
"missingRates": [],
"hasRateMissing": true,
"requiresTimeSlotPopup": true,
"isCompleted": true,
"isPast": true,
"showRestrictedWarning": true,
"restrictedWarningMessage": "This action is restricted for the assigned provider."
}
}Response fields (69)
2 top-level fields; 1 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | object (67 nested) |
Nested fields
data 67 fields
| Field | Type | Description |
|---|---|---|
data.id | string | Example |
data.title | string | Example |
data.shiftBlock | object | |
data.shiftBlock.id | integer | Example |
data.shiftBlock.label | string | Example |
data.shiftBlock.startTime | string (time) | Example |
data.shiftBlock.endTime | string (time) | Example |
data.client | object | |
data.client.id | string | Example |
data.client.name | string | Example |
data.client.image | string | Example |
data.client.onlineStatus | string | Example |
data.assignClient | array of object | |
data.assignClientLocation | array of object | |
data.scheduleType | string | Example |
data.locationType | string | Example |
data.start | string (date) | Example |
data.end | string (date) | Example |
data.convertedStart | string (date-time) | Example |
data.convertedEnd | string (date-time) | Example |
data.convertedStartDate | string (date) | Example |
data.convertedEndDate | string (date) | Example |
data.day | string | Example |
data.convertedDay | string | Example |
data.endDay | string | Example |
data.convertedEndDay | string | Example |
data.date | string (date) | Example |
data.convertedDate | string (date) | Example |
data.time | string (time) | Example |
data.convertedTime | string (time) | Example |
data.userTimezone | string | Example |
data.formateStartTime | string (time) | Example |
data.formateEndTime | string (time) | Example |
data.formateStartDate | string (date) | Example |
data.formateEndDate | string (date) | Example |
data.assignmentTimezone | string | Example |
data.userDateTooltip | string | Example |
data.onsite | object | |
data.onsite.onsiteType | string | Example |
data.remote | object | |
data.remote.remoteType | string | Example |
data.remote.remoteMeetingLink | string | Example |
data.remote.remoteMeetingPlatform | string | Example |
data.remote.onDemandLink | string | Example |
data.remote.onDemandAccessInstructions | string | Example |
data.serviceTypes | object | |
data.serviceTypes.id | integer | Example |
data.serviceTypes.label | string | Example |
data.serviceProviders | string | Example |
data.groupedProvider | string | Example |
data.status | object | |
data.status.id | integer | Example |
data.status.label | string | Example |
data.statusMethod | string | Example |
data.assignmentMethod | string | Example |
data.dontAskMeAgain | string | Example |
data.parentId | string | Example |
data.redirectTo | string | Example |
data.confirmedTimeSlots | string | Example |
data.restrictedActionButtons | array of object | |
data.missingRates | array of object | |
data.hasRateMissing | boolean | Example |
data.requiresTimeSlotPopup | boolean | Example |
data.isCompleted | boolean | Example |
data.isPast | boolean | Example |
data.showRestrictedWarning | boolean | Example |
data.restrictedWarningMessage | string | Example |
401 Not signed in
Unauthorized - authentication required
{
"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
Scope, tenant, IP allow-list or RBAC check failed.
{
"success": false,
"message": "You don't have permission to access this endpoint. This API key is missing the 'schedule: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 invalid parameters
{
"success": false,
"message": "Validation Failed",
"errors": {
"id": [
"The specified assignment does not exist."
]
}
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | object | |
errors.id | array of string |
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
Internal server error
{
"success": false,
"message": "An unexpected error occurred. Please try again later."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |