---
title: "Retrieve an inventory sync job"
method: GET
path: "/v1/inventory-sync-job/{id}"
tags: ["Inventory"]
---

# Retrieve an inventory sync job

`GET /v1/inventory-sync-job/{id}`

## Request

- Base URL: `https://help.puppet.com/api/public`
- URL: `https://help.puppet.com/api/public/v1/inventory-sync-job/{id}`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/puppet/apis/puppet-comply-api/docs/v1/inventory-sync-job/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve an inventory sync job, including its current status and associated information.

To use this endpoint, you must have one of the following roles:
`comply-admin`
`comply-operator`
`comply-viewer`

## Path parameters

- `id` integer, required

## Response `200`

GetInventorySyncJobResponse is the response for a get inventory sync job request.

- object
  - `created_at` string, date-time, required: The time at which the inventory sync job was created.
  - `finished_at` string, date-time, nullable: The time at which the inventory sync job finished.
  - `id` integer, required: The ID of the inventory sync job.
  - `nodes_deleted` integer, required: The number of nodes deleted as part of the inventory sync job.
  - `nodes_synced` integer, required: The number of nodes synced as part of the inventory sync job.
  - `reason` string, required: The reason for failure of inventory sync job, if any.
  - `status` 'started' | 'successful' | 'failed' | 'aborted', required: The status of the inventory sync job.
  - `total_nodes` integer, required: The total number of nodes in the inventory.

## Other responses

- `404`: InventoryJobNotFound is returned when inventory sync job with provided id does not exist.
- `default`: ErrorResponse is the default error response.

---

[API](https://skmtc.dev/puppet/apis/puppet-comply-api.md) - [All operations](https://skmtc.dev/puppet/apis/puppet-comply-api/llms.txt) - [OpenAPI document](https://skmtc.dev/puppet/apis/puppet-comply-api/revisions/0a7ac90117d7?raw)