Flyra API · v2026-06-01

Your service business, in code.

Text customers, book jobs, send estimates and get paid from your own systems. Everything Flyra’s Claude and ChatGPT connector can do is a plain HTTP call with one API key.

200+
endpoints
23
areas of Flyra
1
API key
Send a text
curl https://app.flyra.io/v2026-06-01/messages \
  -H "Authorization: Bearer $FLYRA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to_phone": "+15125550199",
    "body": "On our way, see you at 2pm!"
  }'
200 Response
{
  "data": {
    "ok": true,
    "status": "queued",
    "thread_message_id": "msg_5f0e7c2a-…",
    "from": "+15125550142",
    "to": "+15125550199",
    "contact_id": "contact_1b8d4e6f-…"
  }
}
Quick start

Your first call in two minutes

  1. 1

    Create a key

    In Flyra, an admin opens Developer in the sidebar, creates a key and switches on the areas it needs. The key is shown once, so store it as a secret.

    Open Developer →
  2. 2

    Read something

    Look up customers by name, phone or email. Every list pages with limit and offset.

    GET /customers
    curl -G https://app.flyra.io/v2026-06-01/customers \
      -d search=lee -d limit=5 \
      -H "Authorization: Bearer $FLYRA_API_KEY"
  3. 3

    Run any action

    Anything Flyra can do has a name. Send its inputs as JSON to /actions/{name}. The reference lists every one.

    POST /actions/find_open_slot
    curl https://app.flyra.io/v2026-06-01/actions/find_open_slot \
      -H "Authorization: Bearer $FLYRA_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "employee_id": "3f1c2b7a-5d4e-4c3b-9a8f-1e2d3c4b5a69",
        "duration_minutes": 90
      }'
Texting, email and calls

Talk to customers from anywhere

Texts go out from the company’s own Flyra number and land in the same inbox the team uses, in the customer’s thread. Read replies, answer them, email, and pull call history with transcripts.

What you can build

All of Flyra, over HTTP

Every area of the app has endpoints. Each card opens its section of the reference.

Customers

Create, find and update customers, tags, balances and cards on file.

  • POSTCreate a customer
  • GETSearch customers
  • POSTGet a balance
View in reference →

Leads

Capture leads into a pipeline, move them through stages and convert them.

  • POSTCreate a lead
  • PATCHUpdate a lead
  • POSTConvert to a customer
View in reference →

Jobs & schedule

Book jobs, find open slots, assign the team and move jobs through their status.

  • POSTCreate a job
  • POSTFind the next open slot
  • POSTAssign an employee
View in reference →

Estimates

Build priced estimates from line items, text them to the customer, convert to an invoice.

  • POSTCreate an estimate
  • POSTText it to the customer
  • POSTConvert to an invoice
View in reference →

Invoices & payments

Create invoices, share the payment link, charge a saved card and record outside payments.

  • POSTCreate an invoice
  • POSTCharge a saved card
  • POSTRecord a payment
  • GETList payments
View in reference →

Subscriptions

Start recurring subscriptions from your templates, then pause, resume or cancel them.

  • POSTCreate a subscription
  • POSTPause one
View in reference →

Price book

Your services and prices, and the lead sources you track.

  • GETList the price book
  • POSTAdd a service
View in reference →

Door-to-door map

Pins with outcomes, pin types, objections and rep territories.

  • POSTDrop a pin
  • POSTPins in a territory
View in reference →

Team

Invite people, set roles and working hours, and read each person’s numbers.

  • GETList the team
  • POSTGet someone’s stats
View in reference →

Automations

List automations, switch them on and off, and read or save their steps.

  • POSTList automations
  • POSTTurn one on
View in reference →

Reviews

Read reviews and ask for one after a job is done.

  • POSTSend a review request
View in reference →

Tasks

Create tasks for the team and mark them done.

  • POSTCreate a task
View in reference →

Lead forms

Build, publish and read submissions from your public lead forms.

  • POSTList submissions
View in reference →

Expenses

Log business spend and summarize it by category.

  • POSTLog an expense
View in reference →

Payroll

Period pay, hours worked, pay rates and one-off overrides.

  • POSTGet payroll for a period
View in reference →

Agreements

Your agreement templates.

  • POSTList templates
View in reference →

Equipment

Your equipment and inventory.

  • POSTList inventory
View in reference →

Settings

Organization, message and email settings, payment methods and what each role can see.

  • POSTGet org settings
View in reference →

Bulk

Change or delete many records in one call.

  • POSTChange many records
View in reference →

Search

Search across customers, jobs and subscriptions and fetch any record.

  • POSTSearch Flyra
View in reference →
Two ways in

Code, or an AI assistant

REST API

For your website, your own app, Zapier or n8n. One key per integration, permissions per area, every call logged.

Browse the reference →

MCP server

Connect Claude or ChatGPT to Flyra and ask in plain words. The same actions, picked by the assistant.

Set up MCP →
The basics

How every call works

Authentication

Every request carries your key as a Bearer token. Keys start with flr_live_ and belong to one company.

Authorization: Bearer flr_live_…

Permissions

Each key is limited to the areas an admin switched on: Jobs read, Texting send and so on. A missing one answers 403 and names it.

{ "code": "scope_denied" }

Responses

Success is { data }. An error says what went wrong and, most of the time, what to do next.

{ "error", "code", "hint" }

Rate limits

A busy key gets 429 with Retry-After. Texts are capped at 10 a minute per company; use SMS Blast for larger sends.

Retry-After: 30

Versioning

The version is in the path, so your integration keeps working when we ship a breaking change.

/v2026-06-01/…

Audit log

Every call is logged against the key that made it. Admins see recent activity on the Developer page in Flyra.

Developer → Recent API activity
API reference

Every endpoint

Search, browse by area on the left, and try any call with your key.