Documentation for the Loyalty V1 API. Updated on 07/02/2024

Authentication & Identifications

We use a Bearer token identification with a fixed API secret for authentication

For identification we you need to set an additional header X-Tenant-id your applications’ tenant ID.

curl --location '<http://loyalty.thismightwork.co/api/v1/users/get>' \\
--header 'X-Tenant-id: [YOUR TENANT ID]' \\
--header 'Authorization: Bearer [YOUR TOKEN]' \\
--data ''

Should you execute the request with wrong or missing headers, you will receive an HTTP Response 401 (Unauthorized).

HTTP response codes

• 200 — Success Everything went smooth.
• 401 — Unauthorized Missing or incorrect API secret or tenant id in header.
• 500 — Internal Server Error This is an issue processing your request.
• 503 — Service Unavailable During planned service outages, services will return this HTTP response and associated JSON body.

Endpoints

Endpoint URL

The API is built on REST principles. Authenticated users can interact with any of our URIs by using the specified HTTP request method. We enforce TLS encryption by issuing requests via HTTPS.

<https://loyalty.thismightwork.co/api/>

Transactions

Getting transactions

GET /v1/transactions/get