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

# Listing companies

> Retrieve all companies registered under your integration using the SynchPay API.

## Overview

The `/company/list` endpoint returns all companies associated with your integration. Use it to look up company IDs, verify which companies are connected, or synchronize your system with SynchPay.

## How it works

<Steps>
  <Step title="Obtain an access token">
    Request an access token by calling `/auth/token` with your `ClientId` and `ClientSecret`.
    Refer to the [Authorization](/synchpay/auth) section for details.
  </Step>

  <Step title="Call the endpoint">
    Make a `GET` request to `/company/list` with your access token. No additional
    parameters are required — the endpoint returns every company linked to your
    integration.
  </Step>

  <Step title="Process the results">
    The response contains an array of company objects, each with an `id`, `name`,
    and optional `referenceId`.
  </Step>
</Steps>

## Retrieving your companies

### Endpoint

* **URL**: `https://api.synchpay.com/company/list`
* **Method**: `GET`
* **Authorization**: `Bearer <AccessToken>`

This endpoint requires no query parameters or request body.

### Response

The response contains a single `companies` array:

| Property      | Type   | Description                                                                     |
| ------------- | ------ | ------------------------------------------------------------------------------- |
| `id`          | string | The unique identifier for the company.                                          |
| `name`        | string | The company name provided during registration.                                  |
| `referenceId` | string | The custom reference ID assigned to the company, if one was set. Can be `null`. |

### Example request

```http theme={null}
GET /company/list HTTP/1.1
Host: api.synchpay.com
Authorization: Bearer eyJhbGciOi...
```

### Example response

```json theme={null}
{
  "companies": [
    {
      "id": "0ba2d920-7588-407f-8553-afc4f073c9b8",
      "name": "Downtown Fitness",
      "referenceId": "loc-001"
    },
    {
      "id": "7c3e1a45-92fd-4b10-a6df-8e5d4f2c1b09",
      "name": "Uptown Wellness",
      "referenceId": null
    }
  ]
}
```

## When to use this endpoint

* **Syncing company data** — Keep your system up to date with the companies registered in SynchPay.
* **Looking up companies** — Find a company's `id` or `referenceId`. Use `referenceId` with `/company/{companyReferenceId}/status` and the [company locations](/synchpay/company-locations) endpoints.
* **Verifying registrations** — Confirm that a company was successfully created after calling `/company/create`.