PIM: Channels

Returns a list of PIM Channels

Retrieve PIM Channels

Endpoint for retrieving a collection of Channels.

get/pim/channels

Request

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"
          }
        }
      }
    }
  ],
  "links": {
    "first": "https://example.kontainer.com/jsonapi/v2/dam/folders?page=1",
    "last": "https://example.kontainer.com/jsonapi/v2/dam/folders?page=1"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "Previous",
        "active": false
      },
      {
        "url": "https://example.kontainer.com/jsonapi/v2/dam/folders?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next",
        "active": false
      }
    ],
    "path": "https://example.kontainer.com/jsonapi/v2/dam/folders",
    "per_page": 500,
    "to": 1,
    "total": 1,
    "sort": "name"
  }
}

Changes

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