Search Customers by keyword (email, first name, or last name) for the merchant

GET https://api.leapa.co/v2/customers/search

This endpoint needs your API key

Send it as a bearer token in the Authorization header. A request without one is answered with 401. See Authentication for where to find your key and how to keep it secret.

Request

curl -X GET "https://api.leapa.co/v2/customers/search?keyword=<keyword>&pageFilter=<pageFilter>" \
  -H "Authorization: Bearer $LEAPA_API_KEY" \
  -H "Accept: application/json"

Response

{
  "page": 0,
  "size": 0,
  "total_elements": 0,
  "total_pages": 0,
  "data": [
    {
      "id": "obj_5f21c8a40b",
      "object": "string",
      "email": "jeanne@example.com",
      "address": {
        "object": null,
        "city": null,
        "type": null,
        "status": null,
        "state": null,
        "zip": null,
        "line1": null,
        "line2": null
      },
      "status": "active",
      "first_name": "Jeanne",
      "last_name": "Ndayishimiye",
      "birth_date": "2026-01-31",
      "phone_number": "+25779123456",
      "merchant_name": "Jeanne Ndayishimiye",
      "merchant_id": "mer_1b47d0e9ca",
      "sources": [],
      "destinations": [],
      "live": false,
      "reference_id": "ref_9f2a17c4"
    }
  ]
}

Query parameters

Appended to the URL after a `?`.

keywordstringrequired
pageFilterPageFilterrequired

Response

application/json

pageinteger<int32>
Current page number.
sizeinteger<int32>
Number of element in a page.
total_elementsinteger<int64>
Total Elements.
total_pagesinteger<int64>
The total Pages.
dataarray of CustomerResponse
List of customers
- idstring
  Customer Unique ID
- objectstring
  Customer - Object Returned
- emailstring
  Customer email
- addressAddressResponse
- statusstring
  Customer Status
  Allowed values:activedeactivatedeleted
- first_namestring
  Customer firstname
- last_namestring
  Customer lastname
- birth_datestring
  Customer birthdate
- phone_numberstring
  Customer phone number
- merchant_namestring
  Merchant name associated to this Customer
- merchant_idstring
  Merchant ID associated to this Customer
- sourcesarray of AccountCustomerSourceReferenceResponse
  List of all Account Reference source of the customer
- destinationsarray of AccountCustomerDestinationReferenceResponse
  List of all Account Reference destination of the customer
- liveboolean
  Whether the object exist in live or test mode.
- reference_idstring
  Reference Id

Status codes

200OK
400Bad request
401Unauthorized
402Payment required
403Forbidden
404Not found
428Precondition required
500Server error

Response

{
  "page": 0,
  "size": 0,
  "total_elements": 0,
  "total_pages": 0,
  "data": [
    {
      "id": "obj_5f21c8a40b",
      "object": "string",
      "email": "jeanne@example.com",
      "address": {
        "object": null,
        "city": null,
        "type": null,
        "status": null,
        "state": null,
        "zip": null,
        "line1": null,
        "line2": null
      },
      "status": "active",
      "first_name": "Jeanne",
      "last_name": "Ndayishimiye",
      "birth_date": "2026-01-31",
      "phone_number": "+25779123456",
      "merchant_name": "Jeanne Ndayishimiye",
      "merchant_id": "mer_1b47d0e9ca",
      "sources": [],
      "destinations": [],
      "live": false,
      "reference_id": "ref_9f2a17c4"
    }
  ]
}