Sign in

v1

latestOpenAPI 3.0.02026-07-22207183.5 KB
Customers

Get customers

Returns all customers who match the given set of filters.

When filtering by Customer Id, every customer who matches the identifier will be returned.

When filtering by Email, because it is unique, one customer will be returned for each matching identifier.

If we cannot find a customer provided, we will not include them in the response.

If none of the customers provided can be found, we will return a 404.

You may send 100 customers per request.

Scopes: customers:read

Rate limits: 300 requests per 5 minutes. Shared across all 'customers' endpoints.

post/api/merchant/v2/customers

Request body

Response

All customers who matched the identifiers.

Example response

{
  "data": [
    {
      "customerId": "CUST-1234",
      "email": "email@mention-me.com",
      "firstname": "Jane",
      "surname": "Doe",
      "phoneNumbers": [
        "+447123456789",
        "+447987654321"
      ],
      "profileUrl": "https://mention-me.com/merchant/123/customers/43211234",
      "mentionMeCustomerId": 987654321,
      "offers": {
        "active": [
          {
            "description": "Referrer gets 20% off. Referee gets 20% off",
            "situation": "postpurchase",
            "segment": "VIP",
            "shareLink": "https://your-brand.mention-me.com/m/ol/1234",
            "dashboardLink": "https://your-brand.mention-me.com/d/1234"
          }
        ]
      },
      "nps": {
        "recent": [
          {
            "feedback": "Really great service!"
          }
        ]
      },
      "segments": {
        "ecrStatus": "high",
        "ecrActivity": "lapsed",
        "networkId": "N-123",
        "predictedEcr": "high"
      }
    }
  ]
}