API reference › Handshakes

Get one tab of the provider detail view

GET /v1/handshakes/{id}/provider/{tab}

Scope
handshakes:read
Roles
admin, scheduler

Backs the org-side handshake detail page. The response shape differs per tab: details and qualifications return an object, documents returns an array of document groups, and rates is paginated.

Parameters

Path parameters

NameTypeDescription
id requiredstring

Handshake ID.

tab requiredstring

Which tab to load.

One of: details, qualifications, rates, documents.

Query parameters

NameTypeDescription
serviceTypestring

Rates tab only.

providerTypestring

Rates tab only.

searchstring

Rates tab only.

per_pageinteger

Rates tab only.

pageinteger

Rates tab only.

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

Example request

Shell
curl "https://api.fetchfido.ai/v1/handshakes/{id}/provider/{tab}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Tab data retrieved

Tab data retrieved.

JSON
{
  "success": true,
  "message": "Tab data retrieved.",
  "data": {}
}
Response fields (3)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Tab data retrieved..

dataobject or array of object

Shape follows the tab: an object for details and qualifications, an array of document groups for documents, and a paginated payload for rates.

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 'handshakes: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 'handshakes:read' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

404 Not found

Handshake or provider not found.

JSON
{
  "success": false,
  "message": "The requested resource could not be found.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example The requested resource could not be found..

errorsany or null

Details when the handler has them — a field-keyed object, a single string, or null.

codestring

Empty unless the handler sets one.

Example .

422 Validation failed

Unknown tab. Allowed: details, qualifications, rates, documents.

JSON
{
  "success": false,
  "message": "Unable to save. Please check the highlighted fields",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Unable to save. Please check the highlighted fields.

errorsany or null

Details when the handler has them — a field-keyed object, a single string, or null.

codestring

Empty unless the handler sets one.

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.