Bulk retrieve channelsBeta

POST

/v2/channels/bulk-retrieve

Guide

Look up a list of channels

Try in API Explorer

Link to section

Request body

Example code

Link to section

channel_ids

string [ ]

Required

Link to section

Response fields

Link to section

errors

Information about errors encountered during the request.

Link to section

responses

A map of channel IDs to channel responses which tell whether retrieval for a specific channel is success or not. Channel response of a success retrieval would contain channel info whereas channel response of a failed retrieval would have error info.

Link to section

Examples

All versions ->

POST /v2/channels/bulk-retrieve

curl https://connect.squareup.com/v2/channels/bulk-retrieve \
  -X POST \
  -H 'Square-Version: 2025-10-16' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "channel_ids": [
      "CH_9C03D0B59",
      "CH_6X139B5MN",
      "NOT_EXISTING"
    ]
  }'

Response JSON

{
  "responses": {
    "CH_9C03D0B59": {
      "channel": {
        "id": "CH_9C03D0B59",
        "merchant_id": "ML64FACEA",
        "name": "State Street Store",
        "status": "ACTIVE",
        "version": 1,
        "reference": {
          "type": "LOCATION",
          "id": "OA_9C03D0B59"
        },
        "created_at": "2022-10-25T16:27:00Z",
        "updated_at": "2022-10-25T16:48:00Z"
      }
    },
    "CH_6X139B5MN": {
      "channel": {
        "id": "CH_6X139B5MN",
        "merchant_id": "ML64FACEA",
        "name": "Contoso Fulfillment Application",
        "status": "ACTIVE",
        "version": 1,
        "reference": {
          "type": "OAUTH_APPLICATION",
          "id": "OA_9C03D0444"
        },
        "created_at": "2022-10-25T16:27:00Z",
        "updated_at": "2022-10-25T16:48:00Z"
      }
    },
    "NOT_EXISTING": {
      "errors": [
        {
          "code": "NOT_FOUND"
        }
      ]
    }
  }
}