looped.shDocs

Public API

Programmatic read/write access to your company's data

Looped's public API is the same surface the apps and the CLI use, exposed for external integrations.

It lives at api.looped.sh. That URL renders the interactive reference: every endpoint, every parameter, every response shape, with a "Try it" panel you can run live calls from.

For machine consumption, the OpenAPI spec is at api.looped.sh/openapi.json. Drop it into Postman, Bruno, or your codegen of choice.

Authenticating

There are two ways in. Pick the first unless you are building something that signs in as a person.

API key

Generate a key from your company's API keys page and send it in the X-API-Key header:

bash
curl https://api.looped.sh/v1/invoices \
  -H "X-API-Key: looped_..."

The key carries the company scope, so you don't pass teamId separately. Each key also carries a set of permissions, such as track:time.write or invoices:invoices.read, picked when the key was made. See API keys.

Bearer token (sign in as a person)

A client that signs a person in through Looped's login, like the CLI does, sends their access token in Authorization: Bearer <token> plus an x-team-id header naming the company. The request then has that person's permissions in that company.

GET /v1/auth/teams lists the companies the token's user belongs to. It is the one endpoint that takes a Bearer token without x-team-id, so a client can let the person pick a company first.

Checking a key

GET /v1/whoami returns the key's user, company and permissions. Any valid key can call it, so it's the quickest way to prove a key works end to end.

Status codes

StatusCause
200 / 201Success
400Validation error. The body explains the offending field
401Missing, invalid, expired or revoked credentials
403Credentials are valid but don't include the permission this endpoint needs. The body names it in required
404Resource not found, or it belongs to a different company
409Conflict, such as deleting something that is still in use. The body says what is in the way

Endpoint surface (high-level)

Path prefixResource
/v1/invoicesInvoices: create, update, issue, send, mark paid, credit notes and refunds, PDFs
/v1/invoices/quotesQuotes: create, send, accept or decline, convert to an invoice, PDFs
/v1/invoices/clientsClients, the "billed to" side of invoices and quotes
/v1/invoices/statementsClient statements
/v1/invoices/dashboardInvoicing totals for the dashboard
/v1/invoices/history, /v1/invoices/archivesArchived years, and read-only documents from a closed financial year
/v1/track/timeTime entries
/v1/track/projectsProjects
/v1/track/sectionsSections within a project
/v1/track/tagsTags on time entries
/v1/track/todosTodos
/v1/track/reportsSaved reports, and running a report on demand
/v1/track/dashboardToday's and this week's time, for the dashboard
/v1/track/preferencesThe signed-in person's Track preferences
/v1/financials/accounts, /v1/financials/journal-entriesChart of accounts and the general journal
/v1/financials/imports, /v1/financials/statement-linesBank statement uploads, categorisation and bank rules
/v1/financials/suppliers, /v1/financials/bills, /v1/financials/receiptsSupplier invoices, supplier returns and expense receipts
/v1/financials/customers, /v1/financials/arCustomer balances, statements and aged receivables
/v1/financials/assets, /v1/financials/loans, /v1/financials/exchange-ratesFixed assets, loans and foreign currency
/v1/financials/reports, /v1/financials/exportsTrial balance, income statement, balance sheet, cash flow, general ledger and their CSV and Excel exports
/v1/financials/afs, /v1/financials/notesAnnual financial statements and their notes
/v1/financials/vat, /v1/financials/filings, /v1/financials/taxVAT201 returns, filing deadlines, income and deferred tax
/v1/inventory/items, /v1/inventory/stock-takes, /v1/inventory/adjustmentsItems, stock takes, write-offs and opening stock
/v1/inventory/purchase-ordersPurchase orders, deliveries and reorder drafts
/v1/inventory/price-lists, /v1/inventory/price-list-documentsPrice levels, client prices and customer-facing price lists
/v1/inventory/reports, /v1/inventory/dashboardStock on hand, movements, slow movers and the dashboard
/v1/teamMembers, invites, company settings, address and bank details
/v1/api-keysList, create and revoke API keys
/v1/whoamiThe current credentials' user, company and permissions

Payroll isn't in the public API yet. The exact list and response shapes are authoritative in the live reference.

Response shapes

Track endpoints answer with one envelope. Success is { data, pagination? }, where pagination carries page, limit, total, totalPages, hasNextPage and hasPreviousPage on list endpoints. Errors are { error: { code, message, details? } }, with a machine-readable code such as not_found, forbidden or validation_error.

Invoices, Financials, Inventory and Team endpoints return the resource directly. Lists are paged with page and limit and report total, totalPages and hasMore. Errors are { error, code } with a sentence you can show and a code to branch on. Financials and Inventory validate the body themselves, so a 400 names the offending field in details.

Amounts on invoices are in integer cents of the company's currency. Dates go in as YYYY-MM-DD and durations in seconds.

Idempotency

Mutating endpoints (POST/PATCH/DELETE) are not idempotent. If a workflow might retry, dedupe on your side or use a deterministic id pattern in your application logic.

MCP server

AI agents don't need the REST API. Looped hosts an MCP server at https://api.looped.sh/mcp that exposes the same data as tools. Claude, ChatGPT, Cursor and any other MCP client can connect to it, sign in as you through OAuth, and act with your permissions in every company you belong to. An API key in X-API-Key works there too.

Set it up from Settings → MCP server in Manage, which has the connect command for each client and an agent skill that teaches the assistant how to work in Looped.

To set up a new company, ask your agent to run the onboard-company prompt (or just say you're new to Looped). It checks what's missing, asks a few questions, reads your registration certificate, VAT letter or last year's financial statements, and fills in the company's details before moving on to bank statements and invoicing.

SDKs

We don't ship official SDKs yet. The CLI covers Track, Invoices and company admin from a terminal. For code, generate a client for your language from the OpenAPI spec with openapi-generator or a similar tool.

Where to go next

Are you an AI? Visit llms.txt — these docs as plain markdown.

On this page