v1

latestOpenAPI 3.1.02026-07-22802,2441.7 MB

Auth

Get Connections

Returns connected integrations for your organization.

get/connections

Query parameters

page_tokenstring nullable

Example:page_token

The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.

Headers

x-trackstar-api-keystring required

Example:<x-trackstar-api-key>

Your organization-level Trackstar API key.

Response

Successful response

next_tokenstring nullable

See pagination for more details.

total_countinteger

The number of items returned.

Example response

{
  "data": [
    {
      "connection_id": "07b344db-0304-4866-9ae1-ac8af5292a28",
      "integration_name": "integration_name",
      "integration_display_name": "ShipBob",
      "customer_id": "customer_id",
      "created_at": "2023-01-01T00:00:00Z",
      "last_used": "2023-01-01T00:00:00Z",
      "times_used": 1,
      "sync_schedules": [
        {
          "function_name": "get_inventory",
          "last_crawl_start": "2023-01-01T00:00:00Z",
          "last_crawl_end": "2023-01-01T00:00:00Z",
          "latest_data": "2023-01-01T00:00:00Z",
          "sync_frequency": 3600,
          "sync_status": "enabled"
        }
      ],
      "errors": [
        {
          "error_message": "error_message",
          "affected_endpoints": [
            {
              "endpoint": "GET /connection",
              "preventing_sync": false
            }
          ],
          "first_seen": "2023-01-01T00:00:00Z",
          "last_seen": "2023-01-01T00:00:00Z"
        }
      ],
      "available_actions": [
        "get_inventory",
        "get_products"
      ],
      "integration_type": "wms",
      "webhooks_disabled": false,
      "historical_sync_completed": {
        "get_bills": true,
        "get_inbound_shipments": true,
        "get_inventory": true,
        "get_orders": true,
        "get_products": true,
        "get_returns": true,
        "get_warehouse_customers": true,
        "get_warehouse_locations": true,
        "get_warehouses": true
      },
      "me": {
        "account_id": "account_12345",
        "account_name": "My WMS Account"
      }
    }
  ],
  "next_token": "next_token",
  "total_count": 1
}