GET

List devices

https://api.kustom.co/ipp/v1/devices

Lists all registered devices for the merchant, optionally filtered by location.

Parameters4 fields

location_idstring · uuidoptionalin query
Filter by location ID.
metadataarray<string>optionalin query
Filter by metadata key-value pair. Format: key:value. Repeat the parameter to apply multiple filters — all must match (AND semantics). Maximum 5 entries. Duplicate keys are not allowed.
page_numberinteger · int32optionalin query
Zero-based page number. Defaults to 0.
page_sizeinteger · int32optionalin query
Page size. Defaults to 20.

200

Response7 fields

List of devices.

content[]array<any>optional
total_elementsinteger · int64optional
total_pagesinteger · int32optional
page_numberinteger · int32optional
page_sizeinteger · int32optional
firstbooleanoptional
lastbooleanoptional

401

Response0 fields

Missing or invalid credentials.

No response body — this status returns headers only.

GET https://api.kustom.co/ipp/v1/devices

Response 200· List of devices.

{
  "content": [
    "<string>"
  ],
  "total_elements": 0,
  "total_pages": 0,
  "page_number": 0,
  "page_size": 0,
  "first": false,
  "last": false
}

11 lines

This page is also available as Markdown — append .md to its URL — and is indexed in llms.txt.