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.com

Lob.com URL Shortener API

Lob's URL shortener allows you to generate unique short links, either with Lob's own domain or your own custom domains. Each custom link enables Lob to track mail individually and provide customers the relevant tracking data in their dashboard.Webhooks can be used to integrate Lob's URL Shortener scans into your omni channel marketing stratergy. See the Webhooks section of our documentation to learn how to enable the `letter.viewed`, `postcard.viewed` and `self_mailer.viewed` event notifications for your mail pieces.Furthermore, you can use our Retrieve endpoints to track the impact and engagement rate of links created. back to top

Documentation Provider Profile APIs.io OpenAPI GitHub

Lob.com URL Shortener API is one of 32 APIs that Lob.com publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include URL Shortener. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 9 operations across 4 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 1.22.0.

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

9 operations 4 paths 19 schemas 2 DELETE4 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.22.0
Base URL
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.com URL Shortener API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 9

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

URL Shortener 9

Lob's URL shortener allows you to generate unique short links, either with Lob's own domain or your own custom domains. Each custom link enables Lob to track mail individually and…

GET
/domains/{domain_id}
Retrieve a domain
domain_get 1 param → 200default
DELETE
/domains/{domain_id}
Delete a Domain
domain_delete 1 param → 200default
POST
/domains
Create Domain
domain_create body → 200default
GET
/domains
List all domains
domain_list 3 params → 200default
GET
/links/{link_id}
Retrieve a link
links_get 1 param → 200default
PATCH
/links/{link_id}
Update a Link
link_update 1 param body → 200default
DELETE
/links/{link_id}
Delete Link
links_delete 1 param → 200default
POST
/links
Create Link
link_create body → 200default
GET
/links
List all links
links_list 4 params → 200default

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are link_response (8 properties), domain_response (6 properties), link_single (5 properties), list (5 properties). Each schema is shown below with its type and property counts.

domain
string
The registered domain/hostname.
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
count
integer
number of resources in a set
link_single
object
5 properties 1 required
domains
object
2 properties 1 required
links_response
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…
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…
link_delete_response
object
2 properties
domain_delete
object
2 properties
link_response
object
8 properties
error_redirect_link
string
URL to redirect customers if a short link is broken or inactive.
redirect_link
string
The original target URL.
list
object
Multiple items returned in order
5 properties
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…
domain_response
object
6 properties
object
string
Value is resource type.
link_update
object
3 properties 1 required
domains_response

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lobcom-url-shortener-api-openapi.yml Raw ↑

Other APIs Lob.com publishes across the network.

Lob.com Accounts API
AE Profile APIs.io
Lob.com Addresses API
AE Profile APIs.io
Lob.com Bank Accounts API
AE Profile APIs.io
Lob.com Billing Groups API
AE Profile APIs.io
Lob.com Booklets API
AE Profile APIs.io
Lob.com Buckslip Orders API
AE Profile APIs.io
Lob.com Buckslips API
AE Profile APIs.io
Lob.com Campaigns API
AE Profile APIs.io
Lob.com Card Orders API
AE Profile APIs.io
Lob.com Cards API
AE Profile APIs.io
Lob.com Checks API
AE Profile APIs.io
Lob.com Creatives API
AE Profile APIs.io
#URL Shortener
← Back to L APIs
API Details
ID
lobcom:lobcom-url-shortener-api
Base URL
https://api.lob.com/v1
Docs
https://docs.lob.com/
Provider
Lob.com
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=lobcom-url-shortener-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/lobcom-url-shortener-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.com URL Shortener 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.