Back-office and merchant operations
The Admin API is how you operate Fire spark from the merchant side. Use it to build internal tools, sync customer data in bulk, query orders across every channel, and migrate records from legacy systems — without touching customer-facing flows or POS integrations directly. If the Storefront API powers the channels your customers use (app, web, kiosk), and the Integrations API connects your POS and RMS to those channels, the Admin API is the layer for back-office and operations: dashboards, CRM bridges, data pipelines, and onboarding scripts.New to Fire spark?
Connect a merchant in the dashboard before calling the Admin API.
What you can build
| Use case | Typical consumer |
|---|---|
| Operations dashboard | Internal team monitoring orders across channels |
| CRM sync | Push and pull customer profiles in bulk |
| Reporting and BI | Export order history for analytics |
| Data migration | Import customers and orders from a legacy platform |
| Automation scripts | Scheduled jobs that reconcile or update merchant data |
How it works
Authenticate your server
Your backend obtains an access token using OAuth 2.0 client credentials.
Store your
client_id and client_secret securely — never expose them in
client-side code.Operate on merchant-wide data
Call endpoints to list and manage customers in bulk, query orders across all
channels, or run migration jobs for onboarding.
API areas
Authentication
OAuth 2.0 client credentials secure access to every Admin API endpoint. Authenticate from your server before making bulk or migration calls.Authorize
Obtain an access token with client credentials.
Customers (bulk)
Create, read, update, and delete customer records in bulk. Use these endpoints to sync a CRM, import a contact list, or reconcile customer data across systems.| Endpoint | Purpose |
|---|---|
GET /customers/bulk | List or export customers |
POST /customers/bulk | Create customers in batch |
PATCH /customers/bulk | Update customers in batch |
DELETE /customers/bulk | Remove customers in batch |
Orders
Query orders across all channels and stores for a merchant. Use this to power operational dashboards, support tools, or reporting pipelines.List orders
Retrieve orders across channels.
Migrate
Import customers and historical orders from a legacy platform during onboarding. Migration endpoints support batch imports with a revert path if something goes wrong.Migrate customers
Import customers from a legacy system
Migrate orders
Import historical orders
Revert migration
Roll back a migration batch
Admin API vs Storefront API vs Integrations API
| Admin API | Storefront API | Integrations API | |
|---|---|---|---|
| Who calls it | Merchant backend, internal tools | Customer-facing app, web, kiosk | POS/RMS partners |
| Authentication | Client credentials (server) | OIDC ID token exchange (client) | Client credentials (server) |
| Customers | Bulk read/write, migration | Per-customer profile and consent | Not applicable |
| Orders | Query across channels | Create and manage per customer | Receive via webhook, inject to POS |
| Primary goal | Operate and onboard merchant data | Build custom sales channels | Sync menus and inject orders |
Base URL
Next steps
Authorize
Get an access token
Developers guide
Set up your server integration
Bulk customers
Read and manage customers in bulk
Rate limits
Review rate limits and quotas