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

NameTypeDescription
id requiredstring

Unique identifier of the assignment

Example SFT-ZGJ8T2.

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

Example request

Shell
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

JSON
{
  "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.

FieldTypeDescription
successboolean

Example true.

dataobject (67 nested)

Nested fields

data 67 fields
FieldTypeDescription
data.idstring

Example SFT-MNP4PJ.

data.titlestring

Example Example title.

data.shiftBlockobject
data.shiftBlock.idinteger

Example 1.

data.shiftBlock.labelstring

Example Example label.

data.shiftBlock.startTimestring (time)

Example 09:00:00.

data.shiftBlock.endTimestring (time)

Example 09:00:00.

data.clientobject
data.client.idstring

Example SPR-FG543C.

data.client.namestring

Example Example name.

data.client.imagestring

Example https://cdn.example.com/image.png.

data.client.onlineStatusstring

Example online.

data.assignClientarray of object
data.assignClientLocationarray of object
data.scheduleTypestring

Example one_time.

data.locationTypestring

Example string.

data.startstring (date)

Example 2026-01-15.

data.endstring (date)

Example 2026-01-15.

data.convertedStartstring (date-time)

Example 2026-01-15 09:00 AM.

data.convertedEndstring (date-time)

Example 2026-01-15 09:00 AM.

data.convertedStartDatestring (date)

Example 2026-01-15.

data.convertedEndDatestring (date)

Example 2026-01-15.

data.daystring

Example string.

data.convertedDaystring

Example string.

data.endDaystring

Example string.

data.convertedEndDaystring

Example string.

data.datestring (date)

Example 2026-01-15.

data.convertedDatestring (date)

Example 2026-01-15.

data.timestring (time)

Example 09:00:00.

data.convertedTimestring (time)

Example 09:00:00.

data.userTimezonestring

Example America/New_York.

data.formateStartTimestring (time)

Example 09:00:00.

data.formateEndTimestring (time)

Example 09:00:00.

data.formateStartDatestring (date)

Example 2026-01-15.

data.formateEndDatestring (date)

Example 2026-01-15.

data.assignmentTimezonestring

Example America/New_York.

data.userDateTooltipstring

Example Jan 15, 2026 9:00 AM – 11:00 AM.

data.onsiteobject
data.onsite.onsiteTypestring

Example string.

data.remoteobject
data.remote.remoteTypestring

Example string.

data.remote.remoteMeetingLinkstring

Example https://example.com.

data.remote.remoteMeetingPlatformstring

Example Virtual link provided.

data.remote.onDemandLinkstring

Example https://example.com.

data.remote.onDemandAccessInstructionsstring

Example string.

data.serviceTypesobject
data.serviceTypes.idinteger

Example 1.

data.serviceTypes.labelstring

Example Example label.

data.serviceProvidersstring

Example string.

data.groupedProviderstring

Example string.

data.statusobject
data.status.idinteger

Example 1.

data.status.labelstring

Example Example label.

data.statusMethodstring

Example string.

data.assignmentMethodstring

Example string.

data.dontAskMeAgainstring

Example string.

data.parentIdstring

Example string.

data.redirectTostring

Example shifts.

data.confirmedTimeSlotsstring

Example string.

data.restrictedActionButtonsarray of object
data.missingRatesarray of object
data.hasRateMissingboolean

Example true.

data.requiresTimeSlotPopupboolean

Example true.

data.isCompletedboolean

Example true.

data.isPastboolean

Example true.

data.showRestrictedWarningboolean

Example true.

data.restrictedWarningMessagestring

Example This action is restricted for the assigned provider..

401 Not signed in

Unauthorized - authentication required

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

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

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

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

422 Validation failed

Validation error - Missing or invalid parameters

JSON
{
  "success": false,
  "message": "Validation Failed",
  "errors": {
    "id": [
      "The specified assignment does not exist."
    ]
  }
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Validation Failed.

errorsobject
errors.idarray of string
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

Internal server error

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

Example false.

messagestring

Example An unexpected error occurred. Please try again later..