Skip to main content
POST
/
api
/
merchant
/
v2
/
customers
Get customers
curl --request POST \
  --url https://mention-me.com/api/merchant/v2/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifiers": [
    {
      "type": "email",
      "value": ""
    }
  ]
}
'
{
  "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": [
          {
            "id": "1234",
            "description": "Referrer gets 20% off. Referee gets 20% off",
            "createdDate": "2023-11-07T05:31:56Z",
            "expiryDate": "2023-11-07T05:31:56Z",
            "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": [
          {
            "answer": "10",
            "feedback": "Really great service!",
            "createdDate": "2023-11-07T05:31:56Z"
          }
        ]
      },
      "createdDate": "2023-11-07T05:31:56Z",
      "lastPurchaseDate": "2023-11-07T05:31:56Z",
      "receivingEmails": true,
      "suspectedOfGaming": true,
      "metrics": {
        "successfulReferrals": 0,
        "shareCount": {
          "all": 0,
          "byFacebook": 0,
          "byFacebookMessenger": 0,
          "byName": 0,
          "byNativeShare": 0,
          "byEmailLink": 0,
          "byWhatsApp": 0
        },
        "firstReferralDate": "2023-11-07T05:31:56Z",
        "lastReferralDate": "2023-11-07T05:31:56Z",
        "firstShareDate": "2023-11-07T05:31:56Z",
        "lastShareDate": "2023-11-07T05:31:56Z"
      },
      "segments": {
        "ecrStatus": "high",
        "ecrActivity": "lapsed",
        "networkId": "N-123",
        "predictedEcr": "high"
      }
    }
  ],
  "errors": [
    {
      "type": "email",
      "value": "<string>",
      "reason": "notFound"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.mention-me.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

RFC8725 Compliant JWT

Body

application/json

A collection of identifiers for customers in Mention Me.

identifiers
object[]
required

Maximum of 100 identifiers.

Required array length: 1 - 100 elements

Response

All customers who matched the identifiers.

A collection of customers with their profile data.

data
object[]
Maximum array length: 100
errors
object[]

All the identifiers which resulted in errors.

Maximum array length: 100
Last modified on March 31, 2026