Skip to main content
GET
List Orders

Authorizations

Authorization
string
header
required

Bearer token authentication using your thanks.io API key

Query Parameters

items_per_page
integer
default:25

Number of items to return per page.

sub_account_id
integer

Filter results by Sub Account ID.

type
enum<string>

Only return orders of this mailer type. postcard returns 4x6 postcards only; postcard6x9 returns all 6x9 postcards, including 6x9 orders placed before 6x9 had its own type. 4x6-postcard and 6x9-postcard are accepted as aliases for postcard and postcard6x9.

Available options:
postcard,
postcard6x9,
postcard6x11,
letter,
windowlessletter,
notecard,
giftcard,
magnacard,
4x6-postcard,
6x9-postcard
creative_id
integer

Only return orders sent as this creative from your Creatives library. Use an id from List Creatives.

campaign
integer

Only return orders sent by a campaign. Pass the ID of the campaign's mailing list: every order sent by that list's campaign actions is returned, including actions that have since been deleted.

Response

OK

data
object[]
meta
object