OrgsInventory

countOrgInventory

GET
/api/v1/orgs/{org_id}/inventory/count

Count organization inventory records, optionally grouped by distinct and filtered by device type, site, model, version, and status.

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

distinct?string

Field used to group this count response. enum: model, status, site_id, sku, version

Default"model"

Value in

  • "model"
  • "status"
  • "site_id"
  • "sku"
  • "version"
type?string

Filter results by type. enum: ap, gateway, switch

Default"ap"

Value in

  • "ap"
  • "gateway"
  • "switch"
site_id?string

Filter results by site identifier

model?string

Filter results by device model. Accepts multiple comma-separated values.

version?string

Filter results by software version

status?string

Filter results by status. enum: connected, disconnected

Value in

  • "connected"
  • "disconnected"
limit?integer

Maximum number of results to return per page

Range0 <= value
Default100

Response Body

curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/inventory/count"
{  "distinct": "string",  "end": 0,  "limit": 0,  "results": [    {      "count": 0,      "property": "string"    }  ],  "start": 0,  "total": 0}