Lob
FREE
By dimashirokov
Updated a year ago

Lob API Documentation

Programmatically send physical mail at scale.

Learn more about this API
POSTcreateAddress
POSTcreateAreaMailing
POSTcreateBankAccount
POSTcreateCheck
POSTcreateLetter
POSTcreatePostcard
POSTdeleteAddress
POSTdeleteBankAccount
POSTgetAddress
POSTgetAllAddresses
POSTgetAllAreaMailings
POSTgetAllBankAccounts
POSTgetAllChecks
POSTgetAllCountries
POSTgetAllLetters
POSTgetAllPostcards
POSTgetAllRoutes
POSTgetAllStates
POSTretrieveAreaMailing
POSTretrieveBankAccount
POSTretrieveCheck
POSTretrieveLetter
POSTretrievePostcard
POSTretrieveRoutesByZipcode
POSTverifyAddress
POSTverifyBankAccount
POSTgetAllAddresses

Returns a list of your addresses. The addresses are returned sorted by creation date, with the most recently created addresses appearing first.

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
apiKeyCREDENTIALS
REQUIREDApi Key.
Optional Parameters
metadataARRAY
OPTIONALFilter by metadata key-value pair.
offsetNUMBER
OPTIONALReturn requested # of items starting with the value, default=0, must be an integer
limitNUMBER
OPTIONALHow many results to return, default=10, max 100, must be an integer
dateCreatedJSON
OPTIONALJSON Object. Filter by ISO-8601 date or datetime, e.g. { gt: '2012-01-01', lt: '2012-01-31T12:34:56Z' } where gt is ›, lt is ‹, gte is ≥, and lte is ≤
includeSTRING
OPTIONALRequest that the response include the total count by specifying include[]=total_count
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication