v1
latestOpenAPI 3.0.32026-07-26737274.2 KBSegments
List segments
Returns a cursor-paginated list of all segments in the account with their id, name, and creation date.
Segments are created and managed in the Kit app — the API doesn't currently support creating or updating them. Use segment ids for targeting, for example in a broadcast's subscriber_filter (see Create a broadcast).
get/v4/segments
Query parameters
{"stackTrail":"paths:/v4/segments:get:parameters:0:schema","oasType":"schema","type":"unknown","nullable":true}
To fetch next page of results, use ?after=<end_cursor>
{"stackTrail":"paths:/v4/segments:get:parameters:1:schema","oasType":"schema","type":"unknown","nullable":true}
To fetch previous page of results, use ?before=<start_cursor>
include_total_countboolean
Set to true to include the total_count in the response. This option can cause slow responses; if paging through results, request it only on the first page and reuse the value for subsequent pages.
{"stackTrail":"paths:/v4/segments:get:parameters:3:schema","oasType":"schema","type":"unknown","nullable":true}
Number of results per page. Default 500, maximum 1000.
Response
Returns a paginated list of all segments for your account