> ## Documentation Index
> Fetch the complete documentation index at: https://firespark.cloud/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Manage merchant operations, bulk customer data, and order visibility through Fire spark's Admin API.

## 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](/docs/storefront-api/introduction) powers the channels your customers use (app, web, kiosk), and the [Integrations API](/docs/integrations-api/introduction) 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.

<Card title="New to Fire spark?" icon="lightbulb" href="/docs/guides/connecting-a-merchant">
  Connect a merchant in the dashboard before calling the Admin API.
</Card>

## 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 |

The Admin API is **server-to-server only**. It is not for mobile apps, websites, or kiosks where end customers sign in.

## How it works

<Steps>
  <Step title="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.
  </Step>

  <Step title="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.
  </Step>

  <Step title="Changes propagate through Fire spark">
    Customer updates and migrated records flow into the same omnichannel layer
    that powers your Storefront and Integrations APIs. A customer created through
    the Admin API is available to every connected channel.
  </Step>
</Steps>

## 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.

<Card title="Token" icon="key" href="/docs/admin-api/oauth/token/post">
  Obtain an access token with client credentials.
</Card>

### 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.

<Card title="List orders" icon="list" href="/docs/admin-api/orders/get">
  Retrieve orders across channels.
</Card>

### 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.

<CardGroup cols={3}>
  <Card title="Migrate customers" icon="user-plus" href="/docs/storefront-api/customers/migrate/post">
    Import customers from a legacy system
  </Card>

  <Card title="Migrate orders" icon="receipt" href="/docs/storefront-api/customers/migrate/orders/post">
    Import historical orders
  </Card>

  <Card title="Revert migration" icon="rotate-left" href="/docs/storefront-api/customers/migrate/revert/delete">
    Roll back a migration batch
  </Card>
</CardGroup>

## 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       |

Use the API that matches the actor: customers interact through Storefront, kitchen systems through Integrations, and your operations team through Admin.

## Base URL

```
https://firespark.cloud/api/admin/v1
```

<Card title="Postman collection" icon="download" href="/docs/assets/fire-spark-admin-api-2026-07-26.postman_collection.json">
  Download all Admin API endpoints. Set `client_id` and `client_secret`, then run the Token request to populate `bearerToken`.
</Card>

## Next steps

<CardGroup cols={2}>
  <Card title="Token" icon="key" href="/docs/admin-api/oauth/token/post">
    Get an access token
  </Card>

  <Card title="Developers guide" icon="code" href="/docs/admin-api/guides/developers">
    Set up your server integration
  </Card>

  <Card title="Bulk customers" icon="users" href="/docs/admin-api/customers/bulk/get">
    Read and manage customers in bulk
  </Card>

  <Card title="Rate limits" icon="gauge" href="/docs/admin-api/resources/rate-limit">
    Review rate limits and quotas
  </Card>
</CardGroup>