v1
Scan
Changed onScans the last 30 days of events. All results are sorted by created date, descending.
get/api/events/v1/
Request
- Base URLhttps://pre-api.joincandidhealth.com
- URLhttps://pre-api.joincandidhealth.com/api/events/v1/
- AuthHTTP bearer
Query parameters
page_tokenstring
limitinteger
Number of events to return. Minimum value is 1, maximum is 100. Defaults to 10.
event_typesstring
Event types to filter on. Defaults to showing all event types.
| Event Type | Description |
|---|---|
| CandidApi.Encounter.Created | When a new claim is created |
| CandidApi.Encounter.StatusUpdated | When a claim's status has been updated |
| PreEncounter.Patient.Created | When a new patient has been created |
| PreEncounter.Patient.Updated | When a patient's information has been updated |
| PreEncounter.Coverage.Created | When a new coverage has been created for a patient |
| PreEncounter.Coverage.Updated | When a patient's coverage has been updated |
| PreEncounter.Tag.Created | When a new tag has been created for a patient |
| PreEncounter.Tag.Updated | When a patient's tag has been updated |
| CandidApi.OrganizationProvider.Created | When a new organization provider has been created |
| CandidApi.OrganizationProvider.Updated | When an organization provider has been updated |
created_beforestring date-time
Filters for only events created before this time (inclusive).
created_afterstring date-time
Filters for only events created after this time (inclusive).
Response
Response with status 200
Changes
- breaking
the response's body type changed from no type to
objectfor status - warning
deleted the
headerrequest parameterAuthorization - info
the endpoint scheme security
OAuthSchemewas added to the API - info
added the optional property
to the response with the status - info
added the required property
to the response with the status
- breaking
- info
api operation id
scanremoved and replaced withv1_scan_6
- info