Skip to content
/
Upload a document to a co...

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

Fetches a signed URL for uploading evidence to a control.

Request

The file key returned from this endpoint should be used in the POST /controls/{id}/documents endpoint to associate the uploaded file with the control.

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

The internal unique identifier for the control

Example: 61d325c84a9f97631731a690
periodstringrequired

The specfic period of the control to attach evidence to

curl -i -X GET \
  'https://fq-api.floqast.app/api/v1/controls/61d325c84a9f97631731a690/upload-url/{period}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
dataobject(UploadUrl)

Response containing a presigned upload URL and file key for evidence upload.

Response
application/json
{
  "data": {
    "uploadUrl": "https://production-large-payload-store.s3.us-west-2.amazonaws.com/a1b2c3d4-e5f6-7890-abcd-ef1234567890?...",
    "fileKey": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

Upload a document to a control.

Request

Uploads a file to the user's storage provider from S3 after the user has uploaded the file to S3 using the presigned URL from GET /controls/{id}/upload-url/{period}. The file will be associated with the specified control and period.

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

The internal unique identifier for the control

Example: 61d325c84a9f97631731a690
Bodyapplication/jsonrequired

Document upload information including file details and target period

fileNamestringrequired

Name of the file to be uploaded

Example: "uploaded-using-api-prod.xlsx"
fileKeystringrequired

S3 key of the uploaded file. This is returned from the GET /controls/{id}/upload-url/{period} endpoint

Example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
periodobject(Period)required
period.​monthstring(Month)
Enum"january""february""march""april""may""june""july""august""september""october"
period.​yearstring

four-digit year

Example: "2020"
curl -i -X POST \
  https://fq-api.floqast.app/api/v1/controls/61d325c84a9f97631731a690/documents \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "fileName": "uploaded-using-api-prod.xlsx",
    "fileKey": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "period": {
      "month": "january",
      "year": "2020"
    }
  }'

Responses

Document successfully uploaded and associated with the control

Response
No content

Lock or unlock a control period

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://fq-api.floqast.app/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

Programs

Operations

Processes

Operations

Guest Users

Operations