> For the complete documentation index, see [llms.txt](https://api-docs.getflipturn.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-docs.getflipturn.com/readme.md). # Overview The Flipturn API can be used to retrieve data from the Flipturn Platform for use in other systems including ticketing systems, data warehouses, or other analysis/dashboard tools. The API lives at `https://api.getflipturn.com/api/`, and can only be accessed over a secure `https` connection. ## Getting started Read about [how to get an API key](/authorization.md). ## Integration help We're happy to work with you to advise on the best way to use the API to achieve your goals. Just reach out to and our engineering team will get in touch. ## Feedback and requests We believe that your data in Flipturn should always be accessible to you to use as you wish, and are open to requests to expose additional data types in the API. Please contact with any feedback, questions, or API feature requests. ## OCPI Flipturn also supports [OCPI](https://evroaming.org/ocpi/) for integration with roaming partners. Please contact us at if you would like to get access to the OCPI API. --- # 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 following URL with the `ask` and `goal` query parameters: ``` GET https://api-docs.getflipturn.com/readme.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 `build a script that syncs our docs to a CMS` 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.