Skip to main content

/v1/data/segments

GET /v1/data/segments​

Summary​

Retrieve a stream of segment information based on the provided API key.

Request Headers​

HeaderValueDescription
AuthorizationBearer API_TOKENThe API token required for authentication.

Responses​

200: Successful Response​

The successful response streams a JSON array of objects with the following structure:

[
  {
    "email": "string",
    "customer_id": integer,
    "block_mailing": boolean,
    "slug": "string",
    "exported": {
      "$date": "string"
    },
    "number_of_results": integer,
    "segment_id": {
      "$oid": "string"
    },
    "segment_name": "string",
    "segment_type": "string",
    "segment_color": "string"
  }
]