Pendo.io

Pendo.io Segment API

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

GitHub OpenAPI

Operations 12

GET /api/v1/segment Get All Shared (Everyone) Segments #
GET /api/v1/segment/{id} Get Segment by segmentId #
POST /api/v1/segment/{segmentId}/visitors Start export of segment visitors #
GET /api/v1/segment/{segmentId}/visitors/{jobId}/status Check segment export status #
GET /api/v1/segment/{segmentId}/visitors/{jobId}/results/{contentType} Retrieve segment export results #
POST /api/v1/segment/upload Create a segment #
GET /api/v1/segment/{segmentId}/status Get segment status #
PUT /api/v1/segment/{segmentId} Update a segment #
DELETE /api/v1/segment/{segmentId} Delete a segment #
PUT /api/v1/segment/{segmentId}/visitor/{visitorId} Add a visitor to a segment #
DELETE /api/v1/segment/{segmentId}/visitor/{visitorId} Remove a visitor from a segment #
PATCH /api/v1/segment/{segmentId}/visitor Add/remove small batches of visitors to a segment #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/pendoio/refs/heads/main/authentication/pendoio-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/pendoio/refs/heads/main/openapi/pendoio-segment-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/pendoio/refs/heads/main/errors/pendoio-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/pendoio/refs/heads/main/data-model/pendoio-data-model.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/pendoio/refs/heads/main/conventions/pendoio-conventions.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/pendoio-segment-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

pendoio-segment-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Pendo Engage Account Segment API
  description: Pendo's Engage API provides programmatic access to product analytics and in-app guide data collected by the Pendo agent. It includes resource endpoints for pages, features, track events, guides, visitors, accounts, segments, reports, and metadata, plus a powerful Aggregation API that runs MongoDB-like structured queries over collected events. Authentication uses a per-subscription integration key passed in the x-pendo-integration-key header.
  version: v1
  contact:
    name: Pendo Developers
    url: https://developers.pendo.io/
  x-source: https://engageapi.pendo.io/ (public Postman collection 16265887/Tzm6jvKG)
servers:
- url: https://app.pendo.io
  description: US (default)
- url: https://us1.app.pendo.io
  description: US1
- url: https://app.eu.pendo.io
  description: EU
- url: https://app.au.pendo.io
  description: AU/APAC
- url: https://app.jpn.pendo.io
  description: Japan
security:
- IntegrationKey: []
tags:
- name: Segment
paths:
  /api/v1/segment:
    get:
      operationId: getAllSharedEveryoneSegments
      summary: Get All Shared (Everyone) Segments
      tags:
      - Segment
      responses:
        '200':
          description: Successful response
  /api/v1/segment/{id}:
    get:
      operationId: getSegmentBySegmentid
      summary: Get Segment by segmentId
      tags:
      - Segment
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
  /api/v1/segment/{segmentId}/visitors:
    post:
      operationId: startExportOfSegmentVisitors
      summary: Start export of segment visitors
      tags:
      - Segment
      parameters:
      - name: segmentId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
  /api/v1/segment/{segmentId}/visitors/{jobId}/status:
    get:
      operationId: checkSegmentExportStatus
      summary: Check segment export status
      tags:
      - Segment
      parameters:
      - name: segmentId
        in: path
        required: true
        schema:
          type: string
      - name: jobId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
  /api/v1/segment/{segmentId}/visitors/{jobId}/results/{contentType}:
    get:
      operationId: retrieveSegmentExportResults
      summary: Retrieve segment export results
      tags:
      - Segment
      parameters:
      - name: segmentId
        in: path
        required: true
        schema:
          type: string
      - name: jobId
        in: path
        required: true
        schema:
          type: string
      - name: contentType
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
  /api/v1/segment/upload:
    post:
      operationId: createASegment
      summary: Create a segment
      tags:
      - Segment
      requestBody:
        content:
          application/json:
            example:
              name: EnterYourSegmentName
              visitors:
              - visitor1
              - visitor2
              - visitor3
      responses:
        '200':
          description: Successful response
  /api/v1/segment/{segmentId}/status:
    get:
      operationId: getSegmentStatus
      summary: Get segment status
      tags:
      - Segment
      parameters:
      - name: segmentId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
  /api/v1/segment/{segmentId}:
    put:
      operationId: updateASegment
      summary: Update a segment
      tags:
      - Segment
      parameters:
      - name: segmentId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              name: EnterYourSegmentName
              visitors:
              - visitor1
              - visitor2
              - visitor3
      responses:
        '200':
          description: Successful response
    delete:
      operationId: deleteASegment
      summary: Delete a segment
      tags:
      - Segment
      parameters:
      - name: segmentId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
  /api/v1/segment/{segmentId}/visitor/{visitorId}:
    put:
      operationId: addAVisitorToASegment
      summary: Add a visitor to a segment
      tags:
      - Segment
      parameters:
      - name: segmentId
        in: path
        required: true
        schema:
          type: string
      - name: visitorId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
    delete:
      operationId: removeAVisitorFromASegment
      summary: Remove a visitor from a segment
      tags:
      - Segment
      parameters:
      - name: segmentId
        in: path
        required: true
        schema:
          type: string
      - name: visitorId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
  /api/v1/segment/{segmentId}/visitor:
    patch:
      operationId: addRemoveSmallBatchesOfVisitorsToASegment
      summary: Add/remove small batches of visitors to a segment
      tags:
      - Segment
      parameters:
      - name: segmentId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              patch:
              - op: add
                path: /visitors
                value:
                - visitor3
                - visitor4
              - op: remove
                path: /visitors
                value:
                - visitor1
                - visitor2
      responses:
        '200':
          description: Successful response
components:
  securitySchemes:
    IntegrationKey:
      type: apiKey
      in: header
      name: x-pendo-integration-key
      description: Pendo integration key, created at https://app.pendo.io/admin/integrationkeys