Flokzu public API (Open API)

You can find the API documentation at https://flokzu.docs.apiary.io

What can you do with the Flokzu public API?

The Open API allows you to interact with Flokzu from external systems, enabling integration with your own technology stack.

Available Operations

Instances and Processes

• Get process instance: Allows you to obtain data from an existing instance. It receives the instance identifier as a parameter and returns a JSON with the instance data, including field content and metadata. More information
• New process instance: Allows you to create a new instance. In the parameters, you must indicate the process and the content of the fields to be completed. By default, the process initiator of new instances will be the System user, but you can modify it by adding new headers to the call. More information
• Update process instance: This operation allows you to modify the data of a previously created instance. It's useful when you need to update information from an external system. More information.

Databases

• Get record: This endpoint retrieves the first record that matches a specified condition. More information
• Add record: Used to add a new record to a specific database. It's ideal for adding data from external systems or automating information entry into Flokzu. More information
• Update record: Used to update an existing record using its ID. Only the columns included in the request are modified. If the 'withinsert' property is set to true, a new record will be inserted if the record to be updated is not found. More information
• List records: This endpoint retrieves a list of records that meet a specified condition. More information

User Management

• Send new user invitation: Sends an invitation to create a new account. The user will receive an email with the confirmation link and must enter their data. More information
• Delete user account: Deletes a user account from your tenant. More information
• Add user role: Add role to user. Both the role and the user must be created previously. More information
• Remove user role: Remove role to a specified user. More information
• Get user roles: List the roles of a user. More information

Misc

• Eco (Echo): Returns the same data that is passed as a parameter.
• Operaciones (Operations): sum, concat, contains.

Rate Limit

Rate limits are restrictions that Flokzu imposes on the number of times the OpenAPI can be called from the same IP address within a specified time period.

These limits are a common practice for APIs to help protect against abuse or misuse of the API and ensure that everyone has fair access to the API, preventing one person or organization from making an excessive number of requests that could saturate the API for everyone else.

OpenAPI Request Limit

You can send up to 100 requests per minute. If you exceed this limit, you will be blocked for 1 minute and a 429 error code will be thrown.

Is it possible to increase this limit?

Unfortunately, it is not possible to increase this limit.

Updated on: 17/03/2025