Skip to content
/
Get Entities

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
Mock server
https://developer.floqast.app/_mock/content/api-reference/openapi
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

Get Entities

Request

This API endpoint enables fetching a collection of entities within a given FloQast tenant. Optional query parameters can either narrow the API response or provide pagination functionality.

Security
x-api-key
Query
filter[name]string

Specifies the name of the entity. Cannot be used with page[number].

Example: filter[name]=Entity Name
page[size]integer

The number of items to return. If not specified, the API will return a default of 30,000 items, which is the maximum value.

Example: page[size]=12000
page[number]integer

Indicates the page number of the results to retrieve. This parameter is used to paginate through lists of items. Cannot be used with filter[name].

Example: page[number]=5
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://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/entities?filter%5Bname%5D=Entity+Name&page%5Bsize%5D=12000&page%5Bnumber%5D=5&allowRedirect=true' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
dataArray of objects(Entity)
Response
application/json
{
  "data": [
    { … }
  ]
}

Get Entity by ID

Request

This API endpoint enables fetching a single specific entity with its unique identifier.

Security
x-api-key
Path
idstringrequired

The ID of the entity

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://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/entities/{id}?allowRedirect=true' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
dataArray of objects(Entity)
Response
application/json
{
  "data": [
    { … }
  ]
}

Trial Balance

Operations

Tags

Operations

Chart Of Accounts

Operations

Info

Operations

Users

Operations

User Groups

Operations

Folders

Operations

Controls

Operations

Programs

Operations

Processes

Operations

Guest Users

Operations