List available nudges | PriceLabs

Returns pending, non-expired nudges for listings accessible to the authenticated user. Results can be filtered by nudge type, listing ID, and PMS name.

Query parameters

nudge_typeenumOptional

Filter by nudge type. Omit to return all types.

Allowed values:

listing_idstringOptional

Filter by listing ID. Requires pms when provided.

pmsstringOptional

Filter by PMS name. Required when listing_id is provided.

Response

List of available nudges (may be empty)

nudgeslist of objectsOptional

Errors

400

Bad Request Error

1	{
2	"nudges": [
3	{
4	"listing_id": "10000001",
5	"pms_name": "airbnb",
6	"listing_name": "Cozy Downtown Apartment",
7	"nudge_type": "min_price",
8	"nudge_id": "550e8400-e29b-41d4-a716-446655440000",
9	"current_value": 100,
10	"suggested_value": 120,
11	"direction": "increase",
12	"reason": "Market demand is rising in your area.",
13	"expiration": "2026-07-10T00:00:00.000Z",
14	"status": "pending"
15	}
16	]
17	}

$	curl https://api.pricelabs.co/v1/nudges/available \
>	-H "X-API-Key: {{API_KEY}}"

Headers

Query parameters

Response

Errors