List loyalty programs

View as Markdown

Returns the company’s loyalty program(s) with their type-specific parameters. Companies run a single active program today (the list shape is future-proofing): type tells you whether customers earn cashback or stamps, and exactly one of cashback/stamps carries the configuration. Read it once at integration setup to know which loyalty-state fields matter.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

itemslist of objects

The company’s loyalty programs (unpaginated).

Errors

401
Unauthorized Error
429
Too Many Requests Error
503
Service Unavailable Error