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

Work with the Providers API

Create, update, search, fetch, and delete providers programmatically with the Casebook Providers API

Introduction

In Casebook, Provider records represent the organizations and individuals that deliver human services.

Provider records define each organization's operational footprint, including their locations, assigned staff members, and specific service offerings.

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

  • Providers and parent organizations
  • Locations
  • Staff

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

Providers - POST Provider can be used to create a new Provider in Casebook

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

Query all Providers

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

GET <BASE_URL>/providers/providers
  • Application Roles:
    • Providers - 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 Provider

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

GET <BASE_URL>/providers/providers/:id
  • Application Roles:
    • Providers - 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 Provider

Providers - PATCH Provider by ID can be used to update a Provider in Casebook

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

Delete a Provider

Providers - DELETE Provider by ID can be used to soft-delete a Provider in Casebook

DELETE <BASE_URL>/providers/providers/:id
  • Application Roles:
    • Providers - 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

An ID must be provided to fetch, update, or delete a specific record - If ID is unknown, you can first Query all Providers 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 Providers API to plan your integration, or learn more about similar APIs:

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