Add Smokeball to your AI agent

Submit an irreversible financial Deposit transaction against the specified bank account and matter, with a dollar amount limited to 2 decimal places and an effective date. Deposit is the only documented transaction type. A 202 response means only that creation was accepted, not that the transaction completed; follow the returned link to confirm the resulting transaction.

Creates a contact. A 202 result means accepted; read back the resource to confirm completion.

Creates a relation for a specified contact. A 202 result means accepted; read back the resource to confirm completion.

Creates a calendar event. Send startTime and endTime as local wall-clock time without an offset (YYYY-MM-DDThh:mm:ss) together with the IANA timeZone; an offset or Z is not applied. A 202 result means accepted; read back the event to confirm completion.

Creates a new reminder for an event. A 202 result means accepted; read back the resource to confirm completion.

Get or request a PDF preview of the current file version. The 202 response means accepted, not necessarily completed: if the preview already exists, downloadUrl is immediately populated with a sensitive presigned URL valid for 1 day; otherwise downloadUrl and expiry are null while asynchronous conversion runs. Do not expose or log a populated URL. Poll GET_FILE_VERSION_PREVIEW with documentVersionId until it returns 200. A new file version has a separate preview.

Creates a firm for the current authenticated client and registers an existing user as a staff member and firm owner. A 202 result means accepted; read back the resource to confirm completion.

Creates a new matter or Lead. Lead creation requires isLead=true, a Lead-specific matterTypeId, and a Grow or Prosper account. clientRole and otherSideRole are optional, cannot be identical, and otherwise default from the selected matter type. A 202 result means accepted; confirm completion with GET_MATTER on the returned id.

Creates an expense for the specified matter. A 202 result means accepted; read back the resource to confirm completion.

Creates a fee for the specified matter. A 202 result means accepted; read back the resource to confirm completion.

Creates a new folder under the specified matter. When `parentFolderId` is null or omitted the folder is created under the matter root. A 202 result means accepted; read back the resource to confirm completion.

Creates a memo on the specified matter. A 202 result means accepted; read back the resource to confirm completion.

Send a notification to the specified staff member, including its displayed message and optional toast message, icons, color, and Smokeball action URI. This is an externally visible, irreversible send. A 202 response means only that the request was accepted, not that delivery completed; use the returned link to read the resource and confirm completion.

Creates a staff member in the firm associated with the authenticated client. A 202 result means accepted; read back the resource to confirm completion.

Creates a subtask for a specified task. A 202 result means accepted; read back the resource to confirm completion.

Creates a task. A 202 result means accepted; read back the resource to confirm completion.

Links an existing document to the specified task; it does not create a new document. A 202 result means accepted; read back the task's documents to confirm completion.

Create a persistent user login using Default or Auth0. Invitation emails the user a way to set their password; Permanent and Temporary require the caller to deliver the password, and Temporary forces a change at first sign-in. bypassMfa lets the user sign in without two-factor authentication, while mfaEnrollmentGraceDays allows an Auth0 user to sign in without MFA enrollment for 1-90 days. Creating a login for an invited person registers them without accepting their invitation. This externally visible account and any MFA bypass are treated as irreversible effects.

Create a persistent webhook subscription that sends every selected event type to the external eventNotificationUrl until the subscription is changed or deleted. The key is used to create the signature header on webhook notification requests and must be shared with the callback receiver. This enables ongoing external data egress and is treated as irreversible; verify the destination URL, event types, and signing key before use.

Deletes an activity code. A 202 result means accepted; read back the resource to confirm completion.

Delete an authorization group. A 202 result means accepted; read back the resource to confirm completion.

Deletes a specified contact. A 202 result means accepted; read back the resource to confirm completion.

Deletes a relation for a specified contact. A 202 result means accepted; read back the resource to confirm completion.

Deletes a specified event. A 202 result means accepted; read back the resource to confirm completion.

Deletes a specified event reminder. A 202 result means accepted; read back the resource to confirm completion.

Deletes a specified matter. A 202 result means accepted; GET_MATTER answers 404 once the matter no longer exists.

Deletes an expense. A 202 result means accepted; read back the resource to confirm completion.

Deletes a fee. A 202 result means accepted; read back the resource to confirm completion.

Deletes a specified matter file. A 202 result means accepted; read back the resource to confirm completion.

Deletes a folder belonging to the specified matter. An unknown folder id returns 400 rather than 404, because the folder may have been created but not yet processed. The change is processed asynchronously; the returned Link continues to resolve the folder with `isDeleted: true` once applied. A 202 result means accepted; read back the resource to confirm completion.

Deletes a specified memo. A 202 result means accepted; read back the resource to confirm completion.

Sets the staff member from the firm associated with the authenticated client as a former staff member. The staff member is set as a former staff member and if they are a user, becomes a former user. User access is also disabled. A 202 result means accepted; read back the resource to confirm completion.

Deletes a specified subtask of a specified task. A 202 result means accepted; read back the resource to confirm completion.

Deletes a specified task. A 202 result means accepted; read back the resource to confirm completion.

Unlinks the specified document from the task without deleting the underlying document. A 202 result means accepted; read back the task's documents to confirm completion.

Deletes and unsubscribes from the specified webhook subscription.

Retrieves one activity code by id: code, description, type, whether it is billable, rate type and rate, quantity and tax flags. Use LIST_ACTIVITY_CODES to find the id.

Retrieves one authorization group by id: its name, the ids of the principals it contains, and whether it is deleted. Use LIST_AUTHORIZATION_GROUPS to find the id.

Retrieves one authorization policy by its reference: the principal and resource it binds and its rules. The reference is the one returned when the policy was created (CREATE_AUTHORIZATION_POLICY); Smokeball documents no list endpoint for policies.

Retrieves one bank account by id: type, status, linked matter, account name and number, bank and branch details. Use LIST_BANK_ACCOUNTS to find the id; balances are not part of this record.

Retrieves one transaction by bank account id and transaction id, including its type, amount, dates, references, associated matter and payor links, and reversal status.

Retrieves one contact by id. Exactly one of person, company, trust or groupOfPeople is populated according to the contact kind, plus tags, isDeleted and lastUpdated. Use LIST_CONTACTS to find the id.

Retrieves a relation for a specified contact if associated with the authenticated client.

Return contacts matching up to 500 supplied IDs in request order; nonexistent and other-account IDs are silently omitted. Contact records are detailed, so requesting hundreds at once can produce a very large response and consume substantial model context or tokens; use smaller batches when full 500-contact retrieval is unnecessary.

Retrieves one calendar event by id: subject, description, location, type, start and end times in the event timeZone, allDay flag, attendees and the linked matter. Use LIST_EVENTS to find the id.

Return a sensitive presigned GET URL and metadata for downloading the current or specified version of a matter file. The URL authorizes access to the file until it expires after 1 hour; do not expose or log it. This call does not fetch file bytes.

Return a sensitive presigned URL to the PDF preview of the file's current version. The URL authorizes preview access for 1 day; do not expose or log it. This endpoint never creates a preview. Use CREATE_FILE_PREVIEW to request conversion; while conversion is pending, this endpoint returns 404 rather than a URL.

Return a sensitive presigned URL to the PDF preview of a specific document version. The URL authorizes preview access for 1 day; do not expose or log it. If CREATE_FILE_PREVIEW requested an asynchronous conversion that is still pending, this endpoint returns 404; poll it until it returns 200.

Retrieves the details of the firm associated with the authenticated client.

Retrieves one layout design by id: its name, description and the list of fields a layout matter item of this design carries. Use LIST_LAYOUT_DESIGNS to find the id.

Retrieves one matter by id with its documented fields, including any item, role, layout, and tag details Smokeball returns for it. Use LIST_MATTERS to find the id. Smokeball does not document whether those nested details need the items/read, roles/read, or layouts/read scopes in addition to matters/read.

Retrieves the archive record of a matter: whether it is archived, the archived date and location, box number, comments and destroy date. Answers 404 when the matter has no archive record.

Retrieves the billing configuration for the specified matter.

Retrieves one expense on a matter by matter id and expense id: staff, amounts, tax, origin and the invoice it belongs to, if any. Use LIST_MATTER_EXPENSES to find the id.

Retrieves one fee on a matter by matter id and fee id: staff, duration or quantity, rate, amounts, tax and the invoice it belongs to, if any. Use LIST_MATTER_FEES to find the id.

Retrieves metadata for a file belonging to the specified matter, including its download-details link. It does not return file bytes.

Returns the full folder hierarchy (path) as a collection ordered from the root folder down to the supplied folder. The root folder is not included in the response.

Retrieves one invoice on a matter by matter id and invoice id: number, title, status, dates and totals. Use LIST_MATTER_INVOICES to find the id; GET_MATTER_INVOICE_DOWNLOAD_URL returns the PDF link.

Return a sensitive download URL, its expiry timestamp, version, and status for the specified invoice. The URL authorizes access to invoice contents until the returned expiry; Smokeball does not document a fixed lifetime. Do not expose or log it. This call returns download details and does not fetch the invoice bytes.

Retrieves one item on a matter by matter id and item id: name, index, visibility and its subItems tree. Use LIST_MATTER_ITEMS to find the id.

Retrieves one layout item on a matter by item id, including its name, description, hierarchy and order, layout design link, values, and events.

Retrieves one memo on a matter by matter id and memo id: title, rich text and plain text, author and dates, and whether it is deleted. Use LIST_MATTER_MEMOS to find the id.

Retrieves one role on a matter by matter id and role id: role name, the contact filling it, representatives, relationships and whether it is the client or other side. Use LIST_MATTER_ROLES to find the id.

Retrieves one relationship on a matter role by relationship id, including its name, associated contact link, and representative links.

Retrieves a matter's current stage information, including its stage set, current stage, version id, and last-updated timestamp.

Retrieves one matter type by id: name, category, type, location, representative options and the items it defines. Use LIST_MATTER_TYPES to find the id; CREATE_MATTER needs a matterTypeId from here.

Retrieves one notification by id: message, icon, creator and date, and whether it has been read or seen. Smokeball documents no list endpoint for notifications; the id comes from the notification link or a webhook event.

Retrieves one protected-funds record by bank account id and protection id, including its amount, reason, dates, current protection state, and associated matter or contact.

Retrieves one referral type by id: its name and whether it is deleted. Use LIST_REFERRAL_TYPES to find the id.

Retrieves a staff member (based on staff id parameter provided) in the firm associated with the authenticated client.

Returns the stage set identified by `stage_set_id`, including its configured matter stages.

Retrieves one stage of a stage set by stage-set id and stage id: name, lastUpdated and whether it is deleted. Use GET_STAGE_SET (or LIST_STAGE_SETS) to find the stage ids of a set.

Retrieves the subtask identified by `subtask_id` within the specified `task_id`.

Retrieves one task by id: subject, note, due date, assignees, sub-tasks, the linked matter and who created, completed or last updated it. Use LIST_TASKS to find the id.

Retrieves one document attached to a task by task id and document id, including its document type, deletion state, associated task, and document link.

Retrieves the Smokeball user identified by `user_id`.

Returns the webhook subscription identified by `webhook_subscription_id`, including its callback and subscribed events.

Returns a list of activity codes. Returns one page; pass next_cursor back as cursor to read the next one.

Return the authorization groups for the firm associated with the authenticated client. The provider returns paged metadata and links, but documents no continuation request parameters for this endpoint; if the response indicates more results, this action cannot request another page and the list may be incomplete.

Returns a list of bank account matter balances. Returns one page; pass next_cursor back as cursor to read the next one.

Returns bank accounts available to the authenticated firm, optionally filtered by account type or matter identifier.

Return relations for a contact associated with the authenticated client. The provider returns a paged collection and navigation links, but documents no continuation request parameters for this endpoint; if the response indicates more results, this action cannot request another page and the list may be incomplete.

Lists the tags currently on one contact, by contact id, as a plain string collection under value. Use ADD_CONTACT_TAGS or REMOVE_CONTACT_TAG to change them.

Returns a list of contacts. Returns one page; pass next_cursor back as cursor to read the next one.

Returns the collection of reminders for an event The native root response is returned under data as an explicit Composio normalization.

Returns a list of events. Returns one page; pass next_cursor back as cursor to read the next one.

Returns the full list of history entries for the specified file. The result is not paged.

Returns a list of stage to matter mappings in the firm. Returns one page; pass next_cursor back as cursor to read the next one.

Returns a list of history entries for the specified folder. The response is not paged. An unknown folder id returns 200 with an empty collection rather than 404.

Returns a list of layout designs. Returns one page; pass next_cursor back as cursor to read the next one.

Returns a list of expenses for the specified matter. Returns one page; pass next_cursor back as cursor to read the next one.

Returns a list of fees for the specified matter. Returns one page; pass next_cursor back as cursor to read the next one.

Returns a paged list of non-deleted files associated with a matter. In standard mode (no search or cursor), sort and paging apply; results default to oldest-created first. In search mode, results come from the document search index and sort, paging, and cursor all apply. In cursor-only mode (cursor without search), files modified since the cursor are returned and sort options are ignored. Returns one page; pass next_page_cursor back as page_cursor to read the next one (the provider's own cursor parameter is separate). Limit defaults to the maximum page size.

Returns non-deleted folders and files directly under a matter's root document folder, or directly under folder_id when supplied, with folders before files. Paging spans the combined list; pass next_cursor back as cursor for the next page. A deleted requested folder still returns 200 with isDeleted=true and an empty listing, so an empty result alone does not distinguish a deleted folder from an active empty folder; inspect isDeleted.

Returns a list of invoices for the specified matter. Returns one page; pass next_cursor back as cursor to read the next one.

Returns the versioned item collection for a matter. Each item includes its name, zero-based index, visibility, and nested sub-items.

Returns a list of contacts on a specified layout. The native root response is returned under data as an explicit Composio normalization.

Returns a collection of layout items on a specified matter.

Returns a list of memos on the specified matter. Returns one page; pass next_cursor back as cursor to read the next one.

Returns associated relationships for a specified matter and role group.

Returns associated roles for a specified matter.

Returns the tags assigned to the matter identified by `matter_id`.

Returns a list of all the possible matter type categories.

Returns a paginated list of matter types based on search criteria. Deleted matter types are not included. Note: If no `Location` is provided, all matter types from all locations will be returned. Returns one page; pass next_cursor back as cursor to read the next one.

Returns one page of matters; pass next_cursor back as cursor to read the next one. Supports documented filtering and sorting; the scope-sensitive Fields enrichment parameter is intentionally unavailable.

Returns referral types, including custom referral types.

Retrieves a paginated list of staff members in the firm associated with the authenticated client. Returns one page; pass next_cursor back as cursor to read the next one.

Returns a list of stage sets for the firm. Returns one page; pass next_cursor back as cursor to read the next one.

Returns a list of subtasks for a specified task if associated with the authenticated client.

Returns a list of document links for the specified task, if associated with the authenticated client.

Returns a list of tasks. Returns one page; pass next_cursor back as cursor to read the next one.

Lists the event type names a webhook subscription can subscribe to, as a plain string collection under value. Use one or more of them in CREATE_WEBHOOK_SUBSCRIPTION.

Returns existing webhook subscriptions. Returns one page; pass next_cursor back as cursor to read the next one.

Merges layout data using a restricted documented subset. Layout key/value pairs are supported, but the provider's untyped LayoutValue.state field is intentionally unavailable. A 202 result means accepted; read back the layout to confirm completion.

Patches a matter or Lead, including lead-to-matter conversion and matter-type changes. The recursive items property is intentionally unavailable. Documented field-combination restrictions still apply. A 202 result means accepted; confirm completion with GET_MATTER.

Updates the specified matter archive. The documented ArchiveDto requires isArchived in every request. A 202 result means accepted; read back the resource to confirm completion.

Changes only the supplied billing configuration fields for the specified matter. A 202 result means accepted; read back the resource to confirm completion.

Changes only the supplied expense fields for the specified matter. A 202 result means accepted; read back the resource to confirm completion. The documented queue accepts IDs without an existing-resource check; acceptance does not prove eventual completion.

Patches a fee for the specified matter. The documented FeeDto requires feeDate and subject in every request. A 202 result means accepted; read back the resource to confirm completion. The documented queue accepts IDs without an existing-resource check; acceptance does not prove eventual completion.

Partially updates a file's metadata on the specified matter; only supplied fields change, but the documented schema still requires fileName. The response always includes a presigned PUT URL valid for 1 hour for an optional new version; this toolkit cannot upload bytes to it. Treat that URL as a sensitive temporary bearer capability and do not expose it in messages or logs. Only the documented object body is supported, not a JSON Patch array. A 202 result means accepted; read back the file to confirm completion.

Partially updates a folder belonging to the specified matter. Only the fields supplied in the request are applied. A deleted folder can be restored by setting `isDeleted` to `false`. Only the folder itself is restored; subfolders and files that were deleted remain deleted. Other fields supplied in the same request are applied after the restore. A 202 result means accepted; read back the resource to confirm completion.

Protects funds in a trust bank account. Only trust accounts are supported. A 202 result means accepted; read back the resource to confirm completion.

Removes one tag from a contact. The documented bulk form is unavailable because its route simultaneously marks tagId as required and optional. A 202 result means accepted; read back the contact to confirm completion.

Removes a layout matter item from a matter. A 202 result means accepted; read back the resource to confirm completion. Parent deletion can affect sub-items, and deleted layouts cannot be recovered via the API.

Removes a contact from a specified layout, deleting the associated role or relationship from the matter. A 202 result means accepted; read back the resource to confirm completion.

Removes a specified role from a matter. A 202 result means accepted; read back the resource to confirm completion.

Removes a relationship from a role in a matter. A 202 result means accepted; read back the resource to confirm completion.

Removes the tag from the matter without deleting from the account. A 202 result means accepted; read back the resource to confirm completion.

Search files across the account using a required full-text query and documented filters; return the documented result array. Return one page; use offset and limit to continue. The native root response is returned under data as an explicit Composio normalization.

Unprotects funds in a trust bank account. Only trust accounts are supported. A 202 result means accepted; read back the resource to confirm completion.

Updates an activity code. A 202 result means accepted; read back the resource to confirm completion.

Updates a specified authorization group. A 202 result means accepted; read back the resource to confirm completion.

Updates a specified authorization policy. A 202 result means accepted; read back the resource to confirm completion.

Updates a specified contact. Restore a deleted contact by setting isDeleted=false. A 202 result means accepted; read back the resource to confirm completion.

Updates a relation for a specified contact. A 202 result means accepted; read back the resource to confirm completion.

Updates an event. Send startTime and endTime as local wall-clock time without an offset (YYYY-MM-DDThh:mm:ss) together with the IANA timeZone; an offset or Z is not applied. A 202 result means accepted; read back the event to confirm completion.

Updates an existing reminder for an event. A 202 result means accepted; read back the resource to confirm completion.

Updates firm details for the current authenticated client. A 202 result means accepted; read back the resource to confirm completion.

Updates a specified matter. clientIds and otherSideIds cannot be modified, and a Matter cannot be converted back to a Lead. A 202 result means accepted; confirm completion with GET_MATTER.

Replaces the specified matter archive by applying the full editable archive representation. A 202 result means accepted; read back the resource to confirm completion.

Replaces the specified matter's billing configuration by applying its full editable representation. A 202 result means accepted; read back the resource to confirm completion.

Replaces the expense by applying its full editable representation for the specified matter. A 202 result means accepted; read back the resource to confirm completion. The documented queue accepts IDs without an existing-resource check; acceptance does not prove eventual completion.

Replaces the fee by applying its full editable representation for the specified matter. A 202 result means accepted; read back the resource to confirm completion. The documented queue accepts IDs without an existing-resource check; acceptance does not prove eventual completion.

Replace all editable file fields using PUT; use PATCH_MATTER_FILE for a partial edit. Omitting folderId or setting it to null moves the file to the root folder. Every call records a new upload request and returns a sensitive presigned PUT URL valid for 1 hour, which authorizes uploading an optional new version. Do not expose or log this URL. This toolkit does not upload bytes: PUT them to uploadUrl with an empty Content-Type header outside this toolkit. The 202 response means accepted, not that an upload or update completed.

Replaces the editable fields of a folder belonging to the specified matter. All fields are applied, not only the ones that changed: `name` is required, and omitting `parentFolderId` (or setting it to null) moves the folder to the matter root. Use PATCH to change individual fields. The destination folder must be on the same matter (400 otherwise); a destination that does not exist is not rejected. A 202 result means accepted; read back the resource to confirm completion. Null or omitted parentFolderId moves the folder to the matter root.

Updates a specified memo. A 202 result means accepted; read back the resource to confirm completion.

Updates a specified role on a matter. A 202 result means accepted; read back the resource to confirm completion.

Updates a specified relationship on a matter. A 202 result means accepted; read back the resource to confirm completion.

Updates a staff member in the firm associated with the authenticated client. Setting former=true also deregisters the staff member from the firm. A 202 result means accepted; read back the resource to confirm completion.

Updates a specified subtask of a specified task. A 202 result means accepted; read back the resource to confirm completion.

Updates a specified task. A 202 result means accepted; read back the resource to confirm completion.

Update a persistent webhook subscription's name, event types, external eventNotificationUrl, and signing key. Future selected events are sent to that callback URL until the subscription is changed or deleted; the key creates the signature header on notification requests. This changes ongoing external data egress and is treated as irreversible; verify the destination URL, event types, and key before use.