Skip to content

FloQast External API (1.0.0)

Authentication

Requests to FloQast's API must be authenticated using an API key. The API key must be included in the x-api-key header of each request and can be generated in the FloQast application. The key should also have the correct permissions to access the API endpoints you are using. Directions to generate an API key

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://fq-api.floqast.app
https://fq-api.eu.floqast.app
https://fq-api.au.floqast.app

Checklists

Operations

Reconciliations

Operations

Checklist Analytics

Operations

Reconciliation Analytics

Operations

Audit Trail

Operations

Transactions

Operations

Entities

Operations

Trial Balance

Operations

Tags

Operations

Get Tags

Request

This API endpoint retrieves tags under a TLC

Security
x-api-key
Query
allowRedirectboolean

If set to true, the API will return a 303 redirect response if the response payload is too large. The field body.data.url will include the URL to the actual resource.

Example: allowRedirect=true
curl -i -X GET \
  'https://fq-api.floqast.app/api/v1/tags?allowRedirect=true' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
idstring
Example: "5e94d5b63f557b001420bbe3"
namestring
Example: "journal_entry"
typestring
Example: "CUSTOM"
categorystring
Example: "GENERAL"
tlcIdstring
Example: "5e94d5b63f557b001420bbe3"
deactivationTimestring or null
Example: null
Response
application/json
{
  "id": "5e94d5b63f557b001420bbe3",
  "name": "journal_entry",
  "type": "CUSTOM",
  "category": "GENERAL",
  "tlcId": "5e94d5b63f557b001420bbe3",
  "deactivationTime": null
}

Tag Attachments

Request

This endpoint attaches or detaches a tag to/from a reconciliation. When attaching, if the specified tag does not exist, it will be created and then attached automatically.

Security
x-api-key
Bodyapplication/jsonrequired
systemstringrequired

The name of the system receiving the tag (e.g., Reconciliations, Checklists).

Enum"RECONCILIATIONS""CHECKLISTS"
Example: "RECONCILIATIONS"
systemIdstringrequired

The unique identifier for the system designated to receive the tag (e.g., Reconciliation ID, Checklist ID).

Example: "5e94d5b63f557b001420bbe3"
actionstringrequired

Specifies whether to attach or detach a tag from the system.

Enum"ATTACH""DETACH"
Example: "ATTACH"
namestringrequired

Name of the tag

Example: "low_risk"
curl -i -X PUT \
  https://fq-api.floqast.app/api/v1/tags/attachments \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "system": "RECONCILIATIONS",
    "systemId": "5e94d5b63f557b001420bbe3",
    "action": "ATTACH",
    "name": "low_risk"
  }'

Responses

Success

Response
No content

Chart Of Accounts

Operations

Info

Operations

Users

Operations

User Groups

Operations

Folders

Operations

Controls

Operations

Programs

Operations

Processes

Operations

Guest Users

Operations