Encharge Segments API

The Segments API from Encharge — 2 operation(s) for segments.

OpenAPI Specification

encharge-segments-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Encharge REST Account Segments API
  description: 'Encharge is a behavior-based marketing automation platform built for SaaS companies. The REST API exposes the core resources used by integrations: people, fields, segments, tags, event subscriptions (webhooks), and account information. Authentication uses the X-Encharge-Token header. Also documented here: the Ingest API for backend event submission and the Transactional Email API for templated and custom HTML/text email.

    '
  version: 1.0.0
  contact:
    name: Encharge Developer Documentation
    url: https://docs.encharge.io/api-documentation
servers:
- url: https://api.encharge.io/v1
  description: REST API and Transactional Email API
- url: https://ingest.encharge.io/v1
  description: Ingest API for backend event submission
security:
- tokenHeader: []
- bearer: []
tags:
- name: Segments
paths:
  /segments:
    get:
      summary: List segments
      operationId: listSegments
      tags:
      - Segments
      responses:
        '200':
          description: Segments
  /segments/{segmentId}/people:
    get:
      summary: List people in segment
      operationId: listSegmentPeople
      tags:
      - Segments
      parameters:
      - name: segmentId
        in: path
        required: true
        schema:
          type: string
      - name: limit
        in: query
        schema:
          type: integer
      - name: offset
        in: query
        schema:
          type: integer
      responses:
        '200':
          description: People in segment
components:
  securitySchemes:
    tokenHeader:
      type: apiKey
      in: header
      name: X-Encharge-Token
    bearer:
      type: http
      scheme: bearer