> For the complete documentation index, see [llms.txt](https://docs.hos.accessacloud.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hos.accessacloud.com/atreemo-api/api-reference/atreemo-api-reference/loyalty-program.md). # Loyalty Program API method to get loyalty program details Standard API Responses 200 Success 401 Unauthorized (no valid access token provided) 403 Forbidden Forbidden (indicates you do not have access to this method) 404 Not Found (indicates invalid parameters or missing API endpoint) 500 Internal Server Error (indicates something went wrong on our end) for 200-level responses there is a field named ResponseStatus which will give you the status of the call : true Success false there is an error (you will find the error code and the description in the object Errors ) Possible Errors 2 Internal Error 3 Not authorized to use the brand requested or brand id is missing 26 Many result returned, please specify a brandID ## Get > This method will return the loyalty program details to the specified brand sent in the parameter BrandID :Not mandatory parameter, only used if the instance contains multiple loyalty programs ```json {"openapi":"3.0.3","info":{"title":"Atreemo API","version":"0.1.0"},"tags":[{"name":"LoyaltyProgram","description":"API method to get loyalty program details Standard API Responses 200 Success 401 Unauthorized (no valid access token provided) 403 Forbidden Forbidden (indicates you do not have access to this method) 404 Not Found (indicates invalid parameters or missing API endpoint) 500 Internal Server Error (indicates something went wrong on our end) for 200-level responses there is a field named ResponseStatus which will give you the status of the call : true Success false there is an error (you will find the error code and the description in the object Errors ) Possible Errors 2 Internal Error 3 Not authorized to use the brand requested or brand id is missing 26 Many result returned, please specify a brandID"}],"servers":[{"url":"https://apim-hospitality-dev-uksouth.azure-api.net/atreemo-api","description":"Local DEV APIM import draft only; not a deployed endpoint announcement."}],"security":[{"AtreemoBearer":[]}],"components":{"securitySchemes":{"AtreemoBearer":{"type":"http","scheme":"bearer","description":"Atreemo access token obtained by the caller from the Atreemo instance `POST /token` endpoint (OAuth2 password grant) and sent as `Authorization: Bearer `. See the Authorisation guide."}},"schemas":{"LoyaltyProgramOutput":{"type":"object","properties":{"Errors":{"type":"array","items":{"$ref":"#/components/schemas/APICallError"},"description":"Collection of errors if exist"},"ResponseData":{"allOf":[{"$ref":"#/components/schemas/LoyaltyProgram"}],"description":"Loyalty program details"},"ResponseStatus":{"type":"boolean","description":"True: if the action was succsessfully treated False: if there is an error"}}},"APICallError":{"type":"object","properties":{"ErrorCode":{"type":"integer","format":"int32","description":"The error code"},"ErrorDescription":{"type":"string","description":"The error description"}}},"LoyaltyProgram":{"type":"object","properties":{"Active":{"type":"boolean","description":"The status of the program"},"BrandID":{"type":"integer","format":"int32","description":"The ID of the brand value = 0 mean that theris only one loyalty program in the instance"},"BrandName":{"type":"string","description":"the name of the brand"},"CashRatio":{"type":"integer","format":"int32","description":"The ratio will be used to calaculate the balance of the customer when converted to cash (Applicable only if scheme is Points)"},"EarningRatio":{"type":"integer","format":"int32","description":"The ratio will be used to calaculate the points based on the payment amount (Applicable only if scheme is Points)"},"LoyaltyProgramID":{"type":"integer","format":"int32","description":"The ID of the program"},"MaxPerday":{"type":"integer","format":"int32","description":"Maximum earning per day"},"Rewards":{"type":"integer","format":"int32","description":"Number of Points/Stamps after each transaction (Applicable only if scheme is Stamps)"},"Scheme":{"type":"string","description":"The type of loyalty program (Points or Stamps)"},"Thresholds":{"type":"array","items":{"$ref":"#/components/schemas/LoyaltyThreshold"},"description":"List of thresholds if exist"}}},"LoyaltyThreshold":{"type":"object","properties":{"Name":{"type":"string","description":"The name of the threshold"},"OfferID":{"type":"integer","format":"int32","description":"The offer to be given to the customer once he raech the threshold value"},"Priority":{"type":"integer","format":"int32","description":"The priority if we hame many"},"ThresholdID":{"type":"integer","format":"int32","description":"The ID of the Threshold"},"Value":{"type":"integer","format":"int32","description":"When a customer reach this value , we will burn these points/stamps and convert them to offer if exist"}}}},"responses":{"401":{"description":"Unauthorized (no valid access token provided). Wording from the Atreemo folder documentation; the response body for this status is not documented."},"403":{"description":"Forbidden (indicates you do not have access to this method). Wording from the Atreemo folder documentation; the response body for this status is not documented."},"404":{"description":"Not Found (indicates invalid parameters or missing API endpoint). Wording from the Atreemo folder documentation; the response body for this status is not documented."},"500":{"description":"Internal Server Error (indicates something went wrong on our end). Wording from the Atreemo folder documentation; the response body for this status is not documented."}}},"paths":{"/api/LoyaltyProgram/Get":{"get":{"operationId":"LoyaltyProgramGet","summary":"Get","tags":["LoyaltyProgram"],"description":"This method will return the loyalty program details to the specified brand sent in the parameter BrandID :Not mandatory parameter, only used if the instance contains multiple loyalty programs","parameters":[{"name":"BrandID","in":"query","schema":{"type":"integer","format":"int32","nullable":true},"description":"Native query parameter. CLR int? BrandID in the pinned controller signature.","required":false}],"responses":{"200":{"description":"OK (sample status in the public collection).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoyaltyProgramOutput"}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.hos.accessacloud.com/atreemo-api/api-reference/atreemo-api-reference/loyalty-program.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.