{
  "opencollection": "1.0.0",
  "info": {
    "name": "Clio API Documentation Activities Matters API",
    "version": "v4"
  },
  "items": [
    {
      "info": {
        "name": "Matters",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Return the data for all Matters",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.clio.com/api/v4/matters.json",
            "headers": [
              {
                "name": "X-API-VERSION",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "billable",
                "value": "",
                "type": "query",
                "description": "Filter Matter records to those which are billable."
              },
              {
                "name": "client_id",
                "value": "",
                "type": "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."
              },
              {
                "name": "close_date[]",
                "value": "",
                "type": "query",
                "description": "Filter Matter records by the close date. The date should be provided in the format YYYY-MM-DD.\n\ne.g. `?close_date==2020-01-01`, `?close_date=<=2021-12-31`\n\nYou 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.\n\ne.g. `?close_date[]=>=2020-01-01&close_date[]=<=2021-12-31`\n\nNote that, when providing multiple values for this filter, only Matter records that meet *all* filter conditions will be returned.\n"
              },
              {
                "name": "created_since",
                "value": "",
                "type": "query",
                "description": "Filter Matter records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)."
              },
              {
                "name": "currency_id",
                "value": "",
                "type": "query",
                "description": "Filter Matter records to those of a specific currency."
              },
              {
                "name": "custom_field_ids[]",
                "value": "",
                "type": "query",
                "description": "Filter Matter's custom_field_values to only include values for the given custom field unique identifiers."
              },
              {
                "name": "custom_field_values",
                "value": "",
                "type": "query",
                "description": "Filter records to only those with the given custom field(s) set. The value is compared using the operator provided, or,\nif the value type only supports one operator, the supported operator is used. In the latter case, no check for operator is performed on the input string.\nThe key for the custom field value filter is the custom_field.id. e.g. `custom_field_values[12345]`\nIf an operator is used for a type that does not support it, an `400 Bad Request` is returned.\n\n*Supported operators:*\n* `checkbox`, `contact`, `matter`, `picklist` : `=`\n\ne.g. `?custom_field_values[1]=42`\n\n* `currency`, `date`, `time`, `numeric` : `=`, `<`, `>`, `<=`, `>=`\n\ne.g. `?custom_field_values[1]=>=105.4`\n\n* `email`, `text_area`, `text_line`, `url` : `=`\n\ne.g. `?custom_field_values[1]=url_encoded`\n\n*Multiple conditions for the same custom field:*\n\nIf you want to use more than one operator to filter a custom field, you can do so by passing in an array of values.\ne.g. `?custom_field_values[1]=[<=50, >=45]`\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": "grant_id",
                "value": "",
                "type": "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."
              },
              {
                "name": "group_id",
                "value": "",
                "type": "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."
              },
              {
                "name": "ids[]",
                "value": "",
                "type": "query",
                "description": "Filter Matter records to those having the specified unique identifiers."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "A limit on the number of Matter records to be returned. Limit can range between 1 and 200. Default: `200`."
              },
              {
                "name": "notification_event_subscriber_user_id",
                "value": "",
                "type": "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."
              },
              {
                "name": "open_date[]",
                "value": "",
                "type": "query",
                "description": "Filter Matter records by the open date. The date should be provided in the format YYYY-MM-DD.\n\ne.g. `?open_date==2020-01-01`, `?open_date=<=2021-12-31`\n\nYou 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.\n\ne.g. `?open_date[]=>=2020-01-01&open_date[]=<=2021-12-31`\n\nNote that, when providing multiple values for this filter, only Matter records that meet *all* filter conditions will be returned.\n"
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "Orders the Matter records by the given field. Default: `id(asc)`."
              },
              {
                "name": "originating_attorney_id",
                "value": "",
                "type": "query",
                "description": "The unique identifier for a single User. 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."
              },
              {
                "name": "page_token",
                "value": "",
                "type": "query",
                "description": "A token specifying which page to return."
              },
              {
                "name": "pending_date[]",
                "value": "",
                "type": "query",
                "description": "Filter Matter records by the pending date. The date should be provided in the format YYYY-MM-DD.\n\ne.g. `?pending_date==2020-01-01`, `?pending_date=<=2021-12-31`\n\nYou 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.\n\ne.g. `?pending_date[]=>=2020-01-01&pending_date[]=<=2021-12-31`\n\nNote that, when providing multiple values for this filter, only Matter records that meet *all* filter conditions will be returned.\n"
              },
              {
                "name": "practice_area_id",
                "value": "",
                "type": "query",
                "description": "The unique identifier for a single PracticeArea. The keyword `null` is not valid for this field. The list will be filtered to include only the Matter records with the matching property."
              },
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "Wildcard search for `display_number`, `number` or `description` matching a given string, as well as the `first_name`, `last_name` or `name` of the associated client."
              },
              {
                "name": "responsible_attorney_id",
                "value": "",
                "type": "query",
                "description": "The unique identifier for a single User. 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."
              },
              {
                "name": "responsible_staff_id",
                "value": "",
                "type": "query",
                "description": "The unique identifier for a single User. 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."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter Matter records to those with a given status. It accepts comma-separated statuses, e.g. `open,pending`."
              },
              {
                "name": "subscriber_user_id",
                "value": "",
                "type": "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."
              },
              {
                "name": "updated_since",
                "value": "",
                "type": "query",
                "description": "Filter Matter 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 Matters"
        },
        {
          "info": {
            "name": "Create a new Matter",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://app.clio.com/api/v4/matters.json",
            "headers": [
              {
                "name": "X-API-VERSION",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "custom_field_ids[]",
                "value": "",
                "type": "query",
                "description": "Filter Matter's custom_field_values to only include values for the given custom field unique identifiers."
              },
              {
                "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": "Outlines the parameters and data fields used when creating a new Matter"
        },
        {
          "info": {
            "name": "Return the data for a single Matter",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.clio.com/api/v4/matters/:id.json",
            "headers": [
              {
                "name": "IF-MODIFIED-SINCE",
                "value": ""
              },
              {
                "name": "IF-NONE-MATCH",
                "value": ""
              },
              {
                "name": "X-API-VERSION",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "custom_field_ids[]",
                "value": "",
                "type": "query",
                "description": "Filter Matter's custom_field_values to only include values for the given custom field unique identifiers."
              },
              {
                "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 Matter."
              }
            ]
          },
          "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Matter"
        },
        {
          "info": {
            "name": "Update a single Matter",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://app.clio.com/api/v4/matters/:id.json",
            "headers": [
              {
                "name": "IF-MATCH",
                "value": ""
              },
              {
                "name": "X-API-VERSION",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "custom_field_ids[]",
                "value": "",
                "type": "query",
                "description": "Filter Matter's custom_field_values to only include values for the given custom field unique identifiers."
              },
              {
                "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 Matter."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Outlines the parameters and data fields used when updating a single Matter\n\nWhen updating data that could change the display_number, reset_matter_number must be set in order for the display_number to be updated\n"
        },
        {
          "info": {
            "name": "Delete a single Matter",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://app.clio.com/api/v4/matters/:id.json",
            "headers": [
              {
                "name": "X-API-VERSION",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the Matter."
              }
            ]
          },
          "docs": "Outlines the parameters, optional and required, used when deleting the record for a single Matter"
        }
      ]
    }
  ],
  "bundled": true
}