Clio

App · 20 actions

Read Clio Manage contacts, matters, tasks, notes and calendars, and manage contacts, tasks and notes.

Actions

ActionWhat it does
Create contactCreate contact.
Create noteCreate note.
Create taskCreate task.
Delete contactDelete contact.
Delete noteDelete a note by ID.
Delete taskDelete task.
Get calendar entryGet calendar entry.
Get contactGet contact.
Get matterGet matter.
Get noteGet note.
Get taskGet task.
List calendar entriesList calendar entries.
List contactsList contacts.
List mattersList matters.
List notesList notes.
List tasksList tasks.
List usersList users.
Update contactUpdate contact.
Update noteUpdate note.
Update taskUpdate task.

Create contact

Create contact.

Inputs

Companycompanyobject
company.
Email addressesemail_addresseslist
email_addresses.
First namefirst_nametext
First name of the Contact.
Last namelast_nametext
Last name of the Contact.
NamenametextRequired
Full name of the Contact. For requirements, see [Contact Name](https://docs.developers.clio.com/clio-manage/api-reference/#tag/Contacts/Contact-Name).
Phone numbersphone_numberslist
phone_numbers.
TypetypetextRequired
Type of the Contact.One of: Person, Company.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "account_balances": [],
      "activity_rates": [],
      "addresses": [],
      "avatar": {},
      "client_connect_user_id": 0,
      "clio_connect_email": "",
      "co_counsel_rate": {},
      "company": {},
      "created_at": "",
      "currency": {},
      "custom_field_set_associations": [],
      "custom_field_values": [],
      "date_of_birth": "",
      "email_addresses": [],
      "etag": "",
      "first_name": "",
      "folder": {},
      "has_clio_for_clients_permission": false,
      "id": 0,
      "initials": "",
      "instant_messengers": [],
      "is_bill_recipient": false,
      "is_client": false,
      "is_clio_for_client_user": false,
      "is_co_counsel": false,
      "italy_contact": {},
      "kyc_field_values": [],
      "last_name": "",
      "ledes_client_id": "",
      "legal_aid_uk_contact": {},
      "locked_clio_connect_email": false,
      "middle_name": "",
      "name": "",
      "notification_methods": [],
      "payment_profile": {},
      "phone_numbers": [],
      "prefix": "",
      "primary_address": {},
      "primary_email_address": "",
      "primary_phone_number": "",
      "primary_web_site": {},
      "primary_work_address": {},
      "rate_table_assignment": {},
      "related_contacts": [],
      "require_utbms_codes": false,
      "sales_tax_number": "",
      "secondary_address": {},
      "secondary_email_address": "",
      "secondary_phone_number": "",
      "title": "",
      "type": "Company",
      "updated_at": "",
      "web_sites": []
    }
  },
  "has_more": false,
  "next_cursor": null
}

Create note

Create note.

Inputs

Contactcontact_idnumber
The contact ID. Leave empty to keep the current value.At least 1.
Datedatedate
Date for the Note. (Expects an ISO-8601 date).
Detaildetailtext
Note body in text. This Note supports rich text when setting the `detail_text_type` field to `rich_text`. With supported tags such as ` `, ` `, ` `, ` `, ` `, ` ` ` `, ` `, ` `, ` `, ` `, ` ` and ` `. This Note also supports attributes such as `href`, `rel`, `type`, and `target`.
Mattermatter_idnumber
The matter ID. Leave empty to keep the current value.At least 1.
Subjectsubjecttext
Note subject.
TypetypetextRequired
Note type.One of: Matter, Contact.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "author": {},
      "contact": {},
      "created_at": "",
      "date": "",
      "detail": "",
      "detail_text_type": "plain_text",
      "etag": "",
      "id": 0,
      "matter": {},
      "notification_event_subscribers": [],
      "subject": "",
      "time_entries": [],
      "time_entries_count": 0,
      "type": "Matter",
      "updated_at": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Create task

Create task.

Inputs

Assigneeassignee_idnumber
The assignee ID. Leave empty to keep the current value.At least 1.
DescriptiondescriptiontextRequired
Longer description of the Task. This Task supports rich text when the `description_text_type` field is set to `rich_text`. With supported tags such as ` `, ` `, ` `, ` `, ` `, ` ` ` `, ` `, ` `, ` `, ` `, ` ` and ` `. This Task also supports attributes such as `href`, `rel`, `type`, and `target`.
Due atdue_atdate and time
Date when the Task must be completed by. (Expects an ISO-8601 date).
Mattermatter_idnumber
The matter ID. Leave empty to keep the current value.At least 1.
NamenametextRequired
Name of the Task.
Priorityprioritytext
Priority of the Task.One of: High, Normal, Low.
Statusstatustext
Task status. Users without advanced tasks are allowed to select `Complete` or `Pending` only.One of: pending, in_progress, in_review, complete, draft.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "assignee": {},
      "assignees": [],
      "assigner": {},
      "completed_at": "",
      "created_at": "",
      "description": "",
      "description_text_type": "plain_text",
      "due_at": "",
      "etag": "",
      "id": 0,
      "matter": {},
      "name": "",
      "notify_completion": false,
      "permission": "",
      "priority": "High",
      "reminders": [],
      "status": "pending",
      "statute_of_limitations": false,
      "task_type": {},
      "time_entries": [],
      "time_entries_count": 0,
      "time_estimated": 0,
      "updated_at": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Delete contact

Delete contact.

Inputs

IdidnumberRequired
The unique identifier for the Contact.

Outputs

Result.

datanull
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}

Delete note

Delete a note by ID.

Inputs

IdidnumberRequired
The unique identifier for the Note.

Outputs

Result.

datanull
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}

Delete task

Delete task.

Inputs

IdidnumberRequired
The unique identifier for the Task.

Outputs

Result.

datanull
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}

Get calendar entry

Get calendar entry.

Inputs

IdidnumberRequired
The unique identifier for the CalendarEntry.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "all_day": false,
      "attendees": [],
      "calendar_entry_event_type": {},
      "calendar_owner": {},
      "calendar_owner_id": 0,
      "calendars": [],
      "conference_meeting": {},
      "court_rule": false,
      "created_at": "",
      "description": "",
      "end_at": "",
      "end_date": "",
      "end_time": "",
      "etag": "",
      "external_properties": [],
      "id": "",
      "location": "",
      "matter": {},
      "matter_docket": {},
      "parent_calendar_entry": {},
      "parent_calendar_entry_id": 0,
      "permission": "",
      "recurrence_rule": "",
      "reminders": [],
      "start_at": "",
      "start_at_time_zone": "",
      "start_date": "",
      "start_time": "",
      "summary": "",
      "time_entries": [],
      "time_entries_count": 0,
      "updated_at": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get contact

Get contact.

Inputs

IdidnumberRequired
The unique identifier for the Contact.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "account_balances": [],
      "activity_rates": [],
      "addresses": [],
      "avatar": {},
      "client_connect_user_id": 0,
      "clio_connect_email": "",
      "co_counsel_rate": {},
      "company": {},
      "created_at": "",
      "currency": {},
      "custom_field_set_associations": [],
      "custom_field_values": [],
      "date_of_birth": "",
      "email_addresses": [],
      "etag": "",
      "first_name": "",
      "folder": {},
      "has_clio_for_clients_permission": false,
      "id": 0,
      "initials": "",
      "instant_messengers": [],
      "is_bill_recipient": false,
      "is_client": false,
      "is_clio_for_client_user": false,
      "is_co_counsel": false,
      "italy_contact": {},
      "kyc_field_values": [],
      "last_name": "",
      "ledes_client_id": "",
      "legal_aid_uk_contact": {},
      "locked_clio_connect_email": false,
      "middle_name": "",
      "name": "",
      "notification_methods": [],
      "payment_profile": {},
      "phone_numbers": [],
      "prefix": "",
      "primary_address": {},
      "primary_email_address": "",
      "primary_phone_number": "",
      "primary_web_site": {},
      "primary_work_address": {},
      "rate_table_assignment": {},
      "related_contacts": [],
      "require_utbms_codes": false,
      "sales_tax_number": "",
      "secondary_address": {},
      "secondary_email_address": "",
      "secondary_phone_number": "",
      "title": "",
      "type": "Company",
      "updated_at": "",
      "web_sites": []
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get matter

Get matter.

Inputs

IdidnumberRequired
The unique identifier for the Matter.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "account_balances": [],
      "attorney_allocation": {},
      "billable": false,
      "billing_method": "flat",
      "client": {},
      "client_id": 0,
      "client_reference": "",
      "close_date": "",
      "contingency_fee": {},
      "created_at": "",
      "currency": {},
      "custom_field_set_associations": [],
      "custom_field_values": [],
      "custom_number": "",
      "custom_rate": {},
      "description": "",
      "display_number": "",
      "etag": "",
      "evergreen_retainer": {},
      "folder": {},
      "group": {},
      "has_tasks": false,
      "id": 0,
      "kyc_field_values": [],
      "last_activity_date": "",
      "legal_aid_uk_matter": {},
      "location": "",
      "maildrop_address": "",
      "matter_bill_recipients": [],
      "matter_budget": {},
      "matter_stage": {},
      "matter_stage_updated_at": "",
      "number": 0,
      "open_date": "",
      "originating_attorney": {},
      "pending_date": "",
      "practice_area": {},
      "rate_table_assignment": {},
      "relationships": [],
      "require_utbms_codes": false,
      "responsible_attorney": {},
      "responsible_staff": {},
      "shared": false,
      "split_invoice_payers": [],
      "status": "Pending",
      "statute_of_limitations": {},
      "task_template_list_instances": [],
      "updated_at": "",
      "user": {}
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get note

Get note.

Inputs

IdidnumberRequired
The unique identifier for the Note.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "author": {},
      "contact": {},
      "created_at": "",
      "date": "",
      "detail": "",
      "detail_text_type": "plain_text",
      "etag": "",
      "id": 0,
      "matter": {},
      "notification_event_subscribers": [],
      "subject": "",
      "time_entries": [],
      "time_entries_count": 0,
      "type": "Matter",
      "updated_at": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get task

Get task.

Inputs

IdidnumberRequired
The unique identifier for the Task.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "assignee": {},
      "assignees": [],
      "assigner": {},
      "completed_at": "",
      "created_at": "",
      "description": "",
      "description_text_type": "plain_text",
      "due_at": "",
      "etag": "",
      "id": 0,
      "matter": {},
      "name": "",
      "notify_completion": false,
      "permission": "",
      "priority": "High",
      "reminders": [],
      "status": "pending",
      "statute_of_limitations": false,
      "task_type": {},
      "time_entries": [],
      "time_entries_count": 0,
      "time_estimated": 0,
      "updated_at": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

List calendar entries

List calendar entries. Returns one page; use the continuation value for more records.

Inputs

Created sincecreated_sincedate and time
Filter CalendarEntry records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
Limitlimitnumber
A limit on the number of CalendarEntry records to be returned. Limit can range between 1 and 200. Default: `200`.At least 1.
Matter idmatter_idnumber
The unique identifier for a single Matter. Use the keyword `null` to match those without a CalendarEntry. The list will be filtered to include only the CalendarEntry records with the matching property.
Page tokenpage_tokentext
A token specifying which page to return.
Queryquerytext
Allows matching search on calendar entry.
Updated sinceupdated_sincedate and time
Filter CalendarEntry records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}

List contacts

List contacts. Returns one page; use the continuation value for more records.

Inputs

Created sincecreated_sincedate and time
Filter Contact records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
Limitlimitnumber
A limit on the number of Contact records to be returned. Limit can range between 1 and 200. Default: `200`.At least 1.
Page tokenpage_tokentext
A token specifying which page to return.
Queryquerytext
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.
Updated sinceupdated_sincedate and time
Filter Contact records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}

List matters

List matters. Returns one page; use the continuation value for more records.

Inputs

Created sincecreated_sincedate and time
Filter Matter records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
Limitlimitnumber
A limit on the number of Matter records to be returned. Limit can range between 1 and 200. Default: `200`.At least 1.
Page tokenpage_tokentext
A token specifying which page to return.
Queryquerytext
Wildcard search for `display_number`, `number` or `description` matching a given string, as well as the `first_name`, `last_name` or `name` of the associated client.
Statusstatustext
Filter Matter records to those with a given status. It accepts comma-separated statuses, e.g. `open,pending`.One of: open, closed, pending.
Updated sinceupdated_sincedate and time
Filter Matter records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}

List notes

List notes. Returns one page; use the continuation value for more records.

Inputs

Contact idcontact_idnumber
The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the Note records with the matching property.
Created sincecreated_sincedate and time
Filter Note records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
Limitlimitnumber
A limit on the number of Note records to be returned. Limit can range between 1 and 200. Default: `200`.At least 1.
Matter idmatter_idnumber
The unique identifier for a single Matter. The keyword `null` is not valid for this field. The list will be filtered to include only the Note records with the matching property.
Page tokenpage_tokentext
A token specifying which page to return.
Queryquerytext
Wildcard search across note subject and detail.
TypetypetextRequired
Filter Note records to those of the specified type.One of: Matter, Contact.
Updated sinceupdated_sincedate and time
Filter Note records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}

List tasks

List tasks. Returns one page; use the continuation value for more records.

Inputs

Created sincecreated_sincedate and time
Filter Task records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
Limitlimitnumber
A limit on the number of Task records to be returned. Limit can range between 1 and 200. Default: `200`.At least 1.
Matter idmatter_idnumber
The unique identifier for a single Matter. Use the keyword `null` to match those without a Task. The list will be filtered to include only the Task records with the matching property.
Page tokenpage_tokentext
A token specifying which page to return.
Queryquerytext
Wildcard search for `name` or `description` matching a given string.
Statusstatustext
Filter Task records to those with the given status. Users without advanced tasks enabled may only specify 'complete' or 'pending'.One of: pending, in_progress, in_review, complete, draft.
Updated sinceupdated_sincedate and time
Filter Task records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}

List users

List users. Returns one page; use the continuation value for more records.

Inputs

Created sincecreated_sincedate and time
Filter User records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
Limitlimitnumber
A limit on the number of User records to be returned. Limit can range between 1 and 2000. Default: `2000`.At least 1.
Page tokenpage_tokentext
A token specifying which page to return.
Updated sinceupdated_sincedate and time
Filter User records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}

Update contact

Update contact.

Inputs

IdidnumberRequired
The unique identifier for the Contact.
Companycompanyobject
company.
Email addressesemail_addresseslist
email_addresses.
First namefirst_nametext
First name of the Contact.
Last namelast_nametext
Last name of the Contact.
Namenametext
Full name of the Contact. For requirements, see [Contact Name](https://docs.developers.clio.com/clio-manage/api-reference/#tag/Contacts/Contact-Name).
Phone numbersphone_numberslist
phone_numbers.
Typetypetext
Type of the Contact.One of: Person, Company.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "account_balances": [],
      "activity_rates": [],
      "addresses": [],
      "avatar": {},
      "client_connect_user_id": 0,
      "clio_connect_email": "",
      "co_counsel_rate": {},
      "company": {},
      "created_at": "",
      "currency": {},
      "custom_field_set_associations": [],
      "custom_field_values": [],
      "date_of_birth": "",
      "email_addresses": [],
      "etag": "",
      "first_name": "",
      "folder": {},
      "has_clio_for_clients_permission": false,
      "id": 0,
      "initials": "",
      "instant_messengers": [],
      "is_bill_recipient": false,
      "is_client": false,
      "is_clio_for_client_user": false,
      "is_co_counsel": false,
      "italy_contact": {},
      "kyc_field_values": [],
      "last_name": "",
      "ledes_client_id": "",
      "legal_aid_uk_contact": {},
      "locked_clio_connect_email": false,
      "middle_name": "",
      "name": "",
      "notification_methods": [],
      "payment_profile": {},
      "phone_numbers": [],
      "prefix": "",
      "primary_address": {},
      "primary_email_address": "",
      "primary_phone_number": "",
      "primary_web_site": {},
      "primary_work_address": {},
      "rate_table_assignment": {},
      "related_contacts": [],
      "require_utbms_codes": false,
      "sales_tax_number": "",
      "secondary_address": {},
      "secondary_email_address": "",
      "secondary_phone_number": "",
      "title": "",
      "type": "Company",
      "updated_at": "",
      "web_sites": []
    }
  },
  "has_more": false,
  "next_cursor": null
}

Update note

Update note.

Inputs

IdidnumberRequired
The unique identifier for the Note.
Datedatedate
Date for the Note. (Expects an ISO-8601 date).
Detaildetailtext
Note body in text. This Note supports rich text when setting the `detail_text_type` field to `rich_text`. With supported tags such as ` `, ` `, ` `, ` `, ` `, ` ` ` `, ` `, ` `, ` `, ` `, ` ` and ` `. This Note also supports attributes such as `href`, `rel`, `type`, and `target`.
Subjectsubjecttext
Note subject.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "author": {},
      "contact": {},
      "created_at": "",
      "date": "",
      "detail": "",
      "detail_text_type": "plain_text",
      "etag": "",
      "id": 0,
      "matter": {},
      "notification_event_subscribers": [],
      "subject": "",
      "time_entries": [],
      "time_entries_count": 0,
      "type": "Matter",
      "updated_at": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Update task

Update task.

Inputs

IdidnumberRequired
The unique identifier for the Task.
Assigneeassignee_idnumber
The assignee ID. Leave empty to keep the current value.At least 1.
Descriptiondescriptiontext
Longer description of the Task. This Task supports rich text when the `description_text_type` field is set to `rich_text`. With supported tags such as ` `, ` `, ` `, ` `, ` `, ` ` ` `, ` `, ` `, ` `, ` `, ` ` and ` `. This Task also supports attributes such as `href`, `rel`, `type`, and `target`.
Due atdue_atdate and time
Date when the Task must be completed by. (Expects an ISO-8601 date).
Mattermatter_idnumber
The matter ID. Leave empty to keep the current value.At least 1.
Namenametext
Name of the Task.
Priorityprioritytext
Priority of the Task.One of: High, Normal, Low.
Statusstatustext
Task status. Users without advanced tasks are allowed to select `Complete` or `Pending` only.One of: pending, in_progress, in_review, complete, draft.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "assignee": {},
      "assignees": [],
      "assigner": {},
      "completed_at": "",
      "created_at": "",
      "description": "",
      "description_text_type": "plain_text",
      "due_at": "",
      "etag": "",
      "id": 0,
      "matter": {},
      "name": "",
      "notify_completion": false,
      "permission": "",
      "priority": "High",
      "reminders": [],
      "status": "pending",
      "statute_of_limitations": false,
      "task_type": {},
      "time_entries": [],
      "time_entries_count": 0,
      "time_estimated": 0,
      "updated_at": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

On this page