Skip to main content
Clio Manage logo
  • Category: legal & public records
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 99
  • Triggers: 0
  • Slug: CLIO_MANAGE
  • Version: 20261101_00

Tools

Slug: CLIO_MANAGE_ASSIGN_TASK_TEMPLATE_LISTAssign one Clio task template list to a matter, creating its tasks with assignee notifications disabled. The action reads the current Matter ETag before the PATCH and does not retry a rejected write. Clio does not return guaranteed generated Task IDs or provide atomic undo; find and delete generated tasks separately if cleanup is needed. Requires Matters and Tasks access.

Input Parameters

string
Due date to apply to the generated tasks in YYYY-MM-DD format.
integer
required
Matter to receive the tasks.
integer
User ID to assign the generated tasks to; omit to use template defaults.
integer
required
Task template list whose tasks Clio should create on the matter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_CREATE_ACTIVITYCreate a Clio time or expense activity with Activities write permission. Billable expenses requiring UTBMS codes cannot be created with this tool.

Input Parameters

string
required
Date performed in YYYY-MM-DD format.
string
Description of the work or expense.
number
Hourly or flat rate for time, or amount for an expense; omit to let Clio’s rate hierarchy apply.
integer
Task associated with the activity.
integer
User who performed or owns the activity.
integer
Matter associated with the activity.
boolean
Show an eligible non-billable activity on the bill at no charge.
boolean
Prevent an eligible time activity from appearing as a bill line item.
string ("TimeEntry" | "ExpenseEntry" | "HardCostEntry" | "SoftCostEntry")
required
Time or expense activity type.
number
Duration in seconds for current API TimeEntry records; also the provider quantity for applicable expense entries.
integer
Activity description ID used for rate and category defaults.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_CREATE_CALENDARCreate a Clio custom calendar. Requires the Calendars write permission selected on the Clio developer application.

Input Parameters

string
required
Non-empty custom calendar name.
string ("#367B9C" | "#FFA5A4" | "#83D17F" | "#FFAC7B" | "#8E3F64" | "#C75300" | "#009CEC" | "#62D6B1" | "#9EEDCB" | "#F9A2C4" | "#616161" | "#BBDA81" | "#DFD3F8" | "#D6C4A5" | "#FFD478" | "#6AC9DE" | "#EABBB0" | "#BFC2E1" | "#DADADA" | "#CDE2F5")
Calendar color shown in the Clio Web UI.
string ("web" | "mobile")
Client surface to which the visibility setting applies.
boolean
Whether the calendar is visible by default for the selected source.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_CREATE_CALENDAR_ENTRYCreate a Clio calendar entry. Only internal Clio calendars can be attendees because Clio always emails contact attendees. Calendar notifications are disabled. Requires Clio’s Calendars write permission.

Input Parameters

string
required
End timestamp in ISO-8601 format, not before start_at and on or after 1900-01-01T00:00:00Z.
boolean
Whether this is an all-day event.
string
required
Non-empty short event summary.
string
Event location.
string
required
Start timestamp in ISO-8601 format, on or after 1900-01-01T00:00:00Z.
array
Writable Clio calendars to add as attendees. Contact attendees are unsupported because Clio always emails them.
integer
Matter associated with the event.
string
Detailed event description.
string
Recurrence rule accepted by Clio; omit for a non-recurring event.
integer
required
Writable calendar owner ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_CREATE_COMMUNICATIONRecord a phone or email communication in Clio. This creates a communication log; it does not place a call or send an email. Notification subscribers are intentionally unsupported. Requires Communications write permission in the Clio developer application.

Input Parameters

string
required
Main content of the communication record.
string ("PhoneCommunication" | "EmailCommunication")
required
Whether to record a phone communication or an email communication.
object
Matter associated with the communication.
array
Clio users or contacts who sent the communication.
string
required
Subject of the communication record.
array
Clio users or contacts who received the communication.
string
required
Date and time the communication occurred, in ISO-8601 format.
array
External-system properties to attach; Clio permits at most five.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_CREATE_CONTACTCreate a Clio person or company, including new email addresses and phone numbers. A Company requires name; a Person requires first_name or last_name. Requires Clio’s Contacts write permission.

Input Parameters

string
Required non-empty name when contact_type is Company.
string
Job title for a Person contact.
string
Person last name; a Person requires first_name or last_name.
integer
Existing company contact associated with a person.
string
Person first name; a Person requires first_name or last_name.
string ("Person" | "Company")
required
Whether to create a Person or Company.
array
New phone numbers to add to the contact.
array
New email addresses to add to the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_CREATE_DOCUMENTCreate only the Clio document record and signed-upload initiation. This action does not upload bytes, follow signed destinations, finalize an upload, or create a version of an existing document. Upload without Clio OAuth, then use a separate finalization operation. Requires Documents write permission.

Input Parameters

string
required
Document name.
object
required
Folder, contact, or matter parent.
string
Original filename; Clio otherwise uses name.
string
Time the document was received.
string
MIME type; Clio can infer it from filename.
array
Optional parts to initialize; Clio accepts at most 50 per request.
integer
Optional related communication ID.
integer
Optional document-category ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_CREATE_DOCUMENT_TEMPLATEUpload one non-sensitive file directly to Clio’s documented multipart route and create a document template suitable for START_DOCUMENT_FROM_TEMPLATE or GENERATE_DOCUMENT_FROM_TEMPLATE. Requires Documents write permission.

Input Parameters

object
required
Non-sensitive template file uploaded directly to Clio.
string
Optional stored filename override; otherwise Clio uses the uploaded name.
integer
Optional document-category ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_CREATE_MATTERCreate a Clio matter for a client. Requires Clio’s Matters write permission.

Input Parameters

string ("open" | "closed" | "pending")
Initial matter lifecycle status.
boolean
Whether work on this matter is billable.
integer
required
Client contact ID for the new matter.
string
Matter open date in YYYY-MM-DD format.
string
Matter close date in YYYY-MM-DD format.
string
required
Non-empty description for the new matter.
string
Client-provided reference for the matter.
integer
Practice area ID; pass null to create the matter without an association.
integer
User ID of responsible staff.
integer
User ID of the responsible attorney.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_CREATE_MATTER_FOLDERCreate a subfolder inside a Clio Matter. Clio creates each Matter’s root folder automatically; this action creates a child folder and always uses the supplied Matter as its parent. Requires Documents write permission.

Input Parameters

string
required
Name of the new Matter subfolder.
integer
required
Matter in which to create the subfolder.
array
External-system properties to attach; Clio permits at most five.
integer
Document category to associate with the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_CREATE_MATTER_NOTECreate a note associated with a Clio Matter. The action fixes the note type to Matter and intentionally does not support notification subscribers. Requires Notes and Matter access in the Clio developer application.

Input Parameters

string
Date of the note in YYYY-MM-DD format.
string
Note body. For rich_text, Clio supports a, b, br, div, em, i, li, ol, p, s, strong, u, and ul tags, with href, rel, type, and target attributes.
string
Note subject.
integer
required
Matter to which the note belongs.
string ("plain_text" | "rich_text")
Whether detail is plain text or Clio-supported rich text.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_CREATE_TASKCreate a non-complete Clio task with assignee notifications disabled. To complete it safely, create it as pending and then call UPDATE_TASK with status complete. Requires Clio’s Tasks write permission.

Input Parameters

string
required
Non-empty name for the new task.
string
Task due date or date-time in ISO-8601 format.
string ("pending" | "in_progress" | "in_review" | "draft")
Initial non-complete status. Accounts without Advanced Tasks may use only Pending or Complete; because CREATE_TASK rejects Complete, create as pending and call UPDATE_TASK with status complete.
string ("High" | "Normal" | "Low")
Task priority using Clio’s write values.
integer
Matter associated with the task.
string ("private" | "public")
Who can see the task; defaults to public.
integer
required
User or contact ID assigned to the new task.
string
required
Task details; an empty string is accepted. Clio supports rich text when description_text_type is rich_text, with a, b, br, div, em, i, li, ol, p, s, strong, u, and ul tags and href, rel, type, and target attributes.
string ("User" | "Contact")
required
Model type for assignee_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_CREATE_TASK_TEMPLATE_LISTCreate a Clio task-template list with one to ten private, non-cascading, plain-text task templates without reminders, and read it back to confirm the template count. The tool attempts to clean up partial creation on failure and requires Tasks write permission.

Input Parameters

string
required
Task-template-list name.
array
required
One to ten non-notifying task templates to create in the new list.
string
required
Task-template-list description.
integer
Optional associated practice-area ID.
boolean
Safety invariant: reminders and notification-producing controls remain off.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_DELETE_ACTIVITYPermanently delete one Clio activity by ID, including a time entry, expense entry, or fixed fee. Requires Clio’s Activities write permission.

Input Parameters

integer
required
Unique ID of the time or expense activity to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_DELETE_BILLDelete a Draft or Pending Approval bill after confirming its ID, number, ETag and state, with an ownership attestation and deletion confirmation. Clio requires the bill to have no recorded payments and transitions it based on its state; Billing write permission is required.

Input Parameters

integer
required
Unique ID of the owned Draft or Pending Approval bill to delete.
boolean
required
Must be true to confirm permanent deletion.
string
required
ETag observed when deletion was approved.
boolean
required
Must be true to attest this is an owned disposable bill.
string
required
Bill number observed when deletion was approved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_DELETE_CALENDARPermanently delete one manually created Clio calendar after verifying it is an owner-controlled AdhocCalendar. Built-in firm and user calendars are refused. This tool does not check whether the calendar contains entries, and Clio does not document whether deletion preserves, migrates, or deletes them. Requires Calendars write permission.

Input Parameters

integer
required
Unique ID of the manually created calendar to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_DELETE_CALENDAR_ENTRYPermanently delete a non-recurring Clio calendar entry or an explicitly scoped recurring occurrence, future sequence, or series. Fails closed when Contact attendees exist because Clio would email them. Clio DELETE has no atomic ETag guard, so a concurrent attendee change after preflight remains a notification risk for non-recurring or series deletion. Requires Calendars write permission.

Input Parameters

integer
Parent recurring-series ID; required for series scope, where calendar_entry_id must be this same parent ID.
string ("occurrence" | "future" | "series")
Required for recurring deletion: occurrence deletes one occurrence; future deletes it and following occurrences; series deletes the parent series.
string
required
Calendar entry or expanded occurrence ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_DELETE_COMMUNICATIONPermanently delete one recorded Clio communication after an exact-ID preflight and explicit confirmation. Requires Communications write permission; deletion may trigger subscribed webhooks.

Input Parameters

boolean
required
Must be true to confirm permanent deletion.
integer
required
Unique Clio communication ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_DELETE_CONTACTPermanently delete one Clio contact by ID. Requires Clio’s Contacts write permission.

Input Parameters

integer
required
Unique ID of the contact to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_DELETE_DOCUMENTMove a Clio document to trash after an exact ID-and-name preflight and explicit confirmation. Clio permanently deletes trashed documents after 30 days. Requires Documents write permission.

Input Parameters

boolean
required
Must be true to confirm moving the document to trash.
integer
required
Unique Clio document ID.
string
required
Current name used as an identity guard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_DELETE_DOCUMENT_TEMPLATEPermanently delete a Clio document template after an exact ID-and-filename preflight and explicit confirmation. Requires Documents write permission.

Input Parameters

boolean
required
Must be true to confirm permanent template deletion.
string
required
Current filename used as an identity guard.
integer
required
Unique Clio document-template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_DELETE_FOLDERMove a non-root, unlocked Clio folder to trash after an exact ID-and-name preflight and explicit confirmation. Trashed folders are permanently deleted after 30 days. Requires Documents write permission.

Input Parameters

boolean
required
Must be true to confirm moving the folder to trash.
integer
required
Unique Clio folder ID to trash.
string
required
Current folder name used as an identity guard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_DELETE_MATTERPermanently delete one Clio matter by ID. Requires Clio’s Matters write permission.

Input Parameters

integer
required
Unique ID of the matter to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_DELETE_NOTEPermanently delete one Clio note after an exact-ID preflight and explicit confirmation. This does not notify subscribers. Requires Notes write permission.

Input Parameters

boolean
required
Must be true to confirm permanent deletion.
integer
required
Unique Clio note ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_DELETE_TASKPermanently delete one Clio task by ID. Requires Clio’s Tasks write permission.

Input Parameters

integer
required
Unique ID of the task to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_DELETE_TASK_TEMPLATE_LISTPermanently delete a Clio task-template list after an exact ID-and-name preflight and explicit confirmation. This does not assign tasks or send notifications. Requires Tasks write permission.

Input Parameters

boolean
required
Must be true to confirm permanent list deletion.
string
required
Current list name used as an identity guard.
integer
required
Unique Clio task-template-list ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_DOWNLOAD_DOCUMENTDownload the latest or a specified Clio document version as a managed file, up to 100 MB. Requires Documents read permission; files stored in Clio document integrations are inaccessible through the API.

Input Parameters

integer
required
Unique Clio document ID.
integer
Specific version ID; omit for the latest version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_FIND_BILLFind Clio bills by client, matter, bill number, and state, combining supplied criteria with AND; provide client_id, matter_id, or invoice_number, with state narrowing the lookup. Multiple exact matches are ambiguous, and IDs with incomplete comparisons are reported separately; requires Billing read permission on the Clio developer application.

Input Parameters

string ("draft" | "awaiting_approval" | "awaiting_payment" | "paid" | "void" | "deleted")
Optional state filter; cannot be the only lookup criterion.
integer
Exact client contact ID; provide this, matter_id, or invoice_number.
integer
Exact matter ID; provide this, client_id, or invoice_number.
string
Exact bill number; provide this, client_id, or matter_id. Whitespace is ignored.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_FIND_COMPANY_CONTACTFind Clio company contacts by exact name and optional email, returning matches without choosing among duplicates. Requires Contacts read permission; results identify candidates whose comparison data was missing or redacted.

Input Parameters

string
Exact email address that the company must also have.
string
required
Exact company name to find.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_FIND_CONTACT_BY_CUSTOM_FIELDSearch Clio contacts by a validated active Contact custom field and typed value, reporting matches, duplicate ambiguity, and candidates with incomplete comparisons. The search fails beyond 1,000 pages and requires Custom Fields read and Contacts read permissions.

Input Parameters

string
required
Exact typed custom-field value or reference ID.
string ("Company" | "Person")
Optionally require a company or person contact.
integer
required
Unique active Contact custom-field ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_FIND_MATTERFind a matter by matter_id alone, or search by display_number, description, or client_reference, optionally narrowed by client_id and status. Collection matches are exact-filtered, multiple matches are reported as ambiguous, and records missing comparison fields are reported separately; requires Matters read permission.

Input Parameters

string ("open" | "closed" | "pending")
Optional lifecycle-status filter; cannot be the only lookup criterion.
integer
Optional client filter; cannot be the only lookup criterion.
integer
Exact matter ID; when supplied, omit every other selector.
string
Exact description; a primary selector when matter_id is omitted.
string
Exact displayed number; a primary selector when matter_id is omitted.
string
Exact client reference; a primary selector when matter_id is omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_FIND_MATTER_BY_CUSTOM_FIELDFind matters by a validated Matter custom field and value, optionally filtering by client and status. Scans provider candidates and reports exact matches and matter IDs whose comparison was incomplete; requires Custom Fields and Matters read permissions.

Input Parameters

string
required
Exact typed custom-field value.
string ("open" | "closed" | "pending")
Optional exact matter lifecycle status.
integer
Optional exact client contact ID.
integer
required
Exact Matter custom-field ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_FIND_NEWEST_MATTER_BY_CLIENT_EMAILFind the newest matter for a contact matched by email, optionally filtered by status, using created_at and greatest ID as the tie-break; matching ignores case and surrounding ASCII whitespace. Contacts without email address lists are reported as incomplete, and invalid matter timestamps prevent selection; requires Contacts and Matters read permissions.

Input Parameters

string ("open" | "closed" | "pending")
Optional matter lifecycle status.
string
required
Exact client email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_FIND_OR_CREATE_COMPANY_CONTACTFind or create a Clio company contact by company name and email or a complete custom-field ID/value pair; when both are supplied, both must match. It preflights before creation and postflights for races, requiring Contacts write and, when used, Custom Fields read permissions.

Input Parameters

string
Stable exact email; required unless both custom-field identity parameters are supplied.
string
required
Exact company name to find or create.
object
Additional non-identity fields used only when creating.
integer
Stable Contact custom-field ID; always supply with identity_custom_field_value.
string
Exact typed custom-field value; always supply with identity_custom_field_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_FIND_OR_CREATE_MATTERFind or create a matter using a required description, either client ID or email, and a client reference or complete custom-field ID/value pair. It searches before creation and rechecks afterward for conflicts; requires Matters write and relevant Contacts/Custom Fields access.

Input Parameters

string ("open" | "closed" | "pending")
Matter lifecycle status for creation.
boolean
Whether the created matter is billable.
integer
Exact client contact ID. Use this ID instead of client_email.
string
Matter open date in YYYY-MM-DD format.
string
Matter close date in YYYY-MM-DD format.
string
required
Exact matter description and create value.
string
Exact email used to resolve one client. Use this email instead of client_id.
string
Stable client reference; required unless both custom-field identity parameters are supplied.
integer
Practice area ID.
integer
Responsible staff user ID.
integer
Responsible attorney user ID.
integer
Stable Matter custom-field ID; always supply with identity_custom_field_value.
string
Exact typed custom-field value; always supply with identity_custom_field_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_FIND_OR_CREATE_PERSON_CONTACTFind or create a Clio person contact by first and last name plus email or a complete custom-field ID/value pair, searching accessible contacts before creation and checking afterward for race conflicts. Requires Contacts write and, when used, Custom Fields read permissions.

Input Parameters

string
Stable exact email; required unless both custom-field identity parameters are supplied.
string
required
Exact last name to find or create.
string
required
Exact first name to find or create.
object
Additional non-identity fields used only when creating.
integer
Stable Contact custom-field ID; always supply with identity_custom_field_value.
string
Exact typed custom-field value; always supply with identity_custom_field_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_FIND_PERSON_CONTACTFind Clio person contacts matching first and last name and optionally email, without choosing an arbitrary duplicate. Requires Contacts read permission; results include candidate IDs whose comparison was incomplete due to missing or redacted data.

Input Parameters

string
Exact email address that the person must also have.
string
required
Exact last name to find.
string
required
Exact first name to find.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_FIND_USERFind a Clio user by ID, email, or full name; email and name searches support enabled and co-counsel filters, scan ID-ascending pages, report multiple exact matches as ambiguous, and identify users whose fields prevented comparison. Requires Users read permission on the Clio developer application.

Input Parameters

string
Exact full name. Choose a single selector: user_id, email, or name. Compared with Unicode case folding.
string
Exact email. Choose a single selector: user_id, email, or name. Compared case-insensitively after trimming.
boolean
Optional enabled-state filter for email or name searches; invalid with user_id.
integer
Exact user ID. Choose a single selector: user_id, email, or name. Do not use search filters with user_id.
boolean
Include co-counsel in email or name searches; leave false when using user_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_GENERATE_DOCUMENT_FROM_TEMPLATECreate a persistent Clio document automation from a template and poll its status within a bounded interval and timeout, requiring Documents read/write access and access to the Matter and template. Completed returns generated documents; failed or empty returns that outcome, and polling expiry returns still_pending with the automation ID and latest state.

Input Parameters

array
required
One or both output formats: pdf and original.
string
required
Filename for the generated document, without assuming generation is complete.
integer
required
Matter whose data will populate the document.
integer
required
Document template to use for generation.
number
Polling deadline between status-request starts, from 1 to 60 seconds. An in-flight status request may finish up to 10 seconds later. Expiry returns still_pending with the automation ID instead of creating another automation.
number
Seconds between Clio status requests, from 2 to 10. Clio publishes no polling cadence; use a slower interval to reduce rate-limit pressure.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_GET_ACTIVITYGet one Clio time or expense activity by ID, including billing state and its user and matter references.

Input Parameters

integer
required
Unique Clio activity ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_GET_BILLGet one Clio bill with its ETag and lifecycle state, along with available state transitions and financial totals when provided. Requires Billing read permission.

Input Parameters

integer
required
Unique bill ID.
integer
Optional next bill ID for Clio navigation.
integer
Optional previous bill ID for Clio navigation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_GET_CALENDARGet one Clio calendar by ID, including its type, permission, visibility, source, and colors. Requires the Calendars read permission selected on the Clio developer application.

Input Parameters

integer
required
Unique Clio calendar ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_GET_CALENDAR_ENTRYGet one Clio calendar entry or expanded recurring occurrence by ID with recurrence, attendee, owner, and matter details. Requires the Calendars read permission selected on the Clio developer application.

Input Parameters

string
required
Calendar entry ID. Composite string IDs identify expanded recurring occurrences and are preserved unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_GET_COMMUNICATIONRetrieve one recorded Clio communication. This does not send a message or notify subscribers. Requires Communications read permission.

Input Parameters

integer
required
Unique Clio communication ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_GET_CONTACTGet one Clio person or company by its known ID, including primary and structured email and phone details. Use Search Contacts to discover an ID. Requires Contacts read permission on the Clio developer application.

Input Parameters

integer
required
Unique Clio contact ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_GET_CURRENT_USERReturn the authenticated Clio user and role information for identity checks and default user references. Requires the Users read permission selected on the Clio developer application.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_GET_DOCUMENTGet one Clio document and its latest-version metadata by ID; requires Documents read permission. Files uploaded to Clio document integrations, such as Google Drive and Office 365, are inaccessible through the API.

Input Parameters

integer
required
Unique Clio document ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_GET_FOLDERRetrieve one Clio folder by ID. Requires Documents read permission.

Input Parameters

integer
required
Unique Clio folder ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_GET_MATTERGet one Clio matter by ID with lifecycle, client, staffing, practice area, dates, and billing method. Requires read access to Matters.

Input Parameters

integer
required
Unique Clio matter ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_GET_MATTER_CLIENTRetrieve the client contact for one Clio matter. Requires Contacts and Matters read permission.

Input Parameters

integer
required
Matter whose client is retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_GET_NOTERetrieve one Clio matter or contact note. Reading a note does not notify subscribers. Requires Notes read permission.

Input Parameters

integer
required
Unique Clio note ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_GET_TASKGet one Clio task by its known ID, including description, status, due date, priority, one assignee, matter, and completion-notification state; tasks with multiple firm-user assignees return only one of them. Requires read access to Tasks in the Clio developer application.

Input Parameters

integer
required
Unique Clio task ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_GET_USERGet one Clio firm user by ID with identity, account role, locale, time zone, and default calendar information. Requires the Users read permission selected on the Clio developer application.

Input Parameters

integer
required
Unique Clio firm user ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_LIST_ACTIVITY_DESCRIPTIONSList selectable Clio activity descriptions and resolved rates for time entries. Requires Activities read permission.

Input Parameters

integer
Maximum records in this page (1-200).
string
Opaque next_cursor from a prior call; pass it back unchanged.
integer
Return activity descriptions available to this user ID.
boolean
Filter by whether the activity description has a flat rate.
string ("utbms" | "clio")
Filter to UTBMS or Clio activity descriptions.
string
Return records created after this ISO-8601 timestamp.
string
Return records updated after this ISO-8601 timestamp.
integer
Calculate returned rates for this user ID.
integer
Calculate returned rates for this matter ID.
array
Return only these Clio activity description IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_LIST_CALENDARSList visible or writable Clio calendars to resolve the owner ID for calendar entries. Requires the Calendars read permission selected on the Clio developer application.

Input Parameters

integer
Maximum calendars in this page (1-200).
string
Opaque next_cursor from a previous call; when set, continue that exact listing.
string ("web" | "mobile")
Filter by calendar visibility source: Clio Web or mobile.
boolean
Filter calendar visibility for source; Clio Web visibility applies when source is omitted.
boolean
Optionally filter calendars by whether the user can write to them.
string ("AccountCalendar" | "AdhocCalendar" | "UserCalendar")
Filter by Clio calendar type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_LIST_COMMUNICATIONSReturn one bounded page of recorded Clio email or phone communications. This reads logs and does not send messages or notify subscribers. Requires Communications read permission.

Input Parameters

string
Filter by exact communication date.
string ("EmailCommunication" | "PhoneCommunication")
Filter by communication type.
integer
Page size (1-200).
string
Search body or subject text.
string
Opaque next cursor from a prior call; pass it back unchanged.
integer
Filter by participant user ID.
string
Filter by matter ID, or ‘null’ for no associated matter.
integer
Filter by participant contact ID.
string
Filter by exact occurrence timestamp.
string
Return records created after this timestamp.
string
Return records updated after this timestamp.
string
Return communications on or after this date.
string
Return communications on or before this date.
array
Return only these communication IDs.
boolean
Filter by associated time entries.
string
External-property name filter.
string
External-property value filter; requires its name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_LIST_CONTACT_EMAIL_ADDRESSESReturn one bounded page of email addresses for a Clio contact. Requires Contacts read permission.

Input Parameters

integer
Page size (1-200).
string
Opaque next cursor from a prior call; pass it back unchanged.
integer
required
Contact whose email addresses are listed.
string
Return addresses created after this ISO-8601 timestamp.
string
Return addresses updated after this ISO-8601 timestamp.
array
Return only these email-address IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_LIST_CONTACT_PHONE_NUMBERSReturn one bounded page of phone numbers for a Clio contact. Requires Contacts read permission.

Input Parameters

integer
Page size (1-200).
string
Opaque next cursor from a prior call; pass it back unchanged.
integer
required
Contact whose phone numbers are listed.
string
Return numbers created after this ISO-8601 timestamp.
string
Return numbers updated after this ISO-8601 timestamp.
array
Return only these phone-number IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_LIST_DOCUMENT_AUTOMATIONSReturn one bounded page of Clio document-generation automations. Requires Documents read permission.

Input Parameters

integer
Page size (1-200).
string
Opaque next cursor from a prior call.
string
Return automations created after this timestamp.
string
Return automations updated after this timestamp.
array
Return only these automation IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_LIST_DOCUMENTSReturn one bounded provider page of Clio documents. Requires Documents read permission; files stored in Clio document integrations such as Google Drive and Office 365 are inaccessible through the API.

Input Parameters

integer
Maximum documents in this page (1-200).
string
Wildcard search against document names.
string ("children" | "descendants")
Limit parent filtering to children or all descendants.
string
Opaque next_cursor from a prior response; pass it back unchanged.
boolean
Filter by document lock state.
integer
Filter by associated matter ID.
integer
Filter by parent folder ID.
integer
Filter by associated contact ID.
array
Return only these document IDs.
string
Return documents created after this ISO-8601 timestamp.
string
Return documents updated after this ISO-8601 timestamp.
boolean
Include documents currently in trash.
boolean
Include documents whose signed upload is incomplete.
integer
Filter by document-category ID.
string
Filter by external-property name.
string
Filter by external-property value; requires its name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_LIST_DOCUMENT_TEMPLATESList Clio document templates and IDs for document automation. Requires Documents read permission; availability can depend on the Clio plan.

Input Parameters

integer
Maximum templates in this page (1-200).
string
Opaque next_cursor from a prior call; pass it back unchanged.
string
Return templates created after this ISO-8601 timestamp.
string
Return templates updated after this ISO-8601 timestamp.
array
Return only these Clio document template IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_LIST_EXPENSE_CATEGORIESList selectable Clio expense categories and rates for expense entries. Requires Activities read permission.

Input Parameters

integer
Maximum categories in this page (1-200).
string
Match expense categories by name.
string
Opaque next_cursor from a prior call; pass it back unchanged.
string ("hard_cost" | "soft_cost" | "unassociated")
Filter by supported expense entry type.
string
Return records created after this ISO-8601 timestamp.
string
Return records updated after this ISO-8601 timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_LIST_FOLDER_CONTENTSReturn one bounded page of Clio documents and folders, optionally below a parent folder. Requires Documents read permission.

Input Parameters

integer
Page size (1-200).
string
Wildcard item-name search.
string ("children" | "descendants")
Limit results to children or descendants.
string
Opaque next cursor from a prior call.
array
Return only these document or folder IDs.
string
Filter by matter ID, or ‘null’ for no matter.
integer
Parent folder ID; omit for the account root.
string
Filter by contact ID, or ‘null’ for no contact.
string
Return items created after this timestamp.
string
Return items updated after this timestamp.
boolean
Include trashed items.
boolean
Include documents whose upload is incomplete.
string
Filter by category ID, or ‘null’ for no category.
string
External-property name filter.
string
External-property value filter; requires its name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_LIST_FOLDERSReturn one bounded page of Clio folders using documented filters. Requires Documents read permission.

Input Parameters

integer
Page size (1-200).
string
Wildcard folder-name search.
string ("children" | "descendants")
Limit parent filtering to children or descendants.
string
Opaque next cursor from a prior call.
string
Filter by matter ID, or ‘null’ for no matter.
string
Filter by parent ID, or ‘null’ for no parent.
string
Filter by contact ID, or ‘null’ for no contact.
array
Return only these folder IDs.
string
Return folders created after this timestamp.
string
Return folders updated after this timestamp.
boolean
Include trashed folders.
string
Filter by category ID, or ‘null’ for no category.
string
External-property name filter.
string
External-property value filter; requires its name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_LIST_GROUPSList Clio groups and IDs for matter assignments and user grouping. Requires Groups read permission.

Input Parameters

string
Match an exact group name.
integer
Maximum groups in this page (1-200).
string
Wildcard search against group names.
string
Opaque next_cursor from a prior call; pass it back unchanged.
integer
Return groups containing this user ID.
boolean
Filter by archived status.
array
Return only these Clio group IDs.
string ("AccountGroup" | "AdhocGroup" | "UserGroup")
Filter by Clio group type.
string
Return records created after this ISO-8601 timestamp.
string
Return records updated after this ISO-8601 timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_LIST_MATTER_CONTACTSReturn one bounded page of Clio matter-contact association records, including association ID and ETag, relationship label, is_client, matter reference, and contact details. Use LIST_MATTER_RELATED_CONTACTS for the related-contact relationship view. Requires Contacts and Matters read permissions.

Input Parameters

integer
Page size (1-200).
string
Opaque next cursor from a prior call; pass it back unchanged.
integer
required
Matter whose contacts are listed.
array
Include values for these custom-field IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_LIST_MATTER_PROTECTED_FUNDSReturn one bounded page of protected funds for a Clio matter. Requires Matters read permission.

Input Parameters

integer
Page size (1-200).
string
Opaque next cursor from a prior call; pass it back unchanged.
integer
required
Matter whose protected funds are listed.
string
Return funds created after this ISO-8601 timestamp.
string
Return funds updated after this ISO-8601 timestamp.
array
Return only these protected-fund IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_LIST_MATTER_STAGESList Clio matter stages and practice-area associations for selecting a matter stage. Requires Matters read permission.

Input Parameters

integer
Maximum stages in this page (1-200).
string
Opaque next_cursor from a prior call; pass it back unchanged.
string
Return stages created after this ISO-8601 timestamp.
string
Return stages updated after this ISO-8601 timestamp.
array
Return only these Clio matter stage IDs.
integer
Return stages belonging to this practice area ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_LIST_NOTESReturn one bounded page of Clio matter or contact notes. Reading notes does not notify subscribers. Requires Notes read permission.

Input Parameters

string ("Matter" | "Contact")
required
Required note association type.
integer
Page size (1-200).
string
Search note subject and detail.
string
Opaque next cursor from a prior call; pass it back unchanged.
array
Return only these note IDs.
integer
Filter by matter ID.
integer
Filter by contact ID.
string
Return notes created after this timestamp.
string
Return notes updated after this timestamp.
boolean
Filter by associated time entries.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_LIST_PRACTICE_AREASList Clio practice areas and IDs for matter and task-template selection. Requires Matters read permission.

Input Parameters

string
Match an exact practice area code.
string
Match an exact practice area name.
integer
Maximum practice areas in this page (1-200).
string
Opaque next_cursor from a prior call; pass it back unchanged.
integer
Apply Clio’s matter-specific practice-area eligibility filtering.
string
Return records created after this ISO-8601 timestamp.
string
Return records updated after this ISO-8601 timestamp.
array
Return only these Clio practice area IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_LIST_TASK_TEMPLATE_LISTSList Clio task template lists and IDs for assigning templates to matters. Requires Tasks read permission.

Input Parameters

boolean
Filter by whether lists contain no task templates.
integer
Maximum lists in this page (1-200).
string
Wildcard search against task template list names.
string
Opaque next_cursor from a prior call; pass it back unchanged.
string
Return lists created after this ISO-8601 timestamp.
string
Return lists updated after this ISO-8601 timestamp.
integer
Return lists associated with this practice area ID.
array
Return only these Clio task template list IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_LIST_USERSList Clio users for attorney, staff, task-assignee, and activity-user references, defaulting to enabled users but allowing disabled users to be requested. Requires the Users read permission selected on the Clio developer application.

Input Parameters

string
Filter users by name.
string ("admin" | "accounts" | "billing" | "reports")
Filter users that have this Clio role.
integer
Maximum users in this page (1-2000).
string
Opaque next_cursor from a previous call. Pass it back unchanged to continue that exact listing.
boolean
Return enabled or disabled users; defaults to enabled users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_PREVIEW_BILLRender one Clio bill as HTML, cap the response at 2 MB, and offload it as a file instead of returning active HTML inline. This does not change or send the bill. Requires Billing read permission.

Input Parameters

integer
required
Unique bill ID to preview.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_SAVE_ACTIVITYDeprecated compatibility action. Use CREATE_ACTIVITY when activity_id is omitted and UPDATE_ACTIVITY when it is provided. Preserves the combined Clio time-or-expense create/update behavior. Requires Activities write permission.

Input Parameters

string
Date performed in YYYY-MM-DD format; required when creating.
string
Current activity ETag for concurrency-safe updates; omit to update without a precondition.
string
Description of the work or expense.
number
Hourly or flat rate for time, or amount for an expense; omit to let Clio’s rate hierarchy apply.
integer
Task associated with the activity.
integer
User who performed or owns the activity; pass null on update to clear it.
integer
Matter associated with the activity.
boolean
Show an eligible non-billable activity on the bill at no charge.
integer
Activity to update; omit to create a new activity.
boolean
Prevent a non-billed TimeEntry from appearing as a bill line item; valid only for non-billed TimeEntries except when no_charge is true.
string ("TimeEntry" | "ExpenseEntry" | "HardCostEntry" | "SoftCostEntry")
Time or expense activity type; required when creating.
number
Duration in seconds for current API TimeEntry records; also the provider quantity for applicable expense entries.
integer
Activity description ID used for rate and category defaults.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_SAVE_CALENDARDeprecated compatibility action. Use CREATE_CALENDAR when calendar_id is omitted and UPDATE_CALENDAR when it is provided. Preserves custom-calendar creation and ETag-safe updates. Requires Calendars write permission.

Input Parameters

string
Calendar name. Required and non-empty when creating.
string ("#367B9C" | "#FFA5A4" | "#83D17F" | "#FFAC7B" | "#8E3F64" | "#C75300" | "#009CEC" | "#62D6B1" | "#9EEDCB" | "#F9A2C4" | "#616161" | "#BBDA81" | "#DFD3F8" | "#D6C4A5" | "#FFD478" | "#6AC9DE" | "#EABBB0" | "#BFC2E1" | "#DADADA" | "#CDE2F5")
Calendar color shown in the Clio Web UI.
string ("web" | "mobile")
Client surface to which the visibility setting applies.
boolean
Whether the calendar is visible by default for the selected source.
integer
Unique Clio calendar ID to update; omit to create a custom calendar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_SAVE_CALENDAR_ENTRYDeprecated compatibility action. Use CREATE_CALENDAR_ENTRY when calendar_entry_id is omitted and UPDATE_CALENDAR_ENTRY when it is provided. Contact attendees are unsupported because Clio always emails them, so updates fail closed when any already exist. Recurring updates require occurrence or series scope; future-series updates are unsupported. Calendar notifications are disabled. Requires Clio’s Calendars write permission.

Input Parameters

string
End timestamp in ISO-8601 format; required when creating, not before start_at, and on or after 1900-01-01T00:00:00Z.
boolean
Whether this is an all-day event.
string
Short event summary; required and non-empty when creating.
string
Event location.
string
Start timestamp in ISO-8601 format; required when creating and must be on or after 1900-01-01T00:00:00Z.
array
Writable Clio calendars to add or remove as attendees. Contact attendees are unsupported because Clio always emails them.
integer
Matter associated with the event; pass null on update to clear it.
string
Detailed event description.
string
Recurrence rule accepted by Clio; omit for a non-recurring event or explicitly pass null to clear an existing rule.
integer
Parent recurring-series ID; required for series scope, where calendar_entry_id must be this same parent ID.
string ("occurrence" | "series")
Required for recurring updates: occurrence updates one expanded occurrence; series updates the parent series. Future-series updates are unsupported because Clio has no atomic operation.
string
Calendar entry or expanded occurrence ID to update; omit to create.
integer
Writable calendar owner ID; required when creating.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_SAVE_CONTACTCreate or update a Clio person or company contact using this deprecated compatibility action. Person names use first_name and last_name; nested email addresses and phone numbers can be irreversibly deleted.

Input Parameters

string
Current contact ETag for concurrency-safe updates; omit to update without a precondition.
string
Company name; required when creating or renaming a company.
string
Job title for a Person contact; requires contact_type=Person.
string
Last name for creating or renaming a person contact.
integer
Existing company contact ID associated with a person.
integer
Contact to update; omit to create a new contact.
string
First name for creating or renaming a person contact.
string ("Person" | "Company")
Person or Company; required when creating and when updating name fields.
array
Phone numbers to save on the contact.
array
Email addresses to save on the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_SAVE_MATTERDeprecated compatibility action. Use CREATE_MATTER when matter_id is omitted and UPDATE_MATTER when it is provided. Preserves combined matter create/update behavior. Requires Clio’s Matters write permission.

Input Parameters

string
Current matter ETag for concurrency-safe updates; omit to update without a precondition.
string ("open" | "closed" | "pending")
Matter lifecycle status.
boolean
Whether work on this matter is billable.
integer
Client contact ID; required when creating.
integer
Matter to update; omit to create a new matter.
string
Matter open date in YYYY-MM-DD format.
string
Matter close date in YYYY-MM-DD format.
string
Matter description; required when creating.
string
Client-provided reference for the matter.
integer
Practice area ID; pass null on update to clear the association.
integer
User ID of responsible staff.
integer
User ID of the responsible attorney.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_SAVE_TASKCreate or update a Clio task using this deprecated compatibility action; assigning one user or contact replaces existing assignees. Assignee notifications are disabled on creation and reassignment; completion notifications are checked before updating a task to complete and after creating a completed task, and Clio’s Tasks write permission is required.

Input Parameters

string
Current task ETag for concurrency-safe ordinary updates. Completion uses the fresh ETag from its required safety preflight.
string
Task name; required and non-empty when creating.
string
Task due date or date-time in ISO-8601 format.
string ("pending" | "in_progress" | "in_review" | "complete" | "draft")
Task status; accounts without Advanced Tasks may use only Pending or Complete. Complete existing tasks through UPDATE_TASK.
integer
Task to update; omit to create a new task.
string ("High" | "Normal" | "Low")
Task priority using Clio’s write values.
integer
Matter associated with the task.
string ("private" | "public")
Who can see the task; defaults to public when creating.
integer
User or contact ID assigned to the task; required when creating.
string
Task details; required when creating and may be an empty string. Clio supports rich text when description_text_type is rich_text, with a, b, br, div, em, i, li, ol, p, s, strong, u, and ul tags and href, rel, type, and target attributes.
string ("User" | "Contact")
Model type for assignee_id; provide both assignee fields together.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_SEARCH_ACTIVITIESSearch and filter Clio activities, including multiple activity IDs, one page at a time. Use Get Activity for one known ID and full billing details. Requires Activities read permission in the Clio developer application.

Input Parameters

integer
Maximum activities in this page (1-200); when activity_ids is supplied, limit must be at least the number of IDs.
string
Wildcard search across activity notes.
string
Opaque next_cursor from a previous call; pass it back unchanged to continue that search.
string ("billed" | "draft" | "unbilled" | "non_billable" | "billable" | "written_off")
Filter by billing status.
string
Filter by task ID, or pass ‘null’ for activities without a task.
string
Filter by user ID, or pass ‘null’ for activities without a user.
string
Return activities on or before this date.
string
Filter by matter ID, or pass ‘null’ for activities without a matter.
string
Return activities on or after this date.
array
Filter the collection to these activity IDs. The number of IDs cannot exceed limit (and is always at most 200). For one known ID and full billing details, use Get Activity.
string ("TimeEntry" | "ExpenseEntry" | "HardCostEntry" | "SoftCostEntry")
Filter by time or expense activity type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_SEARCH_CALENDAR_ENTRIESSearch Clio calendar entries by time window, text, calendar, matter, or ID, one page at a time. Requires read access to the Calendars permission in the Clio developer application.

Input Parameters

integer
Maximum entries in this page (1-200); when calendar_entry_ids is supplied, limit must be at least the number of IDs.
string
Search matching calendar entries.
string
Opaque next_cursor from a previous call; pass it back unchanged to continue that search.
boolean
Filter all-day or timed entries.
string
Return entries beginning on or before this ISO-8601 timestamp.
boolean
Expand recurring events into individual occurrences.
string
Return entries ending on or after this ISO-8601 timestamp.
string
Filter by matter ID, or pass ‘null’ for entries without a matter.
integer
Filter entries on this calendar; Clio does not accept the null keyword.
array
Filter by entry or expanded-occurrence IDs; occurrence IDs may be composite strings. The number of IDs cannot exceed limit (and is always at most 200). With expanded recurrence, Clio may also return sibling occurrences, so inspect returned IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_SEARCH_CONTACTSSearch and filter Clio contacts, including multiple contact IDs, one page at a time. Use Get Contact for one known ID and full contact details. Requires Contacts read permission in the Clio developer application.

Input Parameters

integer
Maximum contacts in this page (1-200); when contact_ids is supplied, limit must be at least the number of IDs.
string
Wildcard search for name, title, email address, address, phone number, web site, instant messenger address, custom fields, related matter name, or company name matching a given string.
string
Opaque next_cursor from a previous call; omit for the first page.
array
Filter the collection to these contact IDs. The number of IDs cannot exceed limit (and is always at most 200). For one known ID and full contact details, use Get Contact.
string ("Person" | "Company")
Filter contacts by person or company.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_SEARCH_MATTERSSearch and filter Clio matters, including multiple matter IDs, one page at a time. Use Get Matter for one known ID and full lifecycle, staffing, and billing details. Requires Matters read permission in the Clio developer application.

Input Parameters

integer
Maximum matters in this page (1-200); when matter_ids is supplied, limit must be at least the number of IDs.
string
Wildcard search for display_number, number, or description, and for the first_name, last_name, or name of the associated client.
string
Opaque next_cursor from a previous call; omit for the first page.
string ("open" | "closed" | "pending")
Filter by matter status.
integer
Filter matters for this client contact ID.
array
Filter the collection to these matter IDs. The number of IDs cannot exceed limit (and is always at most 200). For one known ID and full lifecycle, staffing, and billing details, use Get Matter.
integer
Filter matters by practice area ID.
integer
Filter matters assigned to this responsible attorney user ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_SEARCH_TASKSSearch and filter Clio tasks, including multiple task IDs, one page at a time. Use Get Task for one known ID and full task details. Requires Tasks read permission in the Clio developer application.

Input Parameters

integer
Maximum tasks in this page (1-200); when task_ids is supplied, limit must be at least the number of IDs.
string
Wildcard search across task name and description.
string
Opaque next_cursor from a previous call; pass it back unchanged to continue that search.
string
Return tasks due on or before this date.
string ("pending" | "in_progress" | "in_review" | "complete" | "draft")
Filter by task status; advanced statuses require the corresponding Clio feature.
string
Return tasks due on or after this date.
string ("high" | "normal" | "low")
Filter by task priority.
array
Filter the collection to these task IDs. The number of IDs cannot exceed limit (and is always at most 200). For one known ID and full task details, use Get Task.
string
Filter by matter ID, or pass ‘null’ for tasks without a matter.
string
Filter by assigned user or contact ID with assignee_type, or pass ‘null’ without assignee_type for tasks without an assignee.
string ("user" | "contact")
Type of assignee_id; supply with assignee_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_START_DOCUMENT_FROM_TEMPLATEStart Clio’s asynchronous create-document-from-template generation and return the automation ID, current state, and any documents already present. This action does not wait for completion because Clio documents no polling SLA. Check GET /document_automations/{id}.json using Platform Equivalent via proxy, or a future show action, before treating the document as generated. Requires Clio Documents write access and access to the Matter and template.

Input Parameters

array
required
One or both output formats: pdf and original.
string
required
Filename for the generated document, without assuming generation is complete.
integer
required
Matter whose data will populate the document.
integer
required
Document template to use for generation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_TRANSITION_BILL_STATEIrreversibly transition a bill to paid, void, or deleted only after exact identity, ETag, expected current state, available transition, and explicit confirmation checks. Uses Clio’s official PATCH bill operation and requires Billing write permission.

Input Parameters

string
required
ETag observed when the transition was approved.
integer
required
Unique bill ID.
boolean
required
Must be true to confirm the lifecycle transition.
string ("paid" | "void" | "deleted")
required
Confirmed irreversible target state.
string
required
Bill number observed when the transition was approved.
string ("draft" | "awaiting_approval" | "awaiting_payment" | "paid" | "void" | "deleted")
required
Bill state observed when the transition was approved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_UPDATE_ACTIVITYUpdate at least one field on an existing Clio time or expense activity, optionally using its ETag as a concurrency precondition; posted or billed activities may be immutable, and Activities write permission is required. Changing a time entry’s matter, user, or activity description can reset its price according to Clio’s rate hierarchy.

Input Parameters

string
Updated date performed in YYYY-MM-DD format.
string
Current activity ETag for a concurrency-safe update; omit to update without a precondition.
string
Updated work or expense description.
number
Updated hourly rate, flat rate, or expense amount.
integer
Updated task associated with the activity.
integer
Updated user who performed or owns the activity; pass null to clear it.
integer
Updated matter associated with the activity.
boolean
Updated no-charge setting.
integer
required
Activity to update.
boolean
Updated non-billable setting.
string ("TimeEntry" | "ExpenseEntry" | "HardCostEntry" | "SoftCostEntry")
Updated time or expense activity type.
number
Updated duration in seconds or provider quantity.
integer
Updated activity description used for rate and category defaults.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_UPDATE_BILLUpdate ordinary bill presentation, financial, tax, discount, or interest fields using the required current ETag. Lifecycle state is deliberately excluded; use Transition Bill State for a confirmed state change. Requires Billing write permission.

Input Parameters

string
required
Current bill ETag, required to prevent stale financial writes.
string
New bill memo.
string
New due date.
string
New bill number.
integer
required
Unique bill ID.
string
New bill subject.
number
New primary tax rate as a percentage.
string
New issue date.
integer
New currency ID.
integer
New bill theme ID.
string
Note explaining the discount.
number
Discount amount; discount_type selects percentage or money.
string ("percentage" | "money")
Discount calculation type.
number
Interest rate as a percentage.
string ("simple" | "compound")
Simple or compound interest.
string
New purchase order information.
integer
Provider interest period; Clio’s documented example permits zero.
boolean
Use the client’s grace period, overriding an explicitly supplied due_at.
number
New secondary tax rate as a percentage.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_UPDATE_CALENDARUpdate at least one of an existing Clio calendar’s name, color, source, or visibility after reading its current ETag. Requires the Calendars write permission selected on the Clio developer application.

Input Parameters

string
Updated calendar name.
string ("#367B9C" | "#FFA5A4" | "#83D17F" | "#FFAC7B" | "#8E3F64" | "#C75300" | "#009CEC" | "#62D6B1" | "#9EEDCB" | "#F9A2C4" | "#616161" | "#BBDA81" | "#DFD3F8" | "#D6C4A5" | "#FFD478" | "#6AC9DE" | "#EABBB0" | "#BFC2E1" | "#DADADA" | "#CDE2F5")
Updated calendar color shown in the Clio Web UI.
string ("web" | "mobile")
Updated client surface to which the visibility setting applies.
boolean
Updated default visibility for the selected source.
integer
required
Unique Clio calendar ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_UPDATE_CALENDAR_ENTRYUpdate at least one field on a Clio calendar entry without sending calendar notifications. Existing contact attendees cause the update to fail closed because Clio always emails them. Recurring updates require occurrence or series scope; future-series updates are unsupported. Requires Clio’s Calendars write permission.

Input Parameters

string
Changed end timestamp, not before start_at when both are supplied.
boolean
Changed all-day setting.
string
Changed non-empty event summary.
string
Changed event location.
string
Changed start timestamp, on or after 1900-01-01T00:00:00Z.
array
Writable Clio calendars to add or remove. Contact attendees are unsupported because Clio always emails them.
integer
Changed associated matter; pass null to clear it.
string
Changed event description.
string
Changed recurrence rule; pass null to clear it.
integer
Parent recurring-series ID; required for series scope, where calendar_entry_id must be this same parent ID.
string ("occurrence" | "series")
Required for recurring updates: occurrence updates one expanded occurrence; series updates the parent series. Future-series updates are unsupported because Clio has no atomic operation.
string
required
Calendar entry or expanded occurrence ID to update.
integer
Changed writable calendar owner ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_UPDATE_COMMUNICATIONUpdate a recorded Clio communication using its current ETag, including explicitly confirmed irreversible deletion of external properties. Notification subscribers are intentionally unsupported. Requires Communications write permission.

Input Parameters

string
Changed communication body.
string
required
Current communication ETag.
string ("EmailCommunication" | "PhoneCommunication")
Changed communication type.
object
Changed associated matter.
array
Changed sender associations.
string
Changed communication subject.
array
Changed receiver associations.
string
Changed occurrence timestamp.
integer
required
Unique Clio communication ID.
array
External properties to add, change, or delete.
boolean
Must be true when deleting an external property.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_UPDATE_CONTACTUpdate at least one field on a Clio person or company, including adding or updating nested email and phone records. Setting destroy=true with a nested record ID irreversibly deletes that record. Requires Clio’s Contacts write permission.

Input Parameters

string
Current contact ETag for concurrency-safe updates; omit to update without a precondition.
string
Changed company name.
string
Changed job title; requires contact_type=Person.
string
Changed person last name.
integer
Changed associated company contact ID.
integer
required
Contact to update.
string
Changed person first name.
string ("Person" | "Company")
Person or Company; required when updating name fields.
array
Phone numbers to add, update by ID, or irreversibly delete by ID.
array
Email addresses to add, update by ID, or irreversibly delete by ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_UPDATE_DOCUMENTUpdate only Clio document metadata with an If-Match ETag. It cannot restore a trashed document, initialize or finalize uploads, create versions, or mutate external properties. HTTP 412 is surfaced without retry. Requires Documents write permission.

Input Parameters

string
required
Current ETag; stale values fail once with HTTP 412.
string
Replacement name.
object
Replacement folder, contact, or matter parent.
integer
required
Unique Clio document ID.
string
Replacement receipt timestamp.
integer
Replacement related communication ID.
integer
Replacement document-category ID. Omit to leave unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_UPDATE_FOLDERRename, move, recategorize, or restore a Clio folder, and add, change, or explicitly and irreversibly delete external properties, using its current ETag. Requires Documents write permission.

Input Parameters

string
required
Current folder ETag.
string
Replacement folder name.
object
Replacement parent resource.
boolean
Whether to restore a trashed folder.
integer
required
Unique Clio folder ID.
array
External properties to add, change, or delete.
integer
Replacement category ID; null clears it.
boolean
Must be true when deleting an external property.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_UPDATE_MATTERUpdate at least one field on an existing Clio matter, optionally using its ETag for concurrency safety. Requires Clio’s Matters write permission.

Input Parameters

string
Current matter ETag; omit to update without a precondition.
string ("open" | "closed" | "pending")
Updated matter lifecycle status.
boolean
Whether work on this matter is billable.
integer
Client contact ID.
integer
required
Matter to update.
string
Matter open date in YYYY-MM-DD format.
string
Matter close date in YYYY-MM-DD format.
string
Updated matter description.
string
Client-provided reference for the matter.
integer
Practice area ID; pass null to clear the association.
integer
User ID of responsible staff.
integer
User ID of the responsible attorney.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_UPDATE_NOTEUpdate a Clio note using its current ETag. Notification subscribers are intentionally unsupported. Requires Notes write permission.

Input Parameters

string
Changed note date.
string
required
Current note ETag.
string
Changed note body.
integer
required
Unique Clio note ID.
string
Changed note subject.
string ("plain_text" | "rich_text")
Changed note text format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_UPDATE_TASKUpdate at least one field on an existing Clio task; reassignment selects one user or contact, replacing any multiple assignees, with assignee notifications disabled. Completion notifications are disabled and verified before a complete status transition; requires Clio’s Tasks write permission.

Input Parameters

string
Current task ETag for ordinary updates. Completion uses the fresh ETag from its required safety preflight.
string
Updated task name.
string
Task due date or date-time in ISO-8601 format.
string ("pending" | "in_progress" | "in_review" | "complete" | "draft")
Updated task status; accounts without Advanced Tasks may use only Pending or Complete. Use status complete here rather than on CREATE_TASK.
integer
required
Task to update.
string ("High" | "Normal" | "Low")
Task priority using Clio’s write values.
integer
Matter associated with the task.
string ("private" | "public")
Who can see the task.
integer
User or contact ID assigned to the task; provide with assignee_type.
string
Updated task details; an empty string is accepted. Clio supports rich text when description_text_type is rich_text, with a, b, br, div, em, i, li, ol, p, s, strong, u, and ul tags and href, rel, type, and target attributes.
string ("User" | "Contact")
Model type for assignee_id; provide both assignee fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIO_MANAGE_VOID_BILLIrreversibly void an Unpaid bill after exact ID, number, ETag, state, and confirmation checks. Clio only accepts bills without recorded payments. Draft and Pending Approval bills must use Delete Bill. Uses Clio’s official DELETE bill operation and requires Billing write permission.

Input Parameters

integer
required
Unique Unpaid bill ID to void.
boolean
required
Must be true to confirm irreversible voiding.
string
required
ETag observed when voiding was approved.
string
required
Bill number observed when voiding was approved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not