openapi: 3.0.0 info: title: Clio API Documentation Activities Matters 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: Matters description: "[Matters](https://help.clio.com/hc/en-us/articles/9285920226075-Clio-Manage-Matters-Overview) in Clio represent a firm’s cases. All relevant information—Bills, Documents, Time Entries, etc.—are contained in the Matter. A user’s ability to access a Matter is controlled by the [Matter Permission settings](https://help.clio.com/hc/en-us/articles/9286062516123-Matter-Permissions-and-Rates). A user without permission will be unable to view or update a Matter.\n\n[Support Link](https://help.clio.com/hc/en-us/articles/9285920226075-Clio-Manage-Matters-Overview)\n\n[Matters in Clio](http://app.clio.com/matters)\n\n## Associations\nA Matter can be persisted with its associations in a single request. The followings detail the nested attributes to persist the associations.\n\n### Custom Field Values\nA CustomFieldValue contains the value of a CustomField for a Matter.\nBelow are some examples of how to create, read, update, and destroy the CustomFieldValues of a Matter:\n#### Create\nNote: The value of `id` used here is the value of the `id` parameter in the response received when [creating a new CustomField](https://docs.developers.clio.com/clio-manage/api-reference/#tag/Custom-Fields/operation/CustomField#create) or one returned in a [query of an existing CustomField](https://docs.developers.clio.com/clio-manage/api-reference/#tag/Custom-Fields/operation/CustomField#show).\n```json\nRequest\n PATCH /api/v4/matters/1.json\n {\n data: {\n custom_field_values: [\n { custom_field: { id: 2 }, value: \"Initial value\" }\n ]\n }\n }\n```\n#### Read\nNote: The `id` of the CustomFieldValue is a composite value including the custom field type. Use this `id` to update and destroy the CustomFieldValue.\nThe `id` of the associated Custom Field can be found by querying the `custom_field` for all CustomFieldValues related to the Matter, e.g.: `/api/v4/matters/1?fields=id,display_number,custom_field_values{id,value,custom_field}`\n\nNote: The `id` may be `NULL` when the CustomField is displayed by default but has not yet been given a value.\n```json\nRequest\n GET /api/v4/matters/1.json?fields=custom_field_values{id,value,custom_field}\n {\n data: {\n custom_field_values: [\n {\n id: \"text_line-1\",\n value: \"Current value\",\n custom_field: { id: 2 }\n }\n ]\n }\n }\n```\n#### Update\nNote: The value of the CustomFieldValue `id` used here is a composite value and can be found by querying for all CustomFieldValues related to the Matter, e.g.: `/api/v4/matters/1?fields=id,display_number,custom_field_values{id,value,custom_field}`\n\nNote: If the `id` is `NULL`, you must provide `custom_field{id}` to create the CustomFieldValue and assign a value (see **Create**).\n```json\nRequest\n PATCH /api/v4/matters/1.json\n {\n data: {\n custom_field_values: [\n { id: \"text_line-1\", value: \"Updated value\" }\n ]\n }\n }\n```\n#### Destroy\nNote: The value of the CustomFieldValue `id` used here is a composite value and can be found by querying for all CustomFieldValues related to the Matter, e.g.: `/api/v4/matters/1?fields=id,display_number,custom_field_values{id,value}`\n```json\nRequest\n PATCH /api/v4/matters/1.json\n {\n data: {\n custom_field_values: [\n { id: \"picklist-2\", _destroy: true }\n ]\n }\n }\n```\n\n### Custom Rates\nEach Matter can be set up to be billed on an Hourly basis, Flat Fee basis, or on Contingency.\nTo set the rate type, assign `custom_rate[type]` with one of the values, `\"HourlyRate\"`, `\"FlatRate\"` or `\"ContingencyFee\"`.\nBy default, a Matter is billed on an hourly basis. If the rate type is modified, the persisted rates will be deleted.\n\n[Support Link](https://help.clio.com/hc/en-us/articles/9289801180187)\n\n#### Hourly Rates\nSelecting the `\"HourlyRate\"` type will record time entries based on the custom hourly rates.\nA custom hourly rate can be associated to a User or a Group.\nCheckout the sample request to update the hourly rates of a Matter:\n```json\nRequest\n PATCH /api/v4/matters/1.json\n {\n data: {\n custom_rate: {\n type: \"HourlyRate\",\n rates: [\n // update a rate for a user\n { id: 1, rate: 100, user: { id: 1 } },\n // update a rate for a group\n { id: 2, rate: 100, group: { id: 1 } },\n // create a rate for a user\n { rate: 100, user: { id: 2 } },\n // create a rate for a group\n { rate: 100, group: { id: 2 } },\n // destroy a rate\n { id: 3, _destroy: true }\n ]\n }\n }\n }\n```\n\n#### Flat Rate\nSelecting the `\"FlatRate\"` type will bill the matter with a flat fee. A Matter can only have one flat rate.\nFor associated objects, you can specify `_destroy` attribute to delete the rate.\n\nCheckout the sample request to update the flat rate of a Matter:\n```json\nRequest\n PATCH /api/v4/matters/1.json\n {\n data: {\n custom_rate: {\n type: \"FlatRate\",\n rates: [\n {\n id: 1,\n user: { id: 1 },\n activity_description: { id: 1 },\n rate: 100,\n }\n ]\n }\n }\n }\n```\n\n#### Contingency Fee\nSelecting the `\"ContingencyFee\"` type will specify a contingency fee percentage on a Matter and the award or settlement amount won at the completion of the case.\nA Matter can only have one definition of contingency fee.\nFor associated objects, you can specify `_destroy` attribute to delete the rate.\n\nContingency Fee Matters are not available to all plan types. See [here](https://www.clio.com/pricing/) for feature support across different plans.\n\nCheckout the sample request to update the contingency fee of a Matter:\n```json\nRequest\n PATCH /api/v4/matters/1.json\n {\n data: {\n custom_rate: {\n type: \"ContingencyFee\",\n rates: [\n {\n id: 1,\n user: { id: 1 },\n rate: 20,\n }\n ]\n }\n }\n }\n```\n### Matter Budget\nClio supports tracking a matter budget directly within a Matter.\nA Matter can only have one matter budget associated with it.\nA matter budget can not be added to flat rate matters.\nFor associated objects, you can specify the `_destroy` attribute to delete the Matter Budget.\n\nMatter Budget are not available to all plan types. See [here](https://www.clio.com/pricing/) for feature support across different plans.\n\nCheck out the sample request to update the matter budget of a Matter:\n```json\nRequest\n PATCH /api/v4/matters/1.json\n {\n data: {\n matter_budget: {\n budget: 5000000,\n include_expenses: true,\n notification_threshold: 100,\n notify_users: true\n users: [\n { id: 1 },\n // destroy\n { id: 2, _destroy: true }\n ]\n }\n }\n }\n```\n### Grant Matter\nClio supports associating a Grant with a Matter, using Grant Matters.\nA Matter can have up to three Grants (and Grant Matters) associated with it.\nFor associated objects, you can specify the `_destroy` attribute to delete Grant Matters.\n\nGrant Matters are only for legal aid US customers\n\nCheckout the sample request to update a Grant Matter:\n```json\nRequest\n PATCH /api/v4/matters/1.json\n {\n data: {\n \"grant_matters\": [\n {\"id\":{{existing_grant_matter_id}}}\n ]\n }\n }\n ```\n### Relationships\nThere are people and/or companies related to a Matter other than the client of the lawyer. Clio helps define how the entities relate to a Matter.\n\n#### Please be advised that the use of the relationships field below is discouraged. We plan to deprecate it in the future. Please use [Relationships](https://docs.developers.clio.com/clio-manage/api-reference/#tag/Relationships) instead.\n\nCheckout the sample request to update Relationships of a Matter:\n```json\nRequest\n PATCH /api/v4/matters/1.json\n {\n data: {\n relationships: [\n // update\n { id: 1, contact: { id: 1 }, description: \"Opposing Counsel\" },\n // create\n { contact: { id: 2 }, description: \"Judge\" },\n // destroy\n { id: 2, _destroy: true }\n ]\n }\n }\n```\n\n### Statue Of Limitations\nClio supports to track a Statute of Limitations date directly within a Matter.\nIt can be associated with reminders as a Task.\nA Matter can only have one definition of Statue of Limitations.\nFor associated objects, you can specify `_destroy` attribute to delete the Statue of Limitations.\n\nCheck out the sample request to update the Statue of Limitations and its reminders of a Matter:\n```json\nRequest\n PATCH /api/v4/matters/1.json\n {\n data: {\n statue_of_limitations: [\n due_at: \"20201231\",\n status: \"open\",\n reminders: [\n // update\n { id: 1, duration_unit: \"days\", duration_value: 1, notification_method: { id: 1 } },\n // create\n { duration_unit: \"days\", duration_value: 1, notification_method: { id: 2 } },\n // destroy\n { id: 2, _destroy: true }\n ]\n ]\n }\n }\n```\n\n### Task Template Lists\nClio supports assigning task template lists to a matter from with the same request that\ncreates or updates a matter. Please note that a task template list **can only be\nassigned**. Once a task template list is assigned, it **cannot be modified or destroyed**.\n\nCheckout the sample request to assign a task template list id to a matter:\n\n```json\nRequest\n PATCH /api/v4/matters/1.json\n {\n data: {\n task_template_list_instances: [\n {\n notify_assignees: true,\n task_template_list: {id: 1},\n },\n {\n notify_assignees: false,\n task_template_list: {id: 2},\n }\n ],\n }\n }\n```\n" paths: /matters.json: get: tags: - Matters summary: Return the data for all Matters operationId: Matter#index description: Outlines the parameters, optional and required, used when requesting the data for all Matters parameters: - name: X-API-VERSION in: header description: 'The [API minor version](#section/Minor-Versions). Default: latest version.' required: false schema: type: string - name: billable in: query description: Filter Matter records to those which are billable. required: false schema: type: boolean - name: client_id in: query description: 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 Matter records with the matching property. required: false schema: type: integer format: int64 - name: close_date[] in: query description: 'Filter Matter records by the close date. The date should be provided in the format YYYY-MM-DD. e.g. `?close_date==2020-01-01`, `?close_date=<=2021-12-31` You can provide more than one value to narrow the results of this filter. You can do so by passing several individual values and appending `[]` to the parameter name. e.g. `?close_date[]=>=2020-01-01&close_date[]=<=2021-12-31` Note that, when providing multiple values for this filter, only Matter records that meet *all* filter conditions will be returned. ' required: false schema: type: string enum: - '>DATE' - '>=DATE' - =DATE - <=DATE - `, `<=`, `>=` e.g. `?custom_field_values[1]=>=105.4` * `email`, `text_area`, `text_line`, `url` : `=` e.g. `?custom_field_values[1]=url_encoded` *Multiple conditions for the same custom field:* If you want to use more than one operator to filter a custom field, you can do so by passing in an array of values. e.g. `?custom_field_values[1]=[<=50, >=45]` ' required: false schema: type: string enum: - '=' - < - '>' - <= - '>=' - 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: grant_id in: query description: The unique identifier for a single Grant. Use the keyword `null` to match those without a Matter. The list will be filtered to include only the Matter records with the matching property. required: false schema: type: integer format: int64 - name: group_id in: query description: The unique identifier for a single Group. The keyword `null` is not valid for this field. The list will be filtered to include only the Matter records with the matching property. required: false schema: type: integer format: int64 - name: ids[] in: query description: Filter Matter 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 Matter records to be returned. Limit can range between 1 and 200. Default: `200`.' required: false schema: type: integer format: int32 - name: notification_event_subscriber_user_id in: query description: The unique identifier for a single NotificationEventSubscriber. Use the keyword `null` to match those without a Matter. The list will be filtered to include only the Matter records with the matching property. required: false schema: type: integer format: int64 - name: open_date[] in: query description: 'Filter Matter records by the open date. The date should be provided in the format YYYY-MM-DD. e.g. `?open_date==2020-01-01`, `?open_date=<=2021-12-31` You can provide more than one value to narrow the results of this filter. You can do so by passing several individual values and appending `[]` to the parameter name. e.g. `?open_date[]=>=2020-01-01&open_date[]=<=2021-12-31` Note that, when providing multiple values for this filter, only Matter records that meet *all* filter conditions will be returned. ' required: false schema: type: string enum: - '>DATE' - '>=DATE' - =DATE - <=DATE - =2020-01-01&pending_date[]=<=2021-12-31` Note that, when providing multiple values for this filter, only Matter records that meet *all* filter conditions will be returned. ' required: false schema: type: string enum: - '>DATE' - '>=DATE' - =DATE - <=DATE - `, ``, `
`, `
`, ``, `` `
  • `, `
      `, `

      `, ``, ``, `` and `

        `. This Task also supports attributes such as `href`, `rel`, `type`, and `target`. description_text_type: type: string enum: - plain_text - rich_text description: The text type of the *Task* priority: type: string enum: - High - Normal - Low description: The priority of the *Task* due_at: type: string format: date description: The date the *Task* is due (as a ISO-8601 date) permission: type: string description: The permission of the *Task* completed_at: type: string format: date-time description: The time the *Task* was completed (as a ISO-8601 timestamp) notify_completion: type: boolean description: Whether to notify the assigner of the task's completion statute_of_limitations: type: boolean description: Whether the task is a statute of limitations time_estimated: type: integer format: int32 description: Time the *Task* should take to complete created_at: type: string format: date-time description: The time the *Task* was created (as a ISO-8601 timestamp) updated_at: type: string format: date-time description: The time the *Task* was last updated (as a ISO-8601 timestamp) time_entries_count: type: integer format: int32 description: The number of time entries associated with this task CustomFieldValue: allOf: - $ref: '#/components/schemas/CustomFieldValue_base' - type: object properties: custom_field: $ref: '#/components/schemas/CustomField' description: CustomField picklist_option: $ref: '#/components/schemas/PicklistOption' description: PicklistOption matter: $ref: '#/components/schemas/CustomFieldMatterSelection_base' description: CustomFieldMatterSelection contact: $ref: '#/components/schemas/Contact_base' description: Contact AttorneyAllocation_base: type: object properties: id: type: integer format: int64 description: Unique identifier for the *AttorneyAllocation* etag: type: string description: ETag for the *AttorneyAllocation* account_id: type: integer format: int64 description: The unique account identifier resource_id: type: integer format: int64 description: The unique identifier of the resource (e.g., Matter) this allocation belongs to resource_type: type: string description: The type of the resource the allocation is associated with (e.g., Matter) originating_attorney_allocation: type: number format: float description: The percentage of fees allocated to the originating attorney (0-100) responsible_attorney_allocation: type: number format: float description: The percentage of fees allocated to the responsible attorney (0-100) created_at: type: string format: date-time description: The time the *AttorneyAllocation* was created (as a ISO-8601 timestamp) updated_at: type: string format: date-time description: The time the *AttorneyAllocation* was last updated (as a ISO-8601 timestamp) ContingencyFee_base: type: object properties: id: type: integer format: int64 description: Unique identifier for the *ContingencyFee* etag: type: string description: ETag for the *ContingencyFee* created_at: type: string format: date-time description: The time the *ContingencyFee* was created (as a ISO-8601 timestamp) updated_at: type: string format: date-time description: The time the *ContingencyFee* was last updated (as a ISO-8601 timestamp) show_contingency_award: type: boolean description: Whether the *ContingencyFee* is posted or on a bill PolymorphicCustomRate_User_base: type: object properties: enabled: type: boolean description: Whether the *User* is allowed to log in etag: type: string description: ETag for the *User* id: type: integer format: int64 description: Unique identifier for the *User* name: type: string description: The full name of the *User* PolymorphicCustomRate_base: type: object properties: id: type: integer format: int64 description: The unique identifier for the custom rate etag: type: string description: ETag for the *PolymorphicCustomRate* created_at: type: string format: date-time description: The time the *PolymorphicCustomRate* was created (as a ISO-8601 timestamp) updated_at: type: string format: date-time description: The time the *PolymorphicCustomRate* was last updated (as a ISO-8601 timestamp) rate: type: number format: double description: 'If `custom_rate.type` is `HourlyRate`, it is the dollar amount of the custom rate of the User or Group for the Matter. If `custom_rate.type` is `FlatRate`, it is the dollar amount of the custom flat rate for the Matter. If `custom_rate.type` is `ContingencyFee`, it is the percentage of the contingency fee awarded to the user for the Matter. The value may also be expressed as string that represents a rational number such as `1/3`. If the user does not have sufficient rate visibility, the rates are hidden. ' award: type: number format: double description: The value of the ContingencyFee award. note: type: string description: Details about the ContingencyFee award. date: type: string format: date description: The date of the ContingencyFee award. KycFieldValue_base: type: object properties: id: type: integer format: int64 description: Unique identifier for the *KycFieldValue* etag: type: string description: ETag for the *KycFieldValue* field_name: type: string description: The name of the KYC/KYB field. KYC/KYB fields are available for eligible accounts in Australia, Canada, Channel Islands, Ireland, Isle of Man, New Zealand, and United Kingdom. field_label: type: string description: The display label of the KYC/KYB field created_at: type: string format: date-time description: The time the *KycFieldValue* was created (as a ISO-8601 timestamp) updated_at: type: string format: date-time description: The time the *KycFieldValue* was last updated (as a ISO-8601 timestamp) field_type: type: string enum: - date - picklist - text description: The type of the *KycFieldValue* field_value: type: string description: The value of the *KycFieldValue* field_possible_values: type: array items: type: string description: The possible values for the *KycFieldValue* if the field is of the type picklist group: type: string description: The group the *KycFieldValue* belongs to Matter: allOf: - $ref: '#/components/schemas/Matter_base' - type: object properties: client: $ref: '#/components/schemas/Contact_base' description: Contact contingency_fee: $ref: '#/components/schemas/ContingencyFee_base' description: ContingencyFee custom_rate: $ref: '#/components/schemas/MatterCustomRate' description: MatterCustomRate evergreen_retainer: $ref: '#/components/schemas/EvergreenRetainer_base' description: EvergreenRetainer folder: $ref: '#/components/schemas/Folder_base' description: Folder group: $ref: '#/components/schemas/Group_base' description: Group matter_budget: $ref: '#/components/schemas/MatterBudget_base' description: MatterBudget matter_stage: $ref: '#/components/schemas/MatterStage_base' description: MatterStage originating_attorney: $ref: '#/components/schemas/User_base' description: User practice_area: $ref: '#/components/schemas/PracticeArea_base' description: PracticeArea responsible_attorney: $ref: '#/components/schemas/User_base' description: User responsible_staff: $ref: '#/components/schemas/User_base' description: User statute_of_limitations: $ref: '#/components/schemas/Task_base' description: Task user: $ref: '#/components/schemas/User_base' description: User legal_aid_uk_matter: $ref: '#/components/schemas/LegalAidUkMatter_base' description: LegalAidUkMatter attorney_allocation: $ref: '#/components/schemas/AttorneyAllocation_base' description: AttorneyAllocation currency: $ref: '#/components/schemas/Currency_base' description: Currency account_balances: type: array items: $ref: '#/components/schemas/AccountBalance_base' description: AccountBalance custom_field_values: type: array items: $ref: '#/components/schemas/CustomFieldValue' description: CustomFieldValue custom_field_set_associations: type: array items: $ref: '#/components/schemas/CustomFieldSetAssociation_base' description: CustomFieldSetAssociation matter_bill_recipients: type: array items: $ref: '#/components/schemas/MatterBillRecipient' description: MatterBillRecipient relationships: type: array items: $ref: '#/components/schemas/Relationship_base' description: Relationship task_template_list_instances: type: array items: $ref: '#/components/schemas/TaskTemplateListInstace_base' description: TaskTemplateListInstace kyc_field_values: type: array items: $ref: '#/components/schemas/KycFieldValue_base' description: KycFieldValue split_invoice_payers: type: array items: $ref: '#/components/schemas/SplitInvoicePayer_base' description: SplitInvoicePayer CustomField_base: type: object properties: id: type: integer format: int64 description: Unique identifier for the *CustomField* etag: type: string description: ETag for the *CustomField* created_at: type: string format: date-time description: The time the *CustomField* was created (as a ISO-8601 timestamp) updated_at: type: string format: date-time description: The time the *CustomField* was last updated (as a ISO-8601 timestamp) name: type: string description: The name of the *CustomField* parent_type: type: string enum: - Contact - Matter description: Type of object the *CustomField* is for field_type: type: string enum: - checkbox - contact - currency - date - time - email - matter - numeric - picklist - text_area - text_line - url description: Field type of the *CustomField* displayed: type: boolean description: Whether the *CustomField* is displayed by default deleted: type: boolean description: Whether the *CustomField* is deleted for future use required: type: boolean description: Whether the *CustomField* requires a value display_order: type: integer format: int32 description: The display position of the *CustomField* CustomFieldSetAssociation_base: type: object properties: id: type: integer format: int64 description: Unique identifier for the *CustomFieldSetAssociation* etag: type: string description: ETag for the *CustomFieldSetAssociation* display_order: type: integer format: int32 description: The display position of the *CustomFieldSetAssociation* created_at: type: string format: date-time description: The time the *CustomFieldSetAssociation* was created (as a ISO-8601 timestamp) updated_at: type: string format: date-time description: The time the *CustomFieldSetAssociation* was last updated (as a ISO-8601 timestamp) x-tagGroups: - name: Api tags: - Custom Actions - Webhooks - name: Activities tags: - Activities - Activity Descriptions - Activity Rates - Expense Categories - Timers - Utbms Codes - Utbms Sets - name: Accounting tags: - Bank Accounts - Bank Transactions - Bank Transfers - name: Billing tags: - Bills - Billable Clients - Billable Matters - Bill Themes - Interest Charges - Line Items - Outstanding Client Balances - name: Calendars tags: - Calendars - Calendar Entries - Calendar Entry Event Types - Calendar Visibilities - Reminders - name: Clio Payments tags: - Clio Payments Links - Clio Payments Payments - name: Communications tags: - Communications - Conversations - Conversation Messages - name: Contacts tags: - Contacts - Email Addresses - Phone Numbers - Notes - Log Entries - name: Court Rules tags: - Jurisdictions To Triggers - Jurisdictions - Matter Dockets - Service Types - name: Custom Fields tags: - Custom Fields - Custom Field Sets - name: Documents tags: - Documents - Document Versions - Folders - Document Archives - Document Automations - Document Categories - Document Templates - Comments - name: In-app Notifications tags: - My Events - Event Metrics - name: Matters tags: - Matters - Relationships - Clients - Related Contacts - Matter Contacts - Notes - Practice Areas - Log Entries - Matter Stages - Medical Records Details - Medical Records - Medical Bills - Damages - name: Payments tags: - Allocations - Credit Memos - name: Reporting tags: - Reports - Report Presets - Report Schedules - name: Settings tags: - Text Snippets - Billing Settings - Currencies - Tax Rate Configurations - name: Tasks tags: - Tasks - Task Templates - Task Template Lists - Task Types - name: Trust tags: - Trust Line Items - Trust Requests - name: Users tags: - Users - Groups - name: Legal Aid US tags: - Grants - Grant Funding Sources - name: Legal Aid England & Wales tags: - Civil Controlled Rates - Civil Certificated Rates - Criminal Controlled Rates - Expense Categories