> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://partner.docs.trychannel3.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://partner.docs.trychannel3.com/_mcp/server.

# List connections

GET https://partners.trychannel3.com/v0/partner/merchants/{customer_id}/connections

This merchant's state across every available platform.

Reference: https://partner.docs.trychannel3.com/api-overview/getpartnermerchantconnectionsroute

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: Channel3 Partner Program API
  version: 1.0.0
paths:
  /v0/partner/merchants/{customer_id}/connections:
    get:
      operationId: getpartnermerchantconnectionsroute
      summary: List connections
      description: This merchant's state across every available platform.
      tags:
        - subpackage_connections
      parameters:
        - name: customer_id
          in: path
          required: true
          schema:
            type: string
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerConnectionsResponse'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
servers:
  - url: https://partners.trychannel3.com
    description: Production
components:
  schemas:
    PlatformSlug:
      type: string
      enum:
        - channel3
        - google
        - microsoft
        - openai
        - paypal
        - perplexity
        - stripe
        - ucp
        - shopify
        - woocommerce
        - bigcommerce
        - magento
        - salesforce_commerce
        - akeneo
        - web_crawl
      description: Platforms Channel3 can ingest from or distribute to.
      title: PlatformSlug
    PlatformCategory:
      type: string
      enum:
        - distribution
        - ingestion
      description: Catalog source vs. distribution destination.
      title: PlatformCategory
    ConnectionStatus:
      type: string
      enum:
        - not_connected
        - action_required
        - active
      description: Connection health for a merchant on a platform.
      title: ConnectionStatus
    ConnectionAccount:
      type: object
      properties:
        id:
          type: string
        name:
          type:
            - string
            - 'null'
        store_url:
          type:
            - string
            - 'null'
      required:
        - id
      description: A platform-side account/store attached to a connection.
      title: ConnectionAccount
    SyncState:
      type: string
      enum:
        - pending
        - syncing
        - live
      description: >-
        Delivery lifecycle: nothing delivered yet, delivered but unconfirmed, or
        confirmed live.
      title: SyncState
    ConnectionSync:
      type: object
      properties:
        state:
          $ref: '#/components/schemas/SyncState'
          description: Data-delivery lifecycle state.
        last_synced_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Most recent sync activity: last status poll (Google/Microsoft) or
            last feed fetch/generation (OpenAI).
        total_products:
          type:
            - integer
            - 'null'
          description: Products Channel3 is distributing to this platform.
        synced_products:
          type:
            - integer
            - 'null'
          description: Products fully synced with Channel3 data on this platform.
      required:
        - state
      description: Sync status for distribution connections; null on ingestion platforms.
      title: ConnectionSync
    PartnerConnection:
      type: object
      properties:
        platform:
          $ref: '#/components/schemas/PlatformSlug'
        category:
          $ref: '#/components/schemas/PlatformCategory'
        status:
          $ref: '#/components/schemas/ConnectionStatus'
          description: >-
            `not_connected` (merchant hasn't connected this platform),
            `action_required` (a follow-up step is needed), or `active`.
        display_name:
          type: string
          description: >-
            Human-readable label: store/account name or domain when connected,
            otherwise the platform name.
        id:
          type:
            - string
            - 'null'
          description: >-
            Stable identifier for this connection; use it to diff across polls.
            Absent when the platform is not connected.
        connected_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When the merchant connected this platform. Null when not connected.
        accounts:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/ConnectionAccount'
          description: >-
            Platform-side accounts attached to this connection; present only on
            multi-account platforms (Google, Microsoft).
        sync:
          oneOf:
            - $ref: '#/components/schemas/ConnectionSync'
            - type: 'null'
          description: >-
            Data-delivery status; present only on connected distribution
            platforms.
      required:
        - platform
        - category
        - status
        - display_name
      description: A merchant's state on one platform, as exposed to partners.
      title: PartnerConnection
    PartnerConnectionsResponse:
      type: object
      properties:
        connections:
          type: array
          items:
            $ref: '#/components/schemas/PartnerConnection'
      required:
        - connections
      description: A merchant's state across every available platform.
      title: PartnerConnectionsResponse
    ErrorResponseDetail:
      oneOf:
        - type: string
        - type: array
          items:
            type: object
            additionalProperties:
              description: Any type
      title: ErrorResponseDetail
    ErrorResponse:
      type: object
      properties:
        detail:
          $ref: '#/components/schemas/ErrorResponseDetail'
      required:
        - detail
      title: ErrorResponse
  securitySchemes:
    APIKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

```

## Examples



**Request**

```json
{}
```

**Response**

```json
{
  "connections": [
    {
      "platform": "channel3",
      "category": "distribution",
      "status": "not_connected",
      "display_name": "Channel3 Main Account",
      "id": null,
      "connected_at": null,
      "accounts": null,
      "sync": null
    },
    {
      "platform": "google",
      "category": "distribution",
      "status": "active",
      "display_name": "Acme Corp Google Store",
      "id": "conn-1234-google",
      "connected_at": "2024-01-15T09:30:00Z",
      "accounts": [
        {
          "id": "acct-5678",
          "name": "Acme Corp Main Account",
          "store_url": "https://store.google.com/acmecorp"
        }
      ],
      "sync": {
        "state": "live",
        "last_synced_at": "2024-04-20T14:45:00Z",
        "total_products": 150,
        "synced_products": 150
      }
    },
    {
      "platform": "shopify",
      "category": "ingestion",
      "status": "action_required",
      "display_name": "Acme Shopify Store",
      "id": "conn-7890-shopify",
      "connected_at": "2024-02-10T11:00:00Z",
      "accounts": null,
      "sync": null
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://partners.trychannel3.com/v0/partner/merchants/customer_id/connections"

payload = {}
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://partners.trychannel3.com/v0/partner/merchants/customer_id/connections';
const options = {
  method: 'GET',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://partners.trychannel3.com/v0/partner/merchants/customer_id/connections"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://partners.trychannel3.com/v0/partner/merchants/customer_id/connections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://partners.trychannel3.com/v0/partner/merchants/customer_id/connections")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://partners.trychannel3.com/v0/partner/merchants/customer_id/connections', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://partners.trychannel3.com/v0/partner/merchants/customer_id/connections");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://partners.trychannel3.com/v0/partner/merchants/customer_id/connections")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```