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

Depreciations

Operations

Amortization

Operations

Audit Trail

Operations

Transactions

Operations

Entities

Operations

Trial Balance

Operations

Tags

Operations

Chart Of Accounts

Operations

Users

Operations

Folders

Operations

Controls

Operations

Fetches a list of controls with optional filters

Request

Security
x-api-key
Query
filter[month]string(Month)

Filters down the results to controls that include the provided period. Must be used in conjunction with filter[year].

Enum"january""february""march""april""may""june""july""august""september""october"
Example: filter[month]=january
filter[year]string

Filters down the results to controls that include the provided period. Must be a four digit year and be used in conjunction with filter[month].

Example: filter[year]=2024
filter[active]string

Filters down the results to controls that are active.

filter[programId]string(ObjectId)^[a-f\d]{24}$

Filters down the results to controls that are contained by the provided Program ID.

Example: filter[programId]=61d325c84a9f97631731a690
filter[controlId]string

Filters down the results to controls whose Control ID contains the provided string.

Example: filter[controlId]=FQ.001
includeArray of objects

Optional properties in a comma separated string that should be included on each control document

Items Enum"owners""assignees""signatures""documents""checklistItems""reconciliations""reviewNotes""customFields""frequency""attributes"
Example: include=owners,assignees,signatures,documents,checklistItems,reconciliations,reviewNotes,customFields
curl -i -X GET \
  'https://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/controls?filter%5Bmonth%5D=january&filter%5Byear%5D=2024&filter%5Bactive%5D=string&filter%5BprogramId%5D=61d325c84a9f97631731a690&filter%5BcontrolId%5D=FQ.001&include=owners%2Cassignees%2Csignatures%2Cdocuments%2CchecklistItems%2Creconciliations%2CreviewNotes%2CcustomFields' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
dataArray of objects(Control)
linksobject(PaginationInformation)
Response
application/json
{
  "data": [
    { … }
  ],
  "links": {
    "self": "/api/v1/controls?filter[month]=january&filter[year]=2024&page[cursor]=5e94d5b63f557b001420bbe3",
    "next": "/api/v1/checklists?filter[month]=january&filter[year]=2024page[cursor]=5e94d5b63f557b001420bbe6"
  }
}

Inserts new controls up to 20 at a time

Request

Security
x-api-key
Bodyapplication/jsonArray [
controlIdstring

The identifying name this control should use

programIdstring(ObjectId)^[a-f\d]{24}$
Example: "61d325c84a9f97631731a690"
processIdstring(ObjectId)^[a-f\d]{24}$
Example: "61d325c84a9f97631731a690"
titlestring<= 1000 characters

The title of the control

descriptionstring[ 1 .. 10000 ] characters

The description of the control

isKeyControlboolean
isManualboolean
assertionsArray of strings
Items Enum"existence-or-occurrence""completeness""valuation-or-allocation""rights-and-obligation""presentation-and-disclosure"
ownersArray of objects(Owners)

Information about the users that own this control

assigneesArray of objects(Assignees)

Information about the users assigned to this control for sign-off

frequencynumber

Integer from 1-12 where the numbers correspond as follows: Monthly, Quarterly, Annual, Custom, Weekly, Every 2 weeks, Twice per month, As needed, Multiple times per day, Daily, Automated, Continuous

Enum12345678910
frequencyMonthsArray of strings(Month)
Items Enum"january""february""march""april""may""june""july""august""september""october"
requiredEvidenceFrequencynumber

Number value from 0-4 where the numbers correspond as follows: None, Monthly, Quarterly, Annual, Custom

Enum01234
requiredEvidenceFrequencyMonthsArray of strings(Month)
Items Enum"january""february""march""april""may""june""july""august""september""october"
customFieldsArray of objects
]
curl -i -X POST \
  https://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/controls \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '[
    {
      "controlId": "string",
      "programId": "61d325c84a9f97631731a690",
      "processId": "61d325c84a9f97631731a690",
      "title": "string",
      "description": "string",
      "isKeyControl": true,
      "isManual": true,
      "assertions": [
        "existence-or-occurrence"
      ],
      "owners": [
        {
          "type": "primary",
          "isGuest": true,
          "userId": "61d325c84a9f97631731a690"
        }
      ],
      "assignees": [
        {
          "dueDateType": "NONE",
          "dueDateOffsetDays": -99,
          "frequency": 1,
          "frequencyMonths": [
            "january"
          ],
          "group": "reviewer",
          "userId": "61d325c84a9f97631731a690"
        }
      ],
      "frequency": 1,
      "frequencyMonths": [
        "january"
      ],
      "requiredEvidenceFrequency": 0,
      "requiredEvidenceFrequencyMonths": [
        "january"
      ],
      "customFields": [
        {
          "customFieldId": "61d325c84a9f97631731a690",
          "values": []
        }
      ]
    }
  ]'

Responses

Response is an array containing the IDs of the newly created controls.

Bodyapplication/json
dataArray of strings(ObjectId)
Example: ["61d325c84a9f97631731a690"]
Response
application/json
{
  "data": [
    "61d325c84a9f97631731a690"
  ]
}

Fetches control by control mongo ID

Request

If including the optional checklist items and reconciliations, the provided API key must have the Checklists and Reconciliations scopes respectively.

Security
x-api-key
Path
idstring(ObjectId)^[a-f\d]{24}$required

The internal unique identifier for the control

Example: 61d325c84a9f97631731a690
Query
includeArray of objects

Optional properties in a comma separated string that should be included on each control document

Items Enum"owners""assignees""signatures""documents""checklistItems""reconciliations""reviewNotes""customFields""frequency""attributes"
Example: include=owners,assignees,signatures,documents,checklistItems,reconciliations,reviewNotes,customFields
curl -i -X GET \
  'https://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/controls/61d325c84a9f97631731a690?include=owners%2Cassignees%2Csignatures%2Cdocuments%2CchecklistItems%2Creconciliations%2CreviewNotes%2CcustomFields' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
dataobject(Control)
Response
application/json
{
  "data": {
    "id": "61d325c84a9f97631731a690",
    "controlId": "FQ.001",
    "processId": "61d325c84a9f97631731a690",
    "title": "string",
    "description": "string",
    "project": { … },
    "owners": [ … ],
    "assignees": [ … ],
    "signatures": [ … ],
    "documents": [ … ],
    "checklistItems": [ … ],
    "reconciliations": [ … ],
    "reviewNotes": { … },
    "frequency": { … },
    "attributes": { … },
    "lockedPeriods": { … },
    "isArchived": true,
    "createdAt": "2025-01-15T10:30:45.123Z",
    "updatedAt": "2025-01-15T10:30:45.123Z"
  }
}

Programs

Operations

Processes

Operations

Guest Users

Operations