Get a channel

Retrieves a channel by its ID, including all associated tag rules.

GET/api/v1/{team_slug}/{app_slug}/channels/{channel_id}

API: Management
OpenAPI: management-api
Updated: Apr 26, 2026

management-api:GET:/api/v1/{team_slug}/{app_slug}/channels/{channel_id}

Retrieves a channel by its ID, including all associated tag rules.

API ownership

API family: Management API
Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
Do not use from: Browser-only storefront code or public clients.
Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

Method: GET
Path: /api/v1/\{team_slug\}/\{app_slug\}/channels/\{channel_id\}
Summary: Get a channel
Description: Retrieves a channel by its ID, including all associated tag rules.
OpenAPI contract: management-api
Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters3 parameters

Name	In	Required	Type	Description
app_slug	path	Yes	string	App slug
team_slug	path	Yes	string	Team slug
channel_id	path	Yes	string	Channel ID

Request bodyNo documented body

Not documented in the OpenAPI contract.

Responses3 statuses

Status	Description	Content
200	Channel retrieved successfully	application/json (object)
404	Channel not found	application/json (object)
500	Internal server error	application/json (object)

200 - object

Channel Response

Property	Type	Required	Details
`data`	object	No	-
`details`	string[]	No	Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
`success`	boolean	No	-

Channel

Property	Type	Required	Details
`active`	boolean	No	-
`created_at`	string	No	-
`description`	string	No	-
`effective_publishing_rule`	object	No	-
`id`	string	No	-
`market_ids`	string[]	No	-
`name`	string	No	-
`publishing_rule_id`	string	No	-
`slug`	string	No	-
`store_group_id`	string	No	-
`updated_at`	string	No	-

Publishing Rule

Property	Type	Required	Details
`created_at`	string	No	-
`id`	string	No	-
`is_default`	boolean	No	-
`minimum_images`	integer	No	-
`name`	string	No	-
`should_have_brand`	boolean	No	-
`should_have_category`	boolean	No	-
`should_have_description`	boolean	No	-
`should_have_main_category`	boolean	No	-
`should_have_price`	boolean	No	-
`should_have_product_name`	boolean	No	-
`updated_at`	string	No	-

Generated example (synthetic):

{
  "data": {
    "active": false,
    "created_at": "string",
    "description": "string",
    "effective_publishing_rule": {
      "created_at": "string",
      "id": "string",
      "is_default": false,
      "minimum_images": 0,
      "name": "string",
      "should_have_brand": false,
      "should_have_category": false,
      "should_have_description": false,
      "should_have_main_category": false,
      "should_have_price": false,
      "should_have_product_name": false,
      "updated_at": "string"
    },
    "id": "string",
    "market_ids": [
      "string"
    ],
    "name": "string",
    "publishing_rule_id": "string",
    "slug": "string",
    "store_group_id": "string",
    "updated_at": "string"
  },
  "details": [
    "string"
  ],
  "success": false
}

404 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

API family: Management API
Method: GET
Path: /api/v1/\{team_slug\}/\{app_slug\}/channels/\{channel_id\}
Operation ID: Not documented in the OpenAPI contract.
OpenAPI tag: Channels
OpenAPI summary: Get a channel