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

# Developer API

> Generate and manage API access tokens from your BeatPass account settings.

<Tooltip tip="Secret keys that let external applications access your BeatPass account through the API. Treat them like passwords." cta="Developer docs" href="/developers/overview">API access tokens</Tooltip> allow authorized users to connect third-party applications, tools, or scripts to their BeatPass account. API access is **invite-only** — it must be granted by the BeatPass team before you can generate tokens.

<Warning>
  API access is **invite-only**. Developer tokens are granted on a case-by-case basis. To request access, contact [**contact@beatpass.ca**](mailto:contact@beatpass.ca). See [Authentication](/developers/auth) for details.
</Warning>

***

## What Are API Tokens?

API tokens are like passwords for apps:

* They allow external programs to access your BeatPass account
* Each token has a name so you can identify what it's used for
* Tokens can be deleted without affecting your main password

<Note>
  The **Developers** section only appears in account settings when API access has been enabled for your account.
</Note>

***

## Creating an API Token

<Steps>
  <Step title="Go to Account Settings">
    Open **Account Settings** from the user menu, then open **Developers**.
  </Step>

  <Step title="Click Create Token">
    Click **Create token**.
  </Step>

  <Step title="Name Your Token">
    In **Create new token**, enter a **Token name**. BeatPass currently requires 3 to 100 characters.
  </Step>

  <Step title="Save the Token">
    Click **Create** to generate your token.
  </Step>

  <Step title="Copy Your Token">
    Copy the token immediately. BeatPass only shows the full token once. When you are done, click **Done**.
  </Step>
</Steps>

<Warning>
  The complete token is only displayed once when created. Copy and store it securely. If you lose it, you'll need to create a new token.
</Warning>

***

## Token Security

### Best Practices

* **Keep tokens secret** — Never share tokens publicly or commit them to code repositories
* **Use descriptive names** — Name tokens by their use so you know what to revoke later
* **Revoke unused tokens** — Delete tokens you no longer need
* **Rotate periodically** — Consider creating new tokens and deleting old ones regularly

### What Tokens Can Do

Tokens provide access to your account through the BeatPass API. The specific permissions depend on your account type and the API endpoints used.

***

## Deleting API Tokens

If you no longer need a token or suspect it's compromised:

1. Open **Account Settings** from the user menu.
2. Open **Developers** and find the token in your list.
3. Click **Delete**
4. Confirm the **Delete token?** prompt

### Effects of Deletion

* The token stops working immediately
* Any applications using that token will lose access
* You cannot recover a deleted token (create a new one instead)

<Tip>
  If you're not sure which token an application is using, create a new one with a clear name and update the application, then delete the old tokens.
</Tip>

***

## Managing Multiple Tokens

You can create multiple tokens for different purposes:

| Token Name       | Use Case                         |
| ---------------- | -------------------------------- |
| "Mobile App"     | Your personal mobile integration |
| "Analytics Tool" | Third-party analytics service    |
| "Backup Script"  | Automated backup program         |

This way, if one token is compromised, you can revoke just that one without affecting other integrations.

***

## Common Questions

<AccordionGroup>
  <Accordion title="I lost my token. Can I see it again?">
    No. For security, the full token is only shown once when created. You'll need to create a new token.
  </Accordion>

  <Accordion title="How many tokens can I create?">
    You can create multiple tokens. Keep only the ones you need so the list stays easy to manage.
  </Accordion>

  <Accordion title="Will deleting a token log me out?">
    No. API tokens are separate from your login session. Deleting a token only affects applications using that specific token.
  </Accordion>

  <Accordion title="What if someone gets my token?">
    Delete the token immediately in your settings. Then create a new one and update any legitimate applications that need access.
  </Accordion>
</AccordionGroup>

***

## API Documentation

For developers looking to build integrations:

* Start with [Developers Overview](/developers/overview)
* Review [Quickstart](/developers/quickstart)
* Browse the [API Reference](/developers/api-reference/overview)

***

## Related Topics

<CardGroup cols={2}>
  <Card title="Account Security" icon="shield-halved" href="/help/account-settings/two-factor-authentication">
    Secure your account with 2FA.
  </Card>

  <Card title="Active Sessions" icon="desktop" href="/help/account-settings/active-sessions">
    Manage where you're logged in.
  </Card>
</CardGroup>

<Snippet file="sections/need-help.mdx" />