Skip to content

Get a property's details

GET
/api/public/v1/properties/{id}/
curl --request GET \
--url https://app-api.landinsights.co/api/public/v1/properties/7234891/ \
--header 'Authorization: Bearer <token>'

Returns parcel details including geometry centroid, owner, situs address, acreage, year built, zoning, market valuation, and land-suitability signals such as soil types with septic suitability, road frontage, wetlands, and flood-zone coverage.

Cost: 10 tokens per call.

id
required
integer

Land Insights numeric parcel identifier (also returned as property_id in search and filter responses).

Examples
Example SamplePropertyID

Sample PropertyID

7234891
Media type application/json

Full detail for a single parcel: identity, location and boundary, situs and mailing addresses, ownership, assessment and valuation, structures, sale and mortgage history, and derived signals such as terrain (slope and elevation), wetlands, flood zone, and road access.

object
property_id
required

Land Insights numeric identifier for the parcel. Stable.

integer
url
required

Direct link to view this parcel in the Land Insights web app.

string
apn
required

Assessor’s Parcel Number — the county-assigned property identifier.

string
nullable
apn_sequence_number
required

Sequence number distinguishing multiple records sharing an APN.

string
nullable
old_apn
required

Previous or alternate APN.

string
nullable
old_apn_indicator
required

Flag indicating the APN recently changed.

string
nullable
tax_account_number
required

County tax account / bill number.

string
nullable
fips
required

5-digit county FIPS code (2-digit state FIPS + 3-digit county FIPS).

string
nullable
property_class_id
required

First American general property-class code (e.g. Residential, Commercial, Office).

string
nullable
point
required

Geographic centroid (point-on-surface) of the parcel as [longitude, latitude] in WGS84 (EPSG:4326). May be null if geometry is unavailable.

Array<number>
nullable >= 2 characters <= 2 characters
shape
required

Parcel boundary polygon as a GeoJSON geometry object (WGS84). Null when geometry is unavailable.

object
acres
required

Parcel acreage as reported by the county assessor (source field LotSizeAcres). This is the authoritative legal/recorded acreage. For the acreage measured from the parcel polygon, see calculated_acres. Acreage filters use effective_acres.

number format: double
nullable
calculated_acres
required

Parcel acreage computed from the parcel geometry (source field CalculatedAcres): the GIS area of the polygon in acres, rounded to two decimals. May differ from the assessor-reported acres due to surveying or geometry differences, and is null when geometry is unavailable.

number format: double
nullable
effective_acres
required

Parcel acreage used for acreage filtering and sorting: the assessor-reported acres when present, otherwise the polygon-measured calculated_acres. Null only when both are unavailable.

number format: double
nullable
lot_size_sq_ft
required

Parcel area in square feet, per the assessor.

integer
nullable
situs_address
required

Physical street address of the parcel (situs).

string
nullable
situs_house_number
required

Situs house number.

string
nullable
situs_house_number_suffix
required

Situs house-number suffix (e.g. ‘1/2’).

string
nullable
situs_direction_left
required

Pre-directional of the situs street (e.g. ‘N’).

string
nullable
situs_street
required

Situs street name.

string
nullable
situs_mode
required

Situs street suffix/mode (e.g. ‘ST’, ‘RD’).

string
nullable
situs_direction_right
required

Post-directional of the situs street (e.g. ‘SW’).

string
nullable
situs_unit_type
required

Situs unit type (e.g. ‘APT’, ‘STE’).

string
nullable
situs_unit_number
required

Situs unit number.

string
nullable
situs_city
required

Situs city.

string
nullable
situs_state
required

Situs two-letter US state code.

string
nullable
situs_zip
required

Situs 5-digit ZIP code.

string
nullable
situs_zip4
required

Situs ZIP+4 extension.

string
nullable
situs_carrier_code
required

USPS carrier route code for the situs address.

string
nullable
situs_latitude
required

Assessor-provided situs latitude (WGS84).

number format: double
nullable
situs_longitude
required

Assessor-provided situs longitude (WGS84).

number format: double
nullable
situs_census_tract
required

US Census tract.

string
nullable
situs_census_block
required

US Census block.

string
nullable
land_use
required

Land-use description, resolved from the assessor land-use code.

string
nullable
state_land_use_code
required

State-normalized land-use code.

string
nullable
county_land_use_code
required

County-specific land-use code (raw).

string
nullable
zoning
required

Zoning code as recorded by the county assessor. Codes are not standardized across counties — interpret in county context.

string
nullable
mobile_home_indicator
required

Flag indicating a mobile/manufactured home on the parcel.

string
nullable
school_district
required

Name of the school district the parcel falls within.

string
nullable
topography_code
required

Assessor topography code.

string
nullable
water_code
required

Assessor water-service code.

integer
nullable
lot_code
required

Lot code.

string
nullable
lot_number
required

Lot number.

string
nullable
land_lot
required

Land lot.

string
nullable
block
required

Block.

string
nullable
section
required

Section.

string
nullable
district
required

District.

string
nullable
legal_unit
required

Legal unit.

string
nullable
municipality
required

Municipality.

string
nullable
subdivision_name
required

Subdivision name.

string
nullable
subdivision_phase_number
required

Subdivision phase number.

string
nullable
subdivision_tract_number
required

Subdivision tract number.

string
nullable
meridian
required

PLSS meridian.

string
nullable
assessors_map_ref
required

Reference to the assessor’s parcel map.

string
nullable
legal_description
required

Free-text legal description of the parcel.

string
nullable
owner_name
required

Full name of the primary owner of record (raw string from assessor; typically uppercase, may include corporate suffixes like ‘LLC’).

string
nullable
owner_name_2
required

Full name of the secondary owner of record, if any.

string
nullable
owner1_corporate_indicator
required

Set when the primary owner is a corporate entity.

string
nullable
owner1_first_name
required

Primary owner first name.

string
nullable
owner1_middle_name
required

Primary owner middle name.

string
nullable
owner1_last_name
required

Primary owner last name (or entity name).

string
nullable
owner1_suffix
required

Primary owner name suffix.

string
nullable
owner2_corporate_indicator
required

Set when the secondary owner is a corporate entity.

string
nullable
owner2_first_name
required

Secondary owner first name.

string
nullable
owner2_middle_name
required

Secondary owner middle name.

string
nullable
owner2_last_name
required

Secondary owner last name (or entity name).

string
nullable
owner2_suffix
required

Secondary owner name suffix.

string
nullable
owner_occupied
required

‘Y’ when the owner occupies the parcel; blank/null otherwise.

string
nullable
owner1_ownership_rights
required

Ownership-rights code for the primary owner.

string
nullable
mailing_address
required

Owner’s full mailing street address.

string
nullable
mailing_house_number
required

Mailing house number.

string
nullable
mailing_house_number_suffix
required

Mailing house-number suffix.

string
nullable
mailing_direction_left
required

Mailing street pre-directional.

string
nullable
mailing_street
required

Mailing street name.

string
nullable
mailing_mode
required

Mailing street suffix/mode (e.g. ‘ST’, ‘RD’).

string
nullable
mailing_direction_right
required

Mailing street post-directional.

string
nullable
mailing_unit_type
required

Mailing unit type.

string
nullable
mailing_unit_number
required

Mailing unit number.

string
nullable
mailing_city
required

Mailing city.

string
nullable
mailing_state
required

Mailing two-letter US state code.

string
nullable
mailing_zip
required

Mailing 5-digit ZIP code.

string
nullable
mailing_zip4
required

Mailing ZIP+4 extension.

string
nullable
mailing_carrier_code
required

USPS carrier route code for the mailing address.

string
nullable
mailing_opt_out
required

Do-not-mail flag for the owner mailing address.

string
nullable
mailing_foreign_address_indicator
required

Set when the mailing address is outside the US.

string
nullable
assessed_total_value
required

Assessor’s total assessed value, in whole US dollars.

integer
nullable
assessed_land_value
required

Assessor’s assessed land value, in whole US dollars.

integer
nullable
assessed_improvement_value
required

Assessor’s assessed improvement value, in whole US dollars.

integer
nullable
market_total_value
required

Assessor’s most recent total market value estimate, in whole US dollars.

integer
nullable
market_land_value
required

Assessor’s market land value, in whole US dollars.

integer
nullable
market_improvement_value
required

Assessor’s market improvement value, in whole US dollars.

integer
nullable
improvement_percentage
required

Improvement value as a percentage of total value — a vacancy signal (low percentage suggests little/no structure).

number format: double
nullable
tax_amount
required

Annual property tax amount, in US dollars (source TaxAmt).

number format: double
nullable
tax_year
required

Tax year for tax_amount.

string
nullable
tax_delinquent_year
required

Earliest year the parcel became tax-delinquent; null if current.

string
nullable
market_year
required

Year of the assessor market-value estimate.

string
nullable
assessed_year
required

Year of the assessed values.

string
nullable
tax_rate_code_area
required

Tax rate area code governing the parcel.

string
nullable
homestead_indicator
required

Homestead exemption flag.

string
nullable
veteran_indicator
required

Veteran exemption flag.

string
nullable
disabled_indicator
required

Disabled exemption flag.

string
nullable
widow_indicator
required

Widow/widower exemption flag.

string
nullable
senior_indicator
required

Senior exemption flag.

string
nullable
school_college_indicator
required

School/college exemption flag.

string
nullable
religious_indicator
required

Religious exemption flag.

string
nullable
welfare_indicator
required

Welfare exemption flag.

string
nullable
public_utility_indicator
required

Public-utility exemption flag.

string
nullable
cemetery_indicator
required

Cemetery exemption flag.

string
nullable
hospital_indicator
required

Hospital exemption flag.

string
nullable
library_indicator
required

Library exemption flag.

string
nullable
building_area
required

Building square footage considered most representative for assessment/comparison; the source area is named by building_area_indicator (e.g. Living, Adjusted, Gross).

integer
nullable
building_area_indicator
required

Code naming which area was used to populate building_area.

string
nullable
building_sq_ft
required

Total building square footage on the parcel.

integer
nullable
living_area_sq_ft
required

Total living area sq ft.

integer
nullable
ground_floor_sq_ft
required

Ground-floor sq ft.

integer
nullable
gross_area_sq_ft
required

Gross area sq ft.

integer
nullable
adjusted_area_sq_ft
required

Adjusted area sq ft.

integer
nullable
year_built
required

Year the primary structure was built, per the assessor. Null for vacant land or unrecorded structures.

integer
nullable
effective_year_built
required

Effective year built (after major renovations).

integer
nullable
bedrooms
required

Number of bedrooms.

string
nullable
total_rooms
required

Total number of rooms.

string
nullable
bath_total
required

Calculated total bathroom count.

string
nullable
bath_full
required

Number of full bathrooms.

string
nullable
baths_partial
required

Number of partial bathrooms.

string
nullable
air_conditioning_code
required

Assessor air-conditioning code.

integer
nullable
heat_code
required

Assessor heating code.

integer
nullable
garage_parking_number
required

Number of garage/parking spaces.

integer
nullable
building_quality_code
required

Assessor building-quality code.

integer
nullable
roof_cover_code
required

Assessor roof-cover code.

integer
nullable
stories_number_code
required

Assessor number-of-stories code.

integer
nullable
style_code
required

Assessor building-style code.

integer
nullable
residential_units
required

Number of residential units.

integer
nullable
structure_count
required

Number of buildings/structures on the parcel.

integer
nullable
commercial_units
required

Number of commercial units.

integer
nullable
has_structure
required

True when the parcel appears to have a structure (per the vacancy heuristic over building square footage and year built).

boolean
current_sale_doc_number
required

Recording document number for the most recent sale.

string
nullable
current_sale_book
required

Deed book (current sale).

string
nullable
current_sale_page
required

Deed page (current sale).

string
nullable
current_sale_recording_date
required

Recording date of the most recent sale (YYYYMMDD).

string
nullable
current_sale_contract_date
required

Contract date of the most recent sale (YYYYMMDD).

string
nullable
current_sale_document_type
required

Deed/document type description for the most recent sale.

string
nullable
current_sale_price
required

Most recent sale price, in whole US dollars.

integer
nullable
current_sale_price_code
required

Description of the sale-price code (e.g. full value, partial).

string
nullable
current_sale_buyer1_name
required

Primary buyer in the most recent sale.

string
nullable
current_sale_buyer2_name
required

Secondary buyer in the most recent sale.

string
nullable
current_sale_seller1_name
required

Primary seller in the most recent sale (prior owner).

string
nullable
current_sale_seller2_name
required

Secondary seller in the most recent sale.

string
nullable
concurrent_mtg1_doc_number
required

Recording document number for the first concurrent mortgage.

string
nullable
concurrent_mtg1_book
required

Mortgage 1 book.

string
nullable
concurrent_mtg1_page
required

Mortgage 1 page.

string
nullable
concurrent_mtg1_recording_date
required

Recording date of the first concurrent mortgage (YYYYMMDD).

string
nullable
concurrent_mtg1_loan_amount
required

Loan amount of the first concurrent mortgage, in whole USD.

integer
nullable
concurrent_mtg1_lender
required

Lender on the first concurrent mortgage.

string
nullable
concurrent_mtg1_term
required

Term of the first concurrent mortgage.

string
nullable
concurrent_mtg1_interest_rate
required

Interest rate (%) of the first concurrent mortgage.

number format: double
nullable
concurrent_mtg1_loan_due_date
required

Due date of the first concurrent mortgage (YYYYMMDD).

string
nullable
concurrent_mtg1_loan_type
required

Loan-type description for the first concurrent mortgage.

string
nullable
concurrent_mtg1_type_financing
required

Financing-type description for the first concurrent mortgage.

string
nullable
concurrent_mtg2_doc_number
required

Recording document number for the second concurrent mortgage.

string
nullable
concurrent_mtg2_book
required

Mortgage 2 book.

string
nullable
concurrent_mtg2_page
required

Mortgage 2 page.

string
nullable
concurrent_mtg2_recording_date
required

Recording date of the second concurrent mortgage (YYYYMMDD).

string
nullable
concurrent_mtg2_loan_amount
required

Loan amount of the second concurrent mortgage, in whole USD.

integer
nullable
concurrent_mtg2_lender
required

Lender on the second concurrent mortgage.

string
nullable
concurrent_mtg2_term
required

Term of the second concurrent mortgage.

string
nullable
concurrent_mtg2_interest_rate
required

Interest rate (%) of the second concurrent mortgage.

number format: double
nullable
concurrent_mtg2_loan_due_date
required

Due date of the second concurrent mortgage (YYYYMMDD).

string
nullable
concurrent_mtg2_loan_type
required

Loan-type code for the second concurrent mortgage.

string
nullable
concurrent_mtg2_type_financing
required

Financing-type code for the second concurrent mortgage.

string
nullable
prev_sale_doc_number
required

Recording document number for the prior sale.

string
nullable
prev_sale_book
required

Deed book (prior sale).

string
nullable
prev_sale_page
required

Deed page (prior sale).

string
nullable
prev_sale_recording_date
required

Recording date of the prior sale (YYYYMMDD).

string
nullable
prev_sale_contract_date
required

Contract date of the prior sale (YYYYMMDD).

string
nullable
prev_sale_document_type
required

Deed/document type code for the prior sale.

string
nullable
prev_sale_price
required

Prior sale price, in whole US dollars.

integer
nullable
prev_sale_price_code
required

Sale-price code for the prior sale.

string
nullable
prev_sale_buyer1_name
required

Primary buyer in the prior sale.

string
nullable
prev_sale_buyer2_name
required

Secondary buyer in the prior sale.

string
nullable
prev_sale_seller1_name
required

Primary seller in the prior sale.

string
nullable
prev_sale_seller2_name
required

Secondary seller in the prior sale.

string
nullable
prev_mtg1_doc_number
required

Recording document number for the prior first mortgage.

string
nullable
prev_mtg1_book
required

Prior mortgage 1 book.

string
nullable
prev_mtg1_page
required

Prior mortgage 1 page.

string
nullable
prev_mtg1_recording_date
required

Recording date of the prior first mortgage (YYYYMMDD).

string
nullable
prev_mtg1_loan_amount
required

Loan amount of the prior first mortgage, in whole USD.

integer
nullable
prev_mtg1_lender
required

Lender on the prior first mortgage.

string
nullable
prev_mtg1_term
required

Term of the prior first mortgage.

integer
nullable
prev_mtg1_interest_rate
required

Interest rate (%) of the prior first mortgage.

number format: double
nullable
prev_mtg1_loan_due_date
required

Due date of the prior first mortgage (YYYYMMDD).

string
nullable
prev_mtg1_loan_type
required

Loan-type code for the prior first mortgage.

string
nullable
prev_mtg1_type_financing
required

Financing-type code for the prior first mortgage.

string
nullable
hoa1_name
required

Primary HOA name.

string
nullable
hoa1_present
required

True when the parcel belongs to a primary HOA.

boolean
hoa2_name
required

Secondary HOA name.

string
nullable
hoa2_present
required

True when the parcel belongs to a secondary HOA.

boolean
inter_family_flag
required

True when the most recent transfer was between family members.

boolean
nullable
out_of_state_owner
required

True when the owner’s mailing state differs from the parcel’s.

boolean
nullable
out_of_county_owner
required

True when the owner’s mailing county differs from the parcel’s.

boolean
nullable
out_of_zip_owner
required

True when the owner’s mailing ZIP differs from the parcel’s.

boolean
nullable
computed_sq_ft
required

Building square footage estimated from overlapping structures.

integer
nullable
wetlands_percent
required

Percentage of the parcel area overlapping mapped wetlands.

integer
nullable
flood_zone_percent
required

Percentage of the parcel area within a mapped flood zone.

integer
nullable
land_locked
required

True when no qualifying public road borders the parcel.

boolean
nullable
road_frontage_ft
required

Total length of road frontage along the parcel, in feet.

integer
nullable
road_frontage_roads
required

Roads bordering the parcel, each with its name, classification, and the parcel’s frontage along it (feet), ordered by frontage. Null when road frontage has not been computed for the parcel.

Array<object>
nullable
object
name
required

Road name, when known.

string
nullable
type
required

Road classification (e.g., residential, highway).

string
nullable
frontage_ft
required

Length of the parcel’s frontage along this road, in feet.

integer
soil_types
required

USDA-NRCS soil map units overlapping the parcel, each with its share of parcel area (percent), drainage class, hydrologic group, septic limiting features, land capability class, flood frequency, and seasonal high water table depth, ordered by coverage. Empty when no mapped soil overlaps the parcel; null when soil has not been computed.

Array<object>
nullable
object
name
required

USDA-NRCS soil map unit name (e.g., ‘Cecil sandy loam, 2 to 6 percent slopes’).

string
nullable
code
required

Soil map unit symbol (musym).

string
nullable
percent
required

Share of the parcel’s area covered by this soil map unit.

integer
drainage_class

Dominant drainage class (e.g., ‘Well drained’).

string
nullable
hydrologic_group

Hydrologic soil group (A–D); later groups drain more slowly and run off more.

string
nullable
septic_limiting_features

Soil conditions that constrain a conventional septic system, from the set ‘Shallow water table’, ‘Shallow bedrock’, ‘Flooding’, ‘Ponding’, ‘Poor drainage’, and ‘Steep slope’. Empty when no limiting feature was identified.

Array<string>
land_capability_class

USDA non-irrigated land capability class (1–8). Classes 1–4 are suited to cultivation with increasing limitations; classes 5–8 are generally unsuited to cultivation and better for pasture, range, forest, or wildlife. Lower is better cropland.

integer
nullable
flood_frequency

How often the soil floods, dominant condition: one of ‘None’, ‘Very rare’, ‘Rare’, ‘Occasional’, ‘Frequent’, or ‘Very frequent’. ‘None’ means no flooding is expected; null when the soil has no flooding rating.

string
nullable
water_table_depth_in

Shallowest annual depth to the seasonal high water table, in inches. Shallower water tables constrain building, basements, and septic. Null when no seasonal high water table is recorded within the surveyed profile.

integer
nullable
in_city_limits
required

True when the parcel falls within incorporated city limits.

boolean
nullable
elevation_min_ft
required

Lowest ground elevation on the parcel, in feet above sea level.

number format: double
nullable
elevation_max_ft
required

Highest ground elevation on the parcel, in feet above sea level.

number format: double
nullable
elevation_avg_ft
required

Average ground elevation across the parcel, in feet above sea level.

number format: double
nullable
elevation_resolution_m
required

Resolution of the underlying elevation grid, in meters (1 = high-resolution source, 10 = coarser fallback). Lower is more precise.

integer
nullable
slope_min_percent
required

Gentlest ground slope on the parcel, as a percent grade (rise/run × 100).

number format: double
nullable
slope_max_percent
required

Steepest ground slope on the parcel, as a percent grade. Reported at the 99.5th percentile so a few outlier readings don’t dominate.

number format: double
nullable
slope_avg_percent
required

Average ground slope across the parcel, as a percent grade (rise/run × 100).

number format: double
nullable
slope_band_distribution
required

Breakdown of the parcel’s area by ground-slope band, flattest to steepest. Each entry gives the slope range (percent grade) and the share of parcel area in that range; shares sum to roughly 100%. Null when no elevation data is available for the parcel.

Array<object>
nullable
object
min_percent
required

Lower slope bound of the band, in percent grade (inclusive).

number
max_percent
required

Upper slope bound of the band, in percent grade (exclusive). Null for the open-ended steepest band (50%+).

number
nullable
area_percent
required

Share of the parcel’s area whose ground slope falls in this band. Bands sum to roughly 100%.

number
nullable
owner_parcel_count
required

Count of other parcels in the database with the same mailing address as the current owner — a rough portfolio-size signal.

integer
nullable
Examples
Example RuralVacantParcel(abridged—FullDetailHasManyMoreFields)

Rural vacant parcel (abridged — full detail has many more fields)

{
"property_id": 7234891,
"url": "https://app.landinsights.co/data?parcel=7234891",
"apn": "07111-04-006",
"fips": 8023,
"point": [
-105.42,
37.2
],
"shape": {
"type": "Polygon",
"coordinates": [
[
[
-105.421,
37.198
],
[
-105.419,
37.198
],
[
-105.419,
37.201
],
[
-105.421,
37.201
],
[
-105.421,
37.198
]
]
]
},
"acres": 5,
"calculated_acres": 5.13,
"owner_name": "SMITH JOHN",
"situs_address": null,
"situs_city": "SAN LUIS",
"situs_state": "CO",
"situs_zip": "81152",
"land_use": "Vacant Land",
"year_built": null,
"zoning": "AG",
"assessed_total_value": 9800,
"market_total_value": 12400,
"land_locked": false,
"wetlands_percent": 0,
"elevation_avg_ft": 7530,
"slope_avg_percent": 8.3,
"slope_band_distribution": [
{
"min_percent": 0,
"max_percent": 0.5,
"area_percent": 12.3
},
{
"min_percent": 0.5,
"max_percent": 2.5,
"area_percent": 40.1
},
{
"min_percent": 50,
"max_percent": null,
"area_percent": 0
}
],
"owner_parcel_count": 3
}

Validation error.

Media type application/json
object
error
required
object
code
required

Stable machine-readable error code. One of: unauthorized, forbidden, subscription_required, tier_upgrade_required, usage_limit_exceeded, usage_backstop_reached, payment_required, validation_error, unprocessable, not_found, method_not_allowed, rate_limited, internal_error.

string
message
required

Human-readable description of the error.

string
request_id
required

Echoes the request’s X-Request-Id (or a server-issued id). Quote it in support requests.

string
details

Present on validation errors only: maps each rejected field to its list of messages.

object
key
additional properties
any
Example generated
{
"error": {
"code": "example",
"message": "example",
"request_id": "example",
"details": {}
}
}

Missing or invalid credentials.

Media type application/json
object
error
required
object
code
required

Stable machine-readable error code. One of: unauthorized, forbidden, subscription_required, tier_upgrade_required, usage_limit_exceeded, usage_backstop_reached, payment_required, validation_error, unprocessable, not_found, method_not_allowed, rate_limited, internal_error.

string
message
required

Human-readable description of the error.

string
request_id
required

Echoes the request’s X-Request-Id (or a server-issued id). Quote it in support requests.

string
details

Present on validation errors only: maps each rejected field to its list of messages.

object
key
additional properties
any
Example generated
{
"error": {
"code": "example",
"message": "example",
"request_id": "example",
"details": {}
}
}

A Pro subscription or higher API tier is required.

Media type application/json
object
error
required
object
code
required

Stable machine-readable error code. One of: unauthorized, forbidden, subscription_required, tier_upgrade_required, usage_limit_exceeded, usage_backstop_reached, payment_required, validation_error, unprocessable, not_found, method_not_allowed, rate_limited, internal_error.

string
message
required

Human-readable description of the error.

string
request_id
required

Echoes the request’s X-Request-Id (or a server-issued id). Quote it in support requests.

string
details

Present on validation errors only: maps each rejected field to its list of messages.

object
key
additional properties
any
Example generated
{
"error": {
"code": "example",
"message": "example",
"request_id": "example",
"details": {}
}
}

Authenticated but not permitted.

Media type application/json
object
error
required
object
code
required

Stable machine-readable error code. One of: unauthorized, forbidden, subscription_required, tier_upgrade_required, usage_limit_exceeded, usage_backstop_reached, payment_required, validation_error, unprocessable, not_found, method_not_allowed, rate_limited, internal_error.

string
message
required

Human-readable description of the error.

string
request_id
required

Echoes the request’s X-Request-Id (or a server-issued id). Quote it in support requests.

string
details

Present on validation errors only: maps each rejected field to its list of messages.

object
key
additional properties
any
Example generated
{
"error": {
"code": "example",
"message": "example",
"request_id": "example",
"details": {}
}
}

Resource not found.

Media type application/json
object
error
required
object
code
required

Stable machine-readable error code. One of: unauthorized, forbidden, subscription_required, tier_upgrade_required, usage_limit_exceeded, usage_backstop_reached, payment_required, validation_error, unprocessable, not_found, method_not_allowed, rate_limited, internal_error.

string
message
required

Human-readable description of the error.

string
request_id
required

Echoes the request’s X-Request-Id (or a server-issued id). Quote it in support requests.

string
details

Present on validation errors only: maps each rejected field to its list of messages.

object
key
additional properties
any
Example generated
{
"error": {
"code": "example",
"message": "example",
"request_id": "example",
"details": {}
}
}

Rate limit exceeded.

Media type application/json
object
error
required
object
code
required

Stable machine-readable error code. One of: unauthorized, forbidden, subscription_required, tier_upgrade_required, usage_limit_exceeded, usage_backstop_reached, payment_required, validation_error, unprocessable, not_found, method_not_allowed, rate_limited, internal_error.

string
message
required

Human-readable description of the error.

string
request_id
required

Echoes the request’s X-Request-Id (or a server-issued id). Quote it in support requests.

string
details

Present on validation errors only: maps each rejected field to its list of messages.

object
key
additional properties
any
Example generated
{
"error": {
"code": "example",
"message": "example",
"request_id": "example",
"details": {}
}
}

Internal error.

Media type application/json
object
error
required
object
code
required

Stable machine-readable error code. One of: unauthorized, forbidden, subscription_required, tier_upgrade_required, usage_limit_exceeded, usage_backstop_reached, payment_required, validation_error, unprocessable, not_found, method_not_allowed, rate_limited, internal_error.

string
message
required

Human-readable description of the error.

string
request_id
required

Echoes the request’s X-Request-Id (or a server-issued id). Quote it in support requests.

string
details

Present on validation errors only: maps each rejected field to its list of messages.

object
key
additional properties
any
Example generated
{
"error": {
"code": "example",
"message": "example",
"request_id": "example",
"details": {}
}
}