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

The Segment API from Pendo.io — 10 operation(s) for segment.

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

This API exposes 12 operations across 10 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 10 paths 0 schemas 2 DELETE5 GET1 PATCH2 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 Segment 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 10 paths, the API surfaces 12 operations — 2 DELETE, 5 GET, 1 PATCH, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Segment 12
GET
/api/v1/segment
Get All Shared (Everyone) Segments
getAllSharedEveryoneSegments → 200
GET
/api/v1/segment/{id}
Get Segment by segmentId
getSegmentBySegmentid 1 param → 200
POST
/api/v1/segment/{segmentId}/visitors
Start export of segment visitors
startExportOfSegmentVisitors 1 param → 200
GET
/api/v1/segment/{segmentId}/visitors/{jobId}/status
Check segment export status
checkSegmentExportStatus 2 params → 200
GET
/api/v1/segment/{segmentId}/visitors/{jobId}/results/{contentType}
Retrieve segment export results
retrieveSegmentExportResults 3 params → 200
POST
/api/v1/segment/upload
Create a segment
createASegment body → 200
GET
/api/v1/segment/{segmentId}/status
Get segment status
getSegmentStatus 1 param → 200
PUT
/api/v1/segment/{segmentId}
Update a segment
updateASegment 1 param body → 200
DELETE
/api/v1/segment/{segmentId}
Delete a segment
deleteASegment 1 param → 200
PUT
/api/v1/segment/{segmentId}/visitor/{visitorId}
Add a visitor to a segment
addAVisitorToASegment 2 params → 200
DELETE
/api/v1/segment/{segmentId}/visitor/{visitorId}
Remove a visitor from a segment
removeAVisitorFromASegment 2 params → 200
PATCH
/api/v1/segment/{segmentId}/visitor
Add/remove small batches of visitors to a segment
addRemoveSmallBatchesOfVisitorsToASegment 1 param body → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

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