Skip to main content
GET
List zone devices

Authorizations

Authorization
string
header
required

Bearer token obtained from POST /auth/tokens.

Path Parameters

zone_id
string
required

Flatpeak Zone ID.

Query Parameters

limit
integer
default:30

Maximum number of objects to return per page, default 30. Maximum 100.

Required range: 1 <= x <= 100
cursor
string

Pagination cursor. Pass next_cursor from the previous response unchanged; omit for the first page. A cursor used with different parameters returns 400 cursor_invalid.

Response

Zone devices response.

The IDs of your devices resolved into a zone, one page at a time.

object
enum<string>
required

Object type, zone_devices.

Available options:
zone_devices
Example:

"zone_devices"

zone_id
string
required

Flatpeak Zone ID.

Example:

"zon_9b3c5d7e1f2a4b6c8d0e2f4a"

count
integer
required

Total number of your devices in the zone, across every page.

Required range: x >= 0
Example:

412

next_cursor
string | null
required

Cursor for the next page. Pass it as cursor. null on the last page. Page until it is null, even if data is short or empty.

Example:

"djF8ZXZ0fGE5ZjN8NjYxNjc3ODdjMTY1MmIzZmJlYmE1ZjAx"

data
string[]
required

The page of Flatpeak Device IDs.

Example: