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 Guide API

The Guide API from Pendo.io — 12 operation(s) for guide.

Pendo.io Guide 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 Guide. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 12 operations across 12 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.

12 operations 12 paths 0 schemas 4 GET6 POST2 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 Guide 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 12

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

Guide 12
GET
/api/v1/guide
Return List of All Guides
returnListOfAllGuides → 200
GET
/api/v1/guide/{guideId}/history
Retrieve Change History for a Guide
retrieveChangeHistoryForAGuide 1 param → 200
POST
/api/v1/guide/{guideId}/visitor/{visitorId}/reset
Reset Guide Seen for Specific Visitor
resetGuideSeenForSpecificVisitor 2 params → 200
POST
/api/v1/guide/all/visitor/{visitorId}/reset
Reset Guide Seen for Specific Visitor for All Guides
resetGuideSeenForSpecificVisitorForAllGuides 1 param → 200
POST
/api/v1/guide/{guideId}/reset
Reset Individual Staged Guide
resetIndividualStagedGuide 1 param → 200
POST
/api/v1/guide/staged/reset
Reset All Staged Guides
resetAllStagedGuides → 200
POST
/api/v1/guide/{guideId}/experiment/export
Export Guide Experiment Results
exportGuideExperimentResults 1 param → 200
GET
/api/v1/guide/localization/export
Bulk XLIFF Export
bulkXliffExport → 200
POST
/api/v1/guide/localization/import
Bulk XLIFF Import
bulkXliffImport body → 200
GET
/api/v1/guide/order
Get guide order
getGuideOrder → 200
PUT
/api/v1/guide/{guideId}/segment
Change guide segment
changeGuideSegment 1 param body → 200
PUT
/api/v1/guide/{guideId}/state
Change guide state
changeGuideState 1 param body → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pendoio-guide-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 Listen API
Pendo.io Metadata API
Pendo.io Page API
Pendo.io Report API
Where this information came from

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