Segments

List segments

Retrieve a list of the segments in your workspace, cursor-paginated. A segment is a saved group of contacts you can target when sending a campaign. Create one with Create a segment, or list a segment's members with List segment members. Requires the segments:read capability.

get/segments

Request

  • Base URL: https://www.unitpost.com/api/v1
  • URL: https://www.unitpost.com/api/v1/segments
  • Auth: HTTP bearer

Query parameters

limitinteger

Max rows to return (default 20, max 100).

afterstring

Return rows after this id (forward paging).

beforestring

Return rows before this id (backward paging).

Response

A page of segments.

object'list' required
has_moreboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.