> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SmartAdvocate

> How to set up the SmartAdvocate connector, plus the actions that are available.

![SmartAdvocate](https://stackone-logos.com/api/smartadvocate/filled/svg)

Betav1.1.0[See changelog](https://docs.stackone.com/connectors/smartadvocate/changelog.md)

[60 actions](#actions) · 1 auth method

Legal

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Username & Password · Connector Profile](https://docs.stackone.com/connectors/smartadvocate/guides/connector-profile/username-password.md)
>
> Authenticate with your SmartAdvocate username and password. No app registration required. A JWT bearer token is obtained...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Username & Password · Link Account](https://docs.stackone.com/connectors/smartadvocate/guides/link-account/username-password.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

60 actions

ActionDescription

Get Case By Number`smartadvocate_get_case_info`

Look up a case using its case number string (e.g., 9000002). Use this when you have the case number, not the internal nu...

Get Case By ID`smartadvocate_get_case`

Get case by internal case ID

Filter Cases`smartadvocate_filtered_cases`

Search all cases (open and closed) by modification date range with pagination

Create Case`smartadvocate_create_case`

Create a new case

Get Active Cases`smartadvocate_active_cases`

List only currently active (open) cases with pagination

Get Case Contacts`smartadvocate_get_case_contacts`

Get all contacts associated with a case

Add Case Contact`smartadvocate_insert_case_contact`

Add a contact to a case

Update Case Contact`smartadvocate_update_case_contact`

Partially update a contact on a case using JSON Patch operations array \[\{op, path, value}]. Use get\_case\_contacts first...

Remove Case Contact`smartadvocate_delete_case_contact`

Remove a contact from a case

Get Case Types`smartadvocate_case_type`

Get case types available within a specific case group. Requires the CaseGroup ID as input

Get Case Calendar`smartadvocate_get_calendar_by_case_id`

Get all calendar appointments for a case by case ID

Filter Calendar Appointments`smartadvocate_filtered_case_calendar`

Search and filter calendar appointments by date range with pagination

Create Appointment`smartadvocate_add_appointment`

Create a new calendar appointment for a case

Get Appointment Types`smartadvocate_appointment_types`

Get available appointment types

Get Contact`smartadvocate_contact_info`

Get basic contact info by contact ID

Get Full Contact Info`smartadvocate_full_contact_info`

Get full contact info including addresses, phones, and emails

Filter Contacts`smartadvocate_filtered_contacts`

Search and filter contacts by date range with pagination

Create Contact`smartadvocate_insert_contact`

Create a new contact. Set contactCtg to 1 for individual or 2 for organization. Use contact\_types to find valid contactT...

Update Contact`smartadvocate_update_contact`

Partially update a contact using JSON Patch operations array \[\{op, path, value}]. Use contact\_info first to get the cont...

Get Contact Types`smartadvocate_contact_types`

Get available contact types

Get Case Notes`smartadvocate_case_notes_by_case_id`

Get all notes for a case by case ID

Get Case Note`smartadvocate_case_note`

Get a single case note by ID

Create Case Note`smartadvocate_insert_note`

Create a new case note. Requires caseID, noteTypeID (a system-defined note type identifier), and noteText (supports HTML...

Update Case Note`smartadvocate_update_note`

Update a case note (full replacement)

Get Case Documents`smartadvocate_get_documents_by_case_id`

Get all documents belonging to a specific case by its case ID

Get Document`smartadvocate_get_document`

Get document metadata by ID

Filter Documents`smartadvocate_filtered_documents`

Search documents across all cases by modification date range with pagination

Get Document Categories`smartadvocate_get_document_categories`

Get available document categories

Get Document Tags`smartadvocate_get_document_tags`

Get available document tags

Create Document`smartadvocate_insert_document`

Create a document metadata record

Update Document`smartadvocate_update_document`

Fully update a document metadata record

Download Document`smartadvocate_document_content`

Download document content as base64

Upload Document Content`smartadvocate_upload_document_content`

Upload file content to an existing document record

Get Case Tasks`smartadvocate_get_tasks_by_case_id`

Get all tasks for a case by case ID

Get Task`smartadvocate_get_case_task`

Get a single task by ID

Filter Tasks`smartadvocate_filtered_tasks`

Search and filter tasks by date range with pagination

Create Task`smartadvocate_insert_task`

Create a new task

Update Task`smartadvocate_update_task`

Fully update a task

Delete Task`smartadvocate_delete_task`

Delete a task by ID

Get Task Types`smartadvocate_get_task_types`

Get available task types

Get Task Statuses`smartadvocate_get_task_statuses`

Get available task statuses

Get Task Priorities`smartadvocate_get_task_priorities`

Get available task priorities

List Users`smartadvocate_get_users`

Get all users with basic profile info (ID, name, username, email, status)

Get User`smartadvocate_get_user`

Get a single user by ID

List Users (Full Details)`smartadvocate_get_full_users_info`

Get all users with full details

Create User`smartadvocate_insert_user`

Create a new user

Update User`smartadvocate_update_user`

Fully update a user

Delete User`smartadvocate_delete_user`

Delete a user by ID

Get Case Roles`smartadvocate_get_case_roles`

Get available case roles

Get Firm Roles`smartadvocate_get_firm_roles`

Get available firm roles

Get Titles`smartadvocate_get_titles`

Get available user titles

Get Offices`smartadvocate_get_offices`

Get available offices

Get Departments`smartadvocate_get_departments`

Get available departments

Get Permission Groups`smartadvocate_get_permission_groups`

Get available permission groups

Get Teams`smartadvocate_get_teams`

Get available teams

Get Case Status History`smartadvocate_case_status_by_case_id`

Get case status history by case ID

Get Status Entry`smartadvocate_get_case_status`

Get a specific case status entry

Create Case Status`smartadvocate_insert_case_status`

Insert a new case status entry. Requires caseID and statusTypeID (a system-defined status type identifier)

Terminate Case Status`smartadvocate_terminate_case_status`

Terminate/close a case status entry

Get Case Calls`smartadvocate_case_calls_by_case_id`

Get all calls for a case


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.