API reference › Assignments › Provider portal

Get assignment available slots

GET /v1/settings/portal/provider/assignment/{id}/slots

Scope
assignments:read
Roles
service-provider

Fetch assignment slots grouped by service type and provider type for provider coverage selection.

Parameters

Path parameters

NameTypeDescription
id requiredstring

Unique identifier of the assignment or shift.

Example ASG-TQBTH1.

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

Example request

Shell
curl "https://api.fetchfido.ai/v1/settings/portal/provider/assignment/{id}/slots" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Assignment slots retrieved successfully

Assignment slots retrieved successfully

JSON
{
  "success": true,
  "message": "Assignment slots retrieved successfully.",
  "data": {
    "assignmentId": "ASG-TQBTH1",
    "startDate": "2026-04-24",
    "endDate": "2026-04-24",
    "locationType": "hybrid",
    "slots": [
      {
        "slotId": 655,
        "startTime": "12:00 PM",
        "endTime": "1:00 PM",
        "isFilled": false,
        "serviceTypeBreakdowns": [
          {
            "assignmentLocationServiceTypeId": 1020,
            "locationType": "remote",
            "serviceTypeName": "CART",
            "isFilled": false,
            "providerTypes": null
          }
        ]
      }
    ]
  }
}
Response fields (18)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Assignment slots retrieved successfully..

dataobject
data.assignmentIdstring

Example ASG-TQBTH1.

data.startDatestring (date)

Example 2026-04-24.

data.endDatestring (date)

Example 2026-04-24.

data.locationTypestring

Example hybrid.

data.slotsarray of object
data.slots[].slotIdinteger

Example 655.

data.slots[].startTimestring

Example 12:00 PM.

data.slots[].endTimestring

Example 1:00 PM.

data.slots[].isFilledboolean

Example false.

data.slots[].serviceTypeBreakdownsarray of object
data.slots[].serviceTypeBreakdowns[].assignmentLocationServiceTypeIdinteger

Example 1020.

data.slots[].serviceTypeBreakdowns[].locationTypestring

Example remote.

data.slots[].serviceTypeBreakdowns[].serviceTypeNamestring

Example CART.

data.slots[].serviceTypeBreakdowns[].isFilledboolean

Example false.

data.slots[].serviceTypeBreakdowns[].providerTypesarray of object
400 Bad request

Assignment already completed or action not allowed

JSON
{
  "success": false,
  "message": "This assignment has already been completed."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example This assignment has already been completed..

401 Not signed in

Unauthorized

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

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

404 Not found

Assignment not found

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

Example false.

messagestring

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

Example false.

messagestring

Example Something went wrong!.