Users

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

Get Users

Request

This endpoint returns users who have current or historical shared workspace access with the user who the API key belongs to.

Query
page[size]integer

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

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

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

Example: page[cursor]=5e94d5b63f557b001420bbe3
allowRedirectboolean

If set to true, the API will return a 303 redirect response if the response payload is too large. The header Location and body.data.url will also include the URL to the actual resource.

Example: allowRedirect=true
curl -i -X GET \
  'https://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/users?allowRedirect=true&page%5Bcursor%5D=5e94d5b63f557b001420bbe3&page%5Bsize%5D=100' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
dataArray of objects(GetUsersModel)

Array of Users

linksobject
Response
application/json
{
  "data": [
    { … }
  ],
  "links": {
    "self": "/api/v1/users&page[size]=100&page[cursor]=5e94d5b63f557b001420bbe3",
    "next": "/api/v1/users?page[size]=100&page[cursor]=63b88f2cb1f05200179e7857"
  }
}