Loyalty API

Get a loyalty customer's points balance

GET
https://api.sandbox.primer.io/loyalty-customers/:id

The Loyalty API is currently in beta. Please contact support@primer.io for access.

Create an API key with the loyalty-transactions:read scopes.

Get a loyalty customer by ID and connection ID. This includes the customer's points balance.

The connectionId is the unique Primer identifier for your loyalty provider connection. Primer will provide this once the loyalty provider connection is created.

The customerId refers to the customer identifier on the loyalty provider's side.

Path parameters

id
string

The unique identifier for the customer on the loyalty provider.

Query parameters

connectionId
string

ID of the Primer connection configuration.

Response

This endpoint return an object.
id
optional string

The unique identifier for the customer on the loyalty provider.

connectionId
optional string

ID of the Primer connection configuration.

connectionName
optional string

Name of the loyalty provider.

balance
optional integer

The loyalty customer's points balance.

Errors

GET
/loyalty-customers/:id
1
2
curl "https://api.sandbox.primer.io/loyalty-customers/id" \
     -H "X-API-KEY: <apiKey>"
Response
1
{}