v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB
PublishingChannel

Retrieves a PublishingChannel resource.

Retrieves a PublishingChannel resource.

get/publishing_channels/{id}

Path parameters

idstring required

Resource identifier

Response

PublishingChannel resource

idstring
integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring

Unique identifier for publishing channel

createdstring

The time and date the publishing channel was created

updatedstring nullable

The time and date the publishing channel was last modified

isActiveboolean nullable

Whether the publishing channel is active or not

sharedboolean nullable

Whether the publishing channel is shared or not

typestring

Type of publishing channel e.g. "Facebook page"

accountTypestring

Type of account the publishing channel stems from.

namestring

The name of the publishing channel e.g. "ABC Facebook page"

profileUrlstring nullable

The web address to the publishing channel

Example response

{
  "integration": "quickbooks"
}