External API

Connect your own systems to Fido data

The External API lets your developers read and write Fido data from your own systems. It runs through the same controllers as the app, so the same rules apply.

See how it works Common questions

  • Organizations

What you get

External API, in practice.

Want your own systems working with Fido? Hand him a key. He’s a very organized house-sitter.

Organization API keys

An Admin or Scheduler creates a key in Settings. The key is shown once, so it can be stored safely.

Scopes you choose

Each key carries scopes in a module:action form, such as read, write, edit or delete for one module.

Permissions still apply

A request works only when the key's scope and the owner's role both allow it.

Key controls

Set an expiry, a rate limit and an IP allow-list on each key.

A broad surface

The reference at developers.fetchfido.ai covers 535 operations at api.fetchfido.ai/v1, with core routes for assignments, shifts, clients, consumers, providers and check-ins.

Clear rate-limit signals

Responses include the remaining limit, and a Retry-After header tells your code when to try again.

How it works

Follow it start to finish.

SampleAPI key · jobs sync · Lincoln ISD

  1. Setup
    What you see: Dana K., an Admin, opens Settings, then API Keys, and names a key for the developer.
    What Fido does: She chooses scopes in module:action form, an expiry, a rate limit and the IP addresses allowed to use the key.
  2. Setup
    What you see: Fido shows the key once. Dana stores it in the secrets manager and copies the Organization ID.
    What Fido does: The key is shown a single time. The Organization ID goes in the X-Tenant-ID header with each request.
  3. First use
    What you see: The developer asks the whoami endpoint who the key is, and reads back the role and scopes.
    What Fido does: Whoami returns the key's role and scopes at api.fetchfido.ai/v1, so the developer knows what is allowed before building.
  4. Daily
    What you see: The developer's system reads assignments and writes new ones into Fido.
    What Fido does: A request works only when the key's scope and the owner's role both allow it. It runs through the same controllers as the app.
  5. Busy hour
    What you see: The system slows down on its own when Fido says to wait.
    What Fido does: Responses include the remaining limit, and a Retry-After header tells the code when to try again.

From every seat

Every seat, a lighter day.

Admin

Before“Giving another system access meant sharing a login and hoping nobody used it for more.”

With Fido“I make a key with the scopes I choose, an expiry and an IP allow-list. It does only what I set.”

Keys carry scopes, expiry, rate limit and IP allow-list.

Scheduler

Before“Jobs lived in our other system too, so I entered each one twice.”

With Fido“Our developers connect that system to Fido's API, and the jobs go where they belong without my retyping.”

The External API reads and writes assignments, shifts and more.

Common questions

Asked and answered.

Who can create an API key?

An organization Admin or Scheduler creates keys in Settings, API Keys. Fido shows each key once, so your team can store it safely.

Does the API follow my permissions?

Yes. A request needs a matching scope on the key and a role that allows the action.

What can my developers do with it?

Read and write Fido data from your own systems. The API runs through the same controllers as the app, so the same rules apply. Core routes cover assignments, shifts, clients, consumers, providers and check-ins.

What controls does each key have?

Scopes you choose in a module:action form, an expiry, a rate limit and an IP allow-list.

How does my developer connect?

Requests go to api.fetchfido.ai/v1 with the key as a Bearer token and your Organization ID in the X-Tenant-ID header. The whoami endpoint returns the key's role and scopes first.

What happens at a busy hour?

Responses include the remaining limit, and a Retry-After header tells your code when to try again.

Where are the docs?

At developers.fetchfido.ai: guides, a searchable reference and a changelog. See Developer docs.

See it with your own schedule.

Book a demo and we will walk through your own work in Fido.

Book a Demo