openapi: 3.0.0
info:
title: Clio API Documentation Activities API
contact:
name: Clio API Support
email: api@clio.com
description: "# Developer Support and Feedback\n* Clio takes the availability and stability of our API seriously; please report any **degradations** or **breakages** to Clio's API Support team at [api@clio.com](mailto:api@clio.com).\n* For business and partnership inquiries, contact our API Partnerships team at [api.partnerships@clio.com](mailto:api.partnerships@clio.com).\n* For best practices and tips from the Clio development community, join the conversation in the [Clio Developer Slack Channel](https://join.slack.com/t/clio-public/shared_invite/zt-36i0eqgo1-7POORPtMJpp2N0~_auL2IQ).\n\nA community-driven [Clio Developers Stack Overflow Group](https://stackoverflow.com/questions/tagged/clio-api) also exists where you can connect and ask questions from other Clio API users.\n# Getting Started\n> **Note:** The API is available in four distinct data regions: Australia (au.app.clio.com), Canada (ca.app.clio.com), EU (eu.app.clio.com) and US (app.clio.com).\n>\n> Likewise, the developer portal is available at region-specific links for the [Australia](https://au.developers.clio.com), [Canada](https://ca.developers.clio.com), [EU](https://eu.developers.clio.com), and [US](https://developers.clio.com) regions.\n>\n> This document assumes the US region is being used (app.clio.com). If you're building in one of the other regions, you should adapt the links and examples as necessary.\n\nTo start building on the Clio API, you’ll need a Clio account – you can review our [Developer Handbook](https://docs.developers.clio.com/) and follow the steps to sign up for an account.\n\nOnce you have an account, you can [create a developer application](https://docs.developers.clio.com/api-docs/applications) from the [Developer Portal](https://developers.clio.com) and start building!\n# Authorization with OAuth 2.0\nSee our [Authorization documentation →](https://docs.developers.clio.com/api-docs/authorization)\n# Permissions\nSee our [Permissions documentation →](https://docs.developers.clio.com/api-docs/permissions)\n# Fields\nSee our [Fields documentation →](https://docs.developers.clio.com/api-docs/fields)\n# Rate Limiting\nSee our [Rate Limits documentation →](https://docs.developers.clio.com/api-docs/rate-limits)\n# Paging\nSee our [Pagination documentation →](https://docs.developers.clio.com/api-docs/paging)\n# ETags\nSee our [ETags documentation →](https://docs.developers.clio.com/api-docs/etags)\n# Minor Versions\nAPI v4 supports multiple minor versions. Versions are of the form '4.X.Y'. To request a specific version, you can use an `X-API-VERSION` header in your request, with the header value set to the API version you're requesting. If this header is omitted, it will be treated as a request for the default API version. If the header is present but invalid, it will return a `410 Gone` response. If the header is present and valid, but it is no longer supported, it will return a `410 Gone` response.\n\nAn `X-API-VERSION` will be included in all successful responses, with the value being set to the API version used.\n\nYou can find our [API Versioning Policy and Guidelines](https://docs.developers.clio.com/api-docs/api-versioning-policy) in our documentation hub.\n\nThe [API Changelog](https://docs.developers.clio.com/api-docs/api-changelog) explains each version's changes in further detail.\n### [4.0.4](https://docs.developers.clio.com/api-docs/api-changelog#404)\n\n * Update `quantity` field to return values in seconds rather than hours for Activities\n\n### [4.0.5](https://docs.developers.clio.com/api-docs/api-changelog#405)\n\n * Remove `matter_balances` field from Bills\n* Standardize status/state enum values\n* Add a Document association to completed DocumentAutomations\n* Add rate visibility handling for Activity's price and total\n\n### [4.0.6](https://docs.developers.clio.com/api-docs/api-changelog#406)\n\n * Remove `document_versions` collection field from Documents\n\n### [4.0.7](https://docs.developers.clio.com/api-docs/api-changelog#407)\n\n * Change secure link format\n\n### [4.0.8](https://docs.developers.clio.com/api-docs/api-changelog#408)\n\n * `Activity` hours are redacted in the response based on the activity hours visibility setting for the user\n * Add `quantity_redacted` field to activities\n\n### [4.0.9](https://docs.developers.clio.com/api-docs/api-changelog#409)\n\n * Contacts are filtered and redacted in the response based on the new 'Contacts Visibility' user permission setting.\n\n### [4.0.10](https://docs.developers.clio.com/api-docs/api-changelog#4010)\n\n * Fixed validation of `type` query parameter when querying Notes\n\n### [4.0.12](https://docs.developers.clio.com/api-docs/api-changelog#4012)\n\n * Restrict fields for CalendarEntry that should only be visible to event owners, editors, and viewers\n\n### [4.0.13](https://docs.developers.clio.com/api-docs/api-changelog#4013)\n\n **This is the default version**\n\n * Add association limits to Contacts\n* Returns 422 Unprocessable Entity when association limits are exceeded\n\n\n"
version: v4
x-logo:
url: https://www.clio.com/wp-content/uploads/2015/05/Container-5-Logo.png
servers:
- url: https://app.clio.com/api/v4
description: US region Production Server
- url: https://eu.app.clio.com/api/v4
description: Europe region Production Server
- url: https://ca.app.clio.com/api/v4
description: Canada region Production Server
- url: https://au.app.clio.com/api/v4
description: Australia region Production Server
tags:
- name: Activities
description: 'Activities (Time Entries and Expense Entries) track work done at a firm. Activities are recorded in Clio and then posted on bills to clients.
Time Entries can be either be hourly-billable or flat-rate. An hourly-billable Time Entry is valued at the billing rate multiplied by the time entered. Examples could be a phone call, or a research session. A flat-rate Time Entry has a set value. Examples could be a visa application, or a contract review.
Expenses are reimbursable costs the firm pays on behalf of a client (for example, postage, copy fees, etc.).
[Support Link](https://help.clio.com/hc/en-us/sections/9036198517915-Activities)
[Activities in Clio](http://app.clio.com/activities)
'
paths:
/activities.json:
get:
tags:
- Activities
summary: Return the data for all Activities
operationId: Activity#index
description: Outlines the parameters, optional and required, used when requesting the data for all Activities
parameters:
- name: X-API-VERSION
in: header
description: 'The [API minor version](#section/Minor-Versions). Default: latest version.'
required: false
schema:
type: string
- name: activity_description_id
in: query
description: The unique identifier for a single ActivityDescription. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.
required: false
schema:
type: integer
format: int64
- name: calendar_entry_id
in: query
description: The unique identifier for a single CalendarEntry. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.
required: false
schema:
type: integer
format: int64
- name: communication_id
in: query
description: The unique identifier for a single Communication. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.
required: false
schema:
type: integer
format: int64
- name: contact_note_id
in: query
description: The unique identifier for a single Note. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.
required: false
schema:
type: integer
format: int64
- name: created_since
in: query
description: Filter Activity records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
required: false
schema:
type: string
format: date-time
- name: end_date
in: query
description: Filter Activity records to those whose `date` is on or before the date provided (Expects an ISO-8601 date).
required: false
schema:
type: string
format: date-time
- name: expense_category_id
in: query
description: The unique identifier for a single ExpenseCategory. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.
required: false
schema:
type: integer
format: int64
- name: fields
in: query
description: The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
required: false
schema:
type: string
- name: flat_rate
in: query
description: Filter Activity TimeEntry records to those that have a flat rate, or not.
required: false
schema:
type: boolean
- name: grant_id
in: query
description: The unique identifier for a single Grant. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.
required: false
schema:
type: integer
format: int64
- name: ids[]
in: query
description: Filter Activity records to those having the specified unique identifiers.
required: false
schema:
type: integer
format: int64
- name: limit
in: query
description: 'A limit on the number of Activity records to be returned. Limit can range between 1 and 200. Default: `200`.'
required: false
schema:
type: integer
format: int32
- name: matter_id
in: query
description: The unique identifier for a single Matter. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.
required: false
schema:
type: integer
format: int64
- name: matter_note_id
in: query
description: The unique identifier for a single Note. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.
required: false
schema:
type: integer
format: int64
- name: only_unaccounted_for
in: query
description: Only unaccounted for activities.
required: false
schema:
type: boolean
- name: order
in: query
description: 'Orders the Activity records by the given field. Default: `id(asc)`.'
required: false
schema:
type: string
enum:
- id(asc)
- id(desc)
- display_number(asc)
- display_number(desc)
- user.name(asc)
- user.name(desc)
- price(asc)
- price(desc)
- total(asc)
- total(desc)
- type(asc)
- type(desc)
- date(asc)
- date(desc)
- note(asc)
- note(desc)
- updated_at(asc)
- updated_at(desc)
- vendor.name(asc)
- vendor.name(desc)
- expense_category.name(asc)
- expense_category.name(desc)
- non_billable(asc)
- non_billable(desc)
- non_billable_total(asc)
- non_billable_total(desc)
- name: page_token
in: query
description: A token specifying which page to return.
required: false
schema:
type: string
- name: query
in: query
description: Wildcard search for `note` matching a given string.
required: false
schema:
type: string
- name: start_date
in: query
description: Filter Activity records to those whose `date` is on or after the date provided (Expects an ISO-8601 date).
required: false
schema:
type: string
format: date-time
- name: status
in: query
description: Filter Activity records to those that are draft, billed, unbilled or non-billable.
required: false
schema:
type: string
enum:
- billed
- draft
- unbilled
- non_billable
- billable
- written_off
- name: task_id
in: query
description: The unique identifier for a single Task. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.
required: false
schema:
type: integer
format: int64
- name: type
in: query
description: Filter Activity records to those of a specific type.
required: false
schema:
type: string
enum:
- TimeEntry
- ExpenseEntry
- HardCostEntry
- SoftCostEntry
- name: updated_since
in: query
description: Filter Activity records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).
required: false
schema:
type: string
format: date-time
- name: user_id
in: query
description: The unique identifier for a single User. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.
required: false
schema:
type: integer
format: int64
responses:
'200':
description: Ok
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Activity_List'
'400':
description: Bad Request
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Too Many Requests
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
post:
tags:
- Activities
summary: Create a new Activity
operationId: Activity#create
description: Outlines the parameters and data fields used when creating a new Activity
parameters:
- name: X-API-VERSION
in: header
description: 'The [API minor version](#section/Minor-Versions). Default: latest version.'
required: false
schema:
type: string
- name: fields
in: query
description: The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
required: false
schema:
type: string
responses:
'201':
description: Created
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Activity_Show'
'400':
description: Bad Request
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'422':
description: Unprocessable Entity
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Too Many Requests
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
requestBody:
description: Request Body for Activities
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
activity_description:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single ActivityDescription associated with the Activity. The keyword `null` is not valid for this field.
utbms_task_id:
type: integer
format: int64
description: The unique identifier for a single UtbmsTask associated with the Activity. The keyword `null` is not valid for this field.
utbms_activity_id:
type: integer
format: int64
description: The unique identifier for a single UtbmsActivity associated with the Activity. The keyword `null` is not valid for this field.
calendar_entry:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single CalendarEntry associated with the Activity. The keyword `null` is not valid for this field.
client_portal:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single ClientPortal associated with the Activity. The keyword `null` is not valid for this field.
communication:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single Communication associated with the Activity. The keyword `null` is not valid for this field.
contact_note:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single Note associated with the Activity. The keyword `null` is not valid for this field.
date:
type: string
format: date
description: The date the Activity was performed. (Expects an ISO-8601 date).
expense_category:
type: object
properties:
id:
type: integer
format: int64
description: 'The unique identifier for a single ExpenseCategory associated with an Activity.
Use the keyword `null` to specify no association.
'
matter:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single Matter associated with the Activity. The keyword `null` is not valid for this field.
matter_note:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single Note associated with the Activity. The keyword `null` is not valid for this field.
no_charge:
type: boolean
description: Whether the non-billable *Activity* will be shown on the bill.
non_billable:
type: boolean
description: 'Whether or not this Activity is prevented from appearing as a line item in a bill.
Only valid for non-billed TimeEntries, and with the exception of the Activity having no_charge set to true.
'
note:
type: string
description: A custom note to describe what the Activity is for.
price:
type: number
format: double
description: 'For an ExpenseEntry, HardCostEntry, and SoftCostEntry, it is the expense amount.
[Support Link for ExpenseEntry](https://help.clio.com/hc/en-us/articles/9289745356571-Expenses)
[Support Link for HardCostEntry and SoftCostEntry](https://help.clio.com/hc/en-us/articles/9289745356571-Expenses#enable-hard-and-soft-cost-expenses-0-0)
For a TimeEntry, it is the hourly or flat amount. When updating a TimeEntry,
if the price is not given or the user does not have the permission to view the rate,
and its activity description, matter and/or user is changed,
the price is reset according to the rate defined for the activity description, matter, client or user.
[Support Link for Rates Hierarchy](https://help.clio.com/hc/en-us/articles/9289801180187-Rates-and-Rate-Hierarchies-)
[Support Link for Billing Rate Visibility](https://help.clio.com/hc/en-us/articles/9285360193819-Permissions-and-Billing-Rates#billing-rate-visibility-0-3)
'
quantity:
type: number
format: double
description: 'The field is applicable to TimeEntry, ExpenseEntry, and SoftCostEntry.
**Version <= 4.0.3:**
The number of hours the TimeEntry took.
**Latest version:**
The number of seconds the TimeEntry took.
'
reference:
type: string
description: A check reference for a HardCostEntry.
start_timer:
type: boolean
description: Whether or not a timer should be started for this Activity. Only valid for non-FlatRate, non-billed TimeEntries.
task:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single Task associated with the Activity. The keyword `null` is not valid for this field.
tax_setting:
type: string
enum:
- no_tax
- tax_1_only
- tax_2_only
- tax_1_and_tax_2
description: The option denoting whether primary tax, secondary tax, or both is applied to an expense entry.
tax_settings:
type: array
items:
type: object
properties:
tax_rate_configuration_id:
type: integer
format: int64
description: The unique identifier of the tax rate configuration.
order:
type: integer
format: int32
description: The order in which the tax setting should be applied.
rule:
type: string
enum:
- Pre
- Post
description: The rule determining when the tax setting should be applied
required:
- tax_rate_configuration_id
- order
description: Array of objects, with each object representing a tax setting that is applied to an expense entry with 'tax_rate_configuration_id', 'order', and 'rule' as the object properties.
text_message_conversation:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single TextMessageConversation associated with the Activity. The keyword `null` is not valid for this field.
type:
type: string
enum:
- TimeEntry
- ExpenseEntry
- HardCostEntry
- SoftCostEntry
description: The type of the Activity.
user:
type: object
properties:
id:
type: integer
format: int64
description: 'The unique identifier for a single User associated with the Activity.
Use the keyword `null` to specify no association.
On creation, if no user is specified, it will default to the current user.
If a TimeEntry is created by a Clio Connect user, the field is not editable.
'
utbms_expense:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single UtbmsExpense associated with the Activity. The keyword `null` is not valid for this field.
vendor:
type: object
properties:
id:
type: integer
format: int64
description: 'The unique identifier for a single Contact associated with a HardCostEntry.
Use the keyword `null` to specify no association.
'
required:
- type
- date
application/x-www-form-urlencoded:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
activity_description:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single ActivityDescription associated with the Activity. The keyword `null` is not valid for this field.
utbms_task_id:
type: integer
format: int64
description: The unique identifier for a single UtbmsTask associated with the Activity. The keyword `null` is not valid for this field.
utbms_activity_id:
type: integer
format: int64
description: The unique identifier for a single UtbmsActivity associated with the Activity. The keyword `null` is not valid for this field.
calendar_entry:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single CalendarEntry associated with the Activity. The keyword `null` is not valid for this field.
client_portal:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single ClientPortal associated with the Activity. The keyword `null` is not valid for this field.
communication:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single Communication associated with the Activity. The keyword `null` is not valid for this field.
contact_note:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single Note associated with the Activity. The keyword `null` is not valid for this field.
date:
type: string
format: date
description: The date the Activity was performed. (Expects an ISO-8601 date).
expense_category:
type: object
properties:
id:
type: integer
format: int64
description: 'The unique identifier for a single ExpenseCategory associated with an Activity.
Use the keyword `null` to specify no association.
'
matter:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single Matter associated with the Activity. The keyword `null` is not valid for this field.
matter_note:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single Note associated with the Activity. The keyword `null` is not valid for this field.
no_charge:
type: boolean
d
# --- truncated at 32 KB (128 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clio/refs/heads/main/openapi/clio-activities-api-openapi.yml