Skip to navigation
API ReferenceEventsV1

Scan

Scans the last 30 days of events. All results are sorted by created date, descending.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

page_tokenstringOptional
limitintegerOptional
Number of events to return. Minimum value is 1, maximum is 100. Defaults to 10.
event_typesstringOptional

Event types to filter on. Defaults to showing all event types.

Event TypeDescription
CandidApi.Encounter.CreatedWhen a new claim is created
CandidApi.Encounter.StatusUpdatedWhen a claim’s status has been updated
PreEncounter.Patient.CreatedWhen a new patient has been created
PreEncounter.Patient.UpdatedWhen a patient’s information has been updated
PreEncounter.Coverage.CreatedWhen a new coverage has been created for a patient
PreEncounter.Coverage.UpdatedWhen a patient’s coverage has been updated
PreEncounter.Tag.CreatedWhen a new tag has been created for a patient
PreEncounter.Tag.UpdatedWhen a patient’s tag has been updated
CandidApi.OrganizationProvider.CreatedWhen a new organization provider has been created
CandidApi.OrganizationProvider.UpdatedWhen an organization provider has been updated
created_beforedatetimeOptional

Filters for only events created before this time (inclusive).

created_afterdatetimeOptional

Filters for only events created after this time (inclusive).

Response

This endpoint returns an object.
itemslist of objects
next_page_tokenstringOptional

Errors

400
Bad Request Error
500
Internal Error