Bundle CMF

List customers

Changed on

Returns a paginated list of customers, optionally filtered by segment IDs and modification timestamp.

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

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/customers
  • Auth: none declared

Query parameters

pageinteger
Example:42

Page number (1-based)

pageSizeinteger
Example:42

Number of results per page

modificationTimestampinteger
Example:42

Filter customers modified after this Unix timestamp

includeActivitiesboolean
Example:true

Include activity data for each customer

segments[]integer[]

Filter by segment IDs (can be repeated: segments[]=1&segments[]=2)

Response

Paginated customer 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": 42,
      "active": true,
      "email": "jane@example.com",
      "segments": [
        1,
        2,
        3
      ]
    }
  ]
}

Changes