{
  "opencollection": "1.0.0",
  "info": {
    "name": "Clio API Documentation Activities Folders API",
    "version": "v4"
  },
  "items": [
    {
      "info": {
        "name": "Folders",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Return the data of the contents of a Folder",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.clio.com/api/v4/folders/list.json",
            "headers": [
              {
                "name": "X-API-VERSION",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "contact_id",
                "value": "",
                "type": "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."
              },
              {
                "name": "created_since",
                "value": "",
                "type": "query",
                "description": "Filter Folder records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)."
              },
              {
                "name": "document_category_id",
                "value": "",
                "type": "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."
              },
              {
                "name": "external_property_name",
                "value": "",
                "type": "query",
                "description": "Filter records to only those with the given external property(s) name set.\n\ne.g. `?external_property_name=Name`\n"
              },
              {
                "name": "external_property_value",
                "value": "",
                "type": "query",
                "description": "Filter records to only those with the given external property(s) value set. Requires external property name as well.\n\ne.g. `?external_property_name=Name&external_property_value=Value`\n"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields)."
              },
              {
                "name": "ids[]",
                "value": "",
                "type": "query",
                "description": "Filter Folder records to those having the specified unique identifiers."
              },
              {
                "name": "include_deleted",
                "value": "",
                "type": "query",
                "description": "Allow trashed Folder record to be included."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "A limit on the number of Folder records to be returned. Limit can range between 1 and 200. Default: `200`."
              },
              {
                "name": "matter_id",
                "value": "",
                "type": "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."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "Orders the Folder records by the given field. Default: `id(asc)`."
              },
              {
                "name": "page_token",
                "value": "",
                "type": "query",
                "description": "A token specifying which page to return."
              },
              {
                "name": "parent_id",
                "value": "",
                "type": "query",
                "description": "The unique identifier for a single Folder.\n\nWhen 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.\n\nWhen 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.\n"
              },
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "Wildcard search for `name` matching the given string."
              },
              {
                "name": "scope",
                "value": "",
                "type": "query",
                "description": "Filters Folder record to those being a child of the parent Folder, or a descendant of the parent Folder. Default is `children`."
              },
              {
                "name": "show_uncompleted",
                "value": "",
                "type": "query",
                "description": "Allow Folder record being uploaded to be included."
              },
              {
                "name": "updated_since",
                "value": "",
                "type": "query",
                "description": "Filter Folder records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)."
              }
            ]
          },
          "docs": "Return the data of the contents of a Folder.\n\nNote: offset pagination is not supported for this endpoint. Use cursor pagination if you're looking to paginate through the results.\n"
        },
        {
          "info": {
            "name": "Return the data for all Folders",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.clio.com/api/v4/folders.json",
            "headers": [
              {
                "name": "X-API-VERSION",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "contact_id",
                "value": "",
                "type": "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."
              },
              {
                "name": "created_since",
                "value": "",
                "type": "query",
                "description": "Filter Folder records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)."
              },
              {
                "name": "document_category_id",
                "value": "",
                "type": "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."
              },
              {
                "name": "external_property_name",
                "value": "",
                "type": "query",
                "description": "Filter records to only those with the given external property(s) name set.\n\ne.g. `?external_property_name=Name`\n"
              },
              {
                "name": "external_property_value",
                "value": "",
                "type": "query",
                "description": "Filter records to only those with the given external property(s) value set. Requires external property name as well.\n\ne.g. `?external_property_name=Name&external_property_value=Value`\n"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields)."
              },
              {
                "name": "ids[]",
                "value": "",
                "type": "query",
                "description": "Filter Folder records to those having the specified unique identifiers."
              },
              {
                "name": "include_deleted",
                "value": "",
                "type": "query",
                "description": "Allow trashed Folder record to be included."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "A limit on the number of Folder records to be returned. Limit can range between 1 and 200. Default: `200`."
              },
              {
                "name": "matter_id",
                "value": "",
                "type": "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."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "Orders the Folder records by the given field. Default: `id(asc)`."
              },
              {
                "name": "page_token",
                "value": "",
                "type": "query",
                "description": "A token specifying which page to return."
              },
              {
                "name": "parent_id",
                "value": "",
                "type": "query",
                "description": "The unique identifier for a single Folder.\n\nWhen 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.\n\nWhen 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.\n"
              },
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "Wildcard search for `name` matching the given string."
              },
              {
                "name": "scope",
                "value": "",
                "type": "query",
                "description": "Filters Folder record to those being a child of the parent Folder, or a descendant of the parent Folder. Default is `children`."
              },
              {
                "name": "updated_since",
                "value": "",
                "type": "query",
                "description": "Filter Folder records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)."
              }
            ]
          },
          "docs": "Outlines the parameters, optional and required, used when requesting the data for all Folders"
        },
        {
          "info": {
            "name": "Create a new Folder",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://app.clio.com/api/v4/folders.json",
            "headers": [
              {
                "name": "X-API-VERSION",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a Folder to an existing folder.\n"
        },
        {
          "info": {
            "name": "Return the data for a single Folder",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.clio.com/api/v4/folders/:id.json",
            "headers": [
              {
                "name": "IF-MODIFIED-SINCE",
                "value": ""
              },
              {
                "name": "IF-NONE-MATCH",
                "value": ""
              },
              {
                "name": "X-API-VERSION",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields)."
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the Folder."
              }
            ]
          },
          "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Folder"
        },
        {
          "info": {
            "name": "Update a single Folder",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://app.clio.com/api/v4/folders/:id.json",
            "headers": [
              {
                "name": "IF-MATCH",
                "value": ""
              },
              {
                "name": "X-API-VERSION",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields)."
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the Folder."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update Folder, move Folder to another Folder, and/or restore a trashed Folder.\n"
        },
        {
          "info": {
            "name": "Delete a single Folder",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://app.clio.com/api/v4/folders/:id.json",
            "headers": [
              {
                "name": "X-API-VERSION",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the Folder."
              }
            ]
          },
          "docs": "Deleting a Folder using this method will move it to the trash instead of permanently deleting it. Trashed Folders are permanently deleted after 30 days. The following errors may be returned:\n\n- `400 Bad Request`: The Folder cannot be trashed. The `type` of the error will be `DeleteFailed` and the `message` of the error will be one of the following:\n  - `Delete failed: This folder contains more than 100,000 items and cannot be trashed. Please trash some of the items inside it before trying again."
        }
      ]
    }
  ],
  "bundled": true
}