---
title: "Get Connections"
method: GET
path: "/connections"
tags: ["Auth"]
---

# Get Connections

`GET /connections`

Returns connected integrations for your organization.

## Query parameters

- `page_token` string, nullable

## Headers

- `x-trackstar-api-key` string, required

## Response `200`

Successful response

- GetConnectionsResponse
  - `data` Connection[] — A list of connections for your organization.
    - `connection_id` string, required — The unique ID of the connection.
    - `integration_name` string, required — The name of the integration associated with the connection.
    - `integration_display_name` string, required — The human-readable display name of the integration associated with the connection.
    - `customer_id` string, nullable, required — An identifier for your end customer.
    - `created_at` string, date-time, required — The date the connection was created.
    - `last_used` string, date-time, nullable, required — The date the connection was last updated.
    - `times_used` integer, nullable, required — The number of times the connection has been used in a request to the Trackstar API. Equal to the number of API calls made with this connection.
    - `sync_schedules` SyncSchedule[], required — A list of sync schedules for the connection.
      - `function_name` string, required — The function that is being synced.
      - `last_crawl_start` string, date-time, nullable, required — The date when Trackstar last started a crawl for this function.
      - `last_crawl_end` string, date-time, nullable, required — The date when Trackstar last completed a crawl for this function.
      - `latest_data` string, date-time, nullable, required — The date of the most recent data successfully fetched for this function.
      - `sync_frequency` integer, required — The frequency of the sync in seconds.
      - `sync_status` 'enabled' | 'disabled' | 'sync_in_progress' | 'first_sync_in_progress' | 'error' | 'stuck', nullable, required — The status of the sync.
    - `errors` ConnectionError[], required — A list of errors for the connection. e.g. missing permissions, invalid credentials, etc.
      - `error_message` string, required — The error message.
      - `affected_endpoints` AffectedEndpoints[], required — A list of endpoints that were affected by the error and whether the error is preventing the sync from completing.
        - `endpoint` string, required — The endpoint that was affected.
        - `preventing_sync` boolean, required — If True, the error is preventing the sync from completing. If False, we are able to sync but there may be data or fields that we are unable to fetch.
      - `first_seen` string, date-time, required — The date the error was first seen.
      - `last_seen` string, date-time, required — The date the error was last seen.
    - `available_actions` string[], required — A list of actions that the integration supports.
    - `integration_type` 'wms' | 'freight' | 'cart' | 'carrier' | 'erp', required — The type of the integration.
    - `webhooks_disabled` boolean, nullable, required — If True, create & update webhooks for Trackstar objects (e.g. order.created) will not be sent for this connection. Connection specific webhooks (e.g. connection.deleted) will still be sent.
    - `paused` boolean, required — If True, every sync schedule for this connection is paused and no data will sync until at least one schedule is resumed.
    - `paused_at` string, date-time, nullable, required — The date every sync schedule for this connection was paused. Null if the connection is not currently paused.
    - `historical_sync_completed` object, required — Indicates whether the initial historical sync has been completed for each function. If a key is not present or empty, assume the historical sync has not been completed for that function.
    - `me` unknown, required
  - `next_token` string, nullable — See [pagination](/how-to-guides/about-the-api#pagination) for more details.
  - `total_count` integer — The number of items returned.

## Other responses

- `422` — Validation error

---

[API](https://skmtc.net/trackstarhq/apis/trackstar-api.md) · [All operations](https://skmtc.net/trackstarhq/apis/trackstar-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/trackstarhq/trackstar-api/versions/4bc5c6e1a8bf/schema)