---
title: "List reporting fields"
method: GET
path: "/report/fields"
tags: ["report"]
---

# List reporting fields

`GET /report/fields`

Retrieve a list of reporting fields available to the user's account and the programs requested

## Query parameters

- `programIds` string[]

## Response `200`

A list of reporting fields organized by scope.

- ReportFieldSet[]
  - `scope` 'STANDARD' | 'PII' | 'METADATA', required — The scope to which the set of fields belong. Possible values are: * STANDARD - The base fields available to all reports. * PII - The fields containing personally identifiable information that are available to the user's account. * METADATA - The default and custom metadata fields available to the user's account and programs.
  - `fields` ReportField[], required — A list of field objects with each of their the names as they appear in reports and descriptions.
    - `name` string — The name used to identify the report field
    - `columnHeading` string, required — The column heading of the field as it will appear in generated reports
    - `description` string — Explanation of the field's meaning and usage

## Other responses

- `400` — Bad Request - one or more of the requested program ids is invalid.
- `401` — Unauthorized
- `429` — Too many requests. A `429` can mean one of two things — inspect the response body's `errorIds` before retrying: - A transient rate limit applied at the platform edge. If a `Retry-After` header is present, wait that many seconds (using exponential backoff) and retry. - A program/consumer limit such as `verificationLimitExceeded`, `reverificationDailyLimitExceeded`, or `docReviewLimitExceeded` — the consumer has exhausted an allowance defined by the program's limiting policy. This is a permanent rejection (`currentStep: error`, no `Retry-After`); do not retry.
- `500` — Internal server error.
- `503` — Service temporarily unavailable. The request can be safely retried after the interval given in the `Retry-After` header.

---

[API](https://skmtc.dev/sheerid/apis/sheerid-api.md) · [All operations](https://skmtc.dev/sheerid/apis/sheerid-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/sheerid/sheerid-api/revisions/dc7f4e84f543/schema)