Inventory

List inventory locations

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

get/v1/inventory_locations

Request

  • Base URL: https://api.topkey.io
  • URL: https://api.topkey.io/v1/inventory_locations
  • 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: active, created_at, id, location_type, name, property_id, updated_at.

Comma-separated relationships to sideload into included.

Response

A page of inventory.

Changes

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