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

# Using Postman with the Platform API

> Test and explore the StackOne Platform API using the pre-configured Postman collection.

## Get the collection

The StackOne Platform API collection covers account management, connect sessions, actions, and more — auto-synced daily from the live OpenAPI spec.

<a href="https://www.postman.com/stackonehq/stackone-public/collection/4952c776-0324-491c-b597-3b6a4f78e2cb" target="_blank">
  <img src="https://run.pstmn.io/button.svg" alt="Run in Postman" height="48" />
</a>

The collection has Basic Auth pre-configured with `{{apiKey}}` as the username. Most endpoints also require the `x-account-id` header, set via `{{accountId}}`.

## Set up your environment

<Steps>
  <Step title="Create an environment">
    In Postman, click the **Environments** icon in the left sidebar, then **+** to create a new environment.
  </Step>

  <Step title="Add your credentials">
    | Variable    | Value                                                                                                        |
    | ----------- | ------------------------------------------------------------------------------------------------------------ |
    | `apiKey`    | Your StackOne API key — find it in the [dashboard](https://app.stackone.com) under **Settings → API Keys**   |
    | `accountId` | The linked account ID you want to target — visible in the [Accounts page](https://app.stackone.com/accounts) |
    | `baseUrl`   | `https://api.stackone.com` — change only if you're running a self-hosted StackOne region                     |
  </Step>

  <Step title="Select the environment">
    Select your environment from the dropdown in the top-right corner before sending any request.
  </Step>
</Steps>

## Explore the API

The collection is organised into folders by resource:

| Folder               | What it covers                                     |
| -------------------- | -------------------------------------------------- |
| **Accounts**         | List, retrieve, and manage linked accounts         |
| **Actions**          | Execute and list available actions via RPC         |
| **Connect Sessions** | Create connect session tokens for linking accounts |
| **Connectors**       | List enabled connectors and their metadata         |
| **MCP**              | MCP server configuration endpoints                 |
| **Proxy**            | Passthrough proxy requests                         |
| **Request Logs**     | Retrieve API request history                       |

<Tip>
  Start with **GET /accounts** to verify your API key, then use the returned account IDs as your `accountId` variable when exploring other endpoints.
</Tip>

## Also in the public workspace

<CardGroup cols={2}>
  <Card title="StackOne Legacy APIs" icon="rectangle-history" href="https://www.postman.com/stackonehq/stackone-public/collection/8d04033a-b6b1-4c91-8235-729f5c46123a">
    Unified vertical APIs (HRIS, ATS, CRM, etc.)
  </Card>

  <Card title="StackOne MCP" icon="plug" href="https://www.postman.com/stackonehq/stackone-public/collection/68ca4160009b6f9cc908f435">
    MCP server endpoints
  </Card>
</CardGroup>