API reference › Providers

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

NameTypeDescription
id requiredstring

Service provider ID.

Example USR-AB12CD34.

tab requiredstring

Which tab of the profile to return.

One of: details, qualifications, availability, requirement_and_preferences, rates_billing, localizations, assignmentStats.

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

Example request

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

JSON
{
  "success": true,
  "message": "Service Provider details retrieved successfully.",
  "data": {},
  "meta": {
    "currentPage": 1,
    "lastPage": 3,
    "perPage": 10,
    "total": 24
  }
}
Response fields (8)
FieldTypeDescription
successboolean

Example true.

messagestring

Absent on the historyLogs tab.

Example Service Provider details retrieved successfully..

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

metaobject or null

Sent on the historyLogs tab only.

meta.currentPageinteger

Example 1.

meta.lastPageinteger

Example 3.

meta.perPageinteger

Example 10.

meta.totalinteger

Example 24.

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

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.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'providers:read' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

422 Validation failed

Unknown id or tab.

JSON
{
  "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)
FieldTypeDescription
statusstring

Example error.

messagestring

Example Unable to save. Please check the highlighted fields.

errorsobject

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.

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.