Changelog

Changes to the External API, newest first.

November 16, 2026: 19 new operations Version 1.0.0

The reference now matches the API document generated on October 28, 2026: 362 paths and 535 operations.

Added

  • Ethnicities and Identities (General settings): list, get, create, rename (PUT and PATCH) and delete, at /v1/ethnicities and /v1/identities.
  • Insurances (Service setup): list, get, create, update (PUT and PATCH) and delete, at /v1/insurances.
  • Resend an onboarding invite (Team): POST /v1/users/{id}/resend-invite.

Nothing was removed or changed in the existing operations.

October 22, 2026: External API launch Version 1.0.0

The External API is available in production at https://api.fetchfido.ai/v1.

What is included

  • API reference. The published document covers 355 paths and 516 operations across assignments, shifts, schedule, clients, consumers, providers, team, handshakes, requests, finance, forms, history and logs, and settings.
  • Authentication. API keys sent as Authorization: Bearer. Organization and user keys also send X-Tenant-ID. See Getting started.
  • Keys. Admins and Schedulers create organization keys in Settings → API Keys, with scopes, an expiry, a rate limit and an optional IP allow-list.
  • Scopes. A scope is module:action, using the modules and the read, write, edit and delete actions from Roles & Permissions. check_ins and requests are two modules that exist as scopes only.
  • Identity check. GET /v1/whoami returns who the key acts as and the scopes it holds. Any valid key can call it.
  • Provider check-ins. GET /v1/check-ins lists provider sign-ins and sign-outs for a date range. It needs the check_ins:read scope and accepts from, to, userId, workId, status, page and perPage.
  • Platform token exchange. POST /v1/token-exchange is for platform-tier keys, which only Fido platform administrators hold.
  • Errors and limits. One error format, the codes API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED and RATE_LIMITED, and rate limits per key, per organization, and for exports and reports. See Errors and Rate limits.

What is not included

  • Decisions about a minor's records, such as who may see them and the review when a consumer turns 18, stay in the Fido app. No key can make them.
  • Login, password reset, API key management and other account-security routes are not part of the API.
  • Webhooks are not available yet. See Webhooks.

Old whoami address

The identity check was reachable earlier at /api/v1/ext/whoami. That address still answers, as an alias kept for one release. Use /v1/whoami.