Read group-level customizations | Pricelabs

Returns the group’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. ?customizations= filters. 404 only if the group itself is not found.

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

group_idintegerRequired

Group 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

$	curl -G https://api.pricelabs.co/api/customizations/group \
>	-H "X-API-KEY: <apiKey>" \
>	-d group_id=1234 \
>	--data-urlencode customizations=last_minute_prices,demand_factor \
>	-d toggled_on=false

1	{
2	"customizations": {
3	"seasonality": {
4	"seasonality_customization_on": true,
5	"seasonality_type": "recommended"
6	},
7	"last_minute_prices": {
8	"last_min_factor_on": true,
9	"last_min_factor_type": "linear",
10	"last_min_factor_value": -15,
11	"last_min_factor_dfd": 14
12	}
13	}
14	}