Skip to content

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/

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Request

Locks or unlocks a specific period of a control. When locked, the control period cannot be modified. This endpoint also locks associated review notes and files (except for Egnyte storage).

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

The internal unique identifier for the control

Example: 61d325c84a9f97631731a690
periodstring^(january|february|march|april|may|june|july|...required

The specific period of the control in the format month-year (e.g., january-2025)

Example: january-2025
Bodyapplication/jsonrequired

Request body specifying whether to lock or unlock the control period

setIsLockedbooleanrequired

Whether to lock (true) or unlock (false) the control period

Example: true
curl -i -X PATCH \
  https://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/controls/61d325c84a9f97631731a690/lock/january-2025 \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "setIsLocked": true
  }'

Responses

Control period successfully locked or unlocked

Response
No content

Deactivates one control and unlinks associated risks, tests, and FSLIs/scoping sheets

Request

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

The internal unique identifier for the control

Example: 61d325c84a9f97631731a690
curl -i -X PUT \
  https://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/controls/61d325c84a9f97631731a690/deactivate \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Control was successfully deactivated

Response
No content

Reactivate one control and link associated tests

Request

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

The internal unique identifier for the control

Example: 61d325c84a9f97631731a690
curl -i -X PUT \
  https://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/controls/61d325c84a9f97631731a690/reactivate \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Control was successfully reactivated

Response
No content
Operations
Operations
Operations