Retrieve a list of service providers
GET /v1/providers
- Scope
providers:read- Roles
- admin, scheduler
Fetches a paginated list of service providers based on search criteria, filters, and sorting options.
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
search | string | Search query to filter service providers by name, email, or provider ID. Example |
status | integer | Filter service providers by status ID. Example |
hearingStatus | string | Filter service providers by hearing status. One of: |
employmentStatus | string | Filter service providers by employment status. One of: |
skillLevel | integer | Filter service providers by skill ID. Example |
serviceType | integer | Filter service providers by service type ID. Example |
certification | integer | Filter service providers by certification ID. Example |
clearance | integer | Filter service providers by clearance ID. Example |
specialization | integer | Filter service providers by specialization ID. Example |
isPublished | boolean | Filter service providers by their Published status. Example |
sortBy | string | Sort service providers by a specific field (e.g., 'name', 'created_at'). Example |
sortOrder | string | Sorting order: ascending ('asc') or descending ('desc'). One of: |
perPage | integer | Number of service providers to retrieve per page. Example |
page | integer | Page number to retrieve. Example |
columns | string | Search query within visible column content. Example |
startDate | string (date) | Filter service providers created on or after this date (YYYY-MM-DD). |
endDate | string (date) | Filter service providers created on or before this date (YYYY-MM-DD). |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/providers" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Service providers retrieved successfully
Service providers retrieved successfully
{
"success": true,
"data": [
{
"id": "USR-LBW3CV",
"name": "Example name",
"email": "user@example.com",
"phone": "+1-555-0142",
"logo": "https://cdn.example.com/image.png",
"status": {
"id": 1,
"label": "Active"
},
"activeAssignments": 3,
"lastAssignmentDate": "2026-01-15",
"specializations": [
{
"id": 1,
"label": "ASL"
}
],
"clearance": [
{
"id": 1,
"label": "Background Check"
}
],
"employmentStatus": "string",
"serviceProviderRole": "string",
"hearingStatus": "string",
"skill": "string",
"certifications": [
{
"id": 1,
"label": "NIC"
}
],
"serviceTypes": [
{
"id": 1,
"label": "ASL Interpreting"
}
],
"serviceProviderTypes": [
{
"id": 1,
"label": "Interpreter"
}
],
"statusChangedAt": "2026-01-15",
"publishedAt": "2026-01-15",
"isPublished": true,
"portalAccess": true,
"canLogin": true,
"gender": {
"id": "male",
"label": "Male"
},
"onlineStatus": "online",
"requiresPrimaryReassignmentOnDelete": "string",
"otherActiveRoles": "string"
}
],
"meta": {
"currentPage": 1,
"lastPage": 5,
"perPage": 10,
"total": 50
}
}Response fields (47)
3 top-level fields; 2 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | array of object (40 nested) | |
meta | object (4 nested) |
Nested fields
data 40 fields
| Field | Type | Description |
|---|---|---|
data[].id | string | Example |
data[].name | string | Example |
data[].email | string or null | Example |
data[].phone | string or null | Example |
data[].logo | string or null | Example |
data[].status | object or null | |
data[].status.id | integer | Example |
data[].status.label | string | Example |
data[].activeAssignments | integer | Count of active assignments and shifts linked to the provider Example |
data[].lastAssignmentDate | string or null | Example |
data[].specializations | array of object | |
data[].specializations[].id | integer | Example |
data[].specializations[].label | string | Example |
data[].clearance | array of object | |
data[].clearance[].id | integer | Example |
data[].clearance[].label | string | Example |
data[].employmentStatus | string or null | |
data[].serviceProviderRole | string or null | |
data[].hearingStatus | string or null | |
data[].skill | string or null | |
data[].certifications | array of object | |
data[].certifications[].id | integer | Example |
data[].certifications[].label | string | Example |
data[].serviceTypes | array of object | |
data[].serviceTypes[].id | integer | Example |
data[].serviceTypes[].label | string | Example |
data[].serviceProviderTypes | array of object | |
data[].serviceProviderTypes[].id | integer | Example |
data[].serviceProviderTypes[].label | string | Example |
data[].statusChangedAt | string or null | Example |
data[].publishedAt | string or null | Example |
data[].isPublished | boolean or null | Example |
data[].portalAccess | boolean or null | Example |
data[].canLogin | boolean | Example |
data[].gender | object or null | |
data[].gender.id | string | Example |
data[].gender.label | string | Example |
data[].onlineStatus | string | Example |
data[].requiresPrimaryReassignmentOnDelete | string | |
data[].otherActiveRoles | string |
meta 4 fields
| Field | Type | Description |
|---|---|---|
meta.currentPage | integer | Example |
meta.lastPage | integer | Example |
meta.perPage | integer | Example |
meta.total | integer | Example |
400 Bad request
Bad Request - Invalid query parameters
{
"success": false,
"message": "Invalid parameters. Ensure all required filters are correct."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
401 Not signed in
Unauthorized - Authentication required
{
"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 'providers: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 |
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. Please try again later."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |