All API calls are GET and POST HTTP requests to your account domain (except for requests to the authorization server) at the URL / api / v1

To authenticate each request, you must pass a server API key (parameter api_key).

https://{{your_company}}.flowlu.com/api/v1/module/{{module_name}}/{{entity_name}}/{{method}}?api_key=dDhlTUtENmp4OFBGQkN0N2hUMUNUQ0FFeGI5N2JRZ0VfMQ

Data transfer must be in FORM URLEncoded format.

The number of requests per second per account is specified in the subscription. On trial the limit is 1 request per second. If the limit is exceeded, a response with status 429 with the header "Too Many Requests" is returned.

• https://{{your_company}}.flowlu.com/ — Your account URL, where your account code should be specified instead of your_company
• /api/v1/ - API address and version (v1)
• /module/{{module_name}}/ — points to module
• /{{entity_name}}/ —points to an entity
• /{{method}} — points to a method (create, get, list, delete, update)
• ?api_key=* — your personal API key

The response to the request will be returned in JSON format with HTTP code 200. A successful request contains a response object.

API key management is available in the System Settings → API Settings.

You can create and delete keys, as well as configure access rights to individual modules of each key.

Removing the key will permanently deactivate it.

For authentication using an API key, it is required to pass it with each request to the server the api_key parameter.

Example:

https://{{your_company}}.flowlu.com/api/v1/module/crm/lead/list?api_key=dDhlTUtENmp4OFBGQkN0N2hUMUNUQ0FFeGI5N2JRZ0VfMQ

Oauth 2.0 authorization allows access for external applications to Flowlu.  Unlike API keys, the scope is certain users that allow access to their accounts for an external client.  Registration is available only for the portal's administrator, but the number of applications is unlimited.

How to get an authorization token

To get access to OAuth 2.0 API endpoints, you need to follow steps below:

1. Create an application for external resources in the portal settings to connect to the API.
2. Request authorization approval:

GET https://my.flowlu.com/oauth2/authorize?client_id={{client_id}}&state={{state}}

Parameters:

• client_id (required) - application identifier, located on the detail page of the created application,
• state - random token which will be returned to the client. Use for CSRF attack prevention.

The response to the request is a page of authorization approval. If the user is not logged in, they’ll be redirected to the Flowlu authorization page.

3. If the user allows access, Flowlu is redirected to the redirect_uri of the application, requesting the authorization with a temporary code, code parameter and CSRF token you provided in the state. If the condition doesn't match, the request is created by the third part and you have to interrupt the process. The validity of the temporary code is 10 minutes.

If access is denied by the user, redirection is performed with GET parameters error and error_description with the description of the authorization error.

4. Authorization token receiving:

Content-Type: application / x-www-form-urlencoded

POST https://my.flowlu.com/oauth2/access_token

Parameters (all required):

• grant_type - the value of "code", authorization type;
• client_id - unique identifier of the client application;
• client_secret - application password;
• code - the authorization code that was previously received by the client application;
• redirect_uri - the redirect URI of the client application, where it received the authorization code.

The response is returning in JSON format. Example:

{
   "token_type": "Bearer",
   "expires_in": 5270400,
   "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9",
   "refresh_token": "def50200e167a482b9986d640a2cdba892b58aea5e9"
}

• token_type - to bearer token type;
• expires_in - authorization token lifetime in seconds;
• access_token - JWT authorization token for API access;
• refresh_token - refresh token.

By sending requests to the API endpoints with authorization titles, you’ll be able to receive data according to the user access level of your portal.

Authorization: Bearer {{access_token}}

The authorization token lifetime is 2 days, and the refresh token is 6 months.  Limited lifetime is saving your data from third-party interruptions while compromising. Requests with an expired token will be responded to with the 401 Unauthorized status.

{
    "error": "Access token has been revoked"
}

To get a new authorization token, make a request:

Content-Type: application / x-www-form-urlencoded

POST https://my.flowlu.com/oauth2/refresh_token

Parameters (all required):

• grant_type - value of "refresh_token";
• client_id - unique identifier of the client application;
• client_secret - the client secret value;
• refresh_token - the refresh token.

Example of cURL request:

curl -X "POST" "https://my.flowlu.com/oauth2/refresh_token" \
   -H "Content-Type: application/x-www-form-urlencoded" \
   --data-urlencode "grant_type={{refresh_token}}" \
   --data-urlencode "client_id={{client_id}}" \
   --data-urlencode "client_secret={{client_secret}}" \
   --data-urlencode "refresh_token={{refresh_token}}"

Type of the response will be the same as it is with receiving an authorization token.  Note, that the value of refresh_token is updated, so it has to be recreated and applied during the next request.

GET

• /{{module_name}}/{{entity_name}}/get/{id} - getting a record by id

An example of getting a record with id = 42:

GET https://{{your_company}}.flowlu.com/api/v1/module/crm/lead/get/42

Record requests can return an error of the data received in the request

{
  "error": {
    "error_code": 20,
    "error_msg": "not found"
  }
}

CREATE

• /{{module_name}}/{{entity_name}}/create - creating a record

An example of creating a record:

POST https://{{your_company}}.flowlu.com/api/v1/module/crm/lead/create

The response contains the id field with the identifier of the new record

{
  "response": {
    "id": 5,
    "_resultMessage": "Your application is accepted. Application number # 5"
  }
}

A request to create a record may return a validation error for the data received in the request

{
  "error": "validation",
  "description": "Form filling error",
  "details": {
    "name": "name cannot be empty"
  }
}

UPDATE

/{{module_name}}/{{entity_name}}/update/{ID} — update record by id

An example of updating a record with id = 42

POST https://{{your_company}}.flowlu.com/api/v1/module/crm/lead/update/42

The response contains all the fields in the updated record.

Record update requests may return an error on the data received in the request

{
  "error": {
    "error_code": 20,
    "error_msg": "not found"
  }
}

DELETE

/DELETE/{ID} —deleting a record by id.

Example of deleting a deal with id = 42

GET https://{{your_company}}.flowlu.com/api/v1/module/crm/lead/delete/42

The response contains an id field with the identifier of the deleted record

{
  "response": {
    "id": "42"
  }
}

LIST

/LIST — getting a list of records with the ability to filter.

GET https://{{your_company}}.flowlu.com/api/v1/module/crm/lead/list

GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?search=flowlu&page=3

Available query parameters:

• limit - the maximum number of records given per request. The default is 50, the maximum is 100.
• page - page number of the query result. The default is 1.
• filter - an array of parameters for filtering the resulting list of records.
• search - search query.

Field	Description
total	total number of records, excluding the current search query and applied filters
total_result	total number of records, including the current search query and applied filters
page	page number
count	number of records in response
items	array of objects of received records

{
  "response": {
    "total": 3,
    "page": 1,
    "count": 3,
    "items": [
      {
        "id": 5,
        "active": 1,
        "name": "company5",
      },
      {
        "id": 4,
        "active": 1,
        "name": "company4",
        ...
      },
      ...

    ]
  }
}

To filter the received records, you need to pass the filter parameter, which is an array, in which the key is a field of records to filter.

GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?filter[active]=1

Comma-separated list of values are available.

GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?filter[type_id]=1,2

To exclude by value, use the!

GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?filter[type_id]=!1

Filtering by time interval is possible by passing a JSON object, with fields start_date and end_date

GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?filter[created_date]={"start_date": "2017-02-05", "end_date": "2017-10-05"}

GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?filter[closed_date]={"start_date": "2017-01-05"}

Filtering by tag

GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?filter[_tag_id]=69

Filtering by custom fields

GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?filter[cf.field_1]=filter_value

Filtering by exact match (exact_value) is possible by passing a JSON object with the value field, where the required value is specified

GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?filter[id]={"type": "exact_value", "value": 3}

Filtering by the 'less than' (less) condition is performed by passing a JSON object with the value field, where the maximum value is specified. The response will return records with smaller values

GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?filter[id]={"type": "less", "value": 3}

Filtering by the 'greater than' (more) condition is performed by passing a JSON object with the value field, where the minimum value is specified. The response will return records with greater values

GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?filter[id]={"type": "more", "value": 3}

Filtering by a value range is possible by passing a JSON object with the fields start_value and end_value

GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?filter[id]={"type": "range", "start_value": 3, "end_value": 5}

To return only specific fields in the response, pass the fields parameter, listing the required attributes separated by commas

GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?fields=id,name

To search % LIKE% by values, you need to pass the search = {{value}} parameter..

GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?search=Flowlu

Entities can have relationships with other entities using a foreign key. If the relationship goes on several fields, then additional foreign keys are used, which point to the fields.

For the convenience of working with related entities, you can use the methods described below.

Arguments

• {{module}} - module name.
• {{model}} - model name.
• {{model _id}} - model id
• {{alias}} - Alias used for communication with the entity

Many to one relationship (belongs to)

Keys are stored in the same entity.

Receiving

GET https://{{your_company}}.flowlu.com/api/v1/module/{{module}}/{{model}}/{{model_id}}/{{alias}}/get

Update

POST https://{{your_company}}.flowlu.com/api/v1/module/{{module}}/{{model}}/{{model_id}}/{{alias}}/update

One to many relationship (has many)

Keys are stored in the associated entity.

List

GET https://{{your_company}}.flowlu.com/api/v1/module/{{module}}/{{model}}/{{model_id}}/{{alias}}/list

Create

POST https://{{your_company}}.flowlu.com/api/v1/module/{{module}}/{{model}}/{{model_id}}/{{alias}}/create

Name	Description	Example
int	A number in the range -2147483648 to 2147483647	586844
string	String with a maximum length of 255 characters	There can be text with a maximum length of 255
text	Text	There may be a lot of text here
boolean	1 or 0	1 ; 0
float	Floating point number	457.45869
price	Number, the maximum total number of stored decimal places in which is 20 including 2 after the decimal point	546.56
datetime	ISO 8601 format string (YYYY-MM-DD hh: mm: ss)	2020-08-26 09:31:16
date	ISO 8601 format string (YYYY-MM-DD)	2020-08-26

You can create a new webhook in Flowlu via the System Settings → Webhooks. The data is sent in JSON format. The request is made as an HTTP POST request.

Format

{
  "meta": {
    "module": "crm",
    "model": "account",
    "action": "create"
  },
  "current": (the object data as of this update),
  "previous": (the object data prior to this update)
}

Fields

Field	type	description
meta.module	string	Entity module name
meta.model	string	Entity model name
meta.action	string	Event name ("create", "update" or "delete")
current	object or null	Entity current state
previous	object or null	Entity previous state

Entity state is data that are placed in a way which conforms to our API Reference.

This API allows you to manage users in the system.

1. Conditions and Permissions

To perform user creation and editing operations, the authenticated OAuth2.0 user (or API key) must meet one of the following conditions:

• Portal Administrator: A user with administrator rights in the system.
• Access to "System" Module: An API key with access to system methods.

A user can also update their own data without special permissions.

---

2. User Object Fields

The user object is composed of core fields and profile fields. Not all fields are writable, and available fields differ between create and update operations.

Core Fields

These fields contain the fundamental, read-only information about the user.

Field	Type	Description
id	integer	Unique identifier for the user.
username	string	Login name, typically the user's email address.
name	string	The full name of the user, generated automatically.
lang_id	integer	ID of the user's interface language.
register_date	string	The date and time when the user was registered.
last_active	string	The date and time of the user's last activity.
image	string	URL path to the user's profile picture.
role_admin	integer	1 if the user is an administrator, 0 otherwise.
role_login	integer	1 if the user is allowed to log in, 0 otherwise.
role_external	integer	1 if the user is an external user, 0 otherwise.

Writable Core & Profile Fields

These fields can be provided during create or update operations, as specified in the endpoint documentation.

Field	Type	Description
first_name	string	User's first name.
second_name	string	User's middle name or patronymic.
last_name	string	User's last name.
birth_date	string	User's birth date in YYYY-MM-DD format.
timezone	string	The user's timezone (e.g., "Europe/Moscow").
email_personal	string	User's personal email address.
phone_mobile	string	Mobile phone number.
phone_work	string	Work phone number.
phone_internal	string	Internal office phone number or extension.
web	string	URL of a personal or company website.
description	string	A short biography or description.
ref	string	An external system reference identifier.
ref_id	string	The ID for the external system reference.
position	string	The user's job title or position.
link_*	string	Social media links (e.g., link_telegram).
cf_*	mixed	Custom fields defined in the system.

---

3. Get List of Users

GET /api/v1/module/core/user/list

Retrieves a paginated and filterable list of users. (See previous sections for full details)

---

4. Get User Details

GET /api/v1/module/core/user/get/{id}

Retrieves detailed information about a user by their ID. (See previous sections for full details)

---

5. Get Current User Details

GET /api/v1/module/core/user/get

Retrieves detailed information about the currently authenticated user. (See previous sections for full details)

---

6. Create User

POST /api/v1/module/core/user/create

Creates a new user.

Required Permissions: The user must be a portal administrator or use an API key with access to system methods.

Request Body Parameters:

Field	Type	Required	Description
email	string	Yes	User's email. This will be used to set the read-only username field.
role_login	integer	No	1 (default) allows login, 0 creates a "dummy" user record without login.
first_name	string	No	User's first name.
last_name	string	No	User's last name.
position	string	No	User's job title.
...	...	No	Any other writable Core & Profile fields.

Example Request:

POST /api/v1/module/core/user/create
Content-Type: application/json

{
    "email": "new.user@example.com",
    "first_name": "New",
    "last_name": "User",
    "role_login": 1,
    "position": "Manager"
}

---

7. Update User by ID

POST /api/v1/module/core/user/update/{id}

Updates an existing user's data.

Required Permissions:

• A user can update themselves.
• A portal administrator or an API key with access to system methods can update any user.

Important Note: Core fields (first_name, last_name, etc.) will not be updated if the user is a member of multiple accounts. Only Profile fields are updated in this scenario.

Request Body Parameters:

This endpoint accepts any of the "Writable Core & Profile Fields" listed in section 2. Fields like id, username, email, and role_* cannot be modified via this method.

Example Request:

PUT /api/v1/module/core/user/update/123
Content-Type: application/json

{
    "first_name": "Jonathan",
    "position": "Senior Developer",
    "link_telegram": "@jonathan_dev"
}

---

8. Update Current User Data

PUT /api/v1/module/core/user/update

Updates data for the currently authenticated user.

Request Body Parameters:

This endpoint accepts any of the "Writable Core & Profile Fields" listed in section 2. Fields like id and role_* cannot be modified.

Example Request:

PUT /api/v1/module/core/user/update
Content-Type: application/json

{
    "position": "Lead Specialist"
}

Response (200 OK - updated user object):

{
    "id": 123,
    "username": "current.user@example.com",
    "first_name": "Jane",
    "last_name": "Doe",
    "position": "Lead Specialist"
    // ... other updated fields
}

An entity can have custom fields. Such fields are named using the pattern cf_{{number}}. In entity, you cannot create a new field from the API, but you can change, add and remove values, just like with regular entity fields. To get full information about a field, you need add customfields = 1 in query parameters.

If a custom field is configured to use an alias, field name has to look like cf_{{alias}}. To make the field work with an alias, "alias" and "api_use_alias=1" have to be filled.

 If you change the CustomField value but it doesn't update, try cf.{{number}} instead of cf_{{number}}. In some cases, cf_{{number}} template may not work correctly. To set values in checkboxes use square brackets cf_900[] (cf_900[] = option_id, cf_900[] = option2_id). Drop-down sets like a regular field (cf_900 = option_id).

Examples:

1. https://{{your_company}}.flowlu.com/api/v1/module/task/tasks/get/8225

"response": {
                "id": 8225,
                "name": "Task 1",
                ...
                "crm_account_id": 0,
                "cf_900": "0",
                "cf_phone": "+46764055555" 
        }

2. https://{{your_company}}.flowlu.com/api/v1/module/task/tasks/get/8225?customfields=1

"response": {
                "id": 8225,
                "name": "Task 1",
                ...
                "crm_account_id": 0,
                "customfields": [
                    {
                        "id": "900",
                        "title": "Yes-No",
                        "type": "boolean",
                        "value": "0"
                    }
                    {
                        "id": "901",
                        "title": "Phone number",
                        "alias": "phone",
                        "api_use_alias": "1"
                        "type": "smalltext",
                        "value": "+46764055555"
                    }
                ]
        }

3. Seting values in checkboxes

https://{{your_company}}.flowlu.com/api/v1/module/crm/contact/update/666?api_key=<api_key>' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data 'cf_900[]=866' \ --data 'cf_900[]=897'

https://{{your_company}}.flowlu.com/api/v1/module/crm/contact/update/666?api_key=<api_key>' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data 'cf\_{{alias}}[]=866' \ --data 'cf\_{{alias}}[]=897'

Model relations

---

Has many relation

Alias	Module	Model	Foreign key
fields	Custom fields	Fields	fieldset_id

Model relations

---

Belongs to relation

Alias	Module	Model	Foreign key
_fieldset	Custom fields	Fieldsets	fieldset_id
parent_cache	Custom fields	Fields	cache_parent_id

Has many relation

Alias	Module	Model	Foreign key
options	Custom fields	Options	field_id
selected_options	Custom fields	Selected checkboxes option	field_id
cache_fields	Custom fields	Fields	cache_parent_id

Options

Model relations

---

Belongs to relation

Alias	Module	Model	Foreign key
field	Custom fields	Options	field_id

Model relations

---

Belongs to relation

Alias	Module	Model	Foreign key
field	Custom fields	Fields	field_id
option	Custom fields	Options	fieldoption_id