> For the complete documentation index, see [llms.txt](https://developers.trooply.co.uk/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.trooply.co.uk/trooply-developer-api.md). # Trooply Developer API The Trooply API gives developers programmatic access to Trooply for building integrations and custom development on top of the platform. Whether you're syncing data with another system, automating workflows, or building bespoke tooling for your group, these endpoints are here to help you extend what Trooply can do. We'd also love to hear about anything you build on top of Trooply! Get in touch at to tell us how you're using the API. #### API Support These APIs are provided primarily for integration building and development. We're always happy to point you in the right direction and offer guidance where we can — but please be aware that the API is largely unsupported from a technical standpoint. There's no formal SLA, and we can't commit to hands-on debugging of your integration. Treat it as a "best effort" resource rather than a supported product surface. #### Authentication & API keys API keys are generated through your account settings on the main Trooply application. Create a key there, keep it secret, and include it with your requests.\ Keys are tied to your account, so anything done with a key is attributed to you. #### Rate Limiting Every API key is subject to rate limits. This matters more than it might first appear: * Stay within your limits. Build retries, backoff, and sensible request pacing into your integration from the start. * Hitting a rate limit isn't isolated to the API. If a key repeatedly exceeds its limits, our abuse guardrails may treat it as abusive traffic. Depending on severity, this can result in your key — and in some cases your wider access to the Trooply application — being throttled or blocked, not just your API calls. #### Getting started 1. Sign in to the your Trooply account 2. Visit your Account Settings, then the 'Developers' section. 3. Read the endpoint reference below for the resources you need. 4. Build, test against your own data, and pace your requests. 5. Reach out if you need guidance — just remember support is best-effort. --- # 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 dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://developers.trooply.co.uk/trooply-developer-api.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.