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

Programs

Operations

Processes

Operations

Guest Users

Operations

Get Guest Users

Request

This API endpoint enables fetching a collection of guest users. By providing the desired email as parameter, the API response narrows down the results to the specified guest user.

Security
x-api-key
Query
filter[email]string

Specifies the email of a guest user. Valid values are strings. Must be used in conjunction with filter[name].

Example: filter[email]=jane.doe@floqast.com
page[size]integer

The number of items to return. If not specified, the API will return a default of 30,000 items, which is the maximum value.

Example: page[size]=12000
page[cursor]string

Pagination cursor that indicates the starting position for the next set of items

Example: page[cursor]=5e94d5b63f557b001420bbe3
curl -i -X GET \
  'https://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/guest-users?filter%5Bemail%5D=jane.doe%40floqast.com&page%5Bsize%5D=12000&page%5Bcursor%5D=5e94d5b63f557b001420bbe3' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
dataArray of objects(GetGuestUsersModel)

Array of guest users

linksobject
Response
application/json
{
  "data": [
    { … }
  ],
  "links": {
    "self": "string",
    "next": "string"
  }
}