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

Work with the People API

Create, update, search, fetch, and delete people programmatically with the Casebook People API

Introduction

In Casebook, People records represent individuals and their full history with your organization.

People records detail an individual's demographics and involvement across intake reports, cases, providers, and services.

Operations in the People API reflect the entities, attributes, and relationships that can be created in Casebook:

  • People
  • Education
  • Employment

This guide focuses on the most common use cases to help you quickly integrate core intake 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 Person

People - POST Person can be used to create a new Person in Casebook

POST <BASE_URL>/people/people
  • Application Roles:
    • People - Create (All)
  • Headers:
    • Authorization: Bearer <YOUR_BEARER_TOKEN>
    • Content-Type: application/vnd.api+json
  • Body: Person attributes and relationships
  • Query parameters: N/A

Query all People

People - GET People can be used to retrieve a list of People in Casebook

GET <BASE_URL>/people/people
  • Application Roles:
    • 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 Person

People - GET Person by ID can be used to retrieve the full details of a specific Person in Casebook

GET <BASE_URL>/people/people/:id
  • Application Roles:
    • 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 Person

People - PATCH Person by ID can be used to update a Person in Casebook

PATCH <BASE_URL>/people/people/:id
  • Application Roles:
    • People - Edit (All or Limited access)
  •  Headers:
    • Authorization: Bearer <YOUR_BEARER_TOKEN>
    • Content-Type: application/vnd.api+json
  • Body: Person attributes and relationships
  • Query parameters: N/A

Delete a Person

People - DELETE Person by ID can be used to soft-delete a Person in Casebook

DELETE <BASE_URL>/people/people/:id
  • Application Roles:
    • 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 → People → 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 Person ID is unknown, you can first Query all People 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 People API to plan your integration or learn how to access custom fields in People:

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