GET /api/v2/publishing_channels/:publishing_channel_id
Return publishing channel by ID

Headers

Header name	Description
Content-Type required	application/json
X-API-KEY required	YOUR_API_KEY

Params

Param name	Description
publishing_channel_id required	Publishing channel ID Validations: Must be a String

Examples

// Successful request
GET /api/v2/publishing_channels/2
200
{
  "publishing_channel": {
    "id": 2,
    "name": "test_publishing_channel",
    "user_id": 67,
    "config_id": 2,
    "config_type": "FtpConfig",
    "created_at": "2023-11-27T09:42:51.341Z",
    "updated_at": "2023-11-27T09:42:51.341Z",
    "private": false,
    "config": {
      "id": 2,
      "host": "test_ftp_server.com/ftp",
      "username": "test_user",
      "path": "/ftp/folder",
      "created_at": "2023-11-27T09:42:51.328Z",
      "updated_at": "2023-11-27T09:42:51.328Z"
    },
    "users": [],
    "authorized_with": "password"
  }
}

// Publishing channel not found
GET /api/v2/publishing_channels/not-found-id
404
{
  "error": "Publishing channel not found"
}

Errors

Code	Description
401	Unauthorized
404	Not found
500	Internal Server Error
422	Missing parameters