Skip to main content
POST
/
v1
/
reports
Create Report
curl --request POST \
  --url https://api.example.com/v1/reports \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "report_type": "<string>",
  "format": "csv"
}
'
{
  "url": "<string>",
  "filename": "<string>",
  "expires_in": 123
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
report_type
string
required
Allowed value: "patients"
​
format
string
default:csv
Allowed value: "csv"

Response

Returns CSV for patients, calls, and eligibility_batch reports. Returns PDF for eligibility_report with format=pdf. Returns a JSON object with a signed URL for eligibility_report with format=url.

Returned when eligibility_report is requested with format=url.

​
url
string
required
​
filename
string
required
​
expires_in
integer | null