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

Whippy Channels API

List and inspect channels and channel membership.

Whippy Channels API is one of 7 APIs that Whippy 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, API documentation, and an API reference.

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

Requests are made against a single base URL, https://api.whippy.co/v1.

3 operations 3 paths 5 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Whippy Channels API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-WHIPPY-KEY (WhippyApiKey). By default, every request must be authenticated.

  • WhippyApiKey — Organization API key. Generated in the Whippy app under Settings Developers. OAuth 2.0 bearer tokens are also accepted via the Authorization header.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Channels 3

List and inspect channels and channel membership.

GET
/channels
List channels
getChannels → 200401
GET
/channels/{id}
Show a channel
getChannel 1 param → 200401
GET
/channels/{id}/users
List channel users
getChannelUsers 1 param → 200401

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Channel (16 properties), OpeningHour (5 properties), User (3 properties), Error (2 properties). Each schema is shown below with its type and property counts.

ChannelList
object
2 properties
Channel
object
16 properties
OpeningHour
object
5 properties
User
object
3 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

whippy-channels-api-openapi.yml Raw ↑

Other APIs Whippy publishes across the network.

Whippy Campaigns API
Whippy Contacts API
Whippy Conversations API
Whippy Messaging API
Whippy Sequences API
Whippy Webhooks API