canonical: https://jentic.com/apis/pdq.com/pdq

# PDQ Connect

PDQ Connect API provides programmatic access to IT device management operations including deploying software packages, inventorying managed devices, and organizing devices into groups. The API enables IT administrators to list deployments, query device details, manage device groups, and access package information across their fleet. It is designed for organizations managing Windows endpoints at scale.

## For AI agents

Deploy software packages, inventory devices, and manage device groups across IT fleets. Programmatic access to PDQ Connect device management operations.

## Scope

Does not handle remote desktop access, patch creation, or network monitoring - use for device inventory, software deployment tracking, and group management only.

## Capabilities

- List software deployments and track their status across managed devices
- Inventory managed devices with hardware and software details
- Retrieve detailed information for individual devices by ID
- Organize devices into logical groups for targeted management
- Browse and inspect software packages available for deployment
- Access package details including version and deployment configuration

## Use cases

### Fleet Software Deployment Monitoring

Monitor the status of software deployments across managed devices. The API provides a list of all deployments with their current state, enabling IT teams to identify failed installations, track rollout progress, and verify that critical patches reached all target devices.

Example prompt: GET `/v1/api/deployments` to list all deployments and filter for those with failed status to identify devices needing attention

### Device Inventory and Compliance Auditing

Query the complete inventory of managed devices for compliance reporting, asset management, or security audits. Retrieve device details including hardware specifications, installed software, and group membership to verify that endpoints meet organizational standards.

Example prompt: GET `/v1/api/devices` to list all managed devices, then GET `/v1/api/devices/{device_id}` for specific devices requiring detailed compliance checks

### Group-Based Device Management

Organize devices into groups for targeted software deployments, policy application, or reporting. Device groups enable IT administrators to segment their fleet by department, location, role, or any custom criteria, then apply management actions to specific segments.

Example prompt: GET `/v1/api/groups` to list all device groups and identify the correct target group for a targeted deployment action

### AI Agent IT Operations via Jentic

AI agents perform IT management tasks by calling PDQ Connect through Jentic. The agent searches for device management operations, loads endpoint schemas, and executes inventory queries or deployment checks without managing bearer tokens or understanding the PDQ Connect API structure directly.

Example prompt: Search Jentic for 'list managed devices', load the `/v1/api/devices` schema, and execute to retrieve the current device inventory

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/v1/api/deployments` | List all software deployments |
| GET | `/v1/api/devices` | List all managed devices |
| GET | `/v1/api/devices/{device_id}` | Retrieve details for a specific device |
| GET | `/v1/api/groups` | List all device groups |
| GET | `/v1/api/packages` | List all available software packages |
| GET | `/v1/api/packages/{package_id}` | Retrieve details for a specific package |

## Key resources

- **Deployments** — List software deployments and their status across managed devices
- **Devices** — Inventory managed devices with detailed hardware and software information
- **Groups** — Organize devices into logical groups for targeted management
- **Packages** — Browse and inspect software packages available for deployment

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 48 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 99 / 100
  - Developer Experience & Jentic Compatibility: 60 / 100
  - AI-Readiness & Agent Experience: 23 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 58 / 100
- **View full report:** https://jentic.com/apis/pdq.com/pdq/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring PDQ Connect by hand means setting up its bearer auth against app.pdq.com and paging through devices, deployments, groups, and packages yourself. Through Jentic you install once, import PDQ Connect from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** PDQ Connect puts the resource id in the URL path (`/v1/api/devices/{device_id}`, `/v1/api/packages/{package_id}`), so a rule can pin your agent to reading a specific device or package. The endpoints here are read-only inventory queries, and you choose which operations the agent may call so only those run.
- **Credential handling:** Your PDQ Connect bearer token from the admin console is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list managed devices' or 'check software deployment status', and Jentic returns the matching PDQ Connect operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Jamf Pro API** — Apple device management with extensive MDM capabilities
- **CloudConvert API** — File format conversion for documents across your fleet
- **Slack API** — Team messaging for deployment notifications and alerts

## FAQ

### What authentication does the PDQ Connect API use?

PDQ Connect API uses bearer token authentication. You generate an API key from your PDQ Connect admin console and pass it as a Bearer token in the Authorization header. Through Jentic, this token is stored encrypted in the vault and injected automatically.

### Can I list all managed devices in my organization?

Yes. GET `/v1/api/devices` returns all managed devices in your PDQ Connect organization. For individual device details including hardware specs and installed software, use GET `/v1/api/devices/{device_id}` with the specific device identifier.

### How do I check deployment status across my fleet?

GET `/v1/api/deployments` returns all software deployments with their current status. You can identify failed, pending, or completed deployments to track rollout progress across your managed endpoints.

### What are device groups used for in PDQ Connect?

Device groups organize managed endpoints into logical collections for targeted actions. GET `/v1/api/groups` lists all configured groups. Groups enable segmented software deployment, policy application, and filtered reporting by department, location, or custom criteria.

### How do I manage devices through Jentic with PDQ Connect?

Install with pip install jentic, search for 'list managed devices' or 'check deployment status'. Jentic returns the `/v1/api/devices` or `/v1/api/deployments` operation schemas. Execute to query your fleet. Jentic handles bearer token injection automatically.

### Is the PDQ Connect API in stable release?

The current API version is 0.01-beta, indicating it is in beta status. While functional, endpoints and response schemas may change. Check the PDQ Connect documentation for migration guidance when stable versions are released.

### Can I limit what my agent is allowed to do with the PDQ Connect API?

Yes. Because you run Jentic One yourself, your own rules decide which PDQ Connect operations and credentials the agent may use, and you can allow only a subset such as GET `/v1/api/devices` or GET `/v1/api/deployments.` Since PDQ Connect puts the resource id in the URL path (GET `/v1/api/devices/{device_id}`, GET `/v1/api/packages/{package_id}`), a rule can pin the agent to reading one specific device or package. The endpoints here are read-only inventory queries, so the agent can look up devices, deployments, groups, and packages but cannot change your fleet.