---
title: "Retrieve Lob Checks"
method: GET
path: "/checks"
tags: ["Checks"]
---

# Retrieve Lob Checks

`GET /checks`

## Request

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

Retrieve a list of Lob checks matching the criteria set by the query parameter.  If no query parameters are set, all checks affiliated with the company Lob bank account will match the criteria.  A valid Lob account with a bank account ID is required to consume this endpoint.

## Query parameters

- `limit` string
- `date_created` string
- `send_date` string
- `scheduled` boolean
- `mail_type` string
- `sort_by` string

## Response `200`

An array of checks matching the criteria of the query parameters.  Default limit set to 100 checks per request.

- object
  - `count` integer: Number of checks retrieved in request. Default limit set to 100.
  - `results` Check[]: An array of checks matching the criteria of the query parameters. Default limit set to 100 checks per request.
    - `id` string: Unique ID.
    - `description` string, nullable: Description of check.
    - `date_created` string: ISO Timestamp
    - `date_modified` string: ISO Timestamp.
    - `metadata` object: ISO Timestamp
    - `check_number` number: An integer that designates the check number. If check_number is not provided, checks created from a new bank_account will start at 10000 and increment with each check created with the bank_account. A provided check_number overrides the defaults. Subsequent checks created with the same bank_account will increment from the provided check number.
    - `memo` string, nullable: Text to include on the memo line of the check.
    - `amount` number: The payment amount to be sent in US dollars.
    - `url` string: A signed link served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated.
    - `to` object: Destination address of the check.
    - `from` object: Origin address of the check.
    - `bank_account` object: Object of the bank account.
    - `carrier` string: Mail carrier.
    - `tracking_events` unknown[]: An array of tracking_event objects ordered by ascending time. Will not be populated for checks created in test mode.
      - unknown
    - `thumbnails` unknown[]: An array of thumbnails urls of the check image.
      - unknown
    - `merge_variables` object: You can input a merge variable payload object to your template to render dynamic content.
    - `expected_delivery_date` string: A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its send_date.
    - `mail_type` string: The specified mail class.
    - `send_date` string: A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production.
    - `object` string: The resource type being interacted with.
    - `message` string: Max of 400 characters to be included at the bottom of the check page.
    - `check_bottom_template_id` string: The unique ID of the HTML template used for the check bottom.
    - `attachment_template_id` string: The unique ID of the HTML template used for the attachment.
    - `check_bottom_template_version_id` string: The unique ID of the specific version of the HTML template used for the check bottom.
    - `attachment_template_version_id` string: The unique ID of the specific version of the HTML template used for the attachment.
    - `use_type` string, nullable: The use type for each mailpiece. Can be one of marketing, operational, or null. Null use_type is only allowed if an account default use_type is selected in Lob Account Settings.
    - `deleted` boolean: Only returned if the resource has been successfully deleted.
  - `next_url` string: Link to fetch the next set of checks.
  - `previous_url` string: Link to fetch the previous set of checks.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden

---

[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)