Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB
Channels

ListChannels

get/v2/channels

Query parameters

reference_type'UNKNOWN_TYPE' | 'LOCATION' | 'FIRST_PARTY_INTEGRATION' | 'OAUTH_APPLICATION' | 'ONLINE_SITE' | 'ONLINE_CHECKOUT' | 'INVOICE' | 'GIFT_CARD' | 'GIFT_CARD_MARKETPLACE' | 'RECURRING_SUBSCRIPTION' | 'ONLINE_BOOKING_FLOW' | 'SQUARE_ASSISTANT' | 'CASH_LOCAL' | 'POINT_OF_SALE' | 'KIOSK'

The type of platform concept a channel can represent.

Type of reference associated to channel

reference_idstring

id of reference associated to channel

status'ACTIVE' | 'INACTIVE'

Status of channel

cursorstring

Cursor to fetch the next result

limitinteger

Maximum number of results to return. When not provided the returned results will be cap at 100 channels.

Response

Success

cursorstring

The token required to retrieve the next page of results.

Example response

{
  "channels": [
    {
      "created_at": "2022-10-25T16:27:00Z",
      "id": "CH_9C03D0B59",
      "merchant_id": "ML64FACEA",
      "name": "Contoso Fulfillment Application",
      "reference": {
        "id": "OA_9C03D0444",
        "type": "OAUTH_APPLICATION"
      },
      "status": "ACTIVE",
      "updated_at": "2022-10-25T16:48:00Z",
      "version": 1
    }
  ]
}