Docs
V1 APIConnections

List group sets

Account-wide and property-scoped group-set definitions available to the property, including their nested group trees. 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}/groups

Account-wide and property-scoped group-set definitions available to the property, including their nested group trees. 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/groups"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "key": "string",      "objectType": "property",      "allowsMultipleMembership": true,      "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",      "groups": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "label": "string",          "slug": "string",          "description": "string",          "color": "string",          "sortOrder": 0,          "children": [            {}          ]        }      ]    }  ]}