POST
/
link
/
exchange
curl --request POST \
  --url https://production.trackstarhq.com/link/exchange \
  --header 'Content-Type: application/json' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>' \
  --data '{
  "auth_code": "auth_code",
  "customer_id": "customer_id"
}'
{
  "access_token": "your_permanent_access_token",
  "connection_id": "unique_connection_id",
  "integration_name": "shipbob",
  "customer_id": "customer_id",
  "available_actions": [
    "get_inventory",
    "get_products"
  ],
  "available_endpoints": [
    "GET /inventory",
    "GET /products"
  ]
}

Headers

​
x-trackstar-api-key
string
required

Your organization-level Trackstar API key.

Example:

"<x-trackstar-api-key>"

Body

application/json
​
auth_code
string
required

The authorization code returned from the frontend after a user installs an integration.

Example:

"auth_code"

​
customer_id
string | null

An identifier for your end customer.

Example:

"customer_id"

Response

200
application/json
Successful response
​
access_token
string
required

The permanent access token for the integration used to make requests to the Trackstar API.

Example:

"your_permanent_access_token"

​
connection_id
string
required

A unique connection ID for the integration.

Example:

"unique_connection_id"

​
integration_name
string
required

The name of the integration that was installed.

Example:

"shipbob"

​
customer_id
string | null
required

An identifier for your end customer.

Example:

"customer_id"

​
available_actions
string[]
required

A list of actions that the integration supports.

Actions supported by the integration

Example:
["get_inventory", "get_products"]
​
available_endpoints
string[]
required

DEPRECATED: Use available_actions instead.

Endpoints supported by the integration

Example:
["GET /inventory", "GET /products"]
Create Link TokenGet Connections