API reference › Assignments

Retrieve assignment providers

GET /v1/assignment/{id}/providers/{serviceType}/{status}

Scope
assignments:read
Roles
admin, scheduler

Fetches the assignment providers.

Parameters

Path parameters

NameTypeDescription
id requiredstring

Unique identifier of the assignment

Example ASM-ZGJ8T2.

serviceType requiredinteger

Identifier for the service type

Example 1.

status requiredstring

Status of the assignment providers

One of: assigned, interested, pending, declined, not_interested, pending_confirmation, un_assigned, broadcasted. Example assigned.

Query parameters

NameTypeDescription
searchstring

Search query to filter provider by name, method

Example John Doe.

locationTypestring

Limit to providers on this location type.

One of: onsite, remote. Example onsite.

pageinteger

Page number (default: 1).

Example 1.

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

Example request

Shell
curl "https://api.fetchfido.ai/v1/assignment/{id}/providers/{serviceType}/{status}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Assignment providers retrieved successfully

Assignment providers retrieved successfully

JSON
{
  "success": true,
  "data": [
    {
      "id": 1,
      "method": "string",
      "status": "string",
      "serviceProviderId": "SPR-FG543C",
      "onlineStatus": "online",
      "name": "Example name",
      "image": "https://cdn.example.com/image.png",
      "email": "user@example.com",
      "distance": 0,
      "slotType": "string",
      "slotStartTime": "09:00:00",
      "slotEndTime": "09:00:00",
      "serviceType": "string",
      "serviceProviderType": {
        "id": 1,
        "label": "Example label"
      },
      "startDate": "2026-01-15",
      "startTime": "09:00:00",
      "endDate": "2026-01-15",
      "endTime": "09:00:00",
      "locationType": "string",
      "timezone": "America/New_York",
      "verifiedTimeLogs": true,
      "isNetwork": true,
      "isNoShow": true,
      "noShowReason": "Client requested a change",
      "noShowMarkedAt": "2026-01-15 09:00:00",
      "noShowMarkedBy": "string"
    }
  ],
  "meta": {
    "currentPage": 1,
    "lastPage": 1,
    "perPage": 1,
    "total": 1
  }
}
Response fields (35)

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

FieldTypeDescription
successboolean

Example true.

dataarray of object (28 nested)
metaobject (4 nested)

Nested fields

data 28 fields
FieldTypeDescription
data[].idinteger

Example 1.

data[].methodstring

Example string.

data[].statusstring

Example string.

data[].serviceProviderIdstring

Example SPR-FG543C.

data[].onlineStatusstring

Example online.

data[].namestring

Example Example name.

data[].imagestring

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

data[].emailstring

Example user@example.com.

data[].distanceinteger

Example 0.

data[].slotTypestring

Example string.

data[].slotStartTimestring (time)

Example 09:00:00.

data[].slotEndTimestring (time)

Example 09:00:00.

data[].serviceTypestring

Example string.

data[].serviceProviderTypeobject
data[].serviceProviderType.idinteger

Example 1.

data[].serviceProviderType.labelstring

Example Example label.

data[].startDatestring (date)

Example 2026-01-15.

data[].startTimestring (time)

Example 09:00:00.

data[].endDatestring (date)

Example 2026-01-15.

data[].endTimestring (time)

Example 09:00:00.

data[].locationTypestring

Example string.

data[].timezonestring

Example America/New_York.

data[].verifiedTimeLogsboolean

Example true.

data[].isNetworkboolean

Example true.

data[].isNoShowboolean

Example true.

data[].noShowReasonstring

Example Client requested a change.

data[].noShowMarkedAtstring (date-time)

Example 2026-01-15 09:00:00.

data[].noShowMarkedBystring

Example string.

meta 4 fields
FieldTypeDescription
meta.currentPageinteger

Example 1.

meta.lastPageinteger

Example 1.

meta.perPageinteger

Example 1.

meta.totalinteger

Example 1.

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 '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 .

422 Validation failed

Validation error - Missing or invalid parameters

JSON
{
  "success": false,
  "message": "Validation Failed",
  "errors": {
    "id": [
      "The specified assignment does not exist."
    ]
  }
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Validation Failed.

errorsobject
errors.idarray of string
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..