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

Work with the Cases API

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

Introduction

In Casebook, a Case is the central record that tracks an individual, family, or organizational situation over time

Cases bring together people, events, services, and related documentation in one place.

Operations in the Cases API reflect entities, attributes, and relationships in Casebook:

  • Cases
  • Involvements
  • Goals

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

Prerequisites

Your organization must be licensed for External Data Interoperability (API) to interact with the Casebook API.

You will need to register an incoming application and obtain a Bearer token before starting this guide.

Instructions

Create a Case

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

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
  • 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 Casebook

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
  • Body: N/A
  • Query Parameters:
    • fields (Optional): Specify the exact attributes to be included in the response payload to reduce data overhead
    • filter (Optional): Limit the retrieved results based on specific criteria or field values
    • include (Optional): Request related entities to be side-loaded and included in the response for a more comprehensive data set
    • page (Optional): Navigate through result sets by returning records in separate pages for faster performance (10 records per page by default)
    • sort (Optional): 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 Casebook

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
  • Body: N/A
  • Query Parameters:
    • fields (Optional): Specify the exact attributes to be included in the response payload to reduce data overhead
    • include (Optional): 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 Casebook

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
  • 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 Casebook

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
  • Body: N/A
  • Query Parameters: N/A

Tips

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

An ID must be provided to fetch, update, or delete a specific record - If Case ID is unknown, you can first Query all Cases to fetch its value

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

Deleting records hides them from view in Casebook and Reporting - contact Casebook Support if you need to permanently purge records

Next steps

Next, explore all endpoints available in the Cases API to plan your integration or learn how to access custom fields in Cases:

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