> 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/atreemo.md). # Access Atreemo API Documentation Beta documentation for the direct legacy Atreemo API {% hint style="warning" %} **Beta, runtime validation pending.** This documentation describes the direct legacy Atreemo API through Access API Management. Endpoint availability and routing behaviour require staged release validation, and runtime compatibility with the current non-production Release1.35 environment has not yet been validated. All examples are synthetic. {% endhint %} ## About The Access Group The Access Group is one of the largest UK-headquartered business software providers, founded in 1991 and employing over 7,500 people. The company serves more than 100,000 organisations across the UK, Ireland, US, and Asia Pacific. Our technology portfolio includes enterprise-grade solutions for finance, HR, payroll, payments processing, and sector-specific business management systems. Built on cloud infrastructure, our Access Evo platform leverages AI to deliver integrated software experiences across multiple business functions. As an integration partner, you'll benefit from our extensive ecosystem of connected services and our commitment to open APIs that enable seamless data exchange between systems. ## Access Atreemo Platform Overview Atreemo provides customer, preference, loyalty, transaction, reservation, event, survey, messaging and business-intelligence capabilities. Its API is instance-specific: the authenticated user, allowed API methods, brand hierarchy and instance configuration all affect what a caller can do. Native operation names, parameter casing, response envelopes and side effects are not uniform, so integrations must follow each operation's contract rather than assume one generic pattern. This documentation covers the **direct legacy Atreemo API** and preserves its native surface. It is distinct from the existing `loyalty-v1` API, which exposes a smaller transformed wrapper over selected Atreemo customer and loyalty calls. Do not substitute the wrapper's paths, models or gateway-managed behaviour for the native contract described here. The documented resource contract contains **217 operations on 212 paths**. It was derived from the public Atreemo API version **1.34.0.0 / Release1.34** material and supplemented by cited read-only source inspection. All operations remain runtime-unverified. ## Phase 1 access model A caller obtains a native token directly from the relevant Atreemo instance at `https:///token`. The instance URL and credentials are supplied through the approved Atreemo support and onboarding process. The caller then sends the token to resource calls as `Authorization: Bearer `. The resource base URLs are: ``` Staging https://api-staging.hos.accessacloud.com/atreemo-api Production https://api.hos.accessacloud.com/atreemo-api ``` The gateway forwards the caller's Atreemo bearer token unchanged. Gateway routing and endpoint availability still require staged release validation. Phase 1 does not require an APIM subscription key and does not add Hydra, PKCE, client credentials, token exchange or gateway token acquisition. Use Staging for integration validation. Production use follows separately approved release steps. ## Version caveat Read-only investigation indicates that the current non-production Atreemo environment runs **Release1.35**, while this contract is based on **1.34.0.0 / Release1.34**. Runtime compatibility with Release1.35 remains to be validated before production use. Start with [Introduction](/atreemo-api/get-started/introduction.md), then review [Authentication](/atreemo-api/get-started/authentication.md), [Permissions](/atreemo-api/get-started/permissions.md), the workflow guides and the [API reference](/atreemo-api/api-reference/atreemo-api-reference.md). --- # 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/atreemo.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.