List Lodging Links

Return property links for a product, optionally filtered by departure or rate plan.

Method

GET /v1/products/:id/lodging/links

Path Parameters

id · uuid

Product ID to inspect.

Query Parameters

departureId · uuid

Limit results to links scoped to a specific departure.

ratePlanId · uuid

Limit results to links scoped to a rate plan.

Headers

Authorization · string

Bearer token (requires products:read).

Request Example

cURL

curl "https://api.voyantcloud.com/v1/products/prod_123/lodging/links?departureId=dep_456" \
  -H "Authorization: Bearer $VOYANT_API_KEY"

Response

200 OK

{
  "data": [
    {
      "id": "pll_001",
      "property_id": "prop_987",
      "departure_id": "dep_456",
      "rate_plan_id": null,
      "active": "true"
    },
    {
      "id": "pll_002",
      "property_id": "prop_654",
      "departure_id": null,
      "rate_plan_id": "rate_002",
      "active": "true"
    }
  ]
}

When no matching links are found, the API returns an empty array. Providing ratePlanId triggers a fallback that retries without the rate plan if needed.