gainsight-px-rest-api
GET /v1/segment

Retrieves segments. Supports paging. Examples:

URI Results
GET /v1/segment?pageSize=100 Get first 100 segments.
GET /v1/segment?pageSize=100&pageNumber=1 Get next 100 segments.

Query parameters

  • pageNumber integer(int32)

    Page number

    Default value is 0.

  • pageSize integer(int32)

    Number of segments per page

    Minimum value is 1, maximum value is 200. Default value is 25.

Responses

  • 200 */*

    Success

    Hide response attributes Show response attributes object
    • segments array[object]

      Array of segments

      Hide segments attributes Show segments attributes object

      Segment object

      • id string Required
      • name string Required
    • pageNumber integer(int32)

      Page number

    • isLastPage boolean

      True if no more records available on next page
  • 400

    Bad request

  • 401

    Unauthorized or bad API Key

  • 429

    Rate limit exceeded

GET /v1/segment 
curl \
 --request GET 'https://api.aptrinsic.com/v1/segment'
Response examples (200) 
{
  "segments": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "pageNumber": 42,
  "isLastPage": true
}