Segments

List segments for the caller's org

Returns all segments for the org, newest first. Supports filtering by subtype and status. Archived and expired segments are excluded by default unless explicitly requested. Listing emits no billable usage. Requires 'discovery' scope.

get/v1/segments

Request

  • Base URL: https://api.infiniteaudience.ai
  • URL: https://api.infiniteaudience.ai/v1/segments
  • Auth: HTTP bearer

Query parameters

subtype'filter' | 'matched' | 'similarity' | 'propensity'

Filter to a specific segment subtype.

status'pending' | 'active' | 'failed' | 'archived' | 'expired'

Filter by lifecycle status. archived/expired segments are excluded by default.

include_archivedboolean

When true, archived segments are included in results.

include_ephemeralboolean

When true, ephemeral (scratch/auto-expiring) segments are included in results. Excluded by default.

limitinteger

Maximum number of results to return (max 100).

cursorstring

Cursor from a previous response's next_cursor attribute to fetch the next page.

Response

Segment list.

totalinteger
next_cursorstring nullable

Pass as cursor on the next request. Null when no further pages exist.

Changes

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