KOkontainer
PIM: Channels

Returns a single Channel

Returns a single Channel

get/pim/channels/{channel_id}

Request

Path parameters

channel_idstring required

ID of Channel

Query parameters

relationshipsstring

Requested relationships (e.g. fields)

includesstring

Requested includes (e.g. fields)

Response

success

Example response

{
  "data": {
    "type": "channel",
    "id": "55211",
    "attributes": {
      "name": "Shoes",
      "description": "Shoes channel description"
    },
    "links": {
      "self": "https://example.kontainer.com/jsonapi/v2/pim/channels/55211"
    },
    "meta": [],
    "relationships": {
      "category": {
        "data": {
          "type": "category",
          "id": "12"
        }
      },
      "parent_channel": {
        "data": {
          "type": "channel",
          "id": "55210"
        }
      },
      "subchannels": {
        "data": [
          {
            "type": "channel",
            "id": "55212"
          }
        ]
      },
      "fields": {
        "data": [
          {
            "type": "channel_field",
            "id": "12"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "channel_field",
      "id": "12",
      "attributes": {
        "name": "Color"
      },
      "relationships": {
        "element": {
          "data": {
            "type": "element",
            "id": "701"
          }
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.