Checks

Retrieve Lob Checks

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.

get/checks

Request

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

Query parameters

limitstring

The number of checks to list. Default set to 100, maximum set to 10,000.

date_createdstring

Filter by date created. Accepted formats are ISO-8601 date or datetime. Supports operators: date_created__gt, date_created__gte, date_created__lt, date_created__lte.

send_datestring

Filter by send date. Accepted formats are ISO-8601 date or datetime. Supports operators: send_date__gt, send_date__gte, send_date__lt, send_date__lte.

scheduledboolean

true - only return orders (past or future) where send_date is greater than date_created. false - only return orders where send_date is equal to date_created.

mail_typestring

A string designating the mail postage type.

sort_bystring

Sorts items by ascending or descending dates. Use either date_created or send_date, not both.

Response

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

countinteger

Number of checks retrieved in request. Default limit set to 100.

next_urlstring

Link to fetch the next set of checks.

previous_urlstring

Link to fetch the previous set of checks.

Example response

{
  "count": 1,
  "results": [],
  "next_url": "https://api.lob.com/v1/checks?limit=2&after=eyJkYXRlT2Zmc2V0IjoiMjAxOS0wOC0wOFQxOTozNDoyNy44MDJaIiwiaWRPZmZzZXQiOiJjaGtfOTJiOWE2NzE0YmMwNTU3YyJ0",
  "previous_url": "https://api.lob.com/v1/checks?limit=2&before=eyJkYXRlT2Zmc2V0IjoiMjAxOS0wOC0wOFQxOTozNDoyNy44MDJaIiwiaWRPZmZzZXQiOiJjaGtfOTJiOWE2NzE0YmMwNTU3YyJ0"
}

Changes

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