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

Lob Links API

The Links API from Lob — 2 operation(s) for links.

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

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

This API exposes 5 operations across 2 paths, and defines 13 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.

5 operations 2 paths 13 schemas 1 DELETE2 GET1 PATCH1 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
License
Terms of Service
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 5

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

Links 5
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 13

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

count
integer
number of resources in a set
link_update
object
3 properties 1 required
link_response
object
8 properties
link_single
object
5 properties 1 required
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…
links_response
object
string
Value is resource type.
redirect_link
string
The original target URL.
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…
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…
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
link_delete_response
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lob-links-api-openapi.yml Raw ↑

Other APIs Lob publishes across the network.

Lob Accounts API
Lob Addresses API
Lob Bank Accounts API
Lob Bank_id API
Lob Bg_id API
Lob Billing Groups API
Lob Booklet_id API
Lob Booklets API
Lob Buckslip_id API
Lob Buckslips API
Lob Bulk API
Lob Campaigns API
Where this information came from

This is an independent, third-party profile of Lob Links 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.