Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Get channel

Gets a single channel including its market ids and effective publishing rule.

GET/api/v2/{team_slug}/{app_slug}/channels/{channel_id}
Authorization
AuthorizationBearer token · headerrequired

Management API token, sent as Authorization: Bearer <token>.

Path parameters
team_slugstringrequired
app_slugstringrequired
channel_idstring<uuid>required
Responses
200

OK

dataChannelrequired
Show properties
idUUIDrequired
namestringrequired
slugstringrequired
store_groupChannelNamedRefrequired
Show properties
idUUIDrequired
namestringrequired
slugstringrequired
marketsChannelNamedRef[] | null
Show properties
Array of ChannelNamedRef
idUUIDrequired
namestringrequired
slugstringrequired
descriptionstring | null
activebooleanrequired
publishing_rule_idUUID | null
Show properties
Any of:
UUID
string<uuid>
null
null
effective_publishing_ruleChannelPublishingRule | null
Show properties
Any of:
ChannelPublishingRule
idUUIDrequired
namestringrequired
is_defaultboolean
minimum_imagesinteger
should_have_priceboolean
should_have_product_nameboolean
should_have_brandboolean
should_have_descriptionboolean
should_have_categoryboolean
should_have_main_categoryboolean
updated_atstring<date-time> | null
created_atstring<date-time>required
null
null
created_atstring<date-time>required
updated_atstring<date-time> | null
400

Request-level failure

errorErrorBodyrequired
Show properties
messagestringrequired
detailsstring[]required
401

Request-level failure

errorErrorBodyrequired
Show properties
messagestringrequired
detailsstring[]required
403

Request-level failure

errorErrorBodyrequired
Show properties
messagestringrequired
detailsstring[]required
404

Request-level failure

errorErrorBodyrequired
Show properties
messagestringrequired
detailsstring[]required
500

Request-level failure

errorErrorBodyrequired
Show properties
messagestringrequired
detailsstring[]required
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.enad.io/api/v2/string/string/channels/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "slug": "string",
    "store_group": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "slug": "string"
    },
    "markets": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "slug": "string"
      }
    ],
    "description": "string",
    "active": true,
    "publishing_rule_id": "125a9b9d-2f65-4f23-bbd5-4b05bec210bd",
    "effective_publishing_rule": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "is_default": true,
      "minimum_images": 0,
      "should_have_price": true,
      "should_have_product_name": true,
      "should_have_brand": true,
      "should_have_description": true,
      "should_have_category": true,
      "should_have_main_category": true,
      "updated_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z"
    },
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}