Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Listing external links

List external links

Returns all external links for the given property (listing). Each item has id, url, and name. Use the id values for update (PUT), delete (DELETE), or reorder (PUT order). Empty array if the property has no links yet.

get/properties-api/listing-settings/external-links/{propertyId}

Path parameters

propertyIdstring required
Example:507f1f77bcf86cd799439011

The property (listing) ID. A 24-character hexadecimal string.

Response

Array of external links in display order. Empty array [] if none exist.

idstring required

Unique id of the link. Use for update (PUT :propertyId/:linkId), delete (DELETE), or reorder (PUT :propertyId/order).

urlstring required

URL of the link (with protocol).

namestring required

Display name shown to users.

Example response

[
  {
    "id": "507f1f77bcf86cd799439011",
    "url": "https://example.com",
    "name": "My Website"
  }
]