Overview

For a developer, Flowlu is a relational database. The system contains main and auxiliary entities (in substance, data tables) that may be linked between each other. Access to them is provided through API realized by GET & POST HTTP requests on your account’s URL (expect auth requests).

Request must contains API-key or Access token.

Exapmle

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

Request description

  • https://company.flowlu.com/ - your account’s URL
  • /api/v1/ - API request (ver 1);
  • /module/crm/ - module name;
  • /lead/ - entry name;
  • /list - method name;
  • ?api_key=* - your personal API-key. You can manage API-keys in your account settings.

Response will return JSON with HTTP code 200 and will contains object response

Example

{
  "response": {
    "total": 4,
    "page": 1,
    "count": 4,
    "items": [
      {
        "id": 1,
        "name": "Invoicing",
        "ordering": 1,
        "active": 1
      },
      {
        "id": 2,
        "name": "Project managment",
        "ordering": 2,
        "active": 1
      },
      {
        "id": 3,
        "name": "Tech lead",
        "ordering": 3,
        "active": 1
      },
      {
        "id": 4,
        "name": "Overall",
        "ordering": 4,
        "active": 1
      }
    ]
  }
}

In case of error will return object error, contains field error_code and optionally fields error_msg and error_details

{
  "error": {
    "error_code": 11,
    "error_msg": "authorization failed"
  }
}

Error codes description

10 unknown unknown error
11 authorization failed Authorization error. If used access token you need to get new one. If used API key, you need check API-key exists and correct in your account settings
12 invalid request The request is incorrect
13 internal server error Server error, retry request later
20 not found The entry not found
21 validation error The request has errors. Incorrect fields and errors description will in response in array with error_details
22 access denied Access denied
30 unknown method The requested method is incorrect or not available for reaqested entry
31 unknown module Requested module not found, not installed
32 unknown model Requested object (entry) not found, not exist