---
title: "Get a list of report metadata"
method: GET
path: "/reports"
tags: ["Reports"]
---

# Get a list of report metadata

`GET /reports`

## Request

- Base URL: `https://api.jumpcloud.com/insights/directory/v1`
- URL: `https://api.jumpcloud.com/insights/directory/v1/reports`
- Auth: API key in header `x-api-key` and API key in header `x-org-id`
- TypeScript: <https://skmtc.dev/jumpcloud/apis/directory-insights-api/docs/reports/get.ts> (a function with typed inputs; its response is checked against the schema)

Ordered list of report metadata

## Query parameters

- `sort` 'CREATED_AT' | 'EXPIRATION' | 'REQUESTER_EMAIL' | 'STATUS' | 'TYPE' | 'UPDATED_AT' | '-CREATED_AT' | '-EXPIRATION' | '-REQUESTER_EMAIL' | '-STATUS' | '-TYPE' | '-UPDATED_AT'

## Response `200`

Array of report metadata

- object[]
  - `artifacts` object[]
    - `format` 'CSV' | 'JSON'
    - `id` string
  - `created_at` string
  - `expiration` string
  - `id` string
  - `parameters` object[]
  - `requester_email` string
  - `requester_id` string
  - `status` 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'DELETED'
  - `type` 'browser-patch-policy' | 'os-patch-policy' | 'os-version' | 'software-inventory' | 'users-account-health' | 'users-to-devices' | 'users-to-directories' | 'users-to-ldap-servers' | 'users-to-radius-servers' | 'users-to-sso-applications' | 'users-to-user-groups'
  - `updated_at` string

## Other responses

- `400`: Invalid parameter
- `401`: Unauthorized (Invalid API Key)
- `403`: User role does not have access to Reports
- `500`: Technical difficulties processing your request

---

[API](https://skmtc.dev/jumpcloud/apis/directory-insights-api.md) - [All operations](https://skmtc.dev/jumpcloud/apis/directory-insights-api/llms.txt) - [OpenAPI document](https://skmtc.dev/jumpcloud/apis/directory-insights-api/revisions/17eea0b00afb?raw)