Sign in

v1

latestOpenAPI 3.0.12026-07-243266138.0 KB
Channels

Get channels

This endpoint retrieves all channels for your account.

get/channels

Headers

Authorizationstring required

An OAuth2 authorization header with an access token, see OAuth2.

Response

The list of channels associated with your account.

idstring

The channel UUID.

createdAtstring date-time

The date and time when the channel was created, in the ISO 8601 and RFC3339 compliant format yyyy-MM-dd’T’HH:mm:ss.SSSZ. Check the glossary for examples of valid datetime formats.

updatedAtstring date-time

The date and time when the channel was last modified, in the ISO 8601 and RFC3339 compliant format yyyy-MM-dd’T’HH:mm:ss.SSSZ. Check the glossary for examples of valid datetime formats.

namestring

The name of the channel.

addressstring

The address that is associated with the channel.

urlstring

A URL that to a website that the channel represents.

logoUrlstring

A URL to the channel logo.

accountRefstring

A UUID as account reference.

localestring locale

The locale that is associated with the channel.

Example response

[
  {
    "id": "chl-xxxxxxxa-yyyy-xxxx-yyyy-xxxxxxxxxxxx",
    "createdAt": "2018-02-01T17:09:41.79Z",
    "updatedAt": "2018-02-01T17:09:41.79Z",
    "name": "my_example_channel",
    "address": "Anystr. 17, 12345, Anycity, Anystate 12345",
    "url": "https://wwww.myshop.fiction",
    "logoUrl": "https://wwww.myshop.fiction/logo.png",
    "accountRef": "acc-xxxxxxxa-yyyy-xxxx-yyyy-xxxxxxxxxxxx",
    "locale": "en_US"
  }
]
All 32 operations