AVAILITY
Search prior auths
Search one page of authorizations and referrals.
POSThttps://preview.ontross.com/api/integrations/availity/search-prior-auths
Request Fields
input.statuses
array
Provider dashboard status labels. All 16 choices appear in the enum and list-prior-auth-search-options; multiple choices are allowed. Canonical keys and aliases are also accepted.
Example
["Approved","Pending Review"]Accepted values
DeniedErrorIncompleteCancelledApprovedPartially ApprovedPending ActionPending ReviewReceivedAppeal ApprovedAppeal Partially ApprovedAppeal In ProgressAppeal DeniedNo Action RequiredAwaiting ResponsePending Action - Contact Payerinput.transaction_types
array
Provider dashboard transaction type labels. Multiple choices are allowed; case-insensitive keys are also accepted.
Example
["Outpatient","Referral"]Accepted values
OutpatientInpatientReferralinput.organization_customer_id
string
Optional Organization filter. Get customer_id from list-prior-auth-search-options.organizations; preserve leading zeroes.
Example
"1234567"input.payer_id
string
Optional Payer filter. Get payer_id from list-prior-auth-search-options.payers; preserve leading zeroes.
Example
"00987"input.date_range
string
One preset range; defaults to LAST_90_DAYS when no custom dates are given. All presets appear in the enum and filter options.
Example
"LAST_90_DAYS"Accepted values
TODAYLAST_2_DAYSLAST_3_DAYSLAST_7_DAYSLAST_10_DAYSLAST_14_DAYSLAST_30_DAYSLAST_45_DAYSLAST_60_DAYSLAST_90_DAYSinput.start_date
string
Custom From date in YYYY-MM-DD; use with end_date instead of date_range.
Example
"2026-09-01"input.end_date
string
Custom To date in YYYY-MM-DD; use with start_date instead of date_range.
Example
"2026-09-30"input.search
string
Dashboard Search text.
Example
"REF-2026-847291"input.view
string
Dashboard tab; all four values appear in the enum.
Example
"all"Default
"all"Accepted values
allfolloweddraftstrashinput.sort_by
string
Dashboard sort value; defaults to newest status change first. All 14 values appear in the enum and filter options.
Example
"latestStatusChangeDtDsc"Default
"latestStatusChangeDtDsc"Accepted values
latestStatusChangeDtAsclatestStatusChangeDtDscadmissionDtAscadmissionDtDscdischargeDtAscdischargeDtDscnameAscnameDscfacilityAscfacilityDscpatientClassAscpatientClassDscauthorizationStatusAscauthorizationStatusDscinput.limit
integer
One dashboard page only; accepted sizes are 10, 25, and 50.
Example
25Default
25Accepted values
102550input.offset
integer
Zero-based offset of the page to fetch.
Example
0Default
0auth_id
string
requiredSaved 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"Output Fields
items
array
Dashboard entries containing retrieval identifiers and complete original records.
items[].dashboard_id
string
Use as dashboard_id in fetch-prior-auth.
Example
"c7924a16-8e35-4db9-a762-09f531bc684d"items[].customer_id
string
Use as customer_id in fetch-prior-auth; derived from facility.senderId as the dashboard does.
Example
"7842961"items[].dashboard_status
string
Use as dashboard_status in fetch-prior-auth when needed.
Example
"APPROVED"items[].payer_id
string
Availity payer ID.
Example
"00987"items[].data
object
Complete dashboard item returned by Availity.
offset
integer
Returned zero-based starting position, falling back to the requested value.
Example
0limit
integer
Returned page size, falling back to the requested value.
Example
25returned_count
integer
Number of dashboard entries included in this response.
Example
25total_count
integer
Total matching entries reported by the dashboard response.
Example
63has_more
boolean
Whether entries exist and another page remains available.
Example
truenext_offset
integer
Current starting position plus page size when more results remain.
Example
25Code
curl --request POST \
--url https://preview.ontross.com/api/integrations/availity/search-prior-auths \
--header 'X-API-Key: REPLACE_KEY_VALUE' \
--header 'content-type: application/json' \
--data '{"input":{"statuses":["Approved","Pending Review"],"transaction_types":["Outpatient","Referral"],"organization_customer_id":"1234567","payer_id":"00987","date_range":"LAST_90_DAYS","start_date":"2026-09-01","end_date":"2026-09-30","search":"REF-2026-847291","view":"all","sort_by":"latestStatusChangeDtDsc","limit":25,"offset":0},"auth_id":"auth_uuid_here"}'Request BODY
{
"input": {
"statuses": [
"Approved",
"Pending Review"
],
"transaction_types": [
"Outpatient",
"Referral"
],
"organization_customer_id": "1234567",
"payer_id": "00987",
"date_range": "LAST_90_DAYS",
"start_date": "2026-09-01",
"end_date": "2026-09-30",
"search": "REF-2026-847291",
"view": "all",
"sort_by": "latestStatusChangeDtDsc",
"limit": 25,
"offset": 0
},
"auth_id": "auth_uuid_here"
}Response BODY
{
"id": "string",
"workflow_id": "string",
"auth_id": "string",
"status": "string",
"input": {},
"output": {
"items": [
{
"dashboard_id": "c7924a16-8e35-4db9-a762-09f531bc684d",
"customer_id": "7842961",
"dashboard_status": "APPROVED",
"payer_id": "00987",
"data": {}
}
],
"offset": 0,
"limit": 25,
"returned_count": 25,
"total_count": 63,
"has_more": true,
"next_offset": 25
},
"files": null,
"created_at": "2019-08-24T14:15:22Z",
"started_at": "2019-08-24T14:15:22Z",
"completed_at": "2019-08-24T14:15:22Z"
}