Properties

List property groups

Cursor-paginated, scoped to the token's account and role.

Besides the filter[<field>_<predicate>] fields, these filters take a plain value:

  • filter[property_id] — Only groups containing this property id.
get/v1/property_groups

Request

  • Base URL: https://api.topkey.io
  • URL: https://api.topkey.io/v1/property_groups
  • Auth: HTTP bearer

Query parameters

page[size]integer

Rows per page (max 100).

page[after]string

Opaque cursor from the previous page's meta.next_cursor.

property_idstring

Only groups containing this property id.

filter[field_predicate]=value (Ransack, per-resource allowlist), and the plain-value filters listed. Unknown filters return 400. Filterable fields: created_at, id, name, updated_at.

Response

A page of properties.

Changes

No recorded changes to this operation across all 1 revision of this API.