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

Trial Balance

Operations

Tags

Operations

Chart Of Accounts

Operations

Info

Operations

Users

Operations

User Groups

Operations

Folders

Operations

Controls

Operations

Programs

Operations

Get Compliance Programs

Request

Retrieves a paginated list of compliance programs with optional filtering and includes.

Security
x-api-key
Query
includeArray of strings

Comma-separated list of additional fields to include.

Items Enum"companyId""settings""parentProgramId""childProgramIds""programPeriod"
Example: include=companyId,settings,parentProgramId,childProgramIds,programPeriod
page[size]integer[ 1 .. 50 ]

Number of records to return per page.

Default 50
page[cursor]string(ObjectId)^[a-f\d]{24}$

Cursor for pagination.

Example: page[cursor]=61d325c84a9f97631731a690
filter[startPeriod]string(Period-2)

Filter programs by start period.

Example: filter[startPeriod]=january-2024
filter[endPeriod]string(Period-2)

Filter programs by end period.

Example: filter[endPeriod]=january-2024
filter[name]string

Filter programs by name.

curl -i -X GET \
  'https://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/programs?include=companyId%2Csettings%2CparentProgramId%2CchildProgramIds%2CprogramPeriod&page%5Bsize%5D=50&page%5Bcursor%5D=61d325c84a9f97631731a690&filter%5BstartPeriod%5D=january-2024&filter%5BendPeriod%5D=january-2024&filter%5Bname%5D=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
dataArray of objects(Program)

Array of Programs.

linksobject
Response
application/json
{
  "data": [
    { … }
  ],
  "links": {
    "self": "/api/v1/programs/?page[size]=50&page[cursor]=5e94d5b63f557b001420bbe3",
    "next": "/api/v1/programs/?page[size]=50&page[cursor]=63b88f2cb1f05200179e7857"
  }
}

Processes

Operations

Guest Users

Operations