API & Services Connection™
API Reference
Request Sandbox AccessMarketplaceCommunityQuick Reference

Find all eligibility transactions

get
https://sandbox-apigw.optum.com/rcm/eligibility/v1/transactions

Returns matching eligibility transactions. You can use the query parameters listed below to filter the results. If no query parameters are provided, all eligibility transactions will be returned in paginated form. When Optum has assigned a subtenant configuration, include x-optum-subtenant-id to scope results to that subtenant.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
status
array

(Optional) The status of the eligibility transaction. Valid values match Transaction.status.value.

status
Allowed:
string

(Optional) The correlationId associated with the original request.

string

(Optional) Patient's first name.

string

(Optional) Patient's last name.

string

(Optional) Patient's account number.

string

(Optional) Medical Record Number.

string

(Optional) Member Id.

string

(Optional) Patient's date of birth.

string

(Optional) NPI of the primary care provider.

string

(Optional) Payer ID (CHC ID).

string

(Optional) The start date for the report. Start date must be before the end date

string

(Optional) The end date for the report. Must occur after the provided start date

sort
array

(Optional) The property to order the results of the report by. Defaults to '-processedDate', negative sign is 'desc'

sort
Allowed:
integer

(Optional) Pagination. The offset number to retrieve, which is determined by the limit. For example,if limit is 30 and offset is 0, then the response data will include records 1~30; If offset is 30 and limit is 30 then the response data will include records 30~59.

integer | null
1 to 100

(Optional) Number of transactions to return per page. Must be greater than 0 and less than or equal to 100. Defaults to 30.

boolean | null

(Optional) Whether or not to return the total number of records matching the supplied query parameters under the x-total-number HTTP response header. Defaults to false

Headers
string

(Optional) A unique identifier value that is attached to the response that allow reference to the original request. Differs from x-optum-trace-id as the correlation-id is stored within the datastore for future queryability.

string

(Optional) Identifies an Optum-assigned sub-tenant configuration for your organization. Include this header only when Optum has provided a value for a specific enabled customer configuration. Clients must not generate or infer this value.

Responses

Updated 17 days ago

Did this page help you?
Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 17 days ago

Did this page help you?