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

Users

Operations

User Groups

Operations

Get All User Groups

Request

Returns user groups accessible to the requesting tenant. Supports pagination and optional redirect handling for large payloads.

Security
x-api-key
Query
page[number]integer>= 1

The page number to return. If not specified, defaults to the first page.

Example: page[number]=1
page[size]integer[ 1 .. 100 ]

The number of items to return per page. Defaults to 25.

Example: page[size]=25
allowRedirectboolean

If set to true, the API may return a 303 redirect response when the payload is too large. The field body.data.url includes the URL to the resource.

Example: allowRedirect=true
curl -i -X GET \
  'https://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/user-groups?page%5Bnumber%5D=1&page%5Bsize%5D=25&allowRedirect=true' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
dataArray of objects(GetAllUserGroupsModel)required

Collection of user groups.

data[].​groupIdstring^[a-f\d]{24}$required

Unique identifier for the user group.

Example: "5e94d5b63f557b001420bbe3"
data[].​namestringrequired

Name of the user group.

Example: "Finance Team"
data[].​groupOwnerstring or null^[a-f\d]{24}$

Identifier of the user who owns the group.

Example: "5e94d5b63f557b001420bbe4"
metaobjectrequired

Pagination metadata for the response.

meta.​totalCountinteger

Total number of user groups matching the query.

Example: 120
meta.​pageinteger

Current page number.

Example: 1
meta.​limitinteger

Number of items per page.

Example: 25
meta.​totalPagesinteger

Total number of pages available.

Example: 5
meta.​hasNextPageboolean

Indicates if there is another page available.

Example: true
meta.​hasPreviousPageboolean

Indicates if a previous page exists.

Example: false
Response
application/json
{
  "data": [
    { … }
  ],
  "meta": {
    "totalCount": 120,
    "page": 1,
    "limit": 25,
    "totalPages": 5,
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}

Folders

Operations

Controls

Operations

Programs

Operations

Processes

Operations

Guest Users

Operations