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

# Getting Started

> Programmatic access to Firstbase provisioning, inventory, orders, and people management.

The Firstbase Public API lets integrators automate device lifecycle workflows: provisioning people, placing orders, managing inventory, and coordinating returns, without using the admin portal.

Production base URL: `https://apipub.firstbasehq.com`

## What you can build

* **Catalog**: Discover available SKUs, brands, and categories for ordering and asset creation
* **Inventory**: Look up stocked devices, update inventory details, and manage assets across warehouses
* **Inventory Levels**: Set and maintain target stock levels per SKU and warehouse
* **Inventory Orders**: Place and track inventory replenishment orders
* **ITAD**: Submit and track IT asset disposition requests for eligible devices
* **New Joiners**: Monitor onboarding progress and send reminders to new joiners
* **Offices**: List and update office locations used for equipment delivery
* **Orders**: Create, approve, and track equipment orders for people or offices
* **Packages**: Define and maintain equipment packages assigned to people
* **People**: Provision and manage users with SCIM-compatible create, update, and offboard flows
* **Regions**: List the regions your organization can order and ship into
* **Replacements**: Request and track equipment replacements for damaged or outdated devices
* **Returns**: Create return orders and process returned equipment
* **Shipment**: Look up shipment status by tracking number and list supported carriers
* **Shipment Notices**: Submit advance shipping notices when sending equipment to Firstbase
* **Warehouses**: List warehouses available to your organization for inventory and fulfillment

## Authentication

The Public API uses API key authentication via the `Authorization` header.

```
Authorization: ApiKey <token_value>
```

Organization admins create keys in the Firstbase admin portal under **Settings → API Access**. The key is shown only once at creation. Rotate compromised keys immediately by revoking the old key and issuing a new one.

<Warning>
  Never commit API keys to source control or share them in client-side code.
</Warning>

## Make your first request

Prerequisites:

* A Firstbase organization with admin access
* Permission to create a Public API key in the admin portal

```bash theme={null}
curl -sS "https://apipub.firstbasehq.com/api/v1/regions" \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Accept: application/json"
```

<Steps>
  <Step title="Set your base URL">
    Use `https://apipub.firstbasehq.com` in production.
  </Step>

  <Step title="Add your API key">
    Pass `Authorization: ApiKey <token_value>` on every request.
  </Step>

  <Step title="Explore endpoints">
    Browse the API reference sections below, or open [Swagger UI](https://apipub.firstbasehq.com/swagger-ui/index.html).
  </Step>
</Steps>

When testing in [Swagger UI](https://apipub.firstbasehq.com/swagger-ui/index.html), authorize with the same `ApiKey <token_value>` format in the **Authorize** dialog. On endpoint pages in this site, use the **Try it** panel and enter your key the same way.