GET
/
records
Retrieve Workboard Records
curl --request GET \
  --url https://api.floweq.com/v1/records \
  --header 'Authorization: Bearer <token>'
{
  "count": 1,
  "next": "<string>",
  "prev": "<string>",
  "results": [
    "<any>"
  ]
}

Authorizations

​
Authorization
string
header
required

Enter your bearer token in the format: Bearer {token}

Query Parameters

​
created_after
string

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

​
created_before
string

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

​
updated_after
string

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

​
updated_before
string

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

​
next
string

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.

​
prev
string

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_type
string

The type of record. "recordType" also supported.

​
view_id
string

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.

​
count
integer

Number of records retrieved in request. Limited to 100.

Example:

1

​
next
string

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

​
prev
string

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

​
results
any[]

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