How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Zype

Zype Consumers API

The end-viewer surface: consumer records, password reset flows, parental access codes, device pin linking, and video, playlist and subscription entitlements. 24 operations.

Documentation Provider Profile APIs.io OpenAPI GitHub

Zype Consumers API is one of 15 APIs that Zype publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Consumers, Entitlements, Identity, and Device Linking. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 24 operations across 15 paths, organized into 5 resource areas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against a single base URL, https://api.zype.com/.

24 operations 15 paths 0 schemas 3 DELETE9 GET4 POST8 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Base URL
https://api.zype.com/
Authentication
API Key, HTTP Bearer
Resource Areas
5

Authentication & Security 2

Zype Consumers API declares 2 security schemes for authenticating requests. An API key is passed in the query as api_key (api_key). It accepts HTTP bearer tokens (OAuth access token) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth access token of the consumer

Paths & Operations 24

Across 15 paths, the API surfaces 24 operations — 3 DELETE, 9 GET, 4 POST, 8 PUT. They span 5 resource areas: Consumers, Device Linking, Video Entitlements, Playlist Entitlements, Subscription Entitlements. Each is listed below with its method, path, parameters, and response codes.

Consumers 8
GET
/consumers
List Consumers
listConsumers 26 params → 200422
POST
/consumers
Create Consumers
createConsumer body → 201422
GET
/consumers/{id}
View Consumer
getConsumer 1 param → 200404
PUT
/consumers/{id}
Update Consumer
updateConsumer 1 param body → 200404422
DELETE
/consumers/{id}
Delete Consumer
deleteConsumer 1 param → 204404422
PUT
/consumers/{id}/reset_parental_access_code
Reset Consumer Parental Access Code
resetConsumerParentalAccessCode 1 param → 200404422
PUT
/consumers/forgot_password
Initiate Consumer Forgot Password Flow - Consumer receives forgot password email.
resetPasswordFlow body → 200422
PUT
/consumers/reset_password
Reset Consumer's Password Flow
updatePassword body → 200422
Device Linking 4
GET
/pin/status
Retrieve Device Pin
getPinStatus 1 param → 200404
POST
/pin/acquire
Acquire Device Pin
acquireDevicePin 1 param → 201422
PUT
/pin/link
Link Device Pin
linkDevicePin 2 params → 200404
PUT
/pin/unlink
Unlink Device Pin
unlinkDevicePin 2 params → 200404
Video Entitlements 6
GET
/videos/{video_id}/entitled
Check Video Entitlement
checkVideoEntitlement 2 params → 200422
GET
/consumers/{consumer_id}/videos
List Video Entitlements
listVideoEntitlements 1 param → 200404
POST
/consumers/{consumer_id}/videos
Create video entitlement
createVideoEntitlement 1 param body → 201404422
GET
/consumers/{consumer_id}/videos/{id}
View Video Entitlement
viewVideoEntitlement 2 params → 200404
PUT
/consumers/{consumer_id}/videos/{id}
Update Video Entitlement
updateVideoEntitlement 2 params body → 200404422
DELETE
/consumers/{consumer_id}/videos/{id}
Delete Video Entitlement
deleteVideoEntitlement 2 params → 204404
Playlist Entitlements 5
GET
/consumers/{consumer_id}/playlists
List Playlist Entitlements
listPlaylistEntitlements 1 param → 200404
POST
/consumers/{consumer_id}/playlists
Create a Playlist Entitlement
createPlaylistEntitlement 1 param body → 201404422
GET
/consumers/{consumer_id}/playlists/{id}
View Playlist Entitlement
getPlaylistEntitlement 2 params → 200404
PUT
/consumers/{consumer_id}/playlists/{id}
Update Playlist Entitlement
updatePlaylistEntitlement 2 params body → 200404422
DELETE
/consumers/{consumer_id}/playlists/{id}
Delete Playlist Entitlement
deletePlaylistEntitlement 2 params → 204404
Subscription Entitlements 1
GET
/consumers/{consumer_id}/subscription_entitlements
List Subscription Entitlements
listSubscriptionEntitlements 2 params → 200400

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zype-consumers.json Raw ↑

Other APIs Zype publishes across the network.

Zype Platform API
AE Profile APIs.io
Zype Playout Scheduler API
AE Profile APIs.io
Zype Monetization API
AE Profile APIs.io
Zype Live API (V3)
AE Profile APIs.io
Zype Zobjects API
AE Profile APIs.io
Zype Analytics API (V3)
AE Profile APIs.io
Zype Analytics API (V2)
AE Profile APIs.io
Zype Custom Regions API
AE Profile APIs.io
Zype Content Rule Groups API
AE Profile APIs.io
Zype Content Rule Profiles API
AE Profile APIs.io
Zype TVE API
AE Profile APIs.io
Zype Consumer Authentication API
AE Profile APIs.io
#Consumers#Entitlements#Identity#Device Linking
← Back to Z APIs
API Details
ID
zype:consumers
Base URL
https://api.zype.com/
Docs
https://docs.zype.com/reference/consumers
Provider
Zype
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=consumers&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/consumers"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Zype Consumers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.