API reference › Assignment and shift rules › Assignment shift settings

Retrieve specific tab details of assignments and shifts settings

GET /v1/settings/assignment-shift-settings

Scope
settings_assignments_shifts:read
Roles
admin, scheduler

Fetches the details for a specific tab within the assignments & shifts settings, based on the provided tab identifier.

Parameters

None of its own.

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

Example request

Shell
curl "https://api.fetchfido.ai/v1/settings/assignment-shift-settings" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Assignments and Shifts settings retrieved successfully

Assignments and Shifts settings retrieved successfully

JSON
{
  "success": true,
  "data": {
    "id": 1,
    "enableAssignmentFinanceModule": true,
    "enableShiftFinanceModule": true,
    "enableAssignmentBilling": true,
    "enableAssignmentPayables": true,
    "enableAssignmentReimbursement": true,
    "enableAssignmentRateRules": true,
    "enableShiftBilling": true,
    "enableShiftPayables": true,
    "enableShiftReimbursement": true,
    "enableShiftRateRules": true,
    "enableAssignmentRequests": true,
    "enableShiftRequests": true,
    "primaryMode": "string",
    "defaultPriorityLevel": {
      "id": 1,
      "label": "Example label"
    },
    "allowClientCreateRequest": true,
    "allowPriorityOverrideClient": true,
    "allowConsumerRequestService": true,
    "assignmentDefaultAssignedOwner": {
      "id": 1,
      "image": "https://cdn.example.com/image.png",
      "onlineStatus": "online",
      "label": "Example label",
      "subtitle": "user@example.com"
    },
    "shiftDefaultAssignedOwner": {
      "id": 1,
      "image": "https://cdn.example.com/image.png",
      "onlineStatus": "online",
      "label": "Example label",
      "subtitle": "user@example.com"
    },
    "assignmentsPrimaryAssignmentManager": {
      "id": 1,
      "image": "https://cdn.example.com/image.png",
      "onlineStatus": "online",
      "label": "Example label",
      "subtitle": "user@example.com"
    },
    "shiftsPrimaryAssignmentManager": {
      "id": 1,
      "image": "https://cdn.example.com/image.png",
      "onlineStatus": "online",
      "label": "Example label",
      "subtitle": "user@example.com"
    },
    "allowReassignment": true,
    "fallbackManager": {
      "id": 1,
      "image": "https://cdn.example.com/image.png",
      "onlineStatus": "online",
      "label": "Example label",
      "subtitle": "user@example.com"
    },
    "reassignmentTriggerResponseTime": 1,
    "reassignmentTriggerResponseTimeUnit": "string",
    "schedulerUnavailable": true,
    "manualReassignmentAdmin": true,
    "requireVerifiedTimeDocumentation": true,
    "useFidoNetwork": true
  }
}
Response fields (59)

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

FieldTypeDescription
successboolean

Example true.

dataobject (57 nested)

Nested fields

data 57 fields
FieldTypeDescription
data.idinteger

Example 1.

data.enableAssignmentFinanceModuleboolean

Example true.

data.enableShiftFinanceModuleboolean

Example true.

data.enableAssignmentBillingboolean

Example true.

data.enableAssignmentPayablesboolean

Example true.

data.enableAssignmentReimbursementboolean

Example true.

data.enableAssignmentRateRulesboolean

Example true.

data.enableShiftBillingboolean

Example true.

data.enableShiftPayablesboolean

Example true.

data.enableShiftReimbursementboolean

Example true.

data.enableShiftRateRulesboolean

Example true.

data.enableAssignmentRequestsboolean

Example true.

data.enableShiftRequestsboolean

Example true.

data.primaryModestring

Example string.

data.defaultPriorityLevelobject
data.defaultPriorityLevel.idinteger

Example 1.

data.defaultPriorityLevel.labelstring

Example Example label.

data.allowClientCreateRequestboolean

Example true.

data.allowPriorityOverrideClientboolean

Example true.

data.allowConsumerRequestServiceboolean

Example true.

data.assignmentDefaultAssignedOwnerobject
data.assignmentDefaultAssignedOwner.idinteger

Example 1.

data.assignmentDefaultAssignedOwner.imagestring

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

data.assignmentDefaultAssignedOwner.onlineStatusstring

Example online.

data.assignmentDefaultAssignedOwner.labelstring

Example Example label.

data.assignmentDefaultAssignedOwner.subtitlestring

Example user@example.com.

data.shiftDefaultAssignedOwnerobject
data.shiftDefaultAssignedOwner.idinteger

Example 1.

data.shiftDefaultAssignedOwner.imagestring

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

data.shiftDefaultAssignedOwner.onlineStatusstring

Example online.

data.shiftDefaultAssignedOwner.labelstring

Example Example label.

data.shiftDefaultAssignedOwner.subtitlestring

Example user@example.com.

data.assignmentsPrimaryAssignmentManagerobject
data.assignmentsPrimaryAssignmentManager.idinteger

Example 1.

data.assignmentsPrimaryAssignmentManager.imagestring

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

data.assignmentsPrimaryAssignmentManager.onlineStatusstring

Example online.

data.assignmentsPrimaryAssignmentManager.labelstring

Example Example label.

data.assignmentsPrimaryAssignmentManager.subtitlestring

Example user@example.com.

data.shiftsPrimaryAssignmentManagerobject
data.shiftsPrimaryAssignmentManager.idinteger

Example 1.

data.shiftsPrimaryAssignmentManager.imagestring

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

data.shiftsPrimaryAssignmentManager.onlineStatusstring

Example online.

data.shiftsPrimaryAssignmentManager.labelstring

Example Example label.

data.shiftsPrimaryAssignmentManager.subtitlestring

Example user@example.com.

data.allowReassignmentboolean

Example true.

data.fallbackManagerobject
data.fallbackManager.idinteger

Example 1.

data.fallbackManager.imagestring

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

data.fallbackManager.onlineStatusstring

Example online.

data.fallbackManager.labelstring

Example Example label.

data.fallbackManager.subtitlestring

Example user@example.com.

data.reassignmentTriggerResponseTimeinteger

Example 1.

data.reassignmentTriggerResponseTimeUnitstring

Example string.

data.schedulerUnavailableboolean

Example true.

data.manualReassignmentAdminboolean

Example true.

data.requireVerifiedTimeDocumentationboolean

Example true.

data.useFidoNetworkboolean

Example true.

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 'settings_assignments_shifts: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 'settings_assignments_shifts: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": "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..