Skip to main content
GET
/
api
/
v2
/
customers
List customers
curl --request GET \
  --url https://demo.api.loopcrypto.xyz/api/v2/customers \
  --header 'Authorization: Bearer <token>'
{
  "totalResults": 100,
  "customers": [
    {
      "customerId": "1234567890abcdef",
      "customerRefIds": "1234567890abcdef",
      "paymentMethods": [
        {
          "networkId": 1,
          "merchantId": "67e55044-10b1-426f-9247-bb680e5fe0c8",
          "paymentMethodId": "1234567890abcdef",
          "paymentMethodName": "My Crypto Wallet",
          "active": true,
          "walletAddress": "0x1234567890abcdef",
          "isDefault": true,
          "token": {
            "symbol": "USDC",
            "tokenId": "123e4567-e89b-12d3-a456-426614174000",
            "address": "0x1234567890abcdef",
            "decimals": 6,
            "exchangeRates": [
              {
                "currency": "USD",
                "price": "10000",
                "provider": "CoinMarketCap",
                "timestamp": 1715731200
              }
            ]
          },
          "preAuthorization": {
            "balance": "100",
            "authorization": "49.9"
          }
        }
      ],
      "dateCreated": 1716211200
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
customerId
string

Optional filter to retrieve a specific customer by their unique identifier. If provided, returns only the customer matching this ID

​
paymentMethodId
string

Optional filter to retrieve all customers associated with a specific payment method. Useful for filtering customers when managing multiple payment methods

​
merchantId
string

Optional filter to retrieve all customers associated with a specific merchant. Useful for filtering customers when managing multiple merchants

​
customerRefId
string

Optional filter to retrieve all customers associated with a specific customer reference ID. Useful for filtering customers when managing multiple customers

​
subscriptionRefId
string
deprecated

Optional filter to retrieve all customers associated with a specific subscription. Useful for filtering customers when managing multiple subscriptions

​
page
number

Optional pagination parameter to specify the page number of the results to return. Default is 1 which is the first page.

​
limit
number

Optional pagination parameter to specify the number of results per page. Default is 25, maximum is 100.

​
sortBy
string

Optional sorting parameter to specify the field to sort the results by. Valid options are "customerId", "customerRefId", and "dateCreated". Default is "dateCreated".

​
sortDir
string

Optional sorting parameter to specify the direction to sort the results by. Valid options are "asc" and "desc". Default is "desc".

Response

Ok

​
totalResults
number
required

The total count of customers matching the search criteria, regardless of page size or number.

Example:

100

​
customers
object[]
required

The list of customers.

⌘I