Skip to main content

Get Notifications

Request notifications for results letters associated with a client program.

Request

Endpoint

GET {clientId}/api/v1/outreach?programName=someProgram&startDate=01/01/2000&endDate=01/01/2000&continuationToken=123abc

Path parameters

ParameterDescriptionTypeRequired/Optional
clientIdThe clientId is a unique code that is provided by LetsGetChecked. The clientId is used to identify a client, when a client calls the Orders and Results APIs. The code is a number between 0 and 9999.stringRequired

Query parameters

ParameterDescriptionTypeRequired/Optional
programNameThe LetsGetChecked program name.stringRequired
startDateThe program start date.stringRequired
endDateThe program end date.stringRequired
continuationTokenThe response contains an X-Continuation-Token HTTP header which represents a pointer to the last item on the page.stringRequired

Response

The sample response is a single JSON object that contains the following fields:

PropertyDescriptionType
Barcode / numerical codeFormatted as LGC-0000-0000-0000, where 0 indicates any digit.string
programNameThe LetsGetChecked program name.string
pcpLetterSendStatusThe results letter sent to the patient's PCP after the results are released.object
(pcpLetterSendStatus)
{pcpLetterSendStatus}/StatusThe following value is possible: DeliverySentstring
{pcpLetterSendStatus}/FailureReasonFailureReason is always null.string
{pcpLetterSendStatus}/UpdatedAtThe timestamp, in UTC time, in ISO 8601 format.string
patientLetterSendStatusThe patient's results letter that is sent after the results are released.object
(patientLetterSendStatus)
{patientLetterSendStatus}/StatusThe following value is possible: DeliverySentstring
{patientLetterSendStatus}/FailureReasonFailureReason is always null.string
{patientLetterSendStatus}/UpdatedAtThe timestamp, in UTC time, in ISO 8601 format.string

Sample Response

{
"items":[
{
"barcode":"LGC-1234-1234-1234",
"programName":"programName",
"pcpLetterSendStatus":{
"Status":"DeliverySent",
"FailureReason":null,
"UpdatedAt":"2021-06-23T18:25:43.511Z"
},
"patientLetterSendStatus":{
"Status":"DeliverySent",
"FailureReason":null,
"UpdatedAt":"2021-06-23T18:25:43.511Z"
}
}
]
}