Activity Descriptions are custom Time Entry templates. Activity Descriptions help firms expedite their process for recording Time Entries, and ensure that their Time Entry descriptions are consistent. [Support Link](https://help.clio.com/hc/en-us/articles/9289744400667-Activity-Categories) [Activity Descriptions in Clio](https://app.clio.com/nc/#/activity_categories)
openapi: 3.0.0
info:
title: Clio API Documentation Activities Activity Descriptions 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: Activity Descriptions
description: 'Activity Descriptions are custom Time Entry templates. Activity Descriptions help firms expedite their process for recording Time Entries, and ensure that their Time Entry descriptions are consistent.
[Support Link](https://help.clio.com/hc/en-us/articles/9289744400667-Activity-Categories)
[Activity Descriptions in Clio](https://app.clio.com/nc/#/activity_categories)
'
paths:
/activity_descriptions.json:
get:
tags:
- Activity Descriptions
summary: Return the data for all ActivityDescriptions
operationId: ActivityDescription#index
description: Outlines the parameters, optional and required, used when requesting the data for all ActivityDescriptions
parameters:
- name: X-API-VERSION
in: header
description: 'The [API minor version](#section/Minor-Versions). Default: latest version.'
required: false
schema:
type: string
- name: created_since
in: query
description: Filter ActivityDescription 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: 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 ActivityDescription records to those that have a flat rate, or not.
required: false
schema:
type: boolean
- name: ids[]
in: query
description: Filter ActivityDescription 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 ActivityDescription records to be returned. Limit can range between 1 and 200. Default: `200`.'
required: false
schema:
type: integer
format: int32
- name: page_token
in: query
description: A token specifying which page to return.
required: false
schema:
type: string
- name: rate_for[matter_id]
in: query
description: Matter id for rate calculation.
required: false
schema:
type: integer
format: int64
- name: rate_for[user_id]
in: query
description: User id for rate calculation. If not provided, the user associated to the API request is assumed.
required: false
schema:
type: integer
format: int64
- name: type
in: query
description: Filter ActivityDescription records to those of a specific type.
required: false
schema:
type: string
enum:
- utbms
- clio
- name: updated_since
in: query
description: Filter ActivityDescription 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. The keyword `null` is not valid for this field. The list will be filtered to include only the ActivityDescription 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/ActivityDescription_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:
- Activity Descriptions
summary: Create a new ActivityDescription
operationId: ActivityDescription#create
description: Outlines the parameters and data fields used when creating a new ActivityDescription
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/ActivityDescription_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 Activity Descriptions
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
currency:
type: object
description: Currency of the ActivityDescription.
default:
type: boolean
description: Whether or not this should be the API User's default ActivityDescription.
groups:
type: array
items:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single Group associated with the ActivityDescription. The keyword `null` is not valid for this field.
name:
type: string
description: A detailed description of the ActivityDescription.
rate:
type: object
properties:
amount:
type: number
format: double
default: 0
description: The rate of the ActivityDescription. This is ignored for 'User' rates.
non_billable_amount:
type: number
format: double
default: 0
description: The non billable rate of the ActivityDescription. This is ignored for 'User' rates.
type:
type: string
enum:
- User
- FlatRate
- Custom
description: What kind of rate it will be.
visible_to_co_counsel:
type: boolean
description: Whether or not co counsels on the account can see this ActivityDescription.
required:
- name
application/x-www-form-urlencoded:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
currency:
type: object
description: Currency of the ActivityDescription.
default:
type: boolean
description: Whether or not this should be the API User's default ActivityDescription.
groups:
type: array
items:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single Group associated with the ActivityDescription. The keyword `null` is not valid for this field.
name:
type: string
description: A detailed description of the ActivityDescription.
rate:
type: object
properties:
amount:
type: number
format: double
default: 0
description: The rate of the ActivityDescription. This is ignored for 'User' rates.
non_billable_amount:
type: number
format: double
default: 0
description: The non billable rate of the ActivityDescription. This is ignored for 'User' rates.
type:
type: string
enum:
- User
- FlatRate
- Custom
description: What kind of rate it will be.
visible_to_co_counsel:
type: boolean
description: Whether or not co counsels on the account can see this ActivityDescription.
required:
- name
multipart/form-data:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
currency:
type: object
description: Currency of the ActivityDescription.
default:
type: boolean
description: Whether or not this should be the API User's default ActivityDescription.
groups:
type: array
items:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single Group associated with the ActivityDescription. The keyword `null` is not valid for this field.
name:
type: string
description: A detailed description of the ActivityDescription.
rate:
type: object
properties:
amount:
type: number
format: double
default: 0
description: The rate of the ActivityDescription. This is ignored for 'User' rates.
non_billable_amount:
type: number
format: double
default: 0
description: The non billable rate of the ActivityDescription. This is ignored for 'User' rates.
type:
type: string
enum:
- User
- FlatRate
- Custom
description: What kind of rate it will be.
visible_to_co_counsel:
type: boolean
description: Whether or not co counsels on the account can see this ActivityDescription.
required:
- name
required: false
/activity_descriptions/{id}.json:
get:
tags:
- Activity Descriptions
summary: Return the data for a single ActivityDescription
operationId: ActivityDescription#show
description: Outlines the parameters, optional and required, used when requesting the data for a single ActivityDescription
parameters:
- name: IF-MODIFIED-SINCE
in: header
description: The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).
required: false
schema:
type: string
format: date
- name: IF-NONE-MATCH
in: header
description: The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.
required: false
schema:
type: string
- 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
- name: id
in: path
description: The unique identifier for the ActivityDescription.
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Ok
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ActivityDescription_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'
'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'
'304':
description: Not Modified
patch:
tags:
- Activity Descriptions
summary: Update a single ActivityDescription
operationId: ActivityDescription#update
description: Outlines the parameters and data fields used when updating a single ActivityDescription
parameters:
- name: IF-MATCH
in: header
description: The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).
required: false
schema:
type: string
- 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
- name: id
in: path
description: The unique identifier for the ActivityDescription.
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Ok
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ActivityDescription_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'
'412':
description: Precondition Failed
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
requestBody:
description: Request Body for Activity Descriptions
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
currency:
type: object
description: Currency of the ActivityDescription.
default:
type: boolean
description: Whether or not this should be the API User's default ActivityDescription.
groups:
type: array
items:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single Group associated with the ActivityDescription. The keyword `null` is not valid for this field.
_deleted:
type: boolean
description: A flag to determine if this Group should lose access to this ActivityDescription.
name:
type: string
description: A detailed description of the ActivityDescription.
rate:
type: object
properties:
amount:
type: number
format: double
default: 0
description: The rate of the ActivityDescription. This is ignored for 'User' rates.
non_billable_amount:
type: number
format: double
default: 0
description: The non billable rate of the ActivityDescription. This is ignored for 'User' rates.
type:
type: string
enum:
- User
- FlatRate
- Custom
description: What kind of rate it will be.
visible_to_co_counsel:
type: boolean
description: Whether or not co counsels on the account can see this ActivityDescription.
application/x-www-form-urlencoded:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
currency:
type: object
description: Currency of the ActivityDescription.
default:
type: boolean
description: Whether or not this should be the API User's default ActivityDescription.
groups:
type: array
items:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single Group associated with the ActivityDescription. The keyword `null` is not valid for this field.
_deleted:
type: boolean
description: A flag to determine if this Group should lose access to this ActivityDescription.
name:
type: string
description: A detailed description of the ActivityDescription.
rate:
type: object
properties:
amount:
type: number
format: double
default: 0
description: The rate of the ActivityDescription. This is ignored for 'User' rates.
non_billable_amount:
type: number
format: double
default: 0
description: The non billable rate of the ActivityDescription. This is ignored for 'User' rates.
type:
type: string
enum:
- User
- FlatRate
- Custom
description: What kind of rate it will be.
visible_to_co_counsel:
type: boolean
description: Whether or not co counsels on the account can see this ActivityDescription.
multipart/form-data:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
currency:
type: object
description: Currency of the ActivityDescription.
default:
type: boolean
description: Whether or not this should be the API User's default ActivityDescription.
groups:
type: array
items:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single Group associated with the ActivityDescription. The keyword `null` is not valid for this field.
_deleted:
type: boolean
description: A flag to determine if this Group should lose access to this ActivityDescription.
name:
type: string
description: A detailed description of the ActivityDescription.
rate:
type: object
properties:
amount:
type: number
format: double
default: 0
description: The rate of the ActivityDescription. This is ignored for 'User' rates.
non_billable_amount:
type: number
format: double
default: 0
description: The non billable rate of the ActivityDescription. This is ignored for 'User' rates.
type:
type: string
enum:
- User
- FlatRate
- Custom
description: What kind of rate it will be.
visible_to_co_counsel:
type: boolean
description: Whether or not co counsels on the account can see this ActivityDescription.
required: false
delete:
tags:
- Activity Descriptions
summary: Delete a single ActivityDescription
operationId: ActivityDescription#destroy
description: Outlines the parameters, optional and required, used when deleting the
# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clio/refs/heads/main/openapi/clio-activity-descriptions-api-openapi.yml