Files stored in Clio’s Documents section are organized in folders. Folders are automatically generated for new Contacts and Matters. Folders can also be manually created anywhere in the folder structure. [Support Link](https://help.clio.com/hc/en-us/articles/9290308200091-Generate-Manage-and-Share-Documents#manage-documents-in-clio-manage-0-4)
openapi: 3.0.0
info:
title: Clio API Documentation Activities Folders 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: Folders
description: 'Files stored in Clio’s Documents section are organized in folders. Folders are automatically generated for new Contacts and Matters. Folders can also be manually created anywhere in the folder structure.
[Support Link](https://help.clio.com/hc/en-us/articles/9290308200091-Generate-Manage-and-Share-Documents#manage-documents-in-clio-manage-0-4)
'
paths:
/folders/list.json:
get:
tags:
- Folders
summary: Return the data of the contents of a Folder
operationId: Folder#list
description: 'Return the data of the contents of a Folder.
Note: offset pagination is not supported for this endpoint. Use cursor pagination if you''re looking to paginate through the results.
'
parameters:
- name: X-API-VERSION
in: header
description: 'The [API minor version](#section/Minor-Versions). Default: latest version.'
required: false
schema:
type: string
- name: contact_id
in: query
description: The unique identifier for a single Contact. Use the keyword `null` to match those without a Folder. The list will be filtered to include only the Folder records with the matching property.
required: false
schema:
type: integer
format: int64
- name: created_since
in: query
description: Filter Folder 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: document_category_id
in: query
description: The unique identifier for a single DocumentCategory. Use the keyword `null` to match those without a Folder. The list will be filtered to include only the Folder records with the matching property.
required: false
schema:
type: integer
format: int64
- name: external_property_name
in: query
description: 'Filter records to only those with the given external property(s) name set.
e.g. `?external_property_name=Name`
'
required: false
schema:
type: string
- name: external_property_value
in: query
description: 'Filter records to only those with the given external property(s) value set. Requires external property name as well.
e.g. `?external_property_name=Name&external_property_value=Value`
'
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: ids[]
in: query
description: Filter Folder records to those having the specified unique identifiers.
required: false
schema:
type: integer
format: int64
- name: include_deleted
in: query
description: Allow trashed Folder record to be included.
required: false
schema:
type: boolean
- name: limit
in: query
description: 'A limit on the number of Folder 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 Folder. The list will be filtered to include only the Folder records with the matching property.
required: false
schema:
type: integer
format: int64
- name: order
in: query
description: 'Orders the Folder records by the given field. Default: `id(asc)`.'
required: false
schema:
type: string
enum:
- id(asc)
- id(desc)
- document_number(asc)
- document_number(desc)
- name(asc)
- name(desc)
- updated_at(asc)
- updated_at(desc)
- created_at(asc)
- created_at(desc)
- received_at(asc)
- received_at(desc)
- name: page_token
in: query
description: A token specifying which page to return.
required: false
schema:
type: string
- name: parent_id
in: query
description: 'The unique identifier for a single Folder.
When returning the data of the contents of a Folder, the keyword `null` is not valid for this field. If no Folder is provided, it will default to the account''s root Folder.
When returning the data for all Folders, use the keyword `null` to match those without a Folder. The list will be filtered to include only the Folder records with the matching property.
'
required: false
schema:
type: integer
format: int64
- name: query
in: query
description: Wildcard search for `name` matching the given string.
required: false
schema:
type: string
- name: scope
in: query
description: Filters Folder record to those being a child of the parent Folder, or a descendant of the parent Folder. Default is `children`.
required: false
schema:
type: string
enum:
- descendants
- children
- name: show_uncompleted
in: query
description: Allow Folder record being uploaded to be included.
required: false
schema:
type: boolean
- name: updated_since
in: query
description: Filter Folder 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
responses:
'200':
description: Ok
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Item_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'
/folders.json:
get:
tags:
- Folders
summary: Return the data for all Folders
operationId: Folder#index
description: Outlines the parameters, optional and required, used when requesting the data for all Folders
parameters:
- name: X-API-VERSION
in: header
description: 'The [API minor version](#section/Minor-Versions). Default: latest version.'
required: false
schema:
type: string
- name: contact_id
in: query
description: The unique identifier for a single Contact. Use the keyword `null` to match those without a Folder. The list will be filtered to include only the Folder records with the matching property.
required: false
schema:
type: integer
format: int64
- name: created_since
in: query
description: Filter Folder 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: document_category_id
in: query
description: The unique identifier for a single DocumentCategory. Use the keyword `null` to match those without a Folder. The list will be filtered to include only the Folder records with the matching property.
required: false
schema:
type: integer
format: int64
- name: external_property_name
in: query
description: 'Filter records to only those with the given external property(s) name set.
e.g. `?external_property_name=Name`
'
required: false
schema:
type: string
- name: external_property_value
in: query
description: 'Filter records to only those with the given external property(s) value set. Requires external property name as well.
e.g. `?external_property_name=Name&external_property_value=Value`
'
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: ids[]
in: query
description: Filter Folder records to those having the specified unique identifiers.
required: false
schema:
type: integer
format: int64
- name: include_deleted
in: query
description: Allow trashed Folder record to be included.
required: false
schema:
type: boolean
- name: limit
in: query
description: 'A limit on the number of Folder 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 Folder. The list will be filtered to include only the Folder records with the matching property.
required: false
schema:
type: integer
format: int64
- name: order
in: query
description: 'Orders the Folder records by the given field. Default: `id(asc)`.'
required: false
schema:
type: string
enum:
- id(asc)
- id(desc)
- name(asc)
- name(desc)
- updated_at(asc)
- updated_at(desc)
- name: page_token
in: query
description: A token specifying which page to return.
required: false
schema:
type: string
- name: parent_id
in: query
description: 'The unique identifier for a single Folder.
When returning the data of the contents of a Folder, the keyword `null` is not valid for this field. If no Folder is provided, it will default to the account''s root Folder.
When returning the data for all Folders, use the keyword `null` to match those without a Folder. The list will be filtered to include only the Folder records with the matching property.
'
required: false
schema:
type: integer
format: int64
- name: query
in: query
description: Wildcard search for `name` matching the given string.
required: false
schema:
type: string
- name: scope
in: query
description: Filters Folder record to those being a child of the parent Folder, or a descendant of the parent Folder. Default is `children`.
required: false
schema:
type: string
enum:
- descendants
- children
- name: updated_since
in: query
description: Filter Folder 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
responses:
'200':
description: Ok
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Folder_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:
- Folders
summary: Create a new Folder
operationId: Folder#create
description: 'Create a Folder to an existing folder.
'
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/Folder_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 Folders
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
document_category:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single DocumentCategory associated with the Folder. Use the keyword `null` to specify no association.
external_properties:
type: array
items:
type: object
properties:
name:
type: string
description: 'The ExternalProperty name. Note: **there is a limit of 5 external_properties per Folder**'
value:
type: string
description: The ExternalProperty value.
name:
type: string
description: Name of the Folder
parent:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier of the parent object.
type:
type: string
enum:
- Folder
- Contact
- Matter
description: 'Type of parent object:
* "Folder" represents a specified folder on Clio by folder id. It if specified when you add / move an item to a folder.
* "Contact" represents a contact folder on Clio identified by contact id. It is specified when you add / move an item to a contact folder. A contact folder will be created for the specified contact if none exists already.
* "Matter" represents a matter folder on Clio identified by matter id. It is specified when you add / move an item to a matter folder.
'
required:
- id
- type
restore:
type: boolean
description: Whether or not a trashed Folder should be restored.
required:
- name
- parent
application/x-www-form-urlencoded:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
document_category:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single DocumentCategory associated with the Folder. Use the keyword `null` to specify no association.
external_properties:
type: array
items:
type: object
properties:
name:
type: string
description: 'The ExternalProperty name. Note: **there is a limit of 5 external_properties per Folder**'
value:
type: string
description: The ExternalProperty value.
name:
type: string
description: Name of the Folder
parent:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier of the parent object.
type:
type: string
enum:
- Folder
- Contact
- Matter
description: 'Type of parent object:
* "Folder" represents a specified folder on Clio by folder id. It if specified when you add / move an item to a folder.
* "Contact" represents a contact folder on Clio identified by contact id. It is specified when you add / move an item to a contact folder. A contact folder will be created for the specified contact if none exists already.
* "Matter" represents a matter folder on Clio identified by matter id. It is specified when you add / move an item to a matter folder.
'
required:
- id
- type
restore:
type: boolean
description: Whether or not a trashed Folder should be restored.
required:
- name
- parent
multipart/form-data:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
document_category:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier for a single DocumentCategory associated with the Folder. Use the keyword `null` to specify no association.
external_properties:
type: array
items:
type: object
properties:
name:
type: string
description: 'The ExternalProperty name. Note: **there is a limit of 5 external_properties per Folder**'
value:
type: string
description: The ExternalProperty value.
name:
type: string
description: Name of the Folder
parent:
type: object
properties:
id:
type: integer
format: int64
description: The unique identifier of the parent object.
type:
type: string
enum:
- Folder
- Contact
- Matter
description: 'Type of parent object:
* "Folder" represents a specified folder on Clio by folder id. It if specified when you add / move an item to a folder.
* "Contact" represents a contact folder on Clio identified by contact id. It is specified when you add / move an item to a contact folder. A contact folder will be created for the specified contact if none exists already.
* "Matter" represents a matter folder on Clio identified by matter id. It is specified when you add / move an item to a matter folder.
'
required:
- id
- type
restore:
type: boolean
description: Whether or not a trashed Folder should be restored.
required:
- name
- parent
required: false
/folders/{id}.json:
get:
tags:
- Folders
summary: Return the data for a single Folder
operationId: Folder#show
description: Outlines the parameters, optional and required, used when requesting the data for a single Folder
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 Folder.
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Ok
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Folder_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:
- Folders
summary: Update a single Folder
operationId: Folder#update
description: 'Update Folder, move Folder to another Folder, and/or restore a trashed Folder.
'
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 availab
# --- truncated at 32 KB (66 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clio/refs/heads/main/openapi/clio-folders-api-openapi.yml