API reference › Requests › Provider portal

Retrieve paginated provider requests with optional filters

GET /v1/portal/provider/requests

Scope
requests:read
Roles
service-provider

Fetch a paginated list of provider request assignments. Allows filtering, searching, and sorting. Each item adds myTime and myConvertedTime: the provider's own covered hours on that occurrence when they hold only part of a partial-coverage job ('12:00 PM to 4:00 PM', separate runs joined with ', '), null otherwise. startTime/endTime keep the whole job's range.

Parameters

Query parameters

NameTypeDescription
searchstring

Search keyword

columnsstring

Comma-separated list of searchable columns

sortBystring

Column to sort by

Example created_at.

sortOrderstring

Sort order

One of: asc, desc.

perPageinteger

Items per page

Example 10.

pageinteger

Page number to retrieve

Example 1.

locationTypestring

Filter by location type

One of: Onsite, Remote, Hybrid.

durationinteger

Filter by duration

distancestring

Filter by distance (e.g., '5 miles')

serviceTypesarray of integer

Filter by service type IDs

clientstring

Filter by client

statusstring

Filter by assignment status

One of: Pending, Approved, Rejected, Assigned.

startDatestring (date)

Example 2025-09-12.

endDatestring (date)

Example 2025-09-12.

clientTypestring

Filter by the Client Type column. Hyphenated spellings (single-location) match too.

One of: individual, single_location, multi_location. Example single_location.

partialCoverboolean

Filter by the Partial Cover column: true for work items that allow partial coverage, false for those that do not.

Example true.

requestSourcestring

Filter by the Request Source column (origin of the request).

One of: client-portal, consumer-portal, scheduler, public-assistant. Example client-portal.

startTimestring (time)

Filter requests whose scheduled time range overlaps this start time (HH:MM:SS). Pairs with endTime; an overnight range (startTime later than endTime) is handled as spanning midnight.

Example 09:00:00.

endTimestring (time)

Filter requests whose scheduled time range overlaps this end time (HH:MM:SS). Pairs with startTime.

Example 17:00:00.

localSearchstring

The table's own search box: matches only the columns named in columns. search is the global search.

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

Example request

Shell
curl "https://api.fetchfido.ai/v1/portal/provider/requests" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Success

Success

JSON
{
  "success": true,
  "data": [
    {
      "id": "ASG-DYKTKO",
      "assignmentName": "Assignment 4",
      "clientType": null,
      "providers": [
        "2 Deaf",
        "2 Hearing"
      ],
      "startDate": "9/12/2025",
      "endDate": "9/12/2025",
      "startTime": "12:00 PM",
      "endTime": "1:00 PM",
      "duration": null,
      "locationType": "Hybrid",
      "address": {
        "onsite": {
          "title": null,
          "onSiteType": "manual",
          "address": {
            "addressLine1": "asas",
            "addressLine2": "asas",
            "city": "Austin",
            "state": null,
            "postalCode": "151545"
          }
        },
        "remote": {
          "remoteAccessDetails": {
            "url": "http://zoom.us/test",
            "notes": null,
            "meetingPlatform": "Zoom"
          }
        }
      },
      "distance": "5.2 miles",
      "serviceTypes": [
        {
          "id": 1,
          "label": "ASL"
        }
      ],
      "partialCoverage": false,
      "estimatePay": 0,
      "scheduleType": "one_time",
      "update": null,
      "status": "Pending",
      "notesFromScheduler": null
    }
  ],
  "meta": {
    "currentPage": 1,
    "lastPage": 1,
    "perPage": 10,
    "total": 4
  }
}
Response fields (34)

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

FieldTypeDescription
successboolean

Example true.

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

Nested fields

data 27 fields
FieldTypeDescription
data[].idstring

Example ASG-DYKTKO.

data[].assignmentNamestring

Example Assignment 4.

data[].clientTypestring or null
data[].providersarray of string
data[].startDatestring

Example 9/12/2025.

data[].endDatestring

Example 9/12/2025.

data[].startTimestring

Example 12:00 PM.

data[].endTimestring

Example 1:00 PM.

data[].durationinteger or null
data[].locationTypestring

Example Hybrid.

data[].addressobject
data[].address.onsiteobject
data[].address.onsite.titlestring or null
data[].address.onsite.onSiteTypestring

Example manual.

data[].address.onsite.addressobject
data[].address.remoteobject
data[].address.remote.remoteAccessDetailsobject
data[].distancestring

Example 5.2 miles.

data[].serviceTypesarray of object
data[].serviceTypes[].idinteger

Example 1.

data[].serviceTypes[].labelstring

Example ASL.

data[].partialCoverageboolean

Example false.

data[].estimatePaynumber

Example 0.

data[].scheduleTypestring

Example one_time.

data[].updatestring or null
data[].statusstring

Example Pending.

data[].notesFromSchedulerstring or null
meta 4 fields
FieldTypeDescription
meta.currentPageinteger

Example 1.

meta.lastPageinteger

Example 1.

meta.perPageinteger

Example 10.

meta.totalinteger

Example 4.

400 Bad request

Bad Request

JSON
{
  "success": false,
  "message": "Failed to retrieve.",
  "errors": {
    "search": [
      "Invalid search parameter"
    ]
  }
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Failed to retrieve..

errorsobject
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 'requests: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 'requests: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

Server Error

JSON
{
  "success": false,
  "message": "Something went wrong!",
  "errors": "Unexpected error occurred"
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Something went wrong!.

errorsstring or null

Null in production. The exception message only when the application runs with debug on.

Example Unexpected error occurred.