Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Channex Channels API

Manage OTA distribution channels.

Channex Channels API is one of 7 APIs that Channex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Channels. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against 2 base URLs: https://secure.channex.io/api/v1, https://staging.channex.io/api/v1.

5 operations 2 paths 5 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://secure.channex.io/api/v1
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Channex Channels API declares 1 security scheme for authenticating requests. An API key is passed in the header as user-api-key (userApiKey). By default, every request must be authenticated.

  • userApiKey — Channex API key passed in the user-api-key request header. Generate a key in the Channex application under your account settings.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Channels 5

Manage OTA distribution channels.

GET
/channels
List channels
listChannels 3 params → 200
POST
/channels
Add a channel
createChannel body → 201
GET
/channels/{id}
Get a channel
getChannel 1 param → 200
PUT
/channels/{id}
Update a channel
updateChannel 1 param body → 200
DELETE
/channels/{id}
Delete a channel
deleteChannel 1 param → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are ChannelAttributes (6 properties), Channel (3 properties), ChannelList (2 properties), ChannelWriteRequest (1 property). Each schema is shown below with its type and property counts.

ChannelResponse
object
1 property
ChannelWriteRequest
object
1 property 1 required
Channel
object
3 properties
ChannelAttributes
object
6 properties 2 required
ChannelList
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

channex-channels-api-openapi.yml Raw ↑

Other APIs Channex publishes across the network.

Channex ARI API
Channex Bookings API
Channex Properties API
Channex Rate Plans API
Channex Room Types API
Channex Webhooks API