---
title: "Read one practice's weekly status report with the account ID and its access token, or the access token of the credentialing firm it is run for: for each application the payer, state, submitted date, status in the payer's own words, where it came from (the payer's status page with its address and read time, an automated call with the representative's name and the call reference, or a person), what is missing and from whom, and the next check date. When a credentialing firm runs the follow-up, the report carries the firm's name, reply-to address and callback number. The page prints, or saves as a PDF. Add ?format=csv or ?format=xlsx for the applications as a spreadsheet, one row per application, ready to paste into Smartsheet or Excel."
method: GET
path: "/v1/payer-follow-ups/{id}/report"
tags: ["Payer follow-ups", "Payments"]
---

# Read one practice's weekly status report with the account ID and its access token, or the access token of the credentialing firm it is run for: for each application the payer, state, submitted date, status in the payer's own words, where it came from (the payer's status page with its address and read time, an automated call with the representative's name and the call reference, or a person), what is missing and from whom, and the next check date. When a credentialing firm runs the follow-up, the report carries the firm's name, reply-to address and callback number. The page prints, or saves as a PDF. Add ?format=csv or ?format=xlsx for the applications as a spreadsheet, one row per application, ready to paste into Smartsheet or Excel.

`GET /v1/payer-follow-ups/{id}/report`

## Request

- Base URL: `https://www.licium.ai`
- URL: `https://www.licium.ai/v1/payer-follow-ups/{id}/report`
- Auth: none required

Send the follow-up's access token or the access token of the credentialing firm it is run for (header X-Payer-Follow-Up-Token, Authorization: Bearer, or ?token= as in emailed links), or use a session signed in with the follow-up's or the firm's email. Applications come in this order: missing documents first, then no record, then the rest by next check, decided last. source.kind: status_page (url, at = read time), call (rep_name, call_reference, at = when the call ended) or person (note = the reference or representative written down). waiting_on: payer, practice (missing says what, next_step says who sends it where) or nobody (decided). sample: a sample made for a demonstration, every name, number and status in it made up.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `token` string
- `format` 'json' | 'csv' | 'xlsx'

## Headers

- `X-Payer-Follow-Up-Token` string

## Response `200`

The report, or with format csv or xlsx the applications as a spreadsheet file.

- object
  - `success` unknown
  - `data` PayerFollowUpReport: One practice's weekly status report.
    - `account_id` string, uuid
    - `practice` string
    - `week_of` string, date
    - `generated_at` string
    - `prepared_by` object
      - `name` string
      - `firm` boolean: Run by a credentialing firm.
      - `firm_id` string, uuid, nullable
      - `reply_to_email` string, nullable
      - `callback_number` string, nullable
    - `sample` boolean
    - `summary` object
      - `open` integer
      - `decided` integer
      - `approved` integer
      - `denied` integer
      - `needs_documents` integer
      - `changed_this_week` integer
    - `applications` PayerFollowUpReportApplication[]
      - `id` string, uuid
      - `clinician` string, nullable
      - `npi` string
      - `payer` string
      - `state` string
      - `submitted_on` string, date, nullable
      - `to_submit` boolean: An application we write and submit, not submitted yet.
      - `status` 'not_checked' | 'received' | 'in_review' | 'needs_documents' | 'approved' | 'denied' | 'no_record'
      - `status_label` string
      - `payer_words` string, nullable: The status in the payer's own words: its page's words, the representative's, or what was written down.
      - `status_date` string, nullable: The date the payer's page gives with that status, as shown.
      - `expected_decision` string, nullable: When a representative said a decision is expected, as said.
      - `note` string, nullable: What the person who recorded it wrote down, when payer_words came from the payer's page.
      - `effective_date` string, date, nullable
      - `reference` string, nullable: The application's number with the payer, or null.
      - `source` object, nullable
        - `kind` 'status_page' | 'call' | 'person'
        - `label` string
        - `url` string, nullable
        - `at` string
        - `rep_name` string, nullable
        - `call_reference` string, nullable
        - `note` string, nullable
        - `method` 'portal' | 'phone' | 'email'
      - `missing` string, nullable
      - `waiting_on` 'payer' | 'practice' | 'nobody'
      - `next_step` string
      - `last_checked_at` string, nullable
      - `next_check_on` string, date, nullable
      - `changed_this_week` boolean
      - `history` object[]
        - `checked_at` string
        - `status` string
        - `status_label` string
        - `payer_words` string, nullable
        - `source_kind` 'status_page' | 'call' | 'person'
        - `source_label` string
        - `rep_name` string, nullable
        - `call_reference` string, nullable
      - `status_check_page` string, nullable: The page POST /v1/payer-follow-ups/status-check reads for this payer in this state, or null.
    - `authorized_by` 'token' | 'session' | 'ops' | 'firm' | 'firm_session'

## Other responses

- `400`: format must be json, csv or xlsx.
- `401`: Send the follow-up's access token or its firm's, or sign in with the follow-up's email.
- `404`: Follow-up not found, or the token does not open it.
- `429`: Too many requests. Try again in one hour.
- `503`: Could not read the report. Try again in a minute.

---

[API](https://skmtc.dev/licium/apis/licium-public-api.md) · [All operations](https://skmtc.dev/licium/apis/licium-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/licium/apis/licium-public-api/revisions/d91a72f755f4?raw)