How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Lob

Lob Postcards API

The postcards endpoint allows you to easily print and mail postcards. The API provides endpoints for creating postcards,retrieving individual postcards, canceling postcards, and retrieving a list of postcards.back to top

Documentation Provider Profile APIs.io OpenAPI GitHub

Lob Postcards API is one of 48 APIs that Lob publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Postcards. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 1 path, and defines 57 schemas. It is described by OpenAPI 3.2.0, at version 1.20.2.

Requests are made against a single base URL, https://api.lob.com/v1.

2 operations 1 paths 57 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.20.2
Server
https://api.lob.com/v1
Authentication
HTTP Basic
Contact
Lob Developer Experience
License
MIT
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Lob Postcards API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Postcards 2

The postcards endpoint allows you to easily print and mail postcards. The API provides endpoints for creating postcards, retrieving individual postcards, canceling postcards, and…

GET
/postcards
List
postcards_list 12 params → 200default
POST
/postcards
Create
postcard_create 2 params body → 200default

Schemas 57

The contract defines 57 schemas that model the data the API accepts and returns. The most detailed are qr_code (10 properties), generated (7 properties), failure_reason_error (7 properties), list (5 properties). Each schema is shown below with its type and property counts.

qr_code
object
Customize and place a QR code on the creative at the required position.
10 properties 3 required
postcard_size
string
Specifies the size of the postcard. Only 4x6 postcards can be sent to international destinations.
address_editable_us
editable
object
5 properties
expected_delivery_date
string
A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its senddate.
count
integer
number of resources in a set
remote_file_url
string
The location of a remote file. Remote URLs have a 5 MB file size limit and must be downloaded within 40 seconds.
psc_back
The artwork to use as the back of your postcard. Notes: - HTML merge variables should not include delimiting whitespace. - PDF, PNG, and JPGs must be sized at…
psc_use_type
stringnull
The use type for each mailpiece. Can be one of marketing, operational, or null. Null usetype is only allowed if an account default usetype is selected in Accou…
signed_link
string
A [signed link](section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a…
failure_status_code
integer
A conventional HTTP status code: 401 - Authorization error with your API key or account 403 - Forbidden error with your API key or account 404 - The requested…
date_filter
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 e, and lte is d.
tracking_event_normal
evnt_id
string
Unique identifier prefixed with evnt.
merge_variables
objectnull
You can input a merge variable payload object to your template or QR code redirect URLs to render dynamic content. For example, if you have a template like: {{…
company
stringnull
Either name or company is required, you may also add both. Must be no longer than 40 characters. If both name and company are provided, they will be printed on…
generated
object
7 properties 2 required
list
object
Multiple items returned in order
5 properties
metadata
object
Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be…
html_string
string
An HTML string of under 10,000 characters.
error
object
Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx…
1 property 1 required
country_extended
string
Must be a 2 letter country short-name code (ISO 3166). Does not accept US, AS, PR, FM, GU, MH, MP, PW, or VI. For these addresses, please use the US verificati…
mail_type
string
A string designating the mail postage type: uspsfirstclass - (default) uspsstandard - a cheaper option which is less predictable and takes longer to deliver. u…
postcard_base
inline_address_intl
lob_base
object
4 properties 3 required
adr_id
string
Unique identifier prefixed with adr.
address_us
from_us
object
1 property
input_to
object
1 property
address_editable_intl
tracking_event_base
object
As mail pieces travel through the mail stream, USPS scans their unique barcodes, and Lob processes these mail scans to generate tracking events.
5 properties 4 required
psc_id
string
Unique identifier prefixed with psc.
inline_address_us
inline_address
failure_reason
object
An object describing the reason for failure if the resource failed to render.
3 properties
status
string
A string describing the PDF render status: processed - the rendering process is currently in progress. rendered - a PDF has been successfully rendered of the m…
tmpl_id
string
Unique identifier prefixed with tmpl. ID of a saved [HTML template](section/HTML-Templates).
object
string
Value is resource type.
campaign_id
stringnull
Denotes resources created by the provided campaign id, prefixed with cmp. In the case of snap packs, booklets, and letters with size uslegal, however, the camp…
postcard_editable
address
local_file_path
string
The path to a local file.
postcard
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. Setting a…
date_created
string
A timestamp in ISO 8601 format of the date the resource was created.
address_intl
address_fields_us
object
5 properties 4 required
billing_group_id
string
An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See Billing Group API fo…
address_fields_intl
object
5 properties 2 required
failure_reason_error
object
Failure error details
7 properties
date_modified
string
A timestamp in ISO 8601 format of the date the resource was last modified.
deleted
boolean
Only returned if the resource has been successfully deleted.
thumbnail
object
3 properties
resource_description
stringnull
An internal description that identifies this resource. Must be no longer than 255 characters.
input_from_us
object
1 property
psc_front
The artwork to use as the front of your postcard. Notes: - HTML merge variables should not include delimiting whitespace. - PDF, PNG, and JPGs must be sized at…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lob-postcards-api-openapi.yml Raw ↑

Other APIs Lob publishes across the network.

Lob Accounts API
AE Profile APIs.io
Lob Addresses API
AE Profile APIs.io
Lob Bank Accounts API
AE Profile APIs.io
Lob Bank_id API
AE Profile APIs.io
Lob Bg_id API
AE Profile APIs.io
Lob Billing Groups API
AE Profile APIs.io
Lob Booklet_id API
AE Profile APIs.io
Lob Booklets API
AE Profile APIs.io
Lob Buckslip_id API
AE Profile APIs.io
Lob Buckslips API
AE Profile APIs.io
Lob Bulk API
AE Profile APIs.io
Lob Campaigns API
AE Profile APIs.io
#Postcards
← Back to L APIs
API Details
ID
lob:lob-postcards-api
Server
https://api.lob.com/v1
Docs
https://docs.lob.com/
Provider
Lob
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=lob-postcards-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/lob-postcards-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Lob Postcards API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.