API reference › Handshakes

Get missing service combinations

GET /v1/handshakes/{id}/missing-services

Scope
handshakes:read
Roles
admin, scheduler

GET /handshakes/{id}/missing-services

Parameters

Path parameters

NameTypeDescription
id requiredstring

Handshake ID.

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

Example request

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

Try it

Responses

200 Missing services data retrieved successfully

Missing services data retrieved successfully.

JSON
{
  "success": true,
  "message": "Missing services data retrieved successfully.",
  "data": [
    {
      "id": 12,
      "serviceType": {
        "id": 1,
        "label": "Example label"
      },
      "serviceProviderType": {
        "id": 2,
        "label": "Example label"
      },
      "hasMissingData": true
    }
  ]
}
Response fields (11)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Missing services data retrieved successfully..

dataarray of object

One row per service the provider offers. Empty when the provider record is gone.

data[].idinteger

Provider service row id.

Example 12.

data[].serviceTypeobject
data[].serviceType.idinteger

Example 1.

data[].serviceType.labelstring

Example Example label.

data[].serviceProviderTypeobject
data[].serviceProviderType.idinteger

Example 2.

data[].serviceProviderType.labelstring

Example Example label.

data[].hasMissingDataboolean

True when the handshake still needs details for this service.

Example true.

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 .

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.