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

Pendo.io Metadata API

The Metadata API from Pendo.io — 9 operation(s) for metadata.

Pendo.io Metadata API is one of 16 APIs that Pendo.io publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Metadata. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 10 operations across 9 paths. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against 5 base URLs: https://app.pendo.io, https://us1.app.pendo.io, https://app.eu.pendo.io, https://app.au.pendo.io, https://app.jpn.pendo.io.

10 operations 9 paths 0 schemas 1 DELETE4 GET2 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://app.pendo.io/api/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Pendo.io Metadata API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-pendo-integration-key (IntegrationKey). By default, every request must be authenticated.

  • IntegrationKey — Pendo integration key, created at https://app.pendo.io/admin/integrationkeys

Paths & Operations 10

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

Metadata 10
GET
/api/v1/metadata/schema/{kind}
Get a Metadata Schema
getAMetadataSchema 1 param → 200
GET
/api/v1/metadata/{kind}/{group}/value/{id}/{fieldName}
Get Value of a Metadata Field
getValueOfAMetadataField 4 params → 200
PUT
/api/v1/metadata/{kind}/{group}/value/{id}/{fieldName}
Set Value for an Agent or Custom Field
setValueForAnAgentOrCustomField 4 params body → 200
PUT
/api/v1/metadata/{kind}/pendo/value/{id}/blacklistguides
Opt-out a Visitor or Account From All Guide Display
optOutAVisitorOrAccountFromAllGuideDisplay 2 params body → 200
PUT
/api/v1/metadata/{kind}/pendo/value/{id}/donotprocess
Opt-Out or Do Not Process a Visitor or Account
optOutOrDoNotProcessAVisitorOrAccount 2 params body → 200
POST
/api/v1/metadata/{kind}/{group}/value
Set Value for a Set of Agent or Custom Fields
setValueForASetOfAgentOrCustomFields 2 params body → 200
POST
/api/v1/metadata/schema/{kind}/{group}
Create or Undelete an Agent or Custom Field
createOrUndeleteAnAgentOrCustomField 2 params body → 200
DELETE
/api/v1/metadata/schema/{kind}/{group}/{field}
Delete an Agent or Custom Field
deleteAnAgentOrCustomField 3 params → 200
GET
/api/v1/metadata/dependencies
Get a List of Dependencies for All Metadata Fields
getAListOfDependenciesForAllMetadataFields → 200
GET
/api/v1/metadata/dependencies/{kind}/{group}/{fieldName}
Get a List of Dependencies for a Metadata Field
getAListOfDependenciesForAMetadataField 3 params → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pendoio-metadata-api-openapi.yml Raw ↑

Other APIs Pendo.io publishes across the network.

Pendo.io Account API
Pendo.io Admin API
Pendo.io Aggregation API
Pendo.io Bulk Deletion (GDPR/CCPA) API
Pendo.io Conversations API
Pendo.io Data Sync API
Pendo.io Exclude Lists & Servers API
Pendo.io Feature API
Pendo.io Guide API
Pendo.io Listen API
Pendo.io Page API
Pendo.io Report API
Where this information came from

This is an independent, third-party profile of Pendo.io Metadata 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.