--- title: Format requests to the Casebook API description: Get started with the Casebook API --- [Skip to content](https://gohub.casebook.net/knowledge/format-requests-to-the-casebook-api#main-content) [More support](https://gohub.casebook.net/knowledge/kb-tickets/new) [![logo-raspberry (1)](https://gohub.casebook.net/hs-fs/hubfs/logo-raspberry%20(1).png?width=1286&height=255&name=logo-raspberry%20(1).png)](https://gohub.casebook.net/) - [Knowledge Base](https://gohub.casebook.net/knowledge) - [Video Library](https://gohub.casebook.net/video-library) - [Still Need Help?](https://gohub.casebook.net/knowledge/kb-tickets/new) Open main navigation Close main navigation - [Knowledge Base](https://gohub.casebook.net/knowledge) - [Video Library](https://gohub.casebook.net/video-library) - [Still Need Help?](https://gohub.casebook.net/knowledge/kb-tickets/new) - [More support](https://gohub.casebook.net/knowledge/kb-tickets/new) Hi. How can we help? - There are no suggestions because the search field is empty. 1. [Knowledge Base](https://gohub.casebook.net/knowledge) 2. [Integrations](https://gohub.casebook.net/knowledge/integrations) 3. [Custom incoming integrations with Casebook API](https://gohub.casebook.net/knowledge/integrations#custom-incoming-integrations-with-casebook-api) # Format requests to the Casebook API ## Tips for using the Casebook API ### Introduction Requests to the Casebook API support standard [JSON:API](https://jsonapi.org/format/) modifiers for formatting, filtering, sorting, and pagination. This guide provides instructions and code samples for formatting your requests to the Casebook API. ### 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](https://gohub.casebook.net/knowledge/register-an-incoming-application) and [obtain a Bearer token](https://gohub.casebook.net/knowledge/obtain-a-bearer-token)** before starting this guide. ### Instructions #### Set Authorization and Content-Type headers All requests to the Casebook API must include the following headers: - Authorization: `Bearer ` - Content-Type: `application/vnd.api+json` If you do not yet have a token, start with [Obtain a Bearer token](https://gohub.casebook.net/knowledge/obtain-a-bearer-token) instructions. #### Route your request with an operation and an endpoint Start your request with the correct base URL: - For accounts in Canada, all requests will start with `https://api.casebookca.net` - For accounts in the US, all requests will start with `https://api.casebook.net` Next, select the operation that you would like to complete (GET, POST, PATCH, or DELETE) and the endpoint that you would like to reach. Here are a few common endpoints: - [Providers - Query all Providers](https://www.postman.com/casebook/workspace/casebook/request/21327246-41f46006-5ef8-4019-8675-6939e6b0527d?action=share&creator=21327246&active-environment=21327246-f6edc838-e553-4996-82da-f1a51307377b): `GET /providers/providers` - [Intake - Create a Report](https://www.postman.com/casebook/workspace/casebook/request/21327246-ffe6a557-0103-43c4-aed5-81bbb1169a4e?action=share&creator=21327246&active-environment=21327246-f6edc838-e553-4996-82da-f1a51307377b): `POST /intake/reports` - [People - Update a Person by ID](https://www.postman.com/casebook/workspace/casebook/request/21327246-36c44d74-eae9-49e3-b8d0-62856275948b?action=share&creator=21327246&active-environment=21327246-f6edc838-e553-4996-82da-f1a51307377b): `PATCH /people/people/:id` - [Attachments - Delete a Note by ID](https://www.postman.com/casebook/workspace/casebook/request/21327246-39504e35-ebe1-41a9-be8c-66cd1d99c678?action=share&creator=21327246&active-environment=21327246-f6edc838-e553-4996-82da-f1a51307377b): `DELETE /attachments/notes/:id` #### Include query parameters to modify results Requests often require sorting, filters, and pagination to narrow down the records you want to retrieve. Query parameters let you specify these filters directly in the endpoint URL. Use `?` before the first modifier, and `&` before any additional modifiers to chain multiple conditions. Here are a few common modifiers: ##### Filter Filter results based on values in one or more fields - Exact match: filter results with a  case-sensitive exact match on a field - Equals: `filter[]=` - Not equals: `filter[][neq]=` - Comparing dates and numbers: filter results within a range of values - - Greater than: `filter[][g]=` - Greater than or equal to: `filter[][ge]=` - Less than: `filter[][l]=` - Less than or equal to: `filter[][le]=` - Empty values: include or exclude results with null values  - Include only empty values: `filter[]=null`; - Exclude empty values: `filter[][neq]=null` ##### Sort Determine the sort order for your results based on values in one or more fields - Sort in ascending order: `sort=` - Sort in descending order: `sort=-` ##### Page Page through sets of results to (Default: 10 results per page)  - Return a specific page of results: `page=` - Specify the page size for results: `page[size]=` ### Tips **Chain multiple query parameters** - Use `?` before the first parameter and `&` before each additional parameter (e.g. `?filter=[FILTER_CONDITION]&sort=[SORT_CONDITION]`) ### Examples #### Get all active Services offered by a specific Provider ``` GET /services/service_offerings?filter[provider_id]=&filter[archived]=false ``` - Headers: - Authorization: `Bearer ` - Content-Type: `application/vnd.api+json` - Query Parameters: - filter\[provider\_id\]: `` - filter\[archived\]: `false` #### Get all Notes created between two dates ``` GET /attachments/notes?filter[created_at][ge]=2025-01-01T00:00:00Z&filter[created_at][le]=2025-06-30T23:59:59Z ``` - Headers: - Authorization: `Bearer ` - Content-Type: `application/vnd.api+json` - Query Parameters: - filter\[provider\_id\]: `` - filter\[archived\]: `false` #### People - Get all People with a specific last name ``` GET /people/people?filter[last_name][like]=Doe ``` - Headers: - Authorization: `Bearer ` - Content-Type: `application/vnd.api+json` - Query Parameters: - filter\[last\_name\]\[like\]: `Doe` ### Next steps Next, use the framework in this guide to test Casebook APIs with Postman: - Test Casebook APIs with Postman --- For more help with the Casebook API, [get in touch with the Casebook Support team](https://gohub.casebook.net/knowledge/get-help-in-casebook). - [Getting Started With Casebook](https://gohub.casebook.net/knowledge/getting-started-with-casebook#main-content) - [Casebook Overview](https://gohub.casebook.net/knowledge/getting-started-with-casebook#casebook-overview) - [Getting Started for New Users](https://gohub.casebook.net/knowledge/getting-started-with-casebook#getting-started-for-new-users) - [Services in Casebook](https://gohub.casebook.net/knowledge/getting-started-with-casebook#services-in-casebook) - [Notes](https://gohub.casebook.net/knowledge/getting-started-with-casebook#notes) - [Admin](https://gohub.casebook.net/knowledge/admin#main-content) - [Casebook Security](https://gohub.casebook.net/knowledge/admin#casebook-security) - [Roles and Permissions](https://gohub.casebook.net/knowledge/admin#roles-and-permissions) - [User Management](https://gohub.casebook.net/knowledge/admin#user-management) - [Notifications](https://gohub.casebook.net/knowledge/admin#notifications) - [Data](https://gohub.casebook.net/knowledge/admin#data) - [Field Configuration](https://gohub.casebook.net/knowledge/admin#field-configuration) - [Dynamic Fields](https://gohub.casebook.net/knowledge/admin#dynamic-fields) - [Forms](https://gohub.casebook.net/knowledge/admin#forms) - [Implementation & Adoption](https://gohub.casebook.net/knowledge/admin#implementation-adoption) - [People](https://gohub.casebook.net/knowledge/people) - [Intake](https://gohub.casebook.net/knowledge/intake) - [Engage](https://gohub.casebook.net/knowledge/engage#main-content) - [Text Messages](https://gohub.casebook.net/knowledge/engage#text-messages) - [Configuration](https://gohub.casebook.net/knowledge/engage#configuration) - [Notes](https://gohub.casebook.net/knowledge/engage#notes) - [Track](https://gohub.casebook.net/knowledge/track) - [Access](https://gohub.casebook.net/knowledge/access) - [Workflow & Tasks](https://gohub.casebook.net/knowledge/workflow-tasks) - [Reporting](https://gohub.casebook.net/knowledge/reporting#main-content) - [Overview](https://gohub.casebook.net/knowledge/reporting#overview) - [Datasets](https://gohub.casebook.net/knowledge/reporting#datasets) - [Dashboards](https://gohub.casebook.net/knowledge/reporting#dashboards) - [Pre-built Reports](https://gohub.casebook.net/knowledge/reporting#pre-built-reports) - [Custom Reports](https://gohub.casebook.net/knowledge/reporting#custom-reports) - [Data Visualizations](https://gohub.casebook.net/knowledge/reporting#data-visualizations) - [Filters](https://gohub.casebook.net/knowledge/reporting#filters) - [Calculated Fields](https://gohub.casebook.net/knowledge/reporting#calculated-fields) - [Other](https://gohub.casebook.net/knowledge/reporting#other) - [Audit Logs](https://gohub.casebook.net/knowledge/audit-logs) - [Integrations](https://gohub.casebook.net/knowledge/integrations#main-content) - [Low-code incoming integrations with Zapier](https://gohub.casebook.net/knowledge/integrations#low-code-incoming-integrations-with-zapier) - [Custom incoming integrations with Casebook API](https://gohub.casebook.net/knowledge/integrations#custom-incoming-integrations-with-casebook-api) - [Custom outgoing integrations with Webhooks](https://gohub.casebook.net/knowledge/integrations#custom-outgoing-integrations-with-webhooks) - [Program Area Specific](https://gohub.casebook.net/knowledge/program-area-specific#main-content) - [VOCA Reporting](https://gohub.casebook.net/knowledge/program-area-specific#voca-reporting) - [Customer Support](https://gohub.casebook.net/knowledge/customer-support#main-content) - [Getting Unstuck](https://gohub.casebook.net/knowledge/customer-support#getting-unstuck) - [Account Management](https://gohub.casebook.net/knowledge/customer-support#account-management) - [Product Release Notes](https://gohub.casebook.net/knowledge/product-release-notes#main-content) - [2026](https://gohub.casebook.net/knowledge/product-release-notes#2026) - [2025](https://gohub.casebook.net/knowledge/product-release-notes#2025) - [2024](https://gohub.casebook.net/knowledge/product-release-notes#2024) - [2023](https://gohub.casebook.net/knowledge/product-release-notes#2023) - [2022](https://gohub.casebook.net/knowledge/product-release-notes#2022) - [2021](https://gohub.casebook.net/knowledge/product-release-notes#2021) - [2020](https://gohub.casebook.net/knowledge/product-release-notes#2020) - [Frequently Asked Questions](https://gohub.casebook.net/knowledge/frequently-asked-questions#main-content) - [Global](https://gohub.casebook.net/knowledge/frequently-asked-questions#global) - [Casebook Calendar](https://gohub.casebook.net/knowledge/frequently-asked-questions#casebook-calendar) - [Casebook Services](https://gohub.casebook.net/knowledge/frequently-asked-questions#casebook-services) - [Casebook Forms](https://gohub.casebook.net/knowledge/frequently-asked-questions#casebook-forms) - [Casebook Notes](https://gohub.casebook.net/knowledge/frequently-asked-questions#casebook-notes) - [cb Admin](https://gohub.casebook.net/knowledge/frequently-asked-questions#cb-admin) - [cb Track](https://gohub.casebook.net/knowledge/frequently-asked-questions#cb-track) - [cb Reporting](https://gohub.casebook.net/knowledge/frequently-asked-questions#cb-reporting) - [cb Access](https://gohub.casebook.net/knowledge/frequently-asked-questions#cb-access) - [Program Specific](https://gohub.casebook.net/knowledge/frequently-asked-questions#program-specific) [![logo-raspberry-1-1](https://gohub.casebook.net/hs-fs/hubfs/logo-raspberry-1-1.png?width=32&height=30&name=logo-raspberry-1-1.png "logo-raspberry-1-1")](https://www.casebook.net/) © 2025 Casebook. All rights reserved. Casebook Knowledge Base [Video Library](https://gohub.casebook.net/video-library) [Still Need Help?](https://gohub.casebook.net/knowledge/kb-tickets/new)