Channels API Reference
API Reference/Channels

Channels

For authentication instructions, see API overview.

Endpoints

get/api/v2/channels
post/api/v2/channels
get/api/v2/channels/:id
put/api/v2/channels/:id
patch/api/v2/channels/:id
delete/api/v2/channels/deleted/:id
get

List all channels

Returns a list of channels. The channels are returned in sorted order, with the most recent appearing first.

Query parameters

  • limitinteger

    The number of records to return

  • pageinteger

    The page number

  • orderstring

    The order of the records

  • sortBystring

    The sort of the records

  • fieldsstring

    The filter of the records

  • pstring

    policyFilters

  • qstring

    search query

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/channels

Response

No response schema
post

Create channels

Create channels. You need to pass through any required fields, and you can optionally pass through other fields.

Request body

  • channelNamestring
  • linkedPagesarray

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X POST -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/channels \
	-d 'channelName="channel1"' \
	-d 'linkedPages="array"'

Response

No response schema
get

Retrieve channels

Returns a single channel, which you can request by passing through an id in the url.

Path parameters

  • idstring

    ID of the channel

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/channels/:id

Response

No response schema
put

Update channels

Path parameters

  • idstring

    ID of the channel

Request body

  • channelNamestring
  • linkedPagesarray

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X PUT \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/channels/:id \
	-d 'channelName="channel1"' \
	-d 'linkedPages="array"'

Response

No response schema
patch

Update channels soft

Update channels soft by setting the values of the parameters passed. Any parameters not set will be unchanged.

Path parameters

  • idstring

    ID of the channel

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/channels/:id

Response

No response schema
delete

Delete channels

Path parameters

  • idstring

    ID of the channel

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X DELETE \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/channels/deleted/:id

Response

No response schema