KIkit
Segments

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

Request

  • Base URL
    https://api.kit.com
  • URL
    https://api.kit.com/v4/segments
  • Auth
    • API key in header X-Kit-Api-Key
    • or OAuth 2
      Authorization code: https://api.kit.com/v4/oauth/authorize
      Token URL: https://api.kit.com/v4/oauth/token

Query parameters

afterunknown

To fetch next page of results, use ?after=<end_cursor>

beforeunknown

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.

per_pageunknown

Number of results per page. Default 500, maximum 1000.

Response

Returns a paginated list of all segments for your account

Changes

No recorded changes to this operation across all 2 revisions of this API.