---
title: "Retrieve Workboard Records"
method: GET
path: "/records"
tags: ["Records"]
---

# Retrieve Workboard Records

`GET /records`

## Request

- Base URL: `https://api.floweq.com/v1`
- URL: `https://api.floweq.com/v1/records`
- Auth: HTTP bearer

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.

## Query parameters

- `created_after` string
- `created_before` string
- `updated_after` string
- `updated_before` string
- `next` string
- `prev` string
- `record_type` string
- `view_id` string

## Response `200`

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

- object
  - `count` integer: Number of records retrieved in request. Limited to 100.
  - `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` unknown[]: An array of records matching the criteria of the query parameters. Limited to 100 records per request.
    - unknown

## Other responses

- `400`: Bad request: - A query with both "next" and "prev" will throw a 400 error. - A query with multiple timestamp queries (created_after, created_before, updated_after, updated_before) will throw a 400 error. - A query with an unsupported query parameter will throw a 400.
- `401`: Unauthorized

---

[API](https://skmtc.dev/floweq/apis/floweq-external-api-v1.md) - [All operations](https://skmtc.dev/floweq/apis/floweq-external-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/floweq/apis/floweq-external-api-v1/revisions/d826148ce2d7?raw)