Fetch a List of Claims

get

https://api.claims.curacel.co/api/v1/claims

Get list of Claims for Insurer or hospital

Query Params

status

string

enum

The status of the claim.

Note: 'partially_approved' points to claims that have been approved but whose approved amount is less than the total amount.

Allowed:

with_fields

string

When present, value should be comma seperated names of field the user would like returned with the response.

is_submitted

boolean

This parameter is applicable to Providers/Hospitals only. It filters the claims based on if they have been submitted or drafted claims. Returns all claims when absent.

is_vetted

boolean

This parameter is used to filter the claims based on if they have been vetted or not.

is_synced

boolean

This parameter is used to filter the claims based on if they have been synced with external db or not.

insurer_id

integer

Applicable if fetching list as a provider/hospital

The ID of the Insurer that owns the created claims.

provider_id

integer

Applicable if fetching list as an Insurer

The ID of the hospital that created the claims

enrollee_id

integer

The ID of the enrollee the claims were created for.

created_at

Filter returned claims by the creation date.

This implements a range filtering on the claims when set to an object with keys of 'start' and 'end' bearing date values.
Setting it to a single date string also filters the claims with a direct comparison to the value given.

submitted_at

Filter returned claims by the submission date.

This implements a range filtering on the claims when set to an object with keys of 'start' and 'end' bearing date values.
Setting it to a single date string also filters the claims with a direct comparison to the value given.

vetted_at

Filter returned claims by the vetting date.

This implements a range filtering on the claims when set to an object with keys of 'start' and 'end' bearing date values.
Setting it to a single date string also filters the claims with a direct comparison to the value given.

encounter_date

Filter returned claims by the encounter date.

This implements a range filtering on the claims when set to an object with keys of 'start' and 'end' bearing date values.
Setting it to a single date string also filters the claims with a direct comparison to the value given.

synced_at

Filter returned claims by the synced date if available.

This implements a range filtering on the claims when set to an object with keys of 'start' and 'end' bearing date values.
Setting it to a single date string also filters the claims with a direct comparison to the value given.

page

integer

The presence of this param would return results in paginated format
Better used together with the 'per_page' param

This is used to indicate the offset from which results are fetched in paginated format.

per_page

integer

Better used together with the 'page' param

This is used to indicate the how many results are to be in an offset for pagination.

for_export

boolean

enum

Used to fetch an exported list of Claims requests in Excel format. Can be used in conjunction with other filters to achieve results.

Allowed:

search

string

This is used to search for claims by the key word supplied to it.

The search is applied to the enrollee firstname, lastname, and insurance number as well as diagnoses icd codes and names.

Responses

401

Unauthenticated

404

Not Found

422

Unprocessable Entity

Language

Credentials

Bearer

API KEY from your account dashboard

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json