Peakon

Peakon Segments API

Retrieving segments

Documentation GitHub OpenAPI

Operations 1

GET /segments Get segments

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/peakon-segments-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

openapi: 3.2.0
info:
  version: 1.1.0
  title: Peakon Actions Segments API
  description: The Public Peakon API
servers:
- url: https://{subdomain}.peakon.com/api/v1/
  variables:
    subdomain:
      description: Unique subdomain assigned to your Peakon instance.
      default: api
tags:
- description: Retrieving segments
  name: Segments
paths:
  /segments:
    get:
      tags:
      - Segments
      summary: Get segments
      parameters:
      - name: filter[attributeId]
        schema:
          type: integer
        description: The id of the attribute that is the source of a segment
        in: query
      - name: filter[direct]
        schema:
          type: boolean
        description: Segment including only direct reports or all reports
        in: query
      - name: filter[managerId]
        schema:
          type: integer
        description: The employeeId of a manager of a segment
        in: query
      - name: filter[type]
        schema:
          type: string
          enum:
          - employee
          - option
          - date
          - number
        description: The type of attribute that is the source of a segment
        in: query
      security:
      - jwt: []
      responses:
        '200':
          description: A [JSONAPI resource](http://jsonapi.org/format/#document-resource-objects) containing an array of 'segments' objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/segments'
                  included:
                    type: array
                    items:
                      $ref: '#/components/schemas/resourceIdentifier'
                    description: An array of included JSONAPI resources
components:
  schemas:
    resourceIdentifier:
      properties:
        type:
          type: string
        id:
          type: string
      type: object
    segments:
      properties:
        type:
          type: string
        id:
          type: string
        attributes:
          type: object
          properties:
            identifier:
              type: string
            type:
              type: string
            logo:
              type: string
            standard:
              type: string
            benchmarkType:
              type: string
            benchmarkId:
              type: string
            contextId:
              type: string
            name:
              type: string
            abbreviation:
              type: string
            direct:
              type: boolean
      type: object