> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getprimo.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get the devices with their AI tools counts
> Return every device Primo found AI tools on, by name, as JSON `data`: the device and its owner, how many tools, running tools, MCP servers, remote AI connections and instruction files it has, its findings per severity and the worst one. Narrow with `search` (device name, serial number or owner) and `worstSeverity` (a list). Use it for "which Macs have a critical AI finding"; for the full inventory of one device use `getAiToolsDevice`, for the findings themselves `getAiFindings`. AI tools are what Primo finds on Macs (assistant apps, coding agents, IDE plugins, browser extensions, MCP servers, AI connections, agent instruction files), as of the last report (`lastSyncedAt` of `getAiToolsOverview`, every 5 minutes), with Primo's severities, less the findings the company's AI tools settings ignore. They are not the software catalog (`getSoftwares`, `getDeviceSoftware`), the company's own AI agents (`listAgents`) nor AI credits (`getAiUsage`). A company without AI tools monitoring gets a 403, final.
Key: ReadScope: Company
## OpenAPI
````yaml https://api.getprimo.com/openapi.json get /ai-tools/devices
openapi: 3.1.1
info:
title: Public API - BETA
description: Read docs on https://docs.getprimo.com/
version: '1.0'
contact: {}
servers:
- url: https://api.getprimo.com
security:
- apikey: []
tags: []
paths:
/ai-tools/devices:
get:
tags:
- AiTools
summary: Get the devices with their AI tools counts
description: >-
Return every device Primo found AI tools on, by name, as JSON `data`:
the device and its owner, how many tools, running tools, MCP servers,
remote AI connections and instruction files it has, its findings per
severity and the worst one. Narrow with `search` (device name, serial
number or owner) and `worstSeverity` (a list). Use it for "which Macs
have a critical AI finding"; for the full inventory of one device use
`getAiToolsDevice`, for the findings themselves `getAiFindings`. AI
tools are what Primo finds on Macs (assistant apps, coding agents, IDE
plugins, browser extensions, MCP servers, AI connections, agent
instruction files), as of the last report (`lastSyncedAt` of
`getAiToolsOverview`, every 5 minutes), with Primo's severities, less
the findings the company's AI tools settings ignore. They are not the
software catalog (`getSoftwares`, `getDeviceSoftware`), the company's
own AI agents (`listAgents`) nor AI credits (`getAiUsage`). A company
without AI tools monitoring gets a 403, final.
operationId: getAiToolsDevices
parameters:
- name: worstSeverity
required: false
in: query
description: >-
Keep the items whose worst finding has one of these severities
(repeat the param or comma separate)
schema:
type: array
items:
type: string
enum:
- critical
- high
- medium
- low
- name: search
required: false
in: query
description: Part of the device name, its serial number or its owner's name
schema:
type: string
responses:
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GetAiToolsDevicesResponse_Output'
components:
schemas:
GetAiToolsDevicesResponse_Output:
type: object
properties:
data:
type: array
items:
type: object
properties:
deviceId:
description: Primo device id, to pass to `getAiToolsDevice` or `getDevice`
type: string
deviceName:
anyOf:
- type: string
- type: 'null'
serialNumber:
anyOf:
- type: string
- type: 'null'
platform:
anyOf:
- type: string
enum:
- ANDROID
- IOS
- IPADOS
- MACOS
- WINDOWS
- LINUX
- CHROME_OS
- UNKNOWN
- type: 'null'
ownerId:
description: Employee id of the device owner
anyOf:
- type: string
- type: 'null'
ownerName:
anyOf:
- type: string
- type: 'null'
toolsReportedAt:
description: When the device last reported its tools to Primo (ISO 8601)
anyOf:
- type: string
- type: 'null'
toolCount:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
runningToolCount:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
mcpServerCount:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
remoteConnectionCount:
description: Connections to AI services outside the device, last 24 hours
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
instructionFileCount:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
findingCounts:
type: object
properties:
critical:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
high:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
medium:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
low:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
required:
- critical
- high
- medium
- low
additionalProperties: false
worstSeverity:
anyOf:
- type: string
enum:
- critical
- high
- medium
- low
- type: 'null'
worstSeverityLabel:
anyOf:
- type: string
- type: 'null'
required:
- deviceId
- deviceName
- serialNumber
- platform
- ownerId
- ownerName
- toolsReportedAt
- toolCount
- runningToolCount
- mcpServerCount
- remoteConnectionCount
- instructionFileCount
- findingCounts
- worstSeverity
- worstSeverityLabel
additionalProperties: false
required:
- data
additionalProperties: false
securitySchemes:
apikey:
scheme: bearer
bearerFormat: API key
type: http
description: >-
Use your Primo API key in the Authorization header as `Bearer
`.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.