API reference › Finance › Overview, clients and work items

Get assignments and shifts for a provider

GET /v1/finance/provider/{providerId}/assignments-shifts

Scope
finance:read
Roles
admin, scheduler

Retrieves published (non-deleted) assignments and shifts linked to a provider for manual payable creation. Soft eligibility hints (payable_eligible, provider_is_no_show) only mean this provider is not marked no-show — they ignore canceled pay, linked docs, and other gates. Charge engine / 422 validation remain authoritative.

Parameters

Path parameters

NameTypeDescription
providerId requiredstring

Provider ID to get assignments and shifts for

Example SPR-XZQLQ1.

Query parameters

NameTypeDescription
document_idstring

Optional payable id (PAYB-…) already being edited/duplicated. Linked work items are returned even if soft-deleted or unpublished, with the same shape as create (including name). Must belong to this provider.

Example PAYB-ABC123.

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

Example request

Shell
curl "https://api.fetchfido.ai/v1/finance/provider/{providerId}/assignments-shifts" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Assignments and shifts retrieved successfully

Assignments and shifts retrieved successfully

JSON
{
  "success": true,
  "message": "Assignments and shifts retrieved successfully",
  "data": [
    {
      "type": "assignment",
      "id": "ASG-12345",
      "name": "Assignment Title",
      "status": "Completed",
      "status_slug": "completed",
      "finance_bucket": "standard",
      "provider_is_no_show": false,
      "payable_eligible": true
    }
  ]
}
Response fields (11)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Assignments and shifts retrieved successfully.

dataarray of object
data[].typestring

Type of work

One of: assignment, shift. Example assignment.

data[].idstring

Unique identifier

Example ASG-12345.

data[].namestring

Display name

Example Assignment Title.

data[].statusstring

Current status

Example Completed.

data[].status_slugstring

Status slug

Example completed.

data[].finance_bucketstring

Finance money bucket for document mixing rules

One of: standard, canceled, no-show. Example standard.

data[].provider_is_no_showboolean

Provider picker: whether this provider is marked no-show or has a no-show reason recorded.

Example false.

data[].payable_eligibleboolean

Soft hint only: false when this provider is marked no-show; does not consider canceled pay, linked docs, or expenses

Example true.

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 'finance: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 'finance:read' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

404 Not found

Provider not found

JSON
{
  "success": false,
  "message": "Provider not found"
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Provider not found.

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"
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred.