FLfloweq
Records

Retrieve Workboard Records

Retrieve a list of records matching the criteria set by the query parameter. If no query parameters are set, all records affiliated with the user ID and company ID in the JWT authorization token will match the criteria.

get/records

Request

  • Base URL
    https://api.floweq.com/v1
  • Auth
    HTTP bearer

Query parameters

created_afterstring

Lists records created after this timestamp. Cannot be combined with another timestamp query due to limitations of querying Firestore. "createdAfter" also supported.

created_beforestring

Lists records created before this timestamp. Cannot be combined with another timestamp query due to limitations of querying Firestore. "createdBefore" also supported.

updated_afterstring

Lists records updated after this timestamp. Cannot be combined with another timestamp query due to limitations of querying Firestore. "updatedAfter" also supported.

updated_beforestring

Lists records updated before this timestamp. Cannot be combined with another timestamp query due to limitations of querying Firestore. "updatedBefore" also supported.

nextstring

The record ID to provide to the Firestore database in order to fetch the next batch of records. Cannot be present if the "prev" query parameter is also in the request.

prevstring

The record ID to provide to the Firestore database in order to fetch the previous batch of records. Cannot be present if the "next" query parameter is also in the request.

record_typestring

The type of record. "recordType" also supported.

view_idstring

Unique ID of view (bucket) that records may be a part of. "viewId" also supported.

Response

An array of records matching the criteria of the query parameters. Limited to 100 records per request.

countinteger

Number of records retrieved in request. Limited to 100.

nextstring

URL to fetch the next batch of records matching the request query parameters.

prevstring

URL to fetch the previous batch of records matching the request query parameters.

Example response

{
  "count": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.