Get a Channel by ID

GET

https://api.contentful.com/organizations/:organizationId/channels/:channelId

GET

/organizations/:organizationId/channels/:channelId

curl https://api.contentful.com/organizations/1PLOOEmTI2S1NYald2TemO/channels/71dC9lwYk3p6MkM4GoSc8t \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "name": "name",
  "description": "description",
  "properties": [
    {
      "name": "Base URL",
      "id": "baseUrl",
      "type": "String"
    }
  ],
  "nodeProperties": [
    {
      "name": "Path",
      "type": "Path"
    }
  ],
  "sys": {
    "createdAt": "createdAt",
    "createdBy": {
      "sys": {
        "type": "Link",
        "linkType": "linkType",
        "id": "id"
      }
    },
    "firstPublishedAt": "firstPublishedAt",
    "id": "id",
    "organization": {
      "sys": {
        "type": "Link",
        "linkType": "linkType",
        "id": "id"
      }
    },
    "publishedAt": "publishedAt",
    "publishedBy": {
      "sys": {
        "type": "Link",
        "linkType": "linkType",
        "id": "id"
      }
    },
    "publishedCounter": 1,
    "publishedVersion": 1,
    "type": "Channel",
    "updatedAt": "updatedAt",
    "updatedBy": {
      "sys": {
        "type": "Link",
        "linkType": "linkType",
        "id": "id"
      }
    },
    "version": 1
  }
}

Returns a single Channel based on the given identifier.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organizationIdstringRequired

ID of the organization the Channel belongs to.

channelIdstringRequired

ID of the Channel.

Response

OK - Request successful

namestring

descriptionstring

propertieslist of objects

nodePropertieslist of objects

sysobject