Owners

List owners

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

get/v1/owners

Request

  • Base URL: https://api.topkey.io
  • URL: https://api.topkey.io/v1/owners
  • 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.

filterobject

filter[field_predicate]=value (Ransack, per-resource allowlist), and the plain-value filters listed. Unknown filters return 400. Filterable fields: combine_payments, contract_id, created_at, external_id, has_ach_info, id, integration_key, is_active, name, tax_classification, updated_at, user_id.

Comma-separated relationships to sideload into included.

Response

A page of owners.

Changes

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