Get Case Details By Id Endpoint

This GET request expects the following parameters (one of caseId or email is required):

  • caseId - should be passed as query parameter, can be obtained from Patient Get Case Id Endpoint
  • email - should be passed as query parameter, value should be URL-encoded
  • includeAttachments - optional, should be passed as query parameter, if value is 'true' then case attachment contents will be included encoded as base64
  • documentFormat - optional, should be passed as query parameter. "includeAttachments" is required if this query parameter is mentioned. 2 values are acceptable. "base64" and "url". If no value is passed, by default base64 will be returned as "content" key. If "url" is passed, "url" key with document signed url will be returned. Signed url will be valid for 15 mins.
  • secret key should be passed as a CV-Api-Key header
The following is a production API call example. 
curl "https://api.care360-next.carevalidate.com/api/v1/customer-case-detail?caseId=e1e3f5c1-6f12-4e0d-a442-7a9ff31319da"
-H "Content-Type:application/json"
-H "CV-Api-Key:<redacted - obtain from CareValidate>"

Example response: 

{
    "status": 200,
    "success": true,
    "caseDetail": {
        <redacted - same format as in webhook events>
    }
}

Case object format available here - Case Updates Webhook


Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article