v1

latestOpenAPI 3.1.02026-07-241120379.1 KB

Read all customers

This endpoint allows you to retrieves a list of all customers along with their subscription count.

get/2023-10/customer/

Query parameters

pageNointeger

The page number to fetch in a paginated response.

pageSizeinteger

The number of records to return per page.

emailstring

Filters results by the customer’s email address.

type'subscriber' | 'all'

Filters customers by type (e.g., Subscriber or all)

updatedAtStartEpochinteger

Start of the time range (in epoch) for filtering customers based on their last update time.

updatedAtEndEpochinteger

End of the time range (in epoch) for filtering customers based on their last update time.

Response

200

successboolean
messagestring
codestring

Example response

{
  "success": true,
  "message": "Customers fetched successfully",
  "data": [
    {
      "id": 1,
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@testloop.com",
      "shopifyId": 6725863080245,
      "phone": "+911234567890",
      "activeSubscriptionsCount": 16,
      "allSubscriptionsCount": 81
    }
  ],
  "code": "SUCCESS"
}