API ReferenceEndpointsCustomizations

Read listing-level customizations

Returns the listing's OWN-level customization values (write-body-shaped). By default only toggled-ON customizations are returned; pass `toggled_on=false` to also include toggled-off ones with their full data packs. `?customizations=` filters the set. 404 only if the listing itself is not found; a listing with no customizations set returns 200 with an empty `customizations` map.

Authentication

X-API-KEYstring

Customer API key (maps to a user’s pl_api_key). Issued via account settings (Enable API access).

X-SETUP-IDstring
Static setup identifier required for Customer API requests in production.

Query parameters

listing_idstringRequired

Listing id (listing-level).

pms_namestringRequired

PMS/portal name (paired with listing_id).

customizationsstringOptional

Comma-separated spec keys to return; omit to return all supported.

toggled_onbooleanOptionalDefaults to true

When true (default), only customizations whose toggle is ON are returned. Pass false to also include toggled-off customizations with their full data packs.

Response

Customizations retrieved
customizationsobject

Map of customization name → its settings. Include any one or more of the customizations below in a single request. Unknown or unsupported customization names are rejected.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error