---
title: "List Company Connections"
method: GET
path: "/company_connections"
tags: ["Company Connect"]
---

# List Company Connections

`GET /company_connections`

## Request

- Base URL: `https://api.getpinwheel.com/v1`
- URL: `https://api.getpinwheel.com/v1/company_connections`
- Auth: API key in header `X-API-SECRET`
- TypeScript: <https://skmtc.dev/getpinwheel/apis/pinwheel/docs/company_connections/get.ts> (a function with typed inputs; its response is checked against the schema)

List all Company Connections. This is a paginated endpoint; see how Pinwheel implements pagination <a href='https://docs.pinwheelapi.com/docs/pagination-1' target='_blank'>here</a>.

## Query parameters

- `cursor` string: Cursor for the page you want to retrieve.
- `limit` integer: The maximum number of results to return.

## Headers

- `Pinwheel-Version` '2025-07-08' | '2023-11-22' | '2023-07-18' | '2023-04-18' | '2022-09-09' | '2022-06-22' | '2022-03-02', required

## Response `200`

OK

- object
  - `meta` PaginationMeta, required
    - `count` integer: Number of objects returned.
    - `next_cursor` string: Pointer to the next page of results.
  - `data` CompanyConnectionBase[], required
    - `id` string, uuid, required: Unique identifier for the object.
    - `created_at` string, date-time, required: ISO 8601 timestamp of created time.
    - `company_name` string, required: Name of the company used in a Company Connection.
    - `status` 'ready_to_connect' | 'connection_failed' | 'processing' | 'data_available' | 'reconnect_needed', required: The status of the Company Connection. <a href='https://docs.pinwheelapi.com/docs/company-connect-technical-implementation#company-connection-status' target='_blank'>See documentation for details</a>.
    - `status_updated_at` string, date-time, required: Timestamp of when the Company Connection's status was last updated.

---

[API](https://skmtc.dev/getpinwheel/apis/pinwheel.md) - [All operations](https://skmtc.dev/getpinwheel/apis/pinwheel/llms.txt) - [OpenAPI document](https://skmtc.dev/getpinwheel/apis/pinwheel/revisions/4543563d0f72?raw)
