Docs
V1 APIConnections

List announcements

Enabled announcements active at request time. Scoped to the portfolio: `{property}` is a slug resolved against the properties attached to `{connection}`, so a slug outside this portfolio is a `404` rather than another site's property.

GET/api/v1/connection/{connection}/property/{property}/announcements

Enabled announcements active at request time. Scoped to the portfolio: {property} is a slug resolved against the properties attached to {connection}, so a slug outside this portfolio is a 404 rather than another site's property.

Path Parameters

connection*string

Connection UUID.

Formatuuid
property*string

Property slug, resolved against the properties attached to {connection}. A slug outside that portfolio is a 404. Slug only — a UUID does not resolve here.

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/connection/497f6eca-6276-4993-bfeb-53cbbbba6f08/property/1520-gough-street/announcements"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "title": "string",      "hideText": true,      "image": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "thumb_url": "http://example.com",        "full_url": "http://example.com",        "caption": "string",        "alt_text": "string",        "tags": [          "string"        ],        "tags_string": "string",        "reference_url": "http://example.com",        "title": "string"      },      "details": "string",      "disclaimer": "string",      "link": "http://example.com",      "linkText": "string",      "link2": "http://example.com",      "link2Text": "string"    }  ]}

List reviews GET

Published reviews. Confirm syndication rights with the client before re-displaying or marking these up as structured data — some review sources prohibit it. Scoped to the portfolio: `{property}` is a slug resolved against the properties attached to `{connection}`, so a slug outside this portfolio is a `404` rather than another site's property.

List content blocks GET

Enabled content blocks (content groups) with enabled nested content items. Optionally filter the collection by comma-separated website connection keys. Scoped to the portfolio: `{property}` is a slug resolved against the properties attached to `{connection}`, so a slug outside this portfolio is a `404` rather than another site's property.