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
| Name | Type | Description |
|---|---|---|
providerId required | string | Provider ID to get assignments and shifts for Example |
Query parameters
| Name | Type | Description |
|---|---|---|
document_id | string | 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 |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
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
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | array of object | |
data[].type | string | Type of work One of: |
data[].id | string | Unique identifier Example |
data[].name | string | Display name Example |
data[].status | string | Current status Example |
data[].status_slug | string | Status slug Example |
data[].finance_bucket | string | Finance money bucket for document mixing rules One of: |
data[].provider_is_no_show | boolean | Provider picker: whether this provider is marked no-show or has a no-show reason recorded. Example |
data[].payable_eligible | boolean | Soft hint only: false when this provider is marked no-show; does not consider canceled pay, linked docs, or expenses Example |
401 Not signed in
Missing, invalid or expired API key.
{
"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 'finance: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 |
404 Not found
Provider not found
{
"success": false,
"message": "Provider not found"
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
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"
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |