Skip to content
  • There are no suggestions because the search field is empty.

Working with Cases

Create, update, search, and fetch cases programmatically with the Casebook API

To interact with the Casebook API, your organization must be licensed for External Data Interoperability (API), included in Casebook Enterprise.

For more help with the Casebook API, get in touch with the Casebook Support team.

Introduction

In Casebook, a Case is the central record that tracks an individual, family, or organizational situation over time—bringing together people, events, services, and related documentation in one place.

This guide focuses on the most common use cases to help you quickly integrate core case management functionality into your applications.

Prerequisites

You'll need to register an incoming application and obtain a Bearer token to authorize your requests to the Casebook API

Instructions

Create a Case

Cases - POST Case can be used to create a Case in your Casebook system

POST <BASE_URL>/cases/cases
  • Application Roles:
    • Engage - Create (All)
    • People - Create (All)
  •  Headers:
    • Authorization: Bearer <YOUR_BEARER_TOKEN>
    • Content-Type: application/vnd.api+json
  • Operation: POST
  • Casebook service: /cases
  • Endpoint: /cases
  • Body: Case attributes and relationships
  • Query parameters: N/A

Query all Cases

Cases - GET Cases can be used to retrieve a list of Cases in your Casebook system

GET <BASE_URL>/cases/cases
  • Application Roles:
    • Engage - View (All, Limited access, or User's assignments only)
    • People - View (All or Limited access)
  •  Headers:
    • Authorization: Bearer <YOUR_BEARER_TOKEN>
    • Content-Type: application/vnd.api+json
  • Operation: GET
  • Casebook service: /cases
  • Endpoint: /cases
  • Body: N/A
  • Query parameters:
    • fields: Specify the exact attributes to be included in the response payload to reduce data overhead
    • filter: Limit the retrieved results based on specific criteria or field values
    • include: Request related entities to be side-loaded and included in the response for a more comprehensive data set
    • page: Navigate through result sets by returning records in separate pages for faster performance (10 records per page by default)
    • sort: Order the results in ascending or descending order based on a specified field

Fetch the details of a specific Case

Cases - GET Case by ID can be used to retrieve the full details of a specific Case in your Casebook system

GET <BASE_URL>/cases/cases/:id
  • Application Roles:
    • Engage - View (All, Limited access, or User's assignments only)
    • People - View (All or Limited access)
  •  Headers:
    • Authorization: Bearer <YOUR_BEARER_TOKEN>
    • Content-Type: application/vnd.api+json
  • Operation: GET
  • Casebook service: /cases
  • Endpoint: /cases/:id
  • Body: N/A
  • Query parameters:
    • fields: Specify the exact attributes to be included in the response payload to reduce data overhead
    • include: Request related entities to be side-loaded and included in the response for a more comprehensive data set

Update a Case

Cases - PATCH Case by ID can be used to update a Case in your Casebook system

PATCH <BASE_URL>/cases/cases/:id
  • Application Roles:
    • Engage - Edit (All, Limited access, or User's assignments only)
    • People - Edit (All or Limited access)
  •  Headers:
    • Authorization: Bearer <YOUR_BEARER_TOKEN>
    • Content-Type: application/vnd.api+json
  • Operation: PATCH
  • Casebook service: /cases
  • Endpoint: /cases/:id
  • Body: Case attributes and relationships
  • Query parameters: N/A

Delete a Case

Cases - DELETE Case by ID can be used to soft-delete a Case in your Casebook system

DELETE <BASE_URL>/cases/cases/:id

  • Application Roles:

    • Engage - Delete (All, Limited access, or User's assignments only)
    • People - Delete (All or Limited access)
  •  Headers:
    • Authorization: Bearer <YOUR_BEARER_TOKEN>
    • Content-Type: application/vnd.api+json
  • Operation: PATCH
  • Casebook service: /cases
  • Endpoint: /cases/:id
  • Body: N/A
  • Query Parameters: N/A

Tips

Case ID must be provided for some requests - If Case ID is unknown, you can first Query all Cases to fetch its value

All required fields must be provided to create or update data - see Admin → Engage → Dynamic pages for a list of fields which have been set to required in Casebook

Only the attributes included in your request will be created or updated - you do not need to include attributes which are empty or have not changed

Deleted records will be flagged and excluded from view in Casebook and Reporting - contact Casebook Support if you need to permanently purge records