BETA Leady API

Please note that this API is currently a beta version. We are working hard to keep adding additional features and will get them added as quickly as possible. Such changes may become effective without prior notice. We welcome any feedback on the API or its documentation. For contacts see below. Thank you!

Why Open API?

We believe our clients have the right to be fully in charge of all their data collected by Leady. And because effortless use and seamless integration is our priority, we introduce Open API.

So our clients can review all session and actions we (Leady) collected on their behalf. Also, details on referenced companies and persons can be reached. Some additional technical stuff is readable. Later we provide tools to filter and manage the data.

The communication is based on the standard HTTP and JSON protocols, a simple, powerful and fully open tools.

Authentication

We provide each user with an individual, secret, long-lasting access token that can be requested by the api-token-get call below. Your registered e-mail address and valid password needs to be provided with this call.

In case you want to reset you token, for example when it leaks out of your control, use the api-token-reset call to regenerate a new random value. However please note, that all present accesses will be lost instantly.

Live interaction

First, get your token using the INTERACT button in the api-token-get call, fill in your Email and Password, click SEND REQUEST and save the resulting token.

Second, expand the Authentication tab on the bottom of the sidebar, click token, paste the token to the Token line and submit. From now on, until you reload the page, you can use the calls that require the Authorization header.

Pagination

Sometimes you would get too many output records in a single response. In this case, the cursor-based pagination is used for best performance. Provided the previous or next page of results exist, use the appropriate link in your list response to retrieve it.

Throttling

If your application goes a little wild and calls the Leady API too often, it might get throttled. That is to say, once the HTTP Response Code is 429, the client should cease requesting for the number of seconds found in the Retry-After header of the response.

The limits are set individually for different types of data.

If you run into this during your normal work, please contact us to sort it out.

Contact

Anytime you experience an issue regarding API or its documentation, or in case you find out some missing functionality, do not hesitate to let us know. We would also love to hear your tips or just chat with you.

Please contact us via info@leady.com

# For your convenience we offer examples
# based on the ubiquitous curl tool:
$ curl "https://api.leady.com/v1/" \
  -X "GET" \
  -H "Authorization: Token {your_access_token}" \
  -H "Content-type: application/json; charset=utf-8"
Except for the api-token-get call, the Authorization header is mandatory.
# Install the Python client library
$ pip install coreapi
<!-- Load the JavaScript client library -->
<script src="//impr.cz/s/leady/rest_framework/js/coreapi-0.1.0.js"></script>
<script src="/schema.js"></script>

api-token-get

api-token-reset

resources

sessions

companies

persons

saved-filters

blacklist