Lists all segments (based on params provided)

This endpoint retrieves a list of segments based on the provided query parameters, including pagination details.

get/v1/segments

Request

Base URL
https://auth.<env>.citrusad.com
Auth
none declared
TypeScript
https://skmtc.dev/citrusad/apis/citrus-auth-api/docs/v1/segments/get.ts
A function with typed inputs. Its response is checked against the schema.

pageTokenstring

Page token used for pagination. Send this value in subsequent requests.

pageSizestring int64

The number of cross sell categories you are requesting per page.

nameContainsstring

Used to filter by a name containing provided phrase.

teamIdstring

Used to filter by a specific team.

retailerTeamIdsstring[]

Used to filter by specific retailer teams.

A list of segments and a pagination token.

nextPageTokenstring

The page token for requesting the next page of the pagination. Should be used as "pageToken" in the request

totalCountstring int64

The total number of segments that match provided criteria.

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