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
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

Depreciations

Operations

Amortization

Operations

Audit Trail

Operations

Get Audit Trail logs

Request

This API endpoint retrieves audit logs for all API keys within a top-level client, providing a comprehensive overview of usage. It supports querying logs for a specific user's API key ID to facilitate focused analysis.

Query
filter[startDate]string

Specifies the start date (inclusive) for logs to be retrieved. The date must be in the ISO 8601 format like YYYY-MM-DD.

Example: filter[startDate]=2023-11-01
filter[endDate]string

Specifies the end date (inclusive) for logs to be retrieved. The date must be in the ISO 8601 format like YYYY-MM-DD.

Example: filter[endDate]=2023-12-01
filter[userApiKey._id]string

Specifies the user API key ID to filter logs by.

Example: filter[userApiKey._id]=5e94d5b63f557b001420bbe3
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[cursor]string

Pagination cursor that indicates the starting position for the next set of items

Example: page[cursor]=5e94d5b63f557b001420bbe3
allowRedirectboolean

If set to true, the API will return a 303 redirect response if the response payload is too large. The header Location and body.data.url will also 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/audit-trail?allowRedirect=true&filter%5BendDate%5D=2023-12-01&filter%5BstartDate%5D=2023-11-01&filter%5BuserApiKey._id%5D=5e94d5b63f557b001420bbe3&page%5Bcursor%5D=5e94d5b63f557b001420bbe3&page%5Bsize%5D=12000' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
dataArray of objects(AuditTrailModel)

Array of Audit Trail items

linksobject
Response
application/json
{ "data": [ {} ], "links": { "self": "/api/v1/audit-trail?filter[startDate]=2023-11-01&filter[endDate]=2023-12-01&page[size]=12000&page[cursor]=5e94d5b63f557b001420bbe3", "next": "/api/v1/audit-trail?filter[startDate]=2023-11-01&filter[endDate]=2023-12-01&page[size]=12000&page[cursor]=5e94d5b63f557b001420bbe6" } }

Transactions

Operations

Entities

Operations

Trial Balance

Operations

Tags

Operations

Chart Of Accounts

Operations

Info

Operations

Users

Operations