{"openapi":"3.0.1","info":{"description":"## Introduction\n\nAll API calls are GET and POST HTTP requests to your account domain (except for requests to the authorization server) at the URL \/ api \/ v1\n\nTo authenticate each request, you must pass a server API key (parameter api\\_key).\n
\n```\nhttps:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/{{module_name}}\/{{entity_name}}\/{{method}}?api_key=dDhlTUtENmp4OFBGQkN0N2hUMUNUQ0FFeGI5N2JRZ0VfMQ\n```\n\nData transfer must be in FORM URLEncoded format.\n\n## Limits\n\nThe number of requests per second per account is specified in the subscription. On trial the limit is 1 request per second.\nIf the limit is exceeded, a response with status 429 with the header \"Too Many Requests\" is returned.\n\n## Common structure\n\n* https:\/\/{{your\\_company}}.flowlu.com\/\u00a0\u2014 Your account URL, where your account code should be specified instead of your\\_company\n* \/api\/v1\/ - API address and version (v1)\n* \/module\/{{module\\_name}}\/ \u2014 points to module\n* \/{{entity\\_name}}\/ \u2014points to an entity\n* \/{{method}}\u00a0\u2014 points to a method (create, get, list, delete, update)\n* ?api\\_key=\\* \u2014 your personal API key\n\nThe response to the request will be returned in JSON format with HTTP code 200. A successful request contains a response object.\n\n## API key\n\nAPI key management is available in the System Settings \u2192\u00a0<\/span>API Settings.\n\nYou can create and delete keys, as well as configure access rights to individual modules of each key.\n\nRemoving the key will permanently deactivate it.\n\nFor authentication using an API key, it is required to pass it with each request to the server the api\\_key parameter.\n\nExample:\n
\n```\nhttps:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/crm\/lead\/list?api_key=dDhlTUtENmp4OFBGQkN0N2hUMUNUQ0FFeGI5N2JRZ0VfMQ\n```\n\n## OAuth 2.0\n\nOauth 2.0 authorization allows access for external applications to Flowlu.\u00a0<\/span>\nUnlike API keys, the scope is certain users that allow access to their accounts for an external client.\u00a0<\/span>\nRegistration is available only for the portal's administrator, but the number of applications is unlimited.<\/span>\n\n#### How to get an authorization token\n
\nTo get access to OAuth 2.0 API endpoints, you need to follow steps below<\/span>:\n\n1. Create an application for external resources in the portal settings to connect to the API<\/span>.\n2. Request authorization approval<\/span>:\n\n```\nGET https:\/\/my.flowlu.com\/oauth2\/authorize?client_id={{client_id}}&state={{state}}\n```\n\nParameters:\n\n* **client\\_id** (required) - application identifier, located on the detail page of the created application<\/span>,\n* **state** - random token which will be returned to the client. Use for CSRF attack prevention<\/span>.\n\nThe response to the request is a page of authorization approval. If the user is not logged in, they\u2019ll be redirected to the Flowlu authorization page.<\/span>\n\n3. 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<\/span>.\n\nIf access is denied by the user, redirection is performed with **GET** parameters **error** and **error\\_description** with the description of the authorization error.<\/span>\n\n4. Authorization token receiving<\/span>:\n\n`Content-Type:\u00a0application \/ x-www-form-urlencoded`\n
\n```\nPOST https:\/\/my.flowlu.com\/oauth2\/access_token\n```\n\nParameters (all required):\n\n* **grant\\_type**\u00a0- the value of \"code\", authorization type<\/span>;\n* **client\\_id**\u00a0- unique identifier of the client application<\/span>;\n* **client\\_secret** - application password<\/span>;\n* **code** - the authorization code that was previously received by the client application<\/span>;\n* **redirect\\_uri**\u00a0- the redirect URI of the client application, where it received the authorization code<\/span>.\n\n
\nThe response is returning in JSON format. Example<\/span>:\n\n```\n{\n \"token_type\": \"Bearer\",\n \"expires_in\": 5270400,\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9\",\n \"refresh_token\": \"def50200e167a482b9986d640a2cdba892b58aea5e9\"\n}\n```\n\n* **token\\_type**\u00a0- to bearer token type<\/span>;\n* **expires\\_in** - authorization token lifetime in seconds<\/span>;\n* **access\\_token** - JWT authorization token for API access<\/span>;\n* **refresh\\_token**\u00a0- refresh token<\/span>.\n\nBy sending requests to the API endpoints with authorization titles, you\u2019ll be able to receive data according to the user access level of your portal.<\/span>\n
\n```\nAuthorization: Bearer {{access_token}}\n```\n\nThe authorization token lifetime is 2 days, and the refresh token is 6 months.<\/span>\n\u00a0Limited 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.<\/span>\n
\n```\n{\n\u00a0\u00a0\u00a0\u00a0\"error\": \"Access token has been revoked\"\n}\n```\n
\nTo get a new authorization token, make a request<\/span>:\n\n`Content-Type:\u00a0application \/ x-www-form-urlencoded`\n
\n```\nPOST https:\/\/my.flowlu.com\/oauth2\/refresh_token\n```\n\nParameters (all required):\n\n* **grant\\_type**\u00a0-\u00a0value of \"refresh\\_token\"<\/span>*;*\n* **client\\_id**\u00a0- unique identifier of the client application<\/span>;<\/span>\n* **client\\_secret** -\u00a0the client secret value<\/span>;<\/span>\n* **refresh\\_token**\u00a0- the refresh token.\n\n
\nExample of cURL request<\/span>:\n\n```\ncurl -X \"POST\" \"https:\/\/my.flowlu.com\/oauth2\/refresh_token\" \\\n -H \"Content-Type: application\/x-www-form-urlencoded\" \\\n --data-urlencode \"grant_type={{refresh_token}}\" \\\n --data-urlencode \"client_id={{client_id}}\" \\\n --data-urlencode \"client_secret={{client_secret}}\" \\\n --data-urlencode \"refresh_token={{refresh_token}}\"\n```\n\nType of the response will be the same as it is with receiving an authorization token.<\/span>\n\u00a0Note, that the value of refresh\\_token is updated, so it has to be recreated and applied during the next request.<\/span>\n\n## Basic methods\n\n### GET\n\n* \/{{module\\_name}}\/{{entity\\_name}}\/get\/{id} - getting a record by id\n\nAn example of getting a record with id = 42:\n
\n```\nGET https:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/crm\/lead\/get\/42\n```\n\nRecord requests can return an error of the data received in the request\n
\n```\n{\n \"error\": {\n \"error_code\": 20,\n \"error_msg\": \"not found\"\n }\n}\n```\n\n### CREATE\n\n* \/{{module\\_name}}\/{{entity\\_name}}\/create - creating a record\n\nAn example of creating a record:\n
\n```\nPOST https:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/crm\/lead\/create\n```\n\nThe response contains the id field with the identifier of the new record\n
\n```\n{\n \"response\": {\n \"id\": 5,\n \"_resultMessage\": \"Your application is accepted. Application number # 5\"\n }\n}\n```\n\nA request to create a record may return a validation error for the data received in the request\n
\n```\n{\n \"error\": \"validation\",\n \"description\": \"Form filling error\",\n \"details\": {\n \"name\": \"name cannot be empty\"\n }\n}\n```\n\n### UPDATE\n\n\/{{module\\_name}}\/{{entity\\_name}}\/update\/{ID} \u2014\u00a0<\/span>update record by id\n\nAn example of updating a record with id = 42\n
\n```\nPOST https:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/crm\/lead\/update\/42\n```\n\nThe response contains all the fields in the updated record.\n\nRecord update requests may return an error on the data received in the request\n
\n```\n{\n \"error\": {\n \"error_code\": 20,\n \"error_msg\": \"not found\"\n }\n}\n```\n\n### DELETE\n\n\/DELETE\/{ID}\u00a0<\/span>\u2014deleting a record by id.\n\nExample of deleting a deal with id = 42\n
\n```\nGET https:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/crm\/lead\/delete\/42\n```\n\nThe response contains an id field with the identifier of the deleted record\n
\n```\n{\n \"response\": {\n \"id\": \"42\"\n }\n}\n```\n\n### LIST\n\n\/LIST\u00a0<\/span>\u2014\u00a0<\/span>getting a list of records with the ability to filter.\n
\n```\nGET https:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/crm\/lead\/list\n```\n\n```\nGET https:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/crm\/account\/list?search=flowlu&page=3\n```\n\nAvailable query parameters:\n
\n* limit - the maximum number of records given per request. The default is 50, the maximum is 100.\n* page - page number of the query result. The default is 1.\n* filter - an array of parameters for filtering the resulting list of records.\n* search - search query.\n\n| Field | Description |\n| ----- | ----------- |\n| total | total number of records, excluding the current search query and applied filters |\n| total\\_result | total number of records, including the current search query and applied filters |\n| page | page number |\n| count | number of records in response |\n| items | array of objects of received records |\n\n```\n{\n \"response\": {\n \"total\": 3,\n \"page\": 1,\n \"count\": 3,\n \"items\": [\n {\n \"id\": 5,\n \"active\": 1,\n \"name\": \"company5\",\n },\n {\n \"id\": 4,\n \"active\": 1,\n \"name\": \"company4\",\n ...\n },\n ...\n\n ]\n }\n}\n```\n\n## Filter\n\nTo 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.\n\n```\nGET https:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/crm\/account\/list?filter[active]=1\n```\n\nComma-separated list of values are available.\n
\n```\nGET https:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/crm\/account\/list?filter[type_id]=1,2\n```\n\nTo exclude by value, use the!\n
\n```\nGET https:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/crm\/account\/list?filter[type_id]=!1\n```\n\nFiltering by time interval is possible by passing a JSON object, with fields start\\_date and end\\_date\n\n```\nGET https:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/crm\/account\/list?filter[created_date]={\"start_date\": \"2017-02-05\", \"end_date\": \"2017-10-05\"}\n```\n\n```\nGET https:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/crm\/account\/list?filter[closed_date]={\"start_date\": \"2017-01-05\"}\n```\n\nFiltering by tag\n\n```\nGET https:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/crm\/account\/list?filter[_tag_id]=69\n```\n\nFiltering by custom fields\n\n```\nGET https:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/crm\/account\/list?filter[cf.field_1]=filter_value\n```\n\nFiltering by exact match (exact\\_value) is possible by passing a JSON object with the value field, where the required value is specified\n\n```\nGET https:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/crm\/account\/list?filter[id]={\"type\": \"exact_value\", \"value\": 3}\n```\n\nFiltering 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\n\n```\nGET https:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/crm\/account\/list?filter[id]={\"type\": \"less\", \"value\": 3}\n```\n\nFiltering 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\n\n```\nGET https:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/crm\/account\/list?filter[id]={\"type\": \"more\", \"value\": 3}\n```\n\nFiltering by a value range is possible by passing a JSON object with the fields start\\_value and end\\_value\n\n```\nGET https:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/crm\/account\/list?filter[id]={\"type\": \"range\", \"start_value\": 3, \"end_value\": 5}\n```\n\nTo return only specific fields in the response, pass the fields parameter, listing the required attributes separated by commas\n\n```\nGET https:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/crm\/account\/list?fields=id,name\n```\n\n## Search\n\nTo search % LIKE% by values, you need to pass the search = {{value}} parameter..\n\n```\nGET https:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/crm\/account\/list?search=Flowlu\n```\n\n## Relations\n\nEntities can have relationships with other entities using a foreign key.\nIf the relationship goes on several fields, then additional foreign keys are used, which point to the fields.\n\nFor the convenience of working with related entities, you can use the methods described below.\n\nArguments\n\n* {{module}} - module name.\n* {{model}} - model name.\n* {{model \\_id}} - model id\n* {{alias}} - Alias used for communication with the entity\n\n### Many to one relationship (belongs to)\n\n> Keys are stored in the same entity.\n\n#### Receiving\n\n```\nGET https:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/{{module}}\/{{model}}\/{{model_id}}\/{{alias}}\/get\n```\n\n#### Update\n\n```\nPOST https:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/{{module}}\/{{model}}\/{{model_id}}\/{{alias}}\/update\n```\n\n### One to many relationship (has many)\n\n> Keys are stored in the associated entity.\n\n#### List\n\n```\nGET https:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/{{module}}\/{{model}}\/{{model_id}}\/{{alias}}\/list\n```\n\n#### Create\n\n```\nPOST https:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/{{module}}\/{{model}}\/{{model_id}}\/{{alias}}\/create\n```\n\n## Data types\n\n| Name | Description | Example |\n| ---- | ----------- | ------- |\n| int | A number in the range -2147483648 to 2147483647 | 586844 |\n| string | String with a maximum length of 255 characters | There can be text with a maximum length of 255 |\n| text | Text | There may be a lot of text here |\n| boolean | 1 or 0 | 1 ; 0 |\n| float | Floating point number | 457.45869 |\n| price | Number, the maximum total number of stored decimal places in which is 20 including 2 after the decimal point | 546.56 |\n| datetime | ISO 8601 format string (YYYY-MM-DD hh: mm: ss) | 2020-08-26 09:31:16 |\n| date | ISO 8601 format string (YYYY-MM-DD) | 2020-08-26 |\n\n## Webhooks\n\nYou can create a new webhook in Flowlu via the System Settings \u2192<\/span>\u00a0Webhooks. The data is sent in JSON format. The request is made as an HTTP POST request.\n\n### Format\n\n``` json\n{\n \"meta\": {\n \"module\": \"crm\",\n \"model\": \"account\",\n \"action\": \"create\"\n },\n \"current\": (the object data as of this update),\n \"previous\": (the object data prior to this update)\n}\n```\n\n### Fields\n\n| Field | type | description |\n| ----- | ---- | ----------- |\n| meta.module | string | Entity module name |\n| meta.model | string | Entity model name |\n| meta.action | string | Event name (\"create\", \"update\" or \"delete\") |\n| current | object or null | Entity current state |\n| previous | object or null | Entity previous state |\n\nEntity state is data that are placed in a way which conforms to our API Reference.\n\n## Users\n\nThis API allows you to manage users in the system.\n\n### 1\\. Conditions and Permissions\n\nTo perform user creation and editing operations, the authenticated OAuth2.0 user (or API key) must meet one of the following conditions:\n\n* **Portal Administrator**: A user with administrator rights in the system.\n* **Access to \"System\" Module**: An API key with access to system methods.\n\nA user can also update **their own** data without special permissions.\n\n- - -\n\n### 2\\. User Object Fields\n\nThe user object is composed of core fields and profile fields. Not all fields are writable, and available fields differ between `create` and `update` operations.\n\n#### Core Fields\n\nThese fields contain the fundamental, read-only information about the user.\n\n| Field | Type | Description |\n| ----- | ---- | ----------- |\n| `id` | integer | Unique identifier for the user. |\n| `username` | string | Login name, typically the user's email address. |\n| `name` | string | The full name of the user, generated automatically. |\n| `lang_id` | integer | ID of the user's interface language. |\n| `register_date` | string | The date and time when the user was registered. |\n| `last_active` | string | The date and time of the user's last activity. |\n| `image` | string | URL path to the user's profile picture. |\n| `role_admin` | integer | `1` if the user is an administrator, `0` otherwise. |\n| `role_login` | integer | `1` if the user is allowed to log in, `0` otherwise. |\n| `role_external` | integer | `1` if the user is an external user, `0` otherwise. |\n\n#### Writable Core & Profile Fields\n\nThese fields can be provided during create or update operations, as specified in the endpoint documentation.\n\n| Field | Type | Description |\n| ----- | ---- | ----------- |\n| `first_name` | string | User's first name. |\n| `second_name` | string | User's middle name or patronymic. |\n| `last_name` | string | User's last name. |\n| `birth_date` | string | User's birth date in `YYYY-MM-DD` format. |\n| `timezone` | string | The user's timezone (e.g., \"Europe\/Moscow\"). |\n| `email_personal` | string | User's personal email address. |\n| `phone_mobile` | string | Mobile phone number. |\n| `phone_work` | string | Work phone number. |\n| `phone_internal` | string | Internal office phone number or extension. |\n| `web` | string | URL of a personal or company website. |\n| `description` | string | A short biography or description. |\n| `ref` | string | An external system reference identifier. |\n| `ref_id` | string | The ID for the external system reference. |\n| `position` | string | The user's job title or position. |\n| `link_*` | string | Social media links (e.g., `link_telegram`). |\n| `cf_*` | mixed | Custom fields defined in the system. |\n\n- - -\n\n### 3\\. Get List of Users\n\n**GET** `\/api\/v1\/module\/core\/user\/list`\n\nRetrieves a paginated and filterable list of users.\n*(See previous sections for full details)*\n\n- - -\n\n### 4\\. Get User Details\n\n**GET** `\/api\/v1\/module\/core\/user\/get\/{id}`\n\nRetrieves detailed information about a user by their ID.\n*(See previous sections for full details)*\n\n- - -\n\n### 5\\. Get Current User Details\n\n**GET** `\/api\/v1\/module\/core\/user\/get`\n\nRetrieves detailed information about the currently authenticated user.\n*(See previous sections for full details)*\n\n- - -\n\n### 6\\. Create User\n\n**POST** `\/api\/v1\/module\/core\/user\/create`\n\nCreates a new user.\n\n**Required Permissions**: The user must be a portal administrator or use an API key with access to system methods.\n\n#### Request Body Parameters:\n\n| Field | Type | Required | Description |\n| ----- | ---- | -------- | ----------- |\n| `email` | string | Yes | User's email. This will be used to set the read-only `username` field. |\n| `role_login` | integer | No | `1` (default) allows login, `0` creates a \"dummy\" user record without login. |\n| `first_name` | string | No | User's first name. |\n| `last_name` | string | No | User's last name. |\n| `position` | string | No | User's job title. |\n| ... | ... | No | Any other writable Core & Profile fields. |\n\n#### Example Request:\n\n```\nPOST \/api\/v1\/module\/core\/user\/create\nContent-Type: application\/json\n\n{\n \"email\": \"new.user@example.com\",\n \"first_name\": \"New\",\n \"last_name\": \"User\",\n \"role_login\": 1,\n \"position\": \"Manager\"\n}\n```\n\n- - -\n\n### 7\\. Update User by ID\n\n**POST** `\/api\/v1\/module\/core\/user\/update\/{id}`\n\nUpdates an existing user's data.\n\n**Required Permissions**:\n\n* A user can update themselves.\n* A portal administrator or an API key with access to system methods can update any user.\n\n**Important Note**:\nCore 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.\n\n#### Request Body Parameters:\n\nThis 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.\n\n#### Example Request:\n\n```\nPUT \/api\/v1\/module\/core\/user\/update\/123\nContent-Type: application\/json\n\n{\n \"first_name\": \"Jonathan\",\n \"position\": \"Senior Developer\",\n \"link_telegram\": \"@jonathan_dev\"\n}\n```\n\n- - -\n\n### 8\\. Update Current User Data\n\n**PUT** `\/api\/v1\/module\/core\/user\/update`\n\nUpdates data for the currently authenticated user.\n\n#### Request Body Parameters:\n\nThis endpoint accepts any of the \"Writable Core & Profile Fields\" listed in section 2. Fields like `id` and `role_*` cannot be modified.\n\n#### Example Request:\n\n```\nPUT \/api\/v1\/module\/core\/user\/update\nContent-Type: application\/json\n\n{\n \"position\": \"Lead Specialist\"\n}\n```\n\n#### Response (200 OK - updated user object):\n\n``` json\n{\n \"id\": 123,\n \"username\": \"current.user@example.com\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"position\": \"Lead Specialist\"\n \/\/ ... other updated fields\n}\n```","version":" 1.0","title":"Flowlu Rest API Documentation","x-logo":{"url":"https:\/\/www.flowlu.com\/img\/flowlu-com-logo.png","href":"https:\/\/www.flowlu.com\/"}},"servers":[{"url":"https:\/\/{company}.flowlu.com\/api\/v1\/module","variables":{"company":{"default":"your_company","description":""}}}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"query","name":"api_key"}}},"security":[{"ApiKeyAuth":[]}],"x-tagGroups":[{"name":"Custom fields","tags":["Customfields","Fieldsets","Fields","Options","Selected checkboxes option"]},{"name":"My Team","tags":["Company","Employee time off","Time off type"]},{"name":"Tasks","tags":["Task","Tasks","Payment logs for fixed cost tasks","Lists","Linking tasks & lists","Followers","Collaborators","Task Workflows","Workflow Statuses"]},{"name":"Calendar","tags":["Calendar"]},{"name":"Agile Projects","tags":["Agile","Issues","Followers","Issue relation types","Issue relation names","Issue relation","Issue type","Sprint","Agile project","Project users","Workflow","Stage","Issue types and project relations ","Agile categories","Reference issue relation","Epics"]},{"name":"CRM","tags":["CRM","Accounts","Relation","Loss reasons","Opportunities sources","Opportunity stages","Pipelines","Opportunities ","Account types","Account industries","Honorifics","Opportunity Followers","Email","Clients phone numbers","Products & Services","Link opportunity to CRM accounts"]},{"name":"Projects","tags":["Project ","Project","Project Templates","Project stages","Stage Checklist","Project team","Estimated Revenue","Estimated Expenses","Project portfolio","CONFIG.M.ST.BASELINE.TITLE","CONFIG.M.ST.BASELINE_ITEM.TITLE"]},{"name":"Finance","tags":["Finance ","Organization","Invoice","Business line","Invoice items","Money","Invoice contacts","Bank account","Account groups","Estimate","Estimate items","Estimate template","Estimate contacts","Transaction","Transactions for the Profit and Loss statement","Recurring invoice","Liabilities","Recurring Invoice settings","Estimated Cash Flow","Linking the invoice items","Payment history by estimated cash flow"]},{"name":"Time Tracker ","tags":["Time Tracker","Time sheet","TIme Log","User rates"]},{"name":"Products & Services","tags":["Product ","Items","Categories","Price list","Price list and item relation","Price","Units","Warehouses","Stock documents","Stock document goods","Accounts Payable to Vendors"]},{"name":"More","tags":["Webhooks","Global tags","Additional usage examples","Files"]}],"tags":[{"name":"Customfields","description":"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.\n\nIf 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.\n\n <\/span>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.\nTo set values in checkboxes use square brackets `cf_900[]` (cf\\_900[] = option\\_id, cf\\_900[] = option2\\_id).\nDrop-down sets like a regular field (cf\\_900 = option\\_id).\n\nExamples:\n\n1. https:\/\/{{your\\_company}}.flowlu.com\/api\/v1\/module\/task\/tasks\/get\/8225\n\n```\n\"response\": {\n \"id\": 8225,\n \"name\": \"Task 1\",\n ...\n \"crm_account_id\": 0,\n \"cf_900\": \"0\",\n \"cf_phone\": \"+46764055555\" \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0}\n```\n\n2. https:\/\/{{your\\_company}}.flowlu.com\/api\/v1\/module\/task\/tasks\/get\/8225?customfields=1\n\n```\n\"response\": {\n \"id\": 8225,\n \"name\": \"Task 1\",\n ...\n \"crm_account_id\": 0,\n \"customfields\": [\n {\n \"id\": \"900\",\n \"title\": \"Yes-No\",\n \"type\": \"boolean\",\n \"value\": \"0\"\n }\n {\n \"id\": \"901\",\n \"title\": \"Phone number\",\n \"alias\": \"phone\",\n \"api_use_alias\": \"1\"\n \"type\": \"smalltext\",\n \"value\": \"+46764055555\"\n }\n ]\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0}\n```\n\n3. Seting values in checkboxes\n\n```\nhttps:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/crm\/contact\/update\/666?api_key=' \\ --header 'Content-Type: application\/x-www-form-urlencoded' \\ --data 'cf_900[]=866' \\ --data 'cf_900[]=897'\n\nhttps:\/\/{{your_company}}.flowlu.com\/api\/v1\/module\/crm\/contact\/update\/666?api_key=' \\ --header 'Content-Type: application\/x-www-form-urlencoded' \\ --data 'cf\\_{{alias}}[]=866' \\ --data 'cf\\_{{alias}}[]=897'\n```"},{"name":"Fieldsets","description":"

Model relations<\/h3><\/a>

Has many relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
fields<\/td>Custom fields<\/td>Fields<\/td>fieldset_id<\/td><\/tr><\/table>"},{"name":"Fields","description":"

Model relations<\/h3><\/a>

Belongs to relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
_fieldset<\/td>Custom fields<\/td>Fieldsets<\/td>fieldset_id<\/td><\/tr>
parent_cache<\/td>Custom fields<\/td>Fields<\/td>cache_parent_id<\/td><\/tr><\/table>

Has many relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
options<\/td>Custom fields<\/td>Options<\/td>field_id<\/td><\/tr>
selected_options<\/td>Custom fields<\/td>Selected checkboxes option<\/td>field_id<\/td><\/tr>
cache_fields<\/td>Custom fields<\/td>Fields<\/td>cache_parent_id<\/td><\/tr><\/table>"},{"name":"Options","description":"Options

Model relations<\/h3><\/a>

Belongs to relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
field<\/td>Custom fields<\/td>Options<\/td>field_id<\/td><\/tr><\/table>"},{"name":"Selected checkboxes option","description":"

Model relations<\/h3><\/a>

Belongs to relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
field<\/td>Custom fields<\/td>Fields<\/td>field_id<\/td><\/tr>
option<\/td>Custom fields<\/td>Options<\/td>fieldoption_id<\/td><\/tr><\/table>"},{"name":"Company","description":"The module \"Company\" will help you track and record employees\u2019 absence details. Flexible settings and custom types of absences will allow you to monitor each employee personally, so you won\u2019t miss any detail.<\/span>\n\nWith a lifestream chart and list of current absences, you and your teammates will be able to check who\u2019s off right now and when this person will get back to work, so you can manage your time and resources better.<\/span>"},{"name":"Employee time off","description":"Contains a list of time off

Model relations<\/h3><\/a>

Belongs to relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
absence_type<\/td>My Team<\/td>Time off type<\/td>absence_type_id<\/td><\/tr><\/table>"},{"name":"Time off type","description":"Contains time off types

Model relations<\/h3><\/a>

Has many relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
absences<\/td>My Team<\/td>Employee time off<\/td>absence_type_id<\/td><\/tr><\/table>"},{"name":"Task","description":"The\u00a0Tasks, inspired by \u2018Getting things done\u2019 methodology,\u00a0allow you to organize collaborative work, delegate tasks, monitor the work of your team and deadlines. This module brings together all the tasks that are related to you. These are personal or delegated tasks, tasks you follow, etc."},{"name":"Tasks","description":"The tasks for the \"Tasks\" module and events for the \"Calendar\" module are described here.

Model relations<\/h3><\/a>

Belongs to relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th>Foreigh keys<\/th><\/tr>
company<\/td>CRM<\/td>Accounts<\/td>crm_account_id<\/td><\/td><\/tr>
template<\/td>Tasks<\/td>Tasks<\/td>template_id<\/td><\/td><\/tr>
calendar<\/td>Calendar<\/td>Calendar<\/td>event_calendar_id<\/td><\/td><\/tr>
workflow<\/td>Tasks<\/td>Task Workflows<\/td>workflow_id<\/td><\/td><\/tr>
workflow_stage<\/td>Tasks<\/td>Workflow Statuses<\/td>workflow_stage_id<\/td><\/td><\/tr>
parent<\/td>Tasks<\/td>Tasks<\/td>parent_id<\/td><\/td><\/tr>
project<\/td>Projects<\/td>Project<\/td>model_id<\/td>module = st, model = project<\/td><\/tr>
project_template<\/td>Projects<\/td>Project Templates<\/td>model_id<\/td>module = st, model = type<\/td><\/tr>
lead<\/td>CRM<\/td>Opportunities <\/td>model_id<\/td>module = crm, model = leads<\/td><\/tr>
project_stage<\/td>Projects<\/td>Project stages<\/td>project_stage_id<\/td>module = st, model = project<\/td><\/tr>
project_stage_checkitem<\/td>Projects<\/td>Stage Checklist<\/td>project_checkitem_id<\/td>module = st, model = project<\/td><\/tr><\/table>

Has many relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th>Foreigh keys<\/th><\/tr>
model_collaborators<\/td>Tasks<\/td>Followers<\/td>task_id<\/td><\/td><\/tr>
model_participants<\/td>Tasks<\/td>Collaborators<\/td>task_id<\/td><\/td><\/tr>
subtasks<\/td>Tasks<\/td>Tasks<\/td>parent_id<\/td><\/td><\/tr>
item_relation<\/td>Finance<\/td>Linking the invoice items<\/td>model_id<\/td>module = task, model = task<\/td><\/tr><\/table>"},{"name":"Payment logs for fixed cost tasks","description":"The payment logs for fixed cost tasks are described here

Model relations<\/h3><\/a>

Belongs to relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
task<\/td>Tasks<\/td>Tasks<\/td>task_id<\/td><\/tr><\/table>"},{"name":"Lists","description":"
"},{"name":"Linking tasks & lists","description":"
"},{"name":"Followers","description":"

Model relations<\/h3><\/a>

Belongs to relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
task<\/td>Tasks<\/td>Tasks<\/td>task_id<\/td><\/tr><\/table>"},{"name":"Collaborators","description":"

Model relations<\/h3><\/a>

Belongs to relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
task<\/td>Tasks<\/td>Tasks<\/td>task_id<\/td><\/tr><\/table>"},{"name":"Task Workflows","description":"

Model relations<\/h3><\/a>

Has many relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
tasks<\/td>Tasks<\/td>Tasks<\/td>workflow_id<\/td><\/tr>
stages<\/td>Tasks<\/td>Workflow Statuses<\/td>workflow_id<\/td><\/tr>
projects<\/td>Projects<\/td>Project<\/td>tasks_workflow_id<\/td><\/tr>
projects_workflows<\/td>Projects<\/td>Project Templates<\/td>tasks_workflow_id<\/td><\/tr><\/table>"},{"name":"Workflow Statuses","description":"

Model relations<\/h3><\/a>

Belongs to relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
workflow<\/td>Tasks<\/td>Task Workflows<\/td>workflow_id<\/td><\/tr><\/table>

Has many relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
tasks<\/td>Tasks<\/td>Tasks<\/td>workflow_stage_id<\/td><\/tr><\/table>"},{"name":"Calendar","description":"
"},{"name":"Agile","description":"With the Agile, you can manage projects that frequently change requirements and priorities.\u00a0The agile approach is frequently used in project management of various industries, such as software development,\u00a0marketing, education, design, etc.\u00a0An agile approach to project management is focused on bringing maximum value for the consumer."},{"name":"Issues","description":"

Model relations<\/h3><\/a>

Belongs to relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
project<\/td>Agile Projects<\/td>Agile project<\/td>project_id<\/td><\/tr>
sprint<\/td>Agile Projects<\/td>Sprint<\/td>sprint_id<\/td><\/tr>
stage<\/td>Agile Projects<\/td>Stage<\/td>workflow_stage_id<\/td><\/tr>
type<\/td>Agile Projects<\/td>Issue type<\/td>type_id<\/td><\/tr>
category<\/td>Agile Projects<\/td>Agile categories<\/td>category_id<\/td><\/tr>
parent_issue<\/td>Agile Projects<\/td>Issues<\/td>parent_issue_id<\/td><\/tr><\/table>

Has many relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
child_issues<\/td>Agile Projects<\/td>Issues<\/td>parent_issue_id<\/td><\/tr>
parent_issue_relations<\/td>Agile Projects<\/td>Issue relation<\/td>parent_issue_id<\/td><\/tr>
child_issue_relations<\/td>Agile Projects<\/td>Issue relation<\/td>child_issue_id<\/td><\/tr>
subtasks<\/td>Agile Projects<\/td>Issues<\/td>parent_issue_id<\/td><\/tr>
ref_tickets<\/td>Agile Projects<\/td>Reference issue relation<\/td>issue_id<\/td><\/tr><\/table>"},{"name":"Followers","description":"
"},{"name":"Issue relation types","description":"

Model relations<\/h3><\/a>

Belongs to relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
parent_relation_name<\/td>Agile Projects<\/td>Issue relation names<\/td>parent_relation_name_id<\/td><\/tr>
child_relation_name<\/td>Agile Projects<\/td>Issue relation names<\/td>child_relation_name_id<\/td><\/tr><\/table>

Has many relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
issue_relations<\/td>Agile Projects<\/td>Issue relation<\/td>type<\/td><\/tr><\/table>"},{"name":"Issue relation names","description":"
"},{"name":"Issue relation","description":"

Model relations<\/h3><\/a>

Belongs to relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
parent_issue<\/td>Agile Projects<\/td>Issues<\/td>parent_issue_id<\/td><\/tr>
child_issue<\/td>Agile Projects<\/td>Issues<\/td>child_issue_id<\/td><\/tr>
relation_type<\/td>Agile Projects<\/td>Issue relation types<\/td>type<\/td><\/tr><\/table>

Has many relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
parent_issues<\/td>Agile Projects<\/td>Issues<\/td>parent_issue_id<\/td><\/tr><\/table>"},{"name":"Issue type","description":"

Model relations<\/h3><\/a>

Has many relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
issues<\/td>Agile Projects<\/td>Issues<\/td>type_id<\/td><\/tr><\/table>"},{"name":"Sprint","description":"

Model relations<\/h3><\/a>

Belongs to relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
project<\/td>Agile Projects<\/td>Agile project<\/td>project_id<\/td><\/tr><\/table>

Has many relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
issues<\/td>Agile Projects<\/td>Issues<\/td>sprint_id<\/td><\/tr><\/table>"},{"name":"Agile project","description":"

Model relations<\/h3><\/a>

Belongs to relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
workflow<\/td>Agile Projects<\/td>Workflow<\/td>workflow_id<\/td><\/tr><\/table>

Has many relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
sprints<\/td>Agile Projects<\/td>Sprint<\/td>project_id<\/td><\/tr>
issues<\/td>Agile Projects<\/td>Issues<\/td>project_id<\/td><\/tr>
categories<\/td>Agile Projects<\/td>Agile categories<\/td>project_id<\/td><\/tr>
project_users<\/td>Agile Projects<\/td>Project users<\/td>project_id<\/td><\/tr><\/table>"},{"name":"Project users","description":"

Model relations<\/h3><\/a>

Belongs to relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
project<\/td>Agile Projects<\/td>Agile project<\/td>project_id<\/td><\/tr><\/table>"},{"name":"Workflow","description":"

Model relations<\/h3><\/a>

Has many relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
stages<\/td>Agile Projects<\/td>Stage<\/td>workflow_id<\/td><\/tr>
projects<\/td>Agile Projects<\/td>Agile project<\/td>workflow_id<\/td><\/tr><\/table>"},{"name":"Stage","description":"

Model relations<\/h3><\/a>

Belongs to relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
workflow<\/td>Agile Projects<\/td>Workflow<\/td>workflow_id<\/td><\/tr><\/table>

Has many relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
issues<\/td>Agile Projects<\/td>Issues<\/td>workflow_stage_id<\/td><\/tr><\/table>"},{"name":"Issue types and project relations ","description":"

Model relations<\/h3><\/a>

Belongs to relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
issue_type<\/td>Agile Projects<\/td>Issue type<\/td>issue_type_id<\/td><\/tr>
project<\/td>Agile Projects<\/td>Agile project<\/td>project_id<\/td><\/tr><\/table>"},{"name":"Agile categories","description":"

Model relations<\/h3><\/a>

Belongs to relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
project<\/td>Agile Projects<\/td>Agile project<\/td>project_id<\/td><\/tr><\/table>

Has many relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
issues<\/td>Agile Projects<\/td>Issues<\/td>category_id<\/td><\/tr><\/table>"},{"name":"Reference issue relation","description":"

Model relations<\/h3><\/a>

Belongs to relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
issue<\/td>Agile Projects<\/td>Issues<\/td>issue_id<\/td><\/tr><\/table>"},{"name":"Epics","description":"
"},{"name":"CRM","description":"The CRM\u00a0includes tools for managing opportunities and features all client information and interaction, i.e. events, tasks, emails, invoices, projects, etc.\u00a0 CRM helps you build efficient sales processes and provides total control over the whole customer journey \u2013 from lead to order.\n\nThere are several paths to access accounts:\n\n* `\/crm\/account\/` \\- companies and contacts\n* `\/crm\/company\/` \\- only companies \\(the same as `\/crm\/account\/`, but with `type = 1`)\n* `\/crm\/contact\/` \\- only contacts \\(the same as `\/crm\/account\/`, but with `type = 2`)\n\nYou can use any path in most cases, but if you're working with custom fields, you need to choose the path that corresponds with the type of a\u00a0 field.\n\n*Example:*\n\nIf you have custom fields `cf_1` created for \"All Accounts\" and `cf_2` for\"Companies\", use:\n\n* For `cf_1`: `\/crm\/account`\n* For `cf_2`: `\/crm\/company`\n\n*Example requests:*\n\n```\n\/\/ correct request for cf_1\n\nhttps:\/\/{account}.flowlu.com\/api\/v1\/module\/crm\/account\/list?api_key={api_key}&filter[cf.field_1]=accounts\n\n\n\/\/ there are no custom fields for cf_2, so the filter won't work\n\nhttps:\/\/{account}.flowlu.com\/api\/v1\/module\/crm\/account\/list?api_key={api_key}&filter[cf.field_2]=company\n\n\n\/\/ correct request for cf_2\n\nhttps:\/\/{account}.flowlu.com\/api\/v1\/module\/crm\/company\/list?api_key={api_key}&filter[cf.field_2]=company\n```"},{"name":"Accounts","description":"This entity in Flowlu is Company or Contact. Accounts can be your customers, suppliers, partners, competitors etc.
Account can has different types (Company - 1 or Contact - 2). Each account can has relations (Relations entity) to other accounts (contact person in some company or companies). Also you can link to account tasks, leads, events, projects invoices and other entities.
The account can be merged with others (if duplicates found). When account is merged, field merge_to contains id of entry in which current was merged

Model relations<\/h3><\/a>

Belongs to relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
category<\/td>CRM<\/td>Account types<\/td>account_category_id<\/td><\/tr>
industry<\/td>CRM<\/td>Account industries<\/td>industry_id<\/td><\/tr>
honorific<\/td>CRM<\/td>Honorifics<\/td>honorific_title_id<\/td><\/tr>
merged_account<\/td>CRM<\/td>Accounts<\/td>merged_to<\/td><\/tr><\/table>

Has many relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th>Foreigh keys<\/th><\/tr>
parent_relations<\/td>CRM<\/td>Relation<\/td>child_acc_id<\/td><\/td><\/tr>
child_relations<\/td>CRM<\/td>Relation<\/td>parent_acc_id<\/td><\/td><\/tr>
contacts_projects<\/td>Projects<\/td>Project<\/td>customer_crm_contact_id<\/td><\/td><\/tr>
companies_projects<\/td>Projects<\/td>Project<\/td>customer_id<\/td><\/td><\/tr>
contacts_tasks<\/td>Tasks<\/td>Tasks<\/td>model_id<\/td>module = crm, model = contact<\/td><\/tr>
companies_tasks<\/td>Tasks<\/td>Tasks<\/td>model_id<\/td>module = crm, model = company<\/td><\/tr>
account_tasks<\/td>Tasks<\/td>Tasks<\/td>model_id<\/td>module = crm, model = account<\/td><\/tr>
companies_linked_tasks<\/td>Tasks<\/td>Tasks<\/td>crm_account_id<\/td><\/td><\/tr>
tasks<\/td>Tasks<\/td>Tasks<\/td>crm_account_id<\/td><\/td><\/tr>
invoices<\/td>Finance<\/td>Invoice<\/td>customer_id<\/td><\/td><\/tr>
payments_in<\/td>Finance<\/td>Transaction<\/td>crm_account_id<\/td>status = 10, type = 10<\/td><\/tr>
payments_out<\/td>Finance<\/td>Transaction<\/td>crm_account_id<\/td>status = 10, type = 20<\/td><\/tr>
payin<\/td>Finance<\/td>Money<\/td>crm_company_id<\/td><\/td><\/tr>
estimates<\/td>Finance<\/td>Estimate<\/td>customer_id<\/td><\/td><\/tr>
plan_money<\/td>Finance<\/td>Estimated Cash Flow<\/td>crm_company_id<\/td><\/td><\/tr>
plan_incomes<\/td>Finance<\/td>Estimated Cash Flow<\/td>crm_company_id<\/td>type = 30<\/td><\/tr>
plan_expenses<\/td>Finance<\/td>Estimated Cash Flow<\/td>crm_company_id<\/td>type = 40<\/td><\/tr>
transactions<\/td>Finance<\/td>Transaction<\/td>crm_account_id<\/td><\/td><\/tr>
multiemails<\/td>CRM<\/td>Email<\/td>account_id<\/td><\/td><\/tr>
multiphones<\/td>CRM<\/td>Clients phone numbers<\/td>account_id<\/td><\/td><\/tr>
lead_accounts<\/td>CRM<\/td>Link opportunity to CRM accounts<\/td>account_id<\/td><\/td><\/tr><\/table>"},{"name":"Relation","description":"Relation

Model relations<\/h3><\/a>

Belongs to relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
account_parent<\/td>CRM<\/td>Accounts<\/td>parent_acc_id<\/td><\/tr>
account_child<\/td>CRM<\/td>Accounts<\/td>child_acc_id<\/td><\/tr><\/table>"},{"name":"Loss reasons","description":"Opportunity Loss Reasons. When an opportunity is marked as lost, you're required to fill in the Loss Reason field. This helps analyze patterns and improve your sales process by addressing the most common reasons for losing deals. Account administrators can customize Loss Reasons in the Portal Settings.

Model relations<\/h3><\/a>

Has many relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th>Foreigh keys<\/th><\/tr>
leads<\/td>CRM<\/td>Opportunities <\/td>closing_status_id<\/td>active = 2<\/td><\/tr><\/table>"},{"name":"Opportunities sources","description":"The opportunity source shows where a potential sale originated \u2014 for example, an email, phone call, ad campaign, and so on. Account administrators can set up custom sources in the Portal Settings.

Model relations<\/h3><\/a>

Has many relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
leads<\/td>CRM<\/td>Opportunities <\/td>source_id<\/td><\/tr><\/table>"},{"name":"Opportunity stages","description":"Pipeline Stages are a set of steps by which the salesperson navigates the client from the first request to closing the deal. Every stage is linked to the pipeline.

Model relations<\/h3><\/a>

Belongs to relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
pipeline<\/td>CRM<\/td>Pipelines<\/td>pipeline_id<\/td><\/tr><\/table>

Has many relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
leads<\/td>CRM<\/td>Opportunities <\/td>pipeline_stage_id<\/td><\/tr><\/table>"},{"name":"Pipelines","description":"The pipeline represents the customer\u2019s path from the first interaction to the final purchase. It\u2019s made up of steps that guide the client from the initial inquiry to closing the deal \u2014 each step is called a funnel stage.\nThe funnel shows both the potential sales value and the number of opportunities.

Model relations<\/h3><\/a>

Has many relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
leads<\/td>CRM<\/td>Opportunities <\/td>pipeline_id<\/td><\/tr>
stages<\/td>CRM<\/td>Opportunity stages<\/td>pipeline_id<\/td><\/tr>
deals<\/td>CRM<\/td>Opportunities <\/td>pipeline_id<\/td><\/tr><\/table>"},{"name":"Opportunities ","description":"Opportunities are designed for managing your potential deals. Each request of your potential customer, whether it's an email, a completed web form on the website or an incoming call \u2014 all of them are opportunities. During the selling process, the opportunity goes through the stages of the sales funnel. Opportunity records track details about deals, including the value of potential sales, client's interaction history, estimates and invoices, etc.

Model relations<\/h3><\/a>

Belongs to relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th><\/tr>
merged_to<\/td>CRM<\/td>Opportunities <\/td>merged_to_id<\/td><\/tr>
status<\/td>CRM<\/td>Loss reasons<\/td>closing_status_id<\/td><\/tr>
stage<\/td>CRM<\/td>Opportunity stages<\/td>pipeline_stage_id<\/td><\/tr>
source<\/td>CRM<\/td>Opportunities sources<\/td>source_id<\/td><\/tr>
pipeline<\/td>CRM<\/td>Pipelines<\/td>pipeline_id<\/td><\/tr><\/table>

Has many relation<\/h4><\/h3>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t
Alias<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModule<\/th>\n\t\t\t\t\t\t\t\t\t\t\tModel<\/th>\n\t\t\t\t\t\t\t\t\t\t\tForeign key<\/th>Foreigh keys<\/th><\/tr>
tasks<\/td>Tasks<\/td>Tasks<\/td>model_id<\/td>module = crm, model = leads<\/td><\/tr>
invoices<\/td>Finance<\/td>Invoice<\/td>model_id<\/td>module = crm, model = leads<\/td><\/tr>
estimates<\/td>Finance<\/td>Estimate<\/td>model_id<\/td>module = crm, model = leads<\/td><\/tr>
items<\/td>CRM<\/td>Products & Services<\/td>lead_id<\/td><\/td><\/tr>
lead_accounts<\/td>CRM<\/td>Link opportunity to CRM accounts<\/td>lead_id<\/td><\/td><\/tr><\/table>"},{"name":"Account types","description":"The account categories allow to classify them by type of interaction. For example,