Clio Task Template Lists API

openapi: 3.0.0
info:
  title: Clio API Documentation Activities Task Template Lists 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: Task Template Lists
  description: 'With Task Template Lists, users can create groups of [Task Templates](https://docs.developers.clio.com/clio-manage/api-reference/#tag/Task-Templates) for the types of projects they work on most often. Each Task in a list can be given a separate due date in relation to the due dates for other [Tasks](https://docs.developers.clio.com/clio-manage/api-reference/#tag/Tasks) in the list.


    Users can then assign individual tasks on a list to different users, or they can batch assign an entire list.


    [Support Link](https://help.clio.com/hc/en-us/articles/9206286672155-Task-Lists)


    [Task Template Lists in Clio](http://app.clio.com/list_templates)

    '
paths:
  /task_template_lists/{id}/copy.json:
    post:
      tags:
      - Task Template Lists
      summary: Copy a TaskTemplateList
      operationId: TaskTemplateList#copy
      description: 'Creates a copy of the TaskTemplateList identified by the `id` path parameter.

        '
      parameters:
      - 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 TaskTemplateList.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '404':
          description: Not Found
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '400':
          description: Bad Request
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '201':
          description: Created
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/TaskTemplateList_Show'
      requestBody:
        description: Request Body for Task Template Lists
        content:
          application/json:
            schema:
              type: object
              required:
              - data
              properties:
                data:
                  type: object
                  properties:
                    description:
                      type: string
                      description: The description of the TaskTemplateList copy.
                    name:
                      type: string
                      description: The name of the TaskTemplateList copy.
                    practice_area:
                      type: object
                      properties:
                        id:
                          type: integer
                          format: int64
                          description: The unique identifier for the practice area of the TaskTemplateList copy.
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - data
              properties:
                data:
                  type: object
                  properties:
                    description:
                      type: string
                      description: The description of the TaskTemplateList copy.
                    name:
                      type: string
                      description: The name of the TaskTemplateList copy.
                    practice_area:
                      type: object
                      properties:
                        id:
                          type: integer
                          format: int64
                          description: The unique identifier for the practice area of the TaskTemplateList copy.
          multipart/form-data:
            schema:
              type: object
              required:
              - data
              properties:
                data:
                  type: object
                  properties:
                    description:
                      type: string
                      description: The description of the TaskTemplateList copy.
                    name:
                      type: string
                      description: The name of the TaskTemplateList copy.
                    practice_area:
                      type: object
                      properties:
                        id:
                          type: integer
                          format: int64
                          description: The unique identifier for the practice area of the TaskTemplateList copy.
        required: false
  /task_template_lists.json:
    get:
      tags:
      - Task Template Lists
      summary: Return the data for all TaskTemplateLists
      operationId: TaskTemplateList#index
      description: Outlines the parameters, optional and required, used when requesting the data for all TaskTemplateLists
      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 TaskTemplateList 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: empty
        in: query
        description: Filter TaskTemplateList records to those that either contain at least one task template or contain none.
        required: false
        schema:
          type: boolean
      - 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 TaskTemplateList 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 TaskTemplateList records to be returned. Limit can range between 1 and 200. Default: `200`.'
        required: false
        schema:
          type: integer
          format: int32
      - name: order
        in: query
        description: 'Orders the TaskTemplateList records by the given field. Default: `id(asc)`.'
        required: false
        schema:
          type: string
          enum:
          - id(asc)
          - id(desc)
          - name(asc)
          - name(desc)
          - practice_area.name(asc)
          - practice_area.name(desc)
      - name: page_token
        in: query
        description: A token specifying which page to return.
        required: false
        schema:
          type: string
      - name: practice_area_id
        in: query
        description: The unique identifier for a single PracticeArea. Use the keyword `null` to match those without a TaskTemplateList. The list will be filtered to include only the TaskTemplateList records with the matching property.
        required: false
        schema:
          type: integer
          format: int64
      - name: query
        in: query
        description: Wildcard search for `name` matching a given string.
        required: false
        schema:
          type: string
      - name: updated_since
        in: query
        description: Filter TaskTemplateList 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/TaskTemplateList_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:
      - Task Template Lists
      summary: Create a new TaskTemplateList
      operationId: TaskTemplateList#create
      description: Outlines the parameters and data fields used when creating a new TaskTemplateList
      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/TaskTemplateList_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 Task Template Lists
        content:
          application/json:
            schema:
              type: object
              required:
              - data
              properties:
                data:
                  type: object
                  properties:
                    description:
                      type: string
                      description: Description of the TaskTemplateList.
                    name:
                      type: string
                      description: Name of the TaskTemplateList.
                    practice_area:
                      type: object
                      properties:
                        id:
                          type: integer
                          format: int64
                          description: The unique identifier for a single PracticeArea associated with the TaskTemplateList. The keyword `null` is not valid for this field.
                  required:
                  - name
                  - description
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - data
              properties:
                data:
                  type: object
                  properties:
                    description:
                      type: string
                      description: Description of the TaskTemplateList.
                    name:
                      type: string
                      description: Name of the TaskTemplateList.
                    practice_area:
                      type: object
                      properties:
                        id:
                          type: integer
                          format: int64
                          description: The unique identifier for a single PracticeArea associated with the TaskTemplateList. The keyword `null` is not valid for this field.
                  required:
                  - name
                  - description
          multipart/form-data:
            schema:
              type: object
              required:
              - data
              properties:
                data:
                  type: object
                  properties:
                    description:
                      type: string
                      description: Description of the TaskTemplateList.
                    name:
                      type: string
                      description: Name of the TaskTemplateList.
                    practice_area:
                      type: object
                      properties:
                        id:
                          type: integer
                          format: int64
                          description: The unique identifier for a single PracticeArea associated with the TaskTemplateList. The keyword `null` is not valid for this field.
                  required:
                  - name
                  - description
        required: false
  /task_template_lists/{id}.json:
    get:
      tags:
      - Task Template Lists
      summary: Return the data for a single TaskTemplateList
      operationId: TaskTemplateList#show
      description: Outlines the parameters, optional and required, used when requesting the data for a single TaskTemplateList
      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 TaskTemplateList.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Ok
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/TaskTemplateList_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:
      - Task Template Lists
      summary: Update a single TaskTemplateList
      operationId: TaskTemplateList#update
      description: Outlines the parameters and data fields used when updating a single TaskTemplateList
      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 TaskTemplateList.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Ok
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/TaskTemplateList_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 Task Template Lists
        content:
          application/json:
            schema:
              type: object
              required:
              - data
              properties:
                data:
                  type: object
                  properties:
                    description:
                      type: string
                      description: Description of the TaskTemplateList.
                    name:
                      type: string
                      description: Name of the TaskTemplateList.
                    practice_area:
                      type: object
                      properties:
                        id:
                          type: integer
                          format: int64
                          description: The unique identifier for a single PracticeArea associated with the TaskTemplateList. The keyword `null` is not valid for this field.
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - data
              properties:
                data:
                  type: object
                  properties:
                    description:
                      type: string
                      description: Description of the TaskTemplateList.
                    name:
                      type: string
                      description: Name of the TaskTemplateList.
                    practice_area:
                      type: object
                      properties:
                        id:
                          type: integer
                          format: int64
                          description: The unique identifier for a single PracticeArea associated with the TaskTemplateList. The keyword `null` is not valid for this field.
          multipart/form-data:
            schema:
              type: object
              required:
              - data
              properties:
                data:
                  type: object
                  properties:
                    description:
                      type: string
                      description: Description of the TaskTemplateList.
                    name:
                      type: string
                      description: Name of the TaskTemplateList.
                    practice_area:
                      type: object
                      properties:
                        id:
                          type: integer
                          format: int64
                          description: The unique identifier for a single PracticeArea associated with the TaskTemplateList. The keyword `null` is not valid for this field.
        required: false
    delete:
      tags:
      - Task Template Lists
      summary: Delete a single TaskTemplateList
      operationId: TaskTemplateList#destroy
      description: Outlines the parameters, optional and required, used when deleting the record for a single TaskTemplateList
      parameters:
      - name: X-API-VERSION
        in: header
        description: 'The [API minor version](#section/Minor-Versions). Default: latest version.'
        required: false
        schema:
          type: string
      - name: id
        in: path
        description: The unique identifier for the TaskTemplateList.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: No Content
        '403':
          description: Forbidden
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    TaskTemplateList_List:
      type: object
      required:
      - data
      properties:
        data:
          type: array
          description: TaskTemplateList List Response
          items:
            $ref: '#/components/schemas/TaskTemplateList'
    PracticeArea_base:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: Unique identifier for the *PracticeArea*
        etag:
          type: string
          description: ETag for the *PracticeArea*
        created_at:
          type: string
          format: date-time
          description: The time the *PracticeArea* was created (as a ISO-8601 timestamp)
        updated_at:
          type: string
          format: date-time
          description: The time the *PracticeArea* was last updated (as a ISO-8601 timestamp)
        name:
          type: string
          description: The name of the *PracticeArea*
        category:
          type: string
          enum:
          - administrative
          - admiralty_and_maritime
          - anti_trust_and_competition
          - appellate
          - banking_and_finance
          - bankruptcy
          - business_formation_and_compliance
          - civil_litigation
          - civil_rights_and_constitutional
          - collections_and_debt
          - commercial_and_sale_of_goods
          - commercial_litigation
          - construction
          - consumer_protection
          - contracts
          - corporate_litigation
          - criminal
          - disability_and_social_security
          - education
          - elder
          - employment_and_labor
          - energy_and_environmental
          - ethics
          - family
          - food_and_drug
          - general_practice
          - government
          - healthcare
          - immigration
          - in_house_counsel
          - insurance
          - intellectual_property
          - international
          - juvenile
          - legal_aid
          - mediation_and_arbitration
          - medical_malpractice
          - military
          - multi_practice
          - non_profit_and_pro_bono
          - other
          - personal_injury
          - privacy_and_information_security
          - private_client
          - product_liability
          - real_estate
          - science_and_technology
          - securities_and_mergers_and_acquisitions
          - small_claims
          - sports_and_entertainment_and_gaming
          - tax
          - telecommunications
          - traffic_offenses
          - transportation
          - tribal
          - trusts
          - wills_and_estates
          - workers_compensation
          description: 'The practice area category associated with the *PracticeArea*

            '
        code:
          type: string
          description: The code of the *PracticeArea*
    TaskTemplateList_base:
      type: object
      properties:
        created_at:
          type: string
          format: date-time
          description: The time the *TaskTemplateList* was created (as a ISO-8601 timestamp)
        description:
          type: string
          description: A detailed description of the *TaskTemplateList*
        id:
          type: integer
          format: int64
          description: Unique identifier for the *TaskTemplateList*
        etag:
          type: string
          description: ETag for the *TaskTemplateList*
        name:
          type: string
          description: The name of the *TaskTemplateList*
        templates_count:
          type: integer
          format: int32
          description: How many task templates exist as an association to the *TaskTemplateList*
        updated_at:
          type: string
          format: date-time
          description: The time the *TaskTemplateL

# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clio/refs/heads/main/openapi/clio-task-template-lists-api-openapi.yml