Caflou

Welcome to the documentation for Caflou API v1. Documentation is continuously updated, changes may occur.

On all LIST requests, you can also pass per parameter so you can list more than 20 records (which is the default). The maximum value is 1000 but use it wisely, please. Your access can be limited due to overload.

You can also pass the filter as a parameter with its values related to the current bject type. Available filter values are not documented yet but you can read them from the web UI. Example:

json

{
  "filter": {
    "search": "Find this name",
    "start_date": "2022-12-31",
    "company_ids": "1,2"  
  }
}

AUTHORIZATIONBearer Token

Token

{access_token}

Authentication

On each further API request you will need an valid access_token. To gain an access_token POST credentials of the user (email and password) as 'Basic Auth' - https://en.wikipedia.org/wiki/Basic_access_authentication

Access tokens expire 1 week after creation.

POSTGet Access Token

https://app.caflou.com/api/v1/login?otp

https://en.wikipedia.org/wiki/Basic_access_authentication

Example of creating hash value in JavaScript:

javascript

const email = 'your@email.com'
const password = 'yourPassword'
const hash = btoa(`${email}:${password}`)

AUTHORIZATIONBasic Auth

Username

Password

HEADERS

Authorization

Basic {hash}

hash - base64 encoded email:password

PARAMS

otp

If you have enabled 2-factor authentication provide one time password (the 6 digits code).

Accounts

The most of API requests are in scope of the Account. For this purpose you need {account_id} parameter which is part of the URL path.

AUTHORIZATIONBearer Token

This folder is using Bearer Token from collectionCaflou