> For the complete documentation index, see [llms.txt](https://www.boxhero.io/docs/llms.txt). Every page is available as Markdown by appending `.md` to its URL; this page is [Markdown](https://www.boxhero.io/docs/developers/api/quickstart.md).

# Quickstart

> Issue an API token and make your first request to the BoxHero API.

This guide takes you from no token to your first successful API call.

## 1. Issue an API token

In the desktop web app, open the team you want to connect and go to `Settings` > `Integrations`. Generate a new API token and copy it.

![](https://assets.boxhero.io/docs/images/e6bbc8fa4eab21ec0f9ebe74893cd3a6e0c6a5d4d178ae02478ef99adbe4c4cd-2214x1431.jpg)

> **Caution**
>
> **Note**: A token is bound to the team it was issued in and gives full access to that team's data through the API. Keep it on your server — never put it in a mobile app, browser code, or a public repository.

## 2. Make your first request

Call [Get the linked team](https://www.boxhero.io/docs/developers/api/reference/teams/get-linked-team) to check that the token works. Send the token in the `Authorization` header:

```bash
curl https://rest.boxhero-app.com/v1/teams/linked \
  -H "Authorization: Bearer $BOXHERO_API_TOKEN"
```

The response describes the team the token belongs to:

```json
{
  "id": 149058,
  "name": "Acme Retail",
  "mode": 2,
  "currency_symbol": "$",
  "currency_code": "USD",
  "price_decimal_places": 2,
  "memo": null
}
```

If you get a `401` instead, the token is missing or was copied incompletely. See [Errors](https://www.boxhero.io/docs/developers/api/errors) for the error format.

> **Note**
>
> Most endpoints work only for teams that manage stock by [location](https://www.boxhero.io/docs/concepts/locations). For other teams they return an error of type `/errors/invalid-team-mode`. A location team has `mode` set to `2` in the response above.

## 3. Next steps

- List your inventory with [List items](https://www.boxhero.io/docs/developers/api/reference/items/list-items), and learn how to fetch every page in [Pagination](https://www.boxhero.io/docs/developers/api/pagination).
- Record stock changes with [Create a transaction](https://www.boxhero.io/docs/developers/api/reference/transactions/create-transaction) — see [Transactions](https://www.boxhero.io/docs/developers/api/reference/transactions) for the rules.
- Get notified of changes instead of polling with [Webhooks](https://www.boxhero.io/docs/developers/webhooks/overview).
- Browse every endpoint in the [API reference](https://www.boxhero.io/docs/developers/api/reference).