Skip to content

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

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Current user and token information

Request

Get information about the current user and token

Security
x-api-key
Query
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/me?allowRedirect=true' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
dataobject
Response
application/json
{ "data": { "apiKeyId": "5e94d5b63f557b001420bbe3", "userId": "5e94d5b63f557b001420bbe4" } }
Operations
Operations
Operations
Operations
Operations