API reference › Assignments › Provider portal

Retrieve service provider assignments

GET /v1/settings/portal/provider/assignment

Scope
assignments:read
Roles
service-provider

Fetches a paginated list of assignments for the authenticated service provider based on filters. 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.

Parameters

Query parameters

NameTypeDescription
searchstring

Search query to filter assignments by name, email, or assignment ID.

Example assignment 1.

statusinteger

Filter assignments by status ID.

Example 1.

serviceTypesinteger

Filter assignments by service type ID.

Example 1.

clientstring

Filter assignments by client ID.

Example CLT-567FGR.

customTabstring

Filter assignments by custom tab.

Example active.

startDatestring (date)

Filter assignments starting on or after this date (YYYY-MM-DD).

Example 2024-01-01.

endDatestring (date)

Filter assignments ending on or before this date (YYYY-MM-DD).

Example 2024-12-31.

startTimestring

Filter assignments by start time.

Example 09:00.

endTimestring

Filter assignments by end time.

Example 17:00.

locationTypestring

Filter assignments by location type.

Example remote.

durationinteger

Filter assignments by duration in hours.

Example 8.

distancenumber (float)

Filter assignments by distance in miles/km.

Example 25.5.

sortBystring

Sort assignments by a specific field (e.g., 'name', 'created_at').

Example created_at.

sortOrderstring

Sorting order: ascending ('asc') or descending ('desc').

One of: asc, desc. Example desc.

perPageinteger

Number of assignments to retrieve per page.

Example 10.

columnsstring

Comma-separated list of columns to search within.

Example name,status,priority.

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.

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" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Assignments retrieved successfully

Assignments retrieved successfully

JSON
{
  "success": true,
  "message": "Assignment List Retrieved!",
  "data": [
    {
      "assignmentId": "ASG-23RT45",
      "name": "Assignment Name",
      "status": "Active",
      "priority": "High"
    }
  ],
  "meta": {
    "currentPage": 1,
    "lastPage": 5,
    "perPage": 10,
    "total": 50
  }
}
Response fields (12)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Assignment List Retrieved!.

dataarray of object
data[].assignmentIdstring

Example ASG-23RT45.

data[].namestring

Example Assignment Name.

data[].statusstring

Example Active.

data[].prioritystring

Example High.

metaobject
meta.currentPageinteger

Example 1.

meta.lastPageinteger

Example 5.

meta.perPageinteger

Example 10.

meta.totalinteger

Example 50.

400 Bad request

Bad Request - Invalid query parameters

JSON
{
  "success": false,
  "message": "Failed to retrieve.",
  "errors": "Invalid parameters provided."
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Failed to retrieve..

errorsstring

Example Invalid parameters provided..

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 .

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