Installer

listInstallerListOfRecentlyClaimedDevices

GET
/api/v1/installer/orgs/{org_id}/devices

Return recently claimed devices visible to installer workflows, with optional filters for model, site name, or site identifier.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

org_id*string
Formatuuid

Query Parameters

model?string

Filter results by device model

site_name?string

Filter results by site name

site_id?string

Filter results by site identifier

Formatuuid
limit?integer

Maximum number of results to return per page

Range0 <= value
Default100
page?integer

Select the page number to return when using page-based pagination; starts at 1

Range1 <= value
Default1

Response Body

curl -X GET "https://example.com/api/v1/installer/orgs/000000ab-00ab-00ab-00ab-0000000000ab/devices"
[  {    "connected": true,    "deviceprofile_name": "SJ1",    "height": 2.7,    "mac": "5c5b35000018",    "map_id": "845a23bf-bed9-e43c-4c86-6fa474be7ae5",    "model": "AP41",    "name": "hallway",    "orientation": 90,    "serial": "FXLH2015150025",    "site_name": "SJ1",    "x": 150,    "y": 300  }]