v1

latestOpenAPI 3.0.02026-07-2673188210.8 KB

host

Get members (with filters)

post/api/v2/host/members/list

Request body

pageinteger required

Starts at 0

pageSizeinteger required

sortOrder'ASC' | 'DESC'

sortBy'lastSeenAt' | 'firstSeenAt' | 'firstName' | 'lastName' | 'email'

Field to sort by

querystring

Search customers by query

filterPreset'with-active-membership'

staticSegmentIdinteger

Filter customers by static segment ID

Example request

{
  "pageSize": 10
}

Response

Example response

{
  "pagination": {
    "pageSize": 10,
    "totalCount": 1
  },
  "payload": [
    {
      "id": 5,
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@mail.example.com",
      "phoneNumber": "1234567890",
      "pictureUrl": "https://example.com/picture.jpg",
      "firstSeen": "2021-01-01T00:00:00Z",
      "lastSeen": "2021-01-01T00:00:00Z",
      "customerFields": [
        {
          "id": 5,
          "label": "Date of Birth",
          "type": "date-of-birth",
          "value": "1990-01-01"
        }
      ],
      "customerTags": [
        {
          "id": 1,
          "name": "VIP",
          "badgeLabel": "VIP",
          "badgeColor": "#fe0000",
          "corporateTagId": 1
        }
      ]
    }
  ]
}