Get a service provider's detail for one tab
GET /v1/provider/{id}/{tab}
- Scope
providers:read- Roles
- admin, scheduler
Returns one tab's worth of a service provider's profile. The shape of data depends on which tab is requested.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
id required | string | Service provider ID. Example |
tab required | string | Which tab of the profile to return. One of: |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/provider/{id}/{tab}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Service provider detail retrieved successfully
Service provider detail retrieved successfully.
{
"success": true,
"message": "Service Provider details retrieved successfully.",
"data": {},
"meta": {
"currentPage": 1,
"lastPage": 3,
"perPage": 10,
"total": 24
}
}Response fields (8)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Absent on the historyLogs tab. Example |
data | object or array of object | details, qualifications, availability, requirement_and_preferences, configuration, rates_billing, localizations and assignmentStats each return their own object; historyLogs returns an array of audit entries; an unknown tab returns null. |
meta | object or null | Sent on the historyLogs tab only. |
meta.currentPage | integer | Example |
meta.lastPage | integer | Example |
meta.perPage | integer | Example |
meta.total | integer | Example |
401 Not signed in
Missing, invalid or expired API key.
{
"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
Forbidden. The rates_billing tab is Finances data, so a role without Finance Read is refused it whatever it holds on the record's own module. Every other tab follows the record's module alone.
{
"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 |
422 Validation failed
Unknown id or tab.
{
"status": "error",
"message": "Unable to save. Please check the highlighted fields",
"errors": {
"name": [
"Please enter a name."
],
"email": [
"The email has already been taken."
]
}
}Response fields (3)
| Field | Type | Description |
|---|---|---|
status | string | Example |
message | string | Example |
errors | object | Field name to its messages. Nested keys are collapsed onto the field the form renders. |
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: |