v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB

CustomerSegments

ListCustomerSegments

Retrieves the list of customer segments of a business.

get/v2/customers/segments

Query parameters

cursorstring

A pagination cursor returned by previous calls to ListCustomerSegments. This cursor is used to retrieve the next set of query results.

For more information, see Pagination.

limitinteger

The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. The limit is ignored if it is less than 1 or greater than 50. The default value is 50.

For more information, see Pagination.

Response

Success

cursorstring

A pagination cursor to be used in subsequent calls to ListCustomerSegments to retrieve the next set of query results. The cursor is only present if the request succeeded and additional results are available.

For more information, see Pagination.

Example response

{
  "segments": [
    {
      "created_at": "2020-01-09T19:33:24.469Z",
      "id": "GMNXRZVEXNQDF.CHURN_RISK",
      "name": "Lapsed",
      "updated_at": "2020-04-13T21:47:04Z"
    },
    {
      "created_at": "2020-01-09T19:33:24.486Z",
      "id": "GMNXRZVEXNQDF.LOYAL",
      "name": "Regulars",
      "updated_at": "2020-04-13T21:47:04Z"
    },
    {
      "created_at": "2020-01-09T19:33:21.813Z",
      "id": "GMNXRZVEXNQDF.REACHABLE",
      "name": "Reachable",
      "updated_at": "2020-04-13T21:47:04Z"
    },
    {
      "created_at": "2020-01-09T19:33:25Z",
      "id": "gv2:KF92J19VXN5FK30GX2E8HSGQ20",
      "name": "Instant Profile",
      "updated_at": "2020-04-13T23:01:03Z"
    }
  ]
}