API reference › Schedule › Assignments and shifts on the schedule

Get assignment or shift details

GET /v1/schedule/assignments-and-shifts/{id}/{type}

Scope
schedule:read
Roles
admin, scheduler

Retrieve assignment or shift details including client, consumers, location, service types, and requirements

Parameters

Path parameters

NameTypeDescription
id requiredstring

Assignment or Shift ID

Example SFT-2XIM11.

type requiredstring

Type of data to retrieve

One of: assignment, shift. Example shift.

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

Example request

Shell
curl "https://api.fetchfido.ai/v1/schedule/assignments-and-shifts/{id}/{type}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Assignment or shift data retrieved successfully

Assignment or shift data retrieved successfully

JSON
{
  "success": true,
  "message": "Retrieved shift data successfully",
  "data": {
    "client": {
      "id": "CLT-GGM6R1",
      "label": "Client1"
    },
    "assignClient": [
      {
        "id": "CLT-HW3EPL",
        "label": "Client14"
      }
    ],
    "consumer": [
      {
        "id": "CSM-MUQVGB",
        "label": "Consumer5"
      }
    ],
    "assignTo": "organization",
    "locationType": "onsite",
    "onsite": {
      "onSiteType": "organization",
      "serviceTypes": [
        {
          "id": 1,
          "label": "ASL"
        }
      ],
      "serviceTypeBreakdown": [
        {
          "serviceTypeId": 1,
          "providerTypeBreakdown": [
            null
          ],
          "certifications": [
            null
          ],
          "skills": [
            null
          ],
          "clearances": [
            null
          ],
          "specializations": [
            null
          ]
        }
      ]
    }
  }
}
Response fields (26)

3 top-level fields; 1 hold nested fields, listed below.

FieldTypeDescription
successboolean

Example true.

messagestring

Example Retrieved shift data successfully.

dataobject (23 nested)

Nested fields

data 23 fields
FieldTypeDescription
data.clientobject or null
data.client.idstring

Example CLT-GGM6R1.

data.client.labelstring

Example Client1.

data.assignClientarray of object
data.assignClient[].idstring

Example CLT-HW3EPL.

data.assignClient[].labelstring

Example Client14.

data.consumerarray of object
data.consumer[].idstring

Example CSM-MUQVGB.

data.consumer[].labelstring

Example Consumer5.

data.assignTostring

Example organization.

data.locationTypestring

Example onsite.

data.onsiteobject
data.onsite.onSiteTypestring

Example organization.

data.onsite.serviceTypesarray of object
data.onsite.serviceTypes[].idinteger

Example 1.

data.onsite.serviceTypes[].labelstring

Example ASL.

data.onsite.serviceTypeBreakdownarray of object
data.onsite.serviceTypeBreakdown[].serviceTypeIdinteger

Example 1.

data.onsite.serviceTypeBreakdown[].providerTypeBreakdownarray of object
data.onsite.serviceTypeBreakdown[].certificationsarray of object
data.onsite.serviceTypeBreakdown[].skillsarray of object
data.onsite.serviceTypeBreakdown[].clearancesarray of object
data.onsite.serviceTypeBreakdown[].specializationsarray of object
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

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 .

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": "Something went wrong!"
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Something went wrong!.