Customers

Get customer list

Retrieve a paginated list of customers from your loyalty program

GET /rest-api/v1/customers

Query parameters

Name	Type	Description
filter	string	Search by Shopify customer ID or customer email
page	int	Page number
pageSize	int	Number of results per page

Response

{
   success: boolean,
   message: string,
   customers: Array<{
       - id
       - birthday
       - shopifyCustomerId
       - email
       - points
       - status
       - createdAt
       - updatedAt
   }>
}

Get customer by ID

Retrieve details of a single customer

GET /rest-api/v1/customers/{id}

Response

{
   success: boolean,
   message: string,
   customer: {
       - id
       - birthday
       - shopifyCustomerId
       - email
       - points
       - status
       - createdAt
       - updatedAt
   }
}

Update customer birthday

Update a customer’s date of birth

POST /rest-api/v1/customers/updateBirthday

Body

Name	Type	Description
customerIdentifier	string	Shopify customer ID or email
day	int	Day of birth
month	int	Month of birth
year	int	Year of birth

Response

{
   success: boolean,
   message: string,
}

Updated on: 19/08/2025

Was this article helpful?

Thank you!