GET
/
v2
/
customers
curl --request GET \
  --url https://api.loyaltylion.com/v2/customers
{
  "customers": [
    {
      "id": 123,
      "merchant_id": "<string>",
      "email": "<string>",
      "points_approved": 123,
      "points_pending": 123,
      "points_spent": 123,
      "properties": {},
      "metadata": {
        "shopify_source_url": "<string>"
      },
      "rewards_claimed": 123,
      "blocked": true,
      "guest": true,
      "enrolled": true,
      "enrolled_at": "<string>",
      "referral_id": "<string>",
      "referred_by": {
        "id": 123,
        "merchant_id": "<string>"
      },
      "loyalty_tier_membership": {
        "started_at": "<string>",
        "expires_at": "<string>",
        "manual": true,
        "loyalty_tier": {
          "id": 123,
          "name": "<string>",
          "number": 2,
          "default": true,
          "hidden": true,
          "lower_bound": "<string>",
          "upper_bound": "<string>",
          "position": 1
        }
      },
      "insights_segment": "At Risk",
      "birthday": "<string>",
      "referral_url": "<string>",
      "linked_merchant_ids": [
        "<string>"
      ],
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "cursor": {
    "prev": "<string>",
    "next": "<string>"
  }
}

Query Parameters

​
since_id
integer

Return only resources whose id is after the specified id

Required range: x > 0
​
limit
integer
default:
100

Max number of resources to return per request

Required range: 1 < x < 500
​
page
integer
deprecated

Fetch another page of results. This field is deprecated and will be removed in a future version of the API. Use cursors for pagination instead

Required range: x > 1
​
sort_field
enum<string>
Available options:
id,
updated_at
​
sort_direction
enum<string>
Available options:
asc,
desc
​
cursor
string

Fetch another page of results using a cursor returned in a previous response

​
email
string

Return only customers whose email contains the specified string

​
created_at_min
string

Return only customers created on or after the specified ISO 8601 datetime string

​
created_at_max
string

Return only customers created before the specified ISO 8601 datetime string

​
updated_at_min
string

Return only customers updated on or after the specified ISO 8601 datetime string

​
updated_at_max
string

Return only customers updated before the specified ISO 8601 datetime string

Response

200
application/json
200
​
customers
object[]
required
​
cursor
object
required

Cursors that can be used to fetch the previous or next page of results. If a cursor is null, it means there are no more results in that direction

PaginationUpdate Customer