Folders
/
Updates a folder's lock state by Id.

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

Info

Operations

Users

Operations

Folders

Operations

Get metadata about a folder by Id

Request

This API endpoint provides metadata about a folder.

Path
folderIdstringrequired

The ID of the folder item

curl -i -X GET \
  'https://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/folders/{folderId}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Response

Bodyapplication/json
idstring
Example: "66b2710c17c0086b78a02d0c"
namestring
Example: "Folder Name"
lockednumber

0 = unlocked, 1 = locked

Example: 0
Response
application/json
{
  "id": "66b2710c17c0086b78a02d0c",
  "name": "Folder Name",
  "locked": 0
}

Updates a folder's lock state by Id.

Request

This API endpoint updates the lock state of a folder.

Path
folderIdstringrequired

The ID of the folder item

Query
unlockstring

Specifies whether to unlock the folder.

Example: unlock=true
curl -i -X PUT \
  'https://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/folders/{folderId}/locking?unlock=true' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Response

Bodyapplication/json
idstring
Example: "66b2710c17c0086b78a02d0c"
namestring
Example: "Folder Name"
lockedobject
Response
application/json
{
  "id": "66b2710c17c0086b78a02d0c",
  "name": "Folder Name",
  "locked": {
    "isLocked": true,
    "user": "66a8430c17c0086b78a42b2a",
    "time": "2020-10-30T18:00:00.000Z"
  }
}