Skip to main content
GET
/
checks
Retrieve Lob Checks
curl --request GET \
  --url https://api.floweq.com/v1/checks \
  --header 'Authorization: Bearer <token>'
{
  "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"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
string

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

​
date_created
string

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

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.

​
scheduled
boolean

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

A string designating the mail postage type.

​
sort_by
string

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.

​
count
integer

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

Example:

1

​
results
Check · object[]

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

Example:
[]
​
next_url
string

Link to fetch the next set of checks.

Example:

"https://api.lob.com/v1/checks?limit=2&after=eyJkYXRlT2Zmc2V0IjoiMjAxOS0wOC0wOFQxOTozNDoyNy44MDJaIiwiaWRPZmZzZXQiOiJjaGtfOTJiOWE2NzE0YmMwNTU3YyJ0"

​
previous_url
string

Link to fetch the previous set of checks.

Example:

"https://api.lob.com/v1/checks?limit=2&before=eyJkYXRlT2Zmc2V0IjoiMjAxOS0wOC0wOFQxOTozNDoyNy44MDJaIiwiaWRPZmZzZXQiOiJjaGtfOTJiOWE2NzE0YmMwNTU3YyJ0"