Covermymeds List cases

POSThttps://api.ontross.com/api/integrations/covermymeds/list-cases

input.approval

string

Filter using the Prior Authorization task label. Not approved includes denied, pending, and action-required cases.

Example

"not_approved"

Default

"all"

Accepted values

allapprovednot_approved

input.page

integer

One CoverMyMeds page (10 cases in the captured session). Omit to retrieve all pages.

Example

2

auth_id

string

required

Saved connection to run this operation through, from the Authentication page. It decides which practice and login the call uses.

Example

"00000000-0000-4000-8000-000000000000"

cases

array

Matching portal records, deduplicated by identifier when retrieving all pages.

cases[].case_key

string

Portal identifier extracted from the nested case object.

Example

"C-EXAMPLE82"

cases[].first_name

string

Patient's given name from the portal list item.

Example

"Avery"

cases[].middle_name

string

Patient's additional given name from the portal list item.

Example

"Morgan"

cases[].last_name

string

Patient's family name from the portal list item.

Example

"Ellison"

cases[].date_of_birth

string

Patient's birth date, copied unchanged from the portal list item.

Example

"1986-04-17"

cases[].gender

string

Patient's demographic designation from the portal list item.

Example

"Female"

cases[].zipcode

string

Patient's postal code from the portal list item.

Example

"02139"

cases[].medication

string

Workflow label from the case, not a structured drug record.

Example

"Humira"

cases[].created_at

string

Creation timestamp copied unchanged from the nested case object.

Example

"2026-09-08T14:32:10Z"

cases[].prior_authorization_request_key

string

ProcessPa task identifier, using sourceIdentifier when requestKey is unavailable.

Example

"BEXAMPLE"

cases[].prior_authorization_status

string

State label from the case's ProcessPa task.

Example

"Approved"

cases[].prior_authorization_approved

boolean

Whether a nonblank ProcessPa label equals approved, ignoring case and whitespace.

Example

true

cases[].enrollment_status

string

State label from the case's ProcessHubEnrollment task.

Example

"Pending"

cases[].source

object

Complete case list item, including all portal task data.

approval

string

Applied task-label filter, with missing labels excluded from not_approved results.

Example

"not_approved"

pages_fetched

integer

Number of portal pagination responses retrieved during this operation.

Example

3

source_total

integer

Unfiltered record count reported by the first retrieved pagination response.

Example

27

source_last_page

integer

Final pagination index reported by the first retrieved response.

Example

3

complete

boolean

True only when every page reported by the portal was fetched.

Example

true

curl --request POST \
  --url https://api.ontross.com/api/integrations/covermymeds/list-cases \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"approval":"not_approved","page":2},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "approval": "not_approved",
    "page": 2
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "cases": [
      {
        "case_key": "C-EXAMPLE82",
        "first_name": "Avery",
        "middle_name": "Morgan",
        "last_name": "Ellison",
        "date_of_birth": "1986-04-17",
        "gender": "Female",
        "zipcode": "02139",
        "medication": "Humira",
        "created_at": "2026-09-08T14:32:10Z",
        "prior_authorization_request_key": "BEXAMPLE",
        "prior_authorization_status": "Approved",
        "prior_authorization_approved": true,
        "enrollment_status": "Pending",
        "source": {}
      }
    ],
    "approval": "not_approved",
    "pages_fetched": 3,
    "source_total": 27,
    "source_last_page": 3,
    "complete": true
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}