Contacts: Segments

List Segments

Every saved segment of the account, with its where and sort.

POSThttps://g.sendcorex.com/v1/contactscommand: list_segments
i

Needs the contact:read scope on your API key.

Arguments

This endpoint takes no arguments.

Quick start

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "list_segments"
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);

const [result] = response.data.results;
if (result.type !== 'SUCCESS') throw new Error(`${result.code}: ${result.message}`);
console.log(result.data);

Response

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "list_segments",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "segments": [
          {
            "segment_id": "engaged-vips",
            "name": "Engaged VIPs",
            "where": {
              "tags": {
                "has": "vip"
              },
              "last_open_at": {
                "within_days": 30
              }
            },
            "sort": {
              "field": "open_rate"
            },
            "created_at": "2026-10-10T12:00:00.000Z",
            "updated_at": "2026-10-10T12:00:00.000Z"
          }
        ]
      }
    }
  ]
}

Response fields

  • segments[].segment_id

    The id used by Run Segment.

  • segments[].name

    Display name.

  • segments[].where / sort

    The saved query, same format as Query Contacts.

Errors

HTTP-level errors return type, code and message. Errors marked CMD come back inside the command result, with HTTP 200.

  • 401INVALID_API_KEY

    The API key does not exist, was revoked or was disabled in the dashboard.

  • 429RATE_LIMITED

    More than 15 requests/s or 15 in flight for the same IP + API key. Wait the number of seconds in Retry-After.

  • CMDMISSING_SCOPE

    The API key does not have the scope this command needs. The other commands in the request still run.

  • CMDINTERNAL

    Server error. The detail is only written to the server log.