Docs
V2 APIInstagram

Get social profiles

The property's Instagram profile and, for a connection using the Facebook-Login flavor, its linked Facebook Page, as published. Each side has a `status`, so "not connected" and "the API failed" are never reported as missing information.

GET/api/v2/properties/{property}/social-profiles

The property's Instagram profile and, for a connection using the Facebook-Login flavor, its linked Facebook Page, as published. Each side has a status, so "not connected" and "the API failed" are never reported as missing information.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

property*string

Property UUID. This route does not accept a slug.

Formatuuid

Query Parameters

account_id?string

Optional account to run this request against. Defaults to the account the API token is scoped to, so callers with a single account can omit it. Must be an account the authenticated user belongs to; staff may target any account. For write requests the value may be sent in the JSON body instead of the query string. The resolved account is returned on the X-Resi-Account-Id response header.

Formatuuid
fresh?boolean

Read live instead of from the 15-minute cache.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v2/properties/497f6eca-6276-4993-bfeb-53cbbbba6f08/social-profiles"
{  "data": {    "instagram": {      "connected": true,      "status": "ok",      "flavor": "string",      "profile": {},      "error": "string",      "fetched_at": "2019-08-24T14:15:22Z"    },    "facebook": {      "connected": true,      "status": "ok",      "page": {},      "error": "string",      "fetched_at": "2019-08-24T14:15:22Z"    }  }}

Property Instagram feed GET

The property's synced Instagram feed, newest first. Serves stored data only (requests never call Instagram). A property without an enabled Instagram connection returns connected=false with an empty feed. Media URLs prefer the Resi-hosted library asset when a post was saved to the library, falling back to the refreshed Instagram CDN URL.

List neighborhood categories GET

Paginated, ordered by sort_order then name unless `sort` is given.