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

Working with Intake Reports

Create, update, search, and fetch intake reports 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, an Intake Report is the starting point that captures an inquiry, service referral, or incident—bringing together key details about the situation, the people involved, and any early assessments or screening decisions before it may advance into a Case.

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

Intake - POST Report can be used to create a new Intake Report in your Casebook system.

POST <BASE_URL>/intake/reports
  • Application Roles:
    • Intake - Create (All)
    • People - Create (All)
  •  Headers:
    • Authorization: Bearer <YOUR_BEARER_TOKEN>
    • Content-Type: application/vnd.api+json
  • Operation: POST
  • Casebook service: /intake
  • Endpoint: /reports
  • Body: 
    • All required attributes must be populated in order to successfully create a Case
      • See Admin → Intake → Dynamic pages for a list of fields which have been set to required within your Casebook system
    • Only the attributes included in your request will be created - you do not need to include attributes without values
  • Query parameters: N/A

Query all Reports

Intake - GET Reports can be used to retrieve a list of Intake Reports in your Casebook system.

GET <BASE_URL>/intake/reports
  • Application Roles:
    • Intake - 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: /intake
  • Endpoint: /reports
  • Body: N/A
  • Query parameters:
    • Use filter parameters to limit the results retrieved based on any field(s) in the Report record
    • Use page parameters to return results in separate pages for faster performance (10 records per page by default)

Fetch the details of a specific Report

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

GET <BASE_URL>/intake/reports/:id
  • Application Roles:
    • Intake - 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: /intake
  • Endpoint: /report/:id
    • ID for the Report you would like to fetch must be provided in the endpoint's address - If Report ID is unknown, you should first query all Reports to fetch its value
  • Body: N/A
  • Query parameters:
    • Use fields parameters to include only specific fields in the response

Update a Case

Intake - PATCH Report by ID can be used to update a Report in your Casebook system

PATCH <BASE_URL>/intake/reports/:id
  • Application Roles:
    • Intake - 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: /intake
  • Endpoint: /reports/:id
    • ID for the Report you would like to update must be provided in the endpoint's address - If Report ID is unknown, you should first query all Reports to fetch its value
  • Body: 
    • Only the attributes included in your request will be updated - you do not need to include attributes which have not changed
  • Query parameters:
    • Use fields parameters to include only specific fields in the response

Delete a Report

Intake - DELETE Report by ID can be used to soft-delete a Report in your Casebook system

DELETE <BASE_URL>/intake/reports/:id

All Delete actions in Casebook are "soft-deletes", flagging and excluding those records from view in Casebook

Contact Casebook Support if you need to "hard-delete" or purge records
  • Application Roles:
    • Intake - 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: /intake
  • Endpoint: /reports/:id
    • ID for the Report you would like to delete must be provided in the endpoint's address - If Report ID is unknown, you should first query all Reports to fetch its value
  • Body: N/A
  • Query Parameters: N/A