Bundle CMF

List segments

Changed on

Returns a paginated list of customer segments.

get/pimcore-studio/api/bundle/cmf/segments

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pimcore-studio/api/bundle/cmf/segments
  • Auth: none declared

Query parameters

pageinteger
Example:42

Page number (1-based)

pageSizeinteger
Example:42

Number of results per page (default 100)

Response

Paginated segment list

additionalAttributesobject

AdditionalAttributes

pageinteger required

Current page number

totalPagesinteger required

Total number of pages

timestampinteger required

Unix timestamp of the request

Example response

{
  "page": 1,
  "totalPages": 5,
  "timestamp": 1700000000,
  "items": [
    {
      "id": 10,
      "name": "Gold Members",
      "reference": "gold-members",
      "group": 5
    }
  ]
}

Changes