API Reference

Flexie CRM API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors.

We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by HTTP clients. We also support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web or mobile application. JSON is returned by all API responses, including errors. We will send information on new additions and changes to Flexie CRM API and also changed on SDK libraries we announce on the mailing list. Be sure to subscribe to stay informed.

Your API URL is your subdomain + /api/ + your endpoint, as an example it could be like this: https://my-company.flexie.io/api/leads [GET] method

In order to authenticate to your API, it can be done in 2 ways, first one is the most complex one which is the standard OAuth2.0 and you can set it by adding API credentials in the right configuration menu. If you want a more easy and handy method, you can use the simple API key, and you can find it under your account (Top-Right menu under your name), then on the API Settings sub-section.

The simple to use API Authentication can be done by putting your key in the query string of each requests with the index "apikey", as an example it could be like this: https://my-company.flexie.io/api/leads?apikey=xxx-xxxxx-xxxxx [GET/POST/PUT/DELETE] methods, or you can put same parameter on http request header, using same index, so the "apikey".