Clio Tools — Ferrule Docs

MCPREST

GETlist_activities/activities

Return the data for all Activities

Request

Query Parameters

Name	Type	Required	Description
activity_description_id	string	No	The unique identifier for a single ActivityDescription. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.
calendar_entry_id	string	No	The unique identifier for a single CalendarEntry. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.
communication_id	string	No	The unique identifier for a single Communication. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.
contact_note_id	string	No	The unique identifier for a single Note. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.
created_since	string	No	Filter Activity records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
end_date	string	No	Filter Activity records to those whose `date` is on or before the date provided (Expects an ISO-8601 date).
expense_category_id	string	No	The unique identifier for a single ExpenseCategory. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
flat_rate	string	No	Filter Activity TimeEntry records to those that have a flat rate, or not.
grant_id	string	No	The unique identifier for a single Grant. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.
ids[]	string	No	Filter Activity records to those having the specified unique identifiers.
limit	string	No	A limit on the number of Activity records to be returned. Limit can range between 1 and 200. Default: `200`.
matter_id	string	No	The unique identifier for a single Matter. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.
matter_note_id	string	No	The unique identifier for a single Note. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.
only_unaccounted_for	string	No	Only unaccounted for activities.
order	string	No	Orders the Activity records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
query	string	No	Wildcard search for `note` matching a given string.
start_date	string	No	Filter Activity records to those whose `date` is on or after the date provided (Expects an ISO-8601 date).
status	string	No	Filter Activity records to those that are draft, billed, unbilled or non-billable.
task_id	string	No	The unique identifier for a single Task. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.
type	string	No	Filter Activity records to those of a specific type.
updated_since	string	No	Filter Activity records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).
user_id	string	No	The unique identifier for a single User. Use the keyword `null` to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_activities"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_activities",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/activities
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_activity/activities

Create a new Activity

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
activity_description	object	No
calendar_entry	object	No
client_portal	object	No
communication	object	No
contact_note	object	No
date	string	Yes
expense_category	object	No
matter	object	No
matter_note	object	No
no_charge	boolean	No
non_billable	boolean	No
note	string	No
price	number	No
quantity	number	No
reference	string	No
start_timer	boolean	No
task	object	No
tax_setting	object	No
text_message_conversation	object	No
type	object	Yes
user	object	No
utbms_expense	object	No
vendor	object	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_activity"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_activity",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/activities
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "activity_description": "<activity_description>",
  "calendar_entry": "<calendar_entry>",
  "client_portal": "<client_portal>",
  "communication": "<communication>",
  "contact_note": "<contact_note>"
}

Response

{
  "data": null
}

GETget_activity/activities/:id

Return the data for a single Activity

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Activity.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_activity"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_activity",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/activities/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_activity/activities/:id

Update a single Activity

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Activity.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
activity_description	object	No
calendar_entry	object	No
client_portal	object	No
communication	object	No
contact_note	object	No
date	string	No
expense_category	object	No
matter	object	No
matter_note	object	No
no_charge	boolean	No
non_billable	boolean	No
note	string	No
price	number	No
quantity	number	No
reference	string	No
start_timer	boolean	No
task	object	No
tax_setting	object	No
text_message_conversation	object	No
type	object	No
user	object	No
utbms_expense	object	No
vendor	object	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_activity"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_activity",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/activities/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "activity_description": "<activity_description>",
  "calendar_entry": "<calendar_entry>",
  "client_portal": "<client_portal>",
  "communication": "<communication>",
  "contact_note": "<contact_note>"
}

Response

{
  "data": null
}

DELETEdelete_activity/activities/:id

Delete a single Activity

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Activity.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_activity"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_activity",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/activities/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_activity_rates/activity_rates

Return the data for all ActivityRates

Request

Query Parameters

Name	Type	Required	Description
co_counsel_contact_id	string	No	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 ActivityRate records with the matching property.
contact_id	string	No	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 ActivityRate records with the matching property.
created_since	string	No	Filter ActivityRate records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter ActivityRate records to those having the specified unique identifiers.
limit	string	No	A limit on the number of ActivityRate records to be returned. Limit can range between 1 and 200. Default: `200`.
page_token	string	No	A token specifying which page to return.
updated_since	string	No	Filter ActivityRate records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_activity_rates"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_activity_rates",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/activity_rates
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_activity_rate/activity_rates

Create a new ActivityRate

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
co_counsel_contact_id	number	No
contact_id	number	No
flat_rate	boolean	No
rate	number	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_activity_rate"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_activity_rate",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/activity_rates
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "co_counsel_contact_id": 1,
  "contact_id": 1,
  "flat_rate": "<flat_rate>",
  "rate": 1
}

Response

{
  "data": null
}

GETget_activity_rate/activity_rates/:id

Return the data for a single ActivityRate

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the ActivityRate.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_activity_rate"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_activity_rate",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/activity_rates/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_activity_rate/activity_rates/:id

Update a single ActivityRate

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the ActivityRate.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
co_counsel_contact_id	number	No
contact_id	number	No
flat_rate	boolean	No
rate	number	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_activity_rate"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_activity_rate",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/activity_rates/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "co_counsel_contact_id": 1,
  "contact_id": 1,
  "flat_rate": "<flat_rate>",
  "rate": 1
}

Response

{
  "data": null
}

DELETEdelete_activity_rate/activity_rates/:id

Delete a single ActivityRate

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the ActivityRate.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_activity_rate"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_activity_rate",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/activity_rates/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_activity_descriptions/activity_descriptions

Return the data for all ActivityDescriptions

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter ActivityDescription records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
flat_rate	string	No	Filter ActivityDescription records to those that have a flat rate, or not.
ids[]	string	No	Filter ActivityDescription records to those having the specified unique identifiers.
limit	string	No	A limit on the number of ActivityDescription records to be returned. Limit can range between 1 and 200. Default: `200`.
page_token	string	No	A token specifying which page to return.
rate_for[matter_id]	string	No	Matter id for rate calculation.
rate_for[user_id]	string	No	User id for rate calculation. If not provided, the user associated to the API request is assumed.
type	string	No	Filter ActivityDescription records to those of a specific type.
updated_since	string	No	Filter ActivityDescription records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).
user_id	string	No	The unique identifier for a single User. The keyword `null` is not valid for this field. The list will be filtered to include only the ActivityDescription records with the matching property.

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_activity_descriptions"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_activity_descriptions",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/activity_descriptions
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_activity_description/activity_descriptions

Create a new ActivityDescription

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
currency	object	No
default	boolean	No
groups	array	No
name	string	Yes
rate	object	No
visible_to_co_counsel	boolean	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_activity_description"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_activity_description",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/activity_descriptions
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "currency": "<currency>",
  "default": "<default>",
  "groups": "<groups>",
  "name": "<name>",
  "rate": "<rate>"
}

Response

{
  "data": null
}

GETget_activity_description/activity_descriptions/:id

Return the data for a single ActivityDescription

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the ActivityDescription.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_activity_description"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_activity_description",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/activity_descriptions/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_activity_description/activity_descriptions/:id

Update a single ActivityDescription

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the ActivityDescription.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
currency	object	No
default	boolean	No
groups	array	No
name	string	No
rate	object	No
visible_to_co_counsel	boolean	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_activity_description"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_activity_description",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/activity_descriptions/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "currency": "<currency>",
  "default": "<default>",
  "groups": "<groups>",
  "name": "<name>",
  "rate": "<rate>"
}

Response

{
  "data": null
}

DELETEdelete_activity_description/activity_descriptions/:id

Delete a single ActivityDescription

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the ActivityDescription.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_activity_description"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_activity_description",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/activity_descriptions/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_allocations/allocations

Return the data for all Allocations

Request

Query Parameters

Name	Type	Required	Description
bill_id	string	No	The unique identifier for a single Bill. The keyword `null` is not valid for this field. The list will be filtered to include only the Allocation records with the matching property.
contact_id	string	No	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 Allocation records with the matching property.
created_since	string	No	Filter Allocation records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter Allocation records to those having the specified unique identifiers.
limit	string	No	A limit on the number of Allocation records to be returned. Limit can range between 1 and 200. Default: `200`.
matter_id	string	No	The unique identifier for a single Matter. The keyword `null` is not valid for this field. The list will be filtered to include only the Allocation records with the matching property.
order	string	No	Orders the Allocation records by the given field. Default: `date(asc)`.
page_token	string	No	A token specifying which page to return.
parent_id	string	No	ID of parent (either a Payment or CreditMemo) this allocation belongs to
parent_type	string	No	Filter Allocation records based on whether the parent is a CreditMemo or a Payment.
status	string	No	Filter Allocation records to only those that are voided (`"invalid"`) or not voided (`"valid"`).
updated_since	string	No	Filter Allocation records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_allocations"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_allocations",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/allocations
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETget_allocation/allocations/:id

Return the data for a single Allocation

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Allocation.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_allocation"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_allocation",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/allocations/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

GETlist_bank_accounts/bank_accounts

Return the data for all BankAccounts

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter BankAccount records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter BankAccount records to those having the specified unique identifiers.
limit	string	No	A limit on the number of BankAccount records to be returned. Limit can range between 1 and 200. Default: `200`.
order	string	No	Orders the BankAccount records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
show_empty_accounts	string	No	Filter BankAccount records to those having a zero or non zero balance.
status	string	No	Filter BankAccount records to those having a specific status.
type	string	No	Filter BankAccount records to those having a specific type.
updated_since	string	No	Filter BankAccount records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).
user_id	string	No	The unique identifier for a single User. Use the keyword `null` to match those without a BankAccount. The list will be filtered to include only the BankAccount records with the matching property.

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_bank_accounts"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_bank_accounts",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/bank_accounts
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_bank_account/bank_accounts

Create a new BankAccount

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
account_number	string	No
balance	number	No
client	object	No
controlled_account	boolean	No
currency	string	Yes
default_account	boolean	No
domicile_branch	string	No
general_ledger_number	string	No
holder	string	No
institution	string	No
matter	object	No
name	string	No
swift	string	No
transit_number	string	No
type	object	Yes

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_bank_account"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_bank_account",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/bank_accounts
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "account_number": "<account_number>",
  "balance": 1,
  "client": "<client>",
  "controlled_account": "<controlled_account>",
  "currency": "<currency>"
}

Response

{
  "data": null
}

GETget_bank_account/bank_accounts/:id

Return the data for a single BankAccount

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the BankAccount.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_bank_account"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_bank_account",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/bank_accounts/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_bank_account/bank_accounts/:id

Update a single BankAccount

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the BankAccount.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
account_number	string	No
client	object	No
controlled_account	boolean	No
currency	string	No
default_account	boolean	No
domicile_branch	string	No
general_ledger_number	string	No
holder	string	No
institution	string	No
matter	object	No
name	string	No
swift	string	No
transit_number	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_bank_account"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_bank_account",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/bank_accounts/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "account_number": "<account_number>",
  "client": "<client>",
  "controlled_account": "<controlled_account>",
  "currency": "<currency>",
  "default_account": "<default_account>"
}

Response

{
  "data": null
}

DELETEdelete_bank_account/bank_accounts/:id

Delete a single BankAccount

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the BankAccount.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_bank_account"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_bank_account",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/bank_accounts/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_bank_transactions/bank_transactions

Return the data for all BankTransactions

Request

Query Parameters

Name	Type	Required	Description
bank_account_id	string	No	The unique identifier for a single BankAccount. The keyword `null` is not valid for this field. The list will be filtered to include only the BankTransaction records with the matching property.
client_id	string	No	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 BankTransaction records with the matching property.
created_since	string	No	Filter BankTransaction records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter BankTransaction records to those having the specified unique identifiers.
limit	string	No	A limit on the number of BankTransaction records to be returned. Limit can range between 1 and 200. Default: `200`.
matter_id	string	No	The unique identifier for a single Matter. The keyword `null` is not valid for this field. The list will be filtered to include only the BankTransaction records with the matching property.
order	string	No	Orders the BankTransaction records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
type	string	No	Filter BankTransaction records to those having a specific type.
unreconciled_only	string	No	Filter BankTransaction records to only those that are unreconciled
updated_since	string	No	Filter BankTransaction records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_bank_transactions"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_bank_transactions",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/bank_transactions
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_bank_transaction/bank_transactions

Create a new BankTransaction

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
amount	number	Yes
bank_account	object	Yes
bank_account_transaction_type	string	No
client	object	No
confirmation	string	No
currency	string	No
date	string	Yes
description	string	No
exchange_rate	number	No
matter	object	No
source	string	No
transaction_type	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_bank_transaction"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_bank_transaction",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/bank_transactions
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "amount": 1,
  "bank_account": "<bank_account>",
  "bank_account_transaction_type": "<bank_account_transaction_type>",
  "client": "<client>",
  "confirmation": "<confirmation>"
}

Response

{
  "data": null
}

GETget_bank_transaction/bank_transactions/:id

Return the data for a single BankTransaction

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the BankTransaction.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_bank_transaction"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_bank_transaction",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/bank_transactions/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_bank_transaction/bank_transactions/:id

Update a single BankTransaction

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the BankTransaction.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
amount	number	No
bank_account	object	No
bank_account_transaction_type	string	No
client	object	No
confirmation	string	No
currency	string	No
date	string	No
description	string	No
exchange_rate	number	No
matter	object	No
source	string	No
transaction_type	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_bank_transaction"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_bank_transaction",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/bank_transactions/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "amount": 1,
  "bank_account": "<bank_account>",
  "bank_account_transaction_type": "<bank_account_transaction_type>",
  "client": "<client>",
  "confirmation": "<confirmation>"
}

Response

{
  "data": null
}

DELETEdelete_bank_transaction/bank_transactions/:id

Delete a single BankTransaction

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the BankTransaction.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_bank_transaction"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_bank_transaction",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/bank_transactions/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETget_bank_transfer/bank_transfers/:id

Return the data for a single BankTransfer

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the BankTransfer.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_bank_transfer"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_bank_transfer",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/bank_transfers/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

GETlist_bill_themes/bill_themes

Return the data for all BillThemes

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter BillTheme records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter BillTheme records to those having the specified unique identifiers.
limit	string	No	A limit on the number of BillTheme records to be returned. Limit can range between 1 and 200. Default: `200`.
page_token	string	No	A token specifying which page to return.
updated_since	string	No	Filter BillTheme records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_bill_themes"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_bill_themes",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/bill_themes
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

PATCHupdate_bill_theme/bill_themes/:id

Update a single BillTheme

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the BillTheme.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required	Description
config	string	No
name	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_bill_theme"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_bill_theme",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/bill_themes/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "config": "<config>",
  "name": "<name>"
}

Response

{
  "data": null
}

GETlist_billable_clients/billable_clients

Return the data for all BillableClients

Request

Query Parameters

Name	Type	Required	Description
client_id	string	No	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 BillableClient records with the matching property.
custom_field_values	string	No	Filter records to only those with the given custom field(s) set. The value is compared using the operator provided, or, if 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. The key for the custom field value filter is the custom_field.id. e.g. `custom_field_values[12345]` If an operator is used for a type that does not support it, an `400 Bad Request` is returned. Supported operators: * `checkbox`, `contact`, `matter`, `picklist` : `=` e.g. `?custom_field_values[1]=42` * `currency`, `date`, `time`, `numeric` : `=`, `<`, `>`, `<=`, `>=` 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]`
end_date	string	No	Filter BillableClient records to those that have Matters with unbilled Activities on or before this date (Expects an ISO-8601 date).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
limit	string	No	A limit on the number of BillableClient records to be returned. Limit can range between 1 and 25. Default: `25`.
matter_id	string	No	The unique identifier for a single Matter. The keyword `null` is not valid for this field. The list will be filtered to include only the BillableClient records with the matching property.
originating_attorney_id	string	No	The unique identifier for a single User. Use the keyword `null` to match those without a BillableClient. The list will be filtered to include only the BillableClient records with the matching property.
page_token	string	No	A token specifying which page to return.
query	string	No	Wildcard search for `display_number` or `number` or `description` matching a given string.
responsible_attorney_id	string	No	The unique identifier for a single User. Use the keyword `null` to match those without a BillableClient. The list will be filtered to include only the BillableClient records with the matching property.
start_date	string	No	Filter BillableClient records to those that have Matters with unbilled Activities on or after this date (Expects an ISO-8601 date).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_billable_clients"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_billable_clients",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/billable_clients
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETlist_billable_matter_ids/billable_matters/ids

Returns the unique identifiers of all BillableMatter

Request

Query Parameters

Name	Type	Required	Description
client_id	string	No	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 BillableMatter records with the matching property.
custom_field_values	string	No	Filter records to only those with the given custom field(s) set. The value is compared using the operator provided, or, if 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. The key for the custom field value filter is the custom_field.id. e.g. `custom_field_values[12345]` If an operator is used for a type that does not support it, an `400 Bad Request` is returned. Supported operators: * `checkbox`, `contact`, `matter`, `picklist` : `=` e.g. `?custom_field_values[1]=42` * `currency`, `date`, `time`, `numeric` : `=`, `<`, `>`, `<=`, `>=` 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]`
end_date	string	No	Filter BillableMatter records to those that have matters with unbilled activities on or before this date (Expects an ISO-8601 date).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
limit	string	No	A limit on the number of BillableMatter records to be returned. Limit can range between 1 and 1000. Default: `1000`.
matter_id	string	No	The unique identifier for a single Matter. The keyword `null` is not valid for this field. The list will be filtered to include only the BillableMatter records with the matching property.
originating_attorney_id	string	No	The unique identifier for a single User. Use the keyword `null` to match those without a BillableMatter. The list will be filtered to include only the BillableMatter records with the matching property.
page_token	string	No	A token specifying which page to return.
query	string	No	Wildcard search for `display_number` or `number` or `description` matching a given string.
responsible_attorney_id	string	No	The unique identifier for a single User. Use the keyword `null` to match those without a BillableMatter. The list will be filtered to include only the BillableMatter records with the matching property.
start_date	string	No	Filter BillableMatter records to those that have matters with unbilled activities on or after this date (Expects an ISO-8601 date).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_billable_matter_ids"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_billable_matter_ids",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/billable_matters/ids
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETlist_billable_matters/billable_matters

Return the data for all BillableMatters

Request

Query Parameters

Name	Type	Required	Description
client_id	string	No	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 BillableMatter records with the matching property.
custom_field_values	string	No	Filter records to only those with the given custom field(s) set. The value is compared using the operator provided, or, if 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. The key for the custom field value filter is the custom_field.id. e.g. `custom_field_values[12345]` If an operator is used for a type that does not support it, an `400 Bad Request` is returned. Supported operators: * `checkbox`, `contact`, `matter`, `picklist` : `=` e.g. `?custom_field_values[1]=42` * `currency`, `date`, `time`, `numeric` : `=`, `<`, `>`, `<=`, `>=` 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]`
end_date	string	No	Filter BillableMatter records to those that have matters with unbilled activities on or before this date (Expects an ISO-8601 date).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
limit	string	No	A limit on the number of BillableMatter records to be returned. Limit can range between 1 and 1000. Default: `1000`.
matter_id	string	No	The unique identifier for a single Matter. The keyword `null` is not valid for this field. The list will be filtered to include only the BillableMatter records with the matching property.
originating_attorney_id	string	No	The unique identifier for a single User. Use the keyword `null` to match those without a BillableMatter. The list will be filtered to include only the BillableMatter records with the matching property.
page_token	string	No	A token specifying which page to return.
query	string	No	Wildcard search for `display_number` or `number` or `description` matching a given string.
responsible_attorney_id	string	No	The unique identifier for a single User. Use the keyword `null` to match those without a BillableMatter. The list will be filtered to include only the BillableMatter records with the matching property.
start_date	string	No	Filter BillableMatter records to those that have matters with unbilled activities on or after this date (Expects an ISO-8601 date).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_billable_matters"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_billable_matters",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/billable_matters
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETpreview_bill/bills/:id/preview

Returns the pre-rendered html for the Bill

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Bill.

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "preview_bill"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "preview_bill",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/bills/:id/preview
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

// Raw JSON from upstream API

GETlist_bills/bills

Return the data for all Bills

Request

Query Parameters

Name	Type	Required	Description
bill_number	string	No	Filter Bill records to those with this exact bill number
client_id	string	No	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 Bill records with the matching property.
created_since	string	No	Filter Bill records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
currency_id	string	No	Filter Bill records to those of a specific currency.
custom_field_values	string	No	Filter records to only those with the given custom field(s) set. The value is compared using the operator provided, or, if 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. The key for the custom field value filter is the custom_field.id. e.g. `custom_field_values[12345]` If an operator is used for a type that does not support it, an `400 Bad Request` is returned. Supported operators: * `checkbox`, `contact`, `matter`, `picklist` : `=` e.g. `?custom_field_values[1]=42` * `currency`, `date`, `time`, `numeric` : `=`, `<`, `>`, `<=`, `>=` 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]`
due_after	string	No	Filter Bill records to those that have a `due_date` after the one provided (Expects an ISO-8601 date).
due_at	string	No	Filter Bill records to those that have a specific `due_date` (Expects an ISO-8601 date).
due_before	string	No	Filter Bill records to those that have a `due_date` before the one provided (Expects an ISO-8601 date).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter Bill records to those having the specified unique identifiers.
issued_after	string	No	Filter Bill records to those that have an `issue_date` after the one provided (Expects an ISO-8601 date).
issued_before	string	No	Filter Bill records to those that have an `issue_date` before the one provided (Expects an ISO-8601 date).
last_sent_end_date	string	No	Filter Bill records for those whose bills have been sent before the specified date
last_sent_start_date	string	No	Filter Bill records for those whose bills have been sent after the specified date
limit	string	No	A limit on the number of Bill records to be returned. Limit can range between 1 and 200. Default: `200`.
matter_id	string	No	The unique identifier for a single Matter. Use the keyword `null` to match those without a Bill. The list will be filtered to include only the Bill records with the matching property.
order	string	No	Orders the Bill records by the given field. Default: `id(asc)`.
originating_attorney_id	string	No	The unique identifier for a single User. Use the keyword `null` to match those without a Bill. The list will be filtered to include only the Bill records with the matching property.
overdue_only	string	No	Filter Bill records to those that are overdue.
page_token	string	No	A token specifying which page to return.
query	string	No	Allows matching search on invoice number.
responsible_attorney_id	string	No	The unique identifier for a single User. Use the keyword `null` to match those without a Bill. The list will be filtered to include only the Bill records with the matching property.
state	string	No	Filter Bill records to those in a given state.
status	string	No	Filter Bill records to those with particular payment status.
type	string	No	Filter Bill records to those of a specific type.
updated_since	string	No	Filter Bill records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_bills"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_bills",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/bills
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETget_bill/bills/:id

Return the data for a single Bill

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Bill.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
navigation.next	string	No	The id of the next Bill available for viewing
navigation.previous	string	No	The id of the previous Bill available for viewing

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_bill"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_bill",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/bills/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_bill/bills/:id

Update a single Bill

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Bill.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
bill_theme	object	No
currency_id	number	No
discount	object	No
due_at	string	No
interest	object	No
issued_at	string	No
memo	string	No
number	string	No
purchase_order	string	No
secondary_tax_rate	number	No
state	object	No
subject	string	No
tax_rate	number	No
use_grace_period	boolean	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_bill"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_bill",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/bills/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "bill_theme": "<bill_theme>",
  "currency_id": 1,
  "discount": "<discount>",
  "due_at": "<due_at>",
  "interest": "<interest>"
}

Response

{
  "data": null
}

DELETEdelete_bill/bills/:id

Delete or void a Bill

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Bill.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_bill"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_bill",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/bills/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_calendar_entries/calendar_entries

Return the data for all CalendarEntries

Request

Query Parameters

Name	Type	Required	Description
calendar_id	string	No	The unique identifier for a single Calendar. The keyword `null` is not valid for this field. The list will be filtered to include only the CalendarEntry records with the matching property.
created_since	string	No	Filter CalendarEntry records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
expanded	string	No	Returns a record for each occurrence of a recurring calendar event. Non-recurring calendar events are unaffected and returned as separate records regardless of the expanded setting.
external_property_name	string	No	Filter records to only those with the given external property(s) name set. e.g. `?external_property_name=Name`
external_property_value	string	No	Filter records to only those with the given external property(s) value set. Requires external property name as well. e.g. `?external_property_name=Name&external_property_value=Value`
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
from	string	No	Filter CalendarEntry records to those that end on or after the provided time (Expects an ISO-8601 timestamp).
has_court_rule	string	No	Allows matching court rule on calendar entry.
ids[]	string	No	Filter CalendarEntry records to those having the specified unique identifiers.
is_all_day	string	No	Filter CalendarEntry records to those that are marked as all day events.
limit	string	No	A limit on the number of CalendarEntry records to be returned. Limit can range between 1 and 200. Default: `200`.
matter_id	string	No	The unique identifier for a single Matter. Use the keyword `null` to match those without a CalendarEntry. The list will be filtered to include only the CalendarEntry records with the matching property.
owner_entries_across_all_users	string	No	Returns CalendarEntry records for all users related to a matter. Requires matter id.
page_token	string	No	A token specifying which page to return.
query	string	No	Allows matching search on calendar entry.
source	string	No	Filter CalendarEntry records to those having a specific calendar visibility source (mobile, web).
to	string	No	Filter CalendarEntry records to those that begin on or before the provided time (Expects an ISO-8601 timestamp).
updated_since	string	No	Filter CalendarEntry records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).
visible	string	No	Filter CalendarEntry records to those that are visible.

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_calendar_entries"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_calendar_entries",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/calendar_entries
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_calendar_entry/calendar_entries

Create a new CalendarEntry

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
_deleted	object	No
all_day	boolean	No
attendees	array	No
calendar_entry_event_type	object	No
calendar_owner	object	Yes
conference_meeting	object	No
description	string	No
end_at	string	Yes
external_properties	array	No
location	string	No
matter	object	No
recurrence_rule	string	No
send_email_notification	boolean	No
start_at	string	Yes
summary	string	Yes

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_calendar_entry"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_calendar_entry",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/calendar_entries
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "_deleted": "<_deleted>",
  "all_day": "<all_day>",
  "attendees": "<attendees>",
  "calendar_entry_event_type": "<calendar_entry_event_type>",
  "calendar_owner": "<calendar_owner>"
}

Response

{
  "data": null
}

GETget_calendar_entry/calendar_entries/:id

Return the data for a single CalendarEntry

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the CalendarEntry.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_calendar_entry"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_calendar_entry",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/calendar_entries/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_calendar_entry/calendar_entries/:id

Update a single CalendarEntry

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the CalendarEntry.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
_deleted	object	No
all_day	boolean	No
attendees	array	No
calendar_entry_event_type	object	No
calendar_owner	object	No
conference_meeting	object	No
description	string	No
end_at	string	No
external_properties	array	No
location	string	No
matter	object	No
recurrence_rule	string	No
send_email_notification	boolean	No
start_at	string	No
summary	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_calendar_entry"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_calendar_entry",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/calendar_entries/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "_deleted": "<_deleted>",
  "all_day": "<all_day>",
  "attendees": "<attendees>",
  "calendar_entry_event_type": "<calendar_entry_event_type>",
  "calendar_owner": "<calendar_owner>"
}

Response

{
  "data": null
}

DELETEdelete_calendar_entry/calendar_entries/:id

Delete a single CalendarEntry

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the CalendarEntry.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_calendar_entry"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_calendar_entry",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/calendar_entries/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_calendar_entry_event_types/calendar_entry_event_types

Return the data for all calendar entry event types

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter CalendarEntryEventType records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter CalendarEntryEventType records to those having the specified unique identifiers.
limit	string	No	A limit on the number of CalendarEntryEventType records to be returned. Limit can range between 1 and 200. Default: `200`.
page_token	string	No	A token specifying which page to return.
updated_since	string	No	Filter CalendarEntryEventType records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_calendar_entry_event_types"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_calendar_entry_event_types",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/calendar_entry_event_types
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_calendar_entry_event_type/calendar_entry_event_types

Create a new calendar entry event type

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required	Description
color	object	Yes
name	string	Yes

Response

unknown

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_calendar_entry_event_type"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_calendar_entry_event_type",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/calendar_entry_event_types
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "color": "<color>",
  "name": "<name>"
}

GETget_calendar_entry_event_type/calendar_entry_event_types/:id

Return the data for a single calendar entry event type

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the CalendarEntryEventType.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

unknown

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_calendar_entry_event_type"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_calendar_entry_event_type",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/calendar_entry_event_types/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

PATCHupdate_calendar_entry_event_type/calendar_entry_event_types/:id

Update a single calendar entry event type

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the CalendarEntryEventType.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required	Description
color	object	No
name	string	No

Response

unknown

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_calendar_entry_event_type"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_calendar_entry_event_type",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/calendar_entry_event_types/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "color": "<color>",
  "name": "<name>"
}

DELETEdelete_calendar_entry_event_type/calendar_entry_event_types/:id

Delete a single calendar entry event type

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the CalendarEntryEventType.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_calendar_entry_event_type"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_calendar_entry_event_type",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/calendar_entry_event_types/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_calendars/calendars

Return the data for all Calendars

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter Calendar records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
filter_inactive_users	string	No	Filter any shared UserCalendar records whose owner is inactive.
ids[]	string	No	Filter Calendar records to those having the specified unique identifiers.
limit	string	No	A limit on the number of Calendar records to be returned. Limit can range between 1 and 200. Default: `200`.
order	string	No	Orders the Calendar records by the given field. Default: `id(asc)`.
owner	string	No	Filter Calendar records to those that the user owns.
page_token	string	No	A token specifying which page to return.
source	string	No	Filter Calendar records to those having a specific calendar visibility source (mobile, web).
type	string	No	Filter Calendar records to those of the specified type.
updated_since	string	No	Filter Calendar records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).
visible	string	No	Filter Calendar records to those that are visible.
writeable	string	No	Filter Calendar records to those which the user can write to.

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_calendars"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_calendars",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/calendars
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_calendar/calendars

Create a new Calendar

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
color	object	No
name	string	Yes
source	object	No
visible	boolean	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_calendar"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_calendar",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/calendars
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "color": "<color>",
  "name": "<name>",
  "source": "<source>",
  "visible": "<visible>"
}

Response

{
  "data": null
}

GETget_calendar/calendars/:id

Return the data for a single Calendar

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Calendar.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_calendar"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_calendar",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/calendars/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_calendar/calendars/:id

Update a single Calendar

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Calendar.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
color	object	No
name	string	No
source	object	No
visible	boolean	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_calendar"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_calendar",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/calendars/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "color": "<color>",
  "name": "<name>",
  "source": "<source>",
  "visible": "<visible>"
}

Response

{
  "data": null
}

DELETEdelete_calendar/calendars/:id

Delete a single Calendar

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Calendar.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_calendar"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_calendar",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/calendars/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_clio_file_submissions/clio_file/submissions_reports

Return the data for all ClioFile::Submissions

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter ClioFile::Submission records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter ClioFile::Submission records to those having the specified unique identifiers.
limit	string	No	A limit on the number of ClioFile::Submission records to be returned. Limit can range between 1 and 200. Default: `200`.
order	string	No	Orders the ClioFile::Submission records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
submitted_after	string	No	Filter ClioFile::Submission records to those whose `submitted_date` is on or after the given date (Expects an ISO-8601 date).
submitted_before	string	No	Filter ClioFile::Submission records to those whose `submitted_date` is on or before the given date (Expects an ISO-8601 date).
updated_since	string	No	Filter ClioFile::Submission records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_clio_file_submissions"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_clio_file_submissions",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/clio_file/submissions_reports
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETlist_clio_payments_links/clio_payments/links

Return the data for all ClioPaymentsLinks

Request

Query Parameters

Name	Type	Required	Description
active	string	No	Filter ClioPaymentsLink records based on whether or not they have expired.
created_since	string	No	Filter ClioPaymentsLink records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter ClioPaymentsLink records to those having the specified unique identifiers.
limit	string	No	A limit on the number of ClioPaymentsLink records to be returned. Limit can range between 1 and 200. Default: `200`.
page_token	string	No	A token specifying which page to return.
updated_since	string	No	Filter ClioPaymentsLink records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_clio_payments_links"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_clio_payments_links",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/clio_payments/links
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_clio_payments_link/clio_payments/links

Create a new ClioPaymentsLink

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
amount	number	No
currency	string	Yes
description	string	Yes
destination_account	object	Yes
destination_contact	object	No
duration	number	Yes
email_address	string	No
is_allocated_as_revenue	boolean	No
subject	object	Yes

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_clio_payments_link"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_clio_payments_link",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/clio_payments/links
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "amount": 1,
  "currency": "<currency>",
  "description": "<description>",
  "destination_account": "<destination_account>",
  "destination_contact": "<destination_contact>"
}

Response

{
  "data": null
}

GETget_clio_payments_link/clio_payments/links/:id

Return the data for a single ClioPaymentsLink

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the ClioPaymentsLink.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_clio_payments_link"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_clio_payments_link",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/clio_payments/links/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_clio_payments_link/clio_payments/links/:id

Update a single ClioPaymentsLink

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the ClioPaymentsLink.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required	Description
expired	boolean	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_clio_payments_link"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_clio_payments_link",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/clio_payments/links/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "expired": "<expired>"
}

Response

{
  "data": null
}

GETlist_clio_payments_payments/clio_payments/payments

Return the data for all ClioPaymentsPayments

Request

Query Parameters

Name	Type	Required	Description
bill_id	string	No	Filter ClioPaymentsPayment records to those that are allocated to the specified bill.
contact_id	string	No	Filter ClioPaymentsPayment records to those that are assigned to the specified contact.
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter ClioPaymentsPayment records to those having the specified unique identifiers.
limit	string	No	A limit on the number of ClioPaymentsPayment records to be returned. Limit can range between 1 and 200. Default: `200`.
page_token	string	No	A token specifying which page to return.
state	string	No	Filter ClioPaymentsPayment records to those in a given state.

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_clio_payments_payments"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_clio_payments_payments",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/clio_payments/payments
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETget_clio_payments_payment/clio_payments/payments/:id

Return the data for a single ClioPaymentsPayment

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the ClioPaymentsPayment.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_clio_payments_payment"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_clio_payments_payment",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/clio_payments/payments/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

GETlist_communications/communications

Return the data for all Communications

Request

Query Parameters

Name	Type	Required	Description
contact_id	string	No	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 Communication records with the matching property.
created_since	string	No	Filter Communication records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
date	string	No	Filter Communication records to those that occur on the specified date (Expects an ISO-8601 date).
external_property_name	string	No	Filter records to only those with the given external property(s) name set. e.g. `?external_property_name=Name`
external_property_value	string	No	Filter records to only those with the given external property(s) value set. Requires external property name as well. e.g. `?external_property_name=Name&external_property_value=Value`
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
having_time_entries	string	No	Filter Communication records to those that do or do not have time entries.
ids[]	string	No	Filter Communication records to those having the specified unique identifiers.
limit	string	No	A limit on the number of Communication records to be returned. Limit can range between 1 and 200. Default: `200`.
matter_id	string	No	The unique identifier for a single Matter. Use the keyword `null` to match those without a Communication. The list will be filtered to include only the Communication records with the matching property.
order	string	No	Orders the Communication records by the given field. Default: `date(asc)`.
page_token	string	No	A token specifying which page to return.
query	string	No	Wildcard search for `body` or `subject` matching a given string.
received_at	string	No	Filter Communication records to those that occur on the specified date (Expects an ISO-8601 date-time).
received_before	string	No	Filter Communication records to those whose `date` is on or before the date provided (Expects an ISO-8601 date).
received_since	string	No	Filter Communication records to those whose `date` is on or after the date provided (Expects an ISO-8601 date).
type	string	No	Filter Communication records to those of the specified type.
updated_since	string	No	Filter Communication records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).
user_id	string	No	The unique identifier for a single User. The keyword `null` is not valid for this field. The list will be filtered to include only the Communication records with the matching property.

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_communications"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_communications",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/communications
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_communication/communications

Create a new Communication

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
body	string	Yes
external_properties	array	No
matter	object	No
notification_event_subscribers	array	No
received_at	string	Yes
receivers	array	No
senders	array	No
subject	string	Yes
type	object	Yes

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_communication"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_communication",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/communications
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "body": "<body>",
  "external_properties": "<external_properties>",
  "matter": "<matter>",
  "notification_event_subscribers": "<notification_event_subscribers>",
  "received_at": "<received_at>"
}

Response

{
  "data": null
}

GETget_communication/communications/:id

Return the data for a single Communication

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Communication.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_communication"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_communication",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/communications/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_communication/communications/:id

Update a single Communication

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Communication.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
body	string	No
external_properties	array	No
matter	object	No
notification_event_subscribers	array	No
received_at	string	No
receivers	array	No
senders	array	No
subject	string	No
type	object	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_communication"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_communication",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/communications/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "body": "<body>",
  "external_properties": "<external_properties>",
  "matter": "<matter>",
  "notification_event_subscribers": "<notification_event_subscribers>",
  "received_at": "<received_at>"
}

Response

{
  "data": null
}

DELETEdelete_communication/communications/:id

Delete a single Communication

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Communication.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_communication"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_communication",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/communications/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_email_addresses/contacts/:contact_id/email_addresses

Return the data for all EmailAddresses

Request

Path Parameters

Name	Type	Required	Description
contact_id	string	Yes	ID of the Contact

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter EmailAddress records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter EmailAddress records to those having the specified unique identifiers.
limit	string	No	A limit on the number of EmailAddress records to be returned. Limit can range between 1 and 200. Default: `200`.
page_token	string	No	A token specifying which page to return.
updated_since	string	No	Filter EmailAddress records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_email_addresses"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_email_addresses",
      "params": {
        "contact_id": "<contact_id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/contacts/:contact_id/email_addresses
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETlist_phone_numbers/contacts/:contact_id/phone_numbers

Return the data for all PhoneNumbers

Request

Path Parameters

Name	Type	Required	Description
contact_id	string	Yes	ID of the Contact

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter PhoneNumber records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter PhoneNumber records to those having the specified unique identifiers.
limit	string	No	A limit on the number of PhoneNumber records to be returned. Limit can range between 1 and 200. Default: `200`.
page_token	string	No	A token specifying which page to return.
updated_since	string	No	Filter PhoneNumber records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_phone_numbers"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_phone_numbers",
      "params": {
        "contact_id": "<contact_id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/contacts/:contact_id/phone_numbers
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETlist_contacts/contacts

Return the data for all Contacts

Request

Query Parameters

Name	Type	Required	Description
client_only	string	No	Filter Contact records to those that are clients.
clio_connect_only	string	No	Filter Contact records to those that are Clio Connect users.
created_since	string	No	Filter Contact records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
custom_field_ids[]	string	No	Filter Contact's custom_field_values to only include values for the given custom field unique identifiers.
custom_field_values	string	No	Filter records to only those with the given custom field(s) set. The value is compared using the operator provided, or, if 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. The key for the custom field value filter is the custom_field.id. e.g. `custom_field_values[12345]` If an operator is used for a type that does not support it, an `400 Bad Request` is returned. Supported operators: * `checkbox`, `contact`, `matter`, `picklist` : `=` e.g. `?custom_field_values[1]=42` * `currency`, `date`, `time`, `numeric` : `=`, `<`, `>`, `<=`, `>=` 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]`
email_only	string	No	Filter Contact records to those that have email addresses.
exclude_ids[]	string	No	Filter Contact records to those who are not included in the given list of unique identifiers.
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter Contact records to those having the specified unique identifiers.
initial	string	No	Filter Contact records to those where the last name or company name start with the given initial.
limit	string	No	A limit on the number of Contact records to be returned. Limit can range between 1 and 200. Default: `200`.
order	string	No	Orders the Contact records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
query	string	No	Wildcard search for name, title, email address, address, phone number, web site, instant messenger address, custom fields, related matter name, or company name matching a given string.
shared_resource_id	string	No	Filter Contact records to those that currently have access to a given shared resource.
type	string	No	Filter Contact records to those that match the given type.
updated_since	string	No	Filter Contact records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_contacts"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_contacts",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/contacts
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_contact/contacts

Create a new Contact

Request

Query Parameters

Name	Type	Required	Description
custom_field_ids[]	string	No	Filter Contact's custom_field_values to only include values for the given custom field unique identifiers.
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
addresses	array	No
avatar	object	No
clio_connect_email	string	No
co_counsel_rate	object	No
company	object	No
currency	object	No
custom_field_set_associations	array	No
custom_field_values	array	No
date_of_birth	string	No
email_addresses	array	No
first_name	string	No
instant_messengers	array	No
kyc_field_values	array	No
last_name	string	No
ledes_client_id	string	No
middle_name	string	No
name	string	Yes
phone_numbers	array	No
prefix	string	No
sales_tax_number	string	No
title	string	No
type	object	Yes
web_sites	array	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_contact"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_contact",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/contacts
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "addresses": "<addresses>",
  "avatar": "<avatar>",
  "clio_connect_email": "<clio_connect_email>",
  "co_counsel_rate": "<co_counsel_rate>",
  "company": "<company>"
}

Response

{
  "data": null
}

GETget_contact/contacts/:id

Return the data for a single Contact

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Contact.

Query Parameters

Name	Type	Required	Description
custom_field_ids[]	string	No	Filter Contact's custom_field_values to only include values for the given custom field unique identifiers.
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_contact"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_contact",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/contacts/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_contact/contacts/:id

Update a single Contact

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Contact.

Query Parameters

Name	Type	Required	Description
custom_field_ids[]	string	No	Filter Contact's custom_field_values to only include values for the given custom field unique identifiers.
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
addresses	array	No
avatar	object	No
clio_connect_email	string	No
co_counsel_rate	object	No
company	object	No
currency	object	No
custom_field_set_associations	array	No
custom_field_values	array	No
date_of_birth	string	No
email_addresses	array	No
first_name	string	No
instant_messengers	array	No
kyc_field_values	array	No
last_name	string	No
ledes_client_id	string	No
middle_name	string	No
name	string	No
phone_numbers	array	No
prefix	string	No
sales_tax_number	string	No
title	string	No
type	object	No
web_sites	array	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_contact"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_contact",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/contacts/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "addresses": "<addresses>",
  "avatar": "<avatar>",
  "clio_connect_email": "<clio_connect_email>",
  "co_counsel_rate": "<co_counsel_rate>",
  "company": "<company>"
}

Response

{
  "data": null
}

DELETEdelete_contact/contacts/:id

Delete a single Contact

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Contact.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_contact"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_contact",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/contacts/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_conversation_messages/conversation_messages

Return the data for all ConversationMessages

Request

Query Parameters

Name	Type	Required	Description
conversation_id	string	No	The unique identifier for a single Conversation. Use the keyword `null` to match those without a ConversationMessage. The list will be filtered to include only the ConversationMessage records with the matching property.
created_since	string	No	Filter ConversationMessage records to those having the `created_at` field on the related Conversation after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter ConversationMessage records to those having the specified unique identifiers.
limit	string	No	A limit on the number of ConversationMessage records to be returned. Limit can range between 1 and 200. Default: `200`.
order	string	No	Orders the ConversationMessage records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
query	string	No	Wildcard search for `body` matching a given string.
updated_since	string	No	Filter ConversationMessage records to those having the `updated_at` field on the related Conversation after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_conversation_messages"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_conversation_messages",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/conversation_messages
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_conversation_message/conversation_messages

Create a new ConversationMessage

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
attachment	object	No
body	string	Yes
conversation	object	No
matter	object	No
receivers	array	Yes
subject	string	Yes

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_conversation_message"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_conversation_message",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/conversation_messages
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "attachment": "<attachment>",
  "body": "<body>",
  "conversation": "<conversation>",
  "matter": "<matter>",
  "receivers": "<receivers>"
}

Response

{
  "data": null
}

GETget_conversation_message/conversation_messages/:id

Return the data for a single ConversationMessage

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the ConversationMessage.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_conversation_message"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_conversation_message",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/conversation_messages/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

GETlist_conversations/conversations

Return the data for all Conversations

Request

Query Parameters

Name	Type	Required	Description
archived	string	No	Filter archived Conversation records.
contact_id	string	No	Filter Conversation records for the contact.
created_since	string	No	Filter Conversation records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
date	string	No	Filter Conversation records created on a given date. (Expects an ISO-8601 date).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
for_user	string	No	If set to true, filter Conversation records accessible to any groups of the user. Note that the user may not be member of the conversations. If set to false, filter Conversation records of which the user is a member.
ids[]	string	No	Filter Conversation records to those having the specified unique identifiers.
limit	string	No	A limit on the number of Conversation records to be returned. Limit can range between 1 and 200. Default: `200`.
matter_id	string	No	The unique identifier for a single Matter. Use the keyword `null` to match those without a Conversation. The list will be filtered to include only the Conversation records with the matching property.
order	string	No	Orders the Conversation records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
read_status	string	No	Filter Conversation records to those which have been read.
time_entries	string	No	Filter Conversation records to those with or without associated time entries.
updated_since	string	No	Filter Conversation records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_conversations"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_conversations",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/conversations
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETget_conversation/conversations/:id

Return the data for a single Conversation

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Conversation.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_conversation"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_conversation",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/conversations/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_conversation/conversations/:id

Update a single Conversation

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Conversation.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
archived	boolean	No
matter	object	No
read	boolean	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_conversation"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_conversation",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/conversations/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "archived": "<archived>",
  "matter": "<matter>",
  "read": "<read>"
}

Response

{
  "data": null
}

GETlist_jurisdictions_to_triggers/court_rules/jurisdictions/:jurisdiction_id/triggers

Return the data for all triggers

Request

Path Parameters

Name	Type	Required	Description
jurisdiction_id	string	Yes	The unique identifier for the Jurisdiction.

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter JurisdictionsToTrigger records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter JurisdictionsToTrigger records to those having the specified unique identifiers.
is_requirements_required	string	No	Filter JurisdictionsToTrigger records to those which require addition requirements to be checked (usually specifying trigger time).
is_served	string	No	Filter JurisdictionsToTrigger records to those which require a service type to be selected.
limit	string	No	A limit on the number of JurisdictionsToTrigger records to be returned. Limit can range between 1 and 1000. Default: `1000`.
order	string	No	Orders the JurisdictionsToTrigger records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
query	string	No	Wildcard search for `description` matching a given string.
updated_since	string	No	Filter JurisdictionsToTrigger records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_jurisdictions_to_triggers"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_jurisdictions_to_triggers",
      "params": {
        "jurisdiction_id": "<jurisdiction_id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/court_rules/jurisdictions/:jurisdiction_id/triggers
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETget_jurisdictions_to_trigger/court_rules/jurisdictions/:jurisdiction_id/triggers/:id

Return the data for the trigger

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the JurisdictionsToTrigger.
jurisdiction_id	string	Yes	The unique identifier for the Jurisdiction.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_jurisdictions_to_trigger"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_jurisdictions_to_trigger",
      "params": {
        "id": "<id>",
        "jurisdiction_id": "<jurisdiction_id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/court_rules/jurisdictions/:jurisdiction_id/triggers/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

GETlist_jurisdictions/court_rules/jurisdictions

Return the data for all jurisdictions

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter Jurisdiction records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
for_current_account	string	No	Filter Jurisdiction records to those set up for this account.
ids[]	string	No	Filter Jurisdiction records to those having the specified unique identifiers.
limit	string	No	A limit on the number of Jurisdiction records to be returned. Limit can range between 1 and 200. Default: `200`.
order	string	No	Orders the Jurisdiction records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
query	string	No	Wildcard search for `description` matching a given string.
updated_since	string	No	Filter Jurisdiction records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_jurisdictions"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_jurisdictions",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/court_rules/jurisdictions
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETget_jurisdiction/court_rules/jurisdictions/:id

Return the data for the jurisdiction

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Jurisdiction.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_jurisdiction"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_jurisdiction",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/court_rules/jurisdictions/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

GETpreview_matter_docket/court_rules/matter_dockets/preview

Preview calendar dates for the docket

Request

Query Parameters

Name	Type	Required	Description
event_prefix	string	No	The prefix that will be added to the beginning of all court rule event titles
jurisdiction[id]	string	No	The unique identifier for a single Jurisdiction. The keyword `null` is not valid for this field. The list will be filtered to include only the MatterDocket records with the matching property.
service_type[id]	string	No	The unique identifier for a single ServiceType. The keyword `null` is not valid for this field. The list will be filtered to include only the MatterDocket records with the matching property.
start_date	string	No	The date the MatterDocket should start. (Expects an ISO-8601 date).
start_time	string	No	The time the MatterDocket should start. (Expects an ISO-8601 timestamp).
trigger[id]	string	No	The unique identifier for a single JurisdictionsToTrigger. The keyword `null` is not valid for this field. The list will be filtered to include only the MatterDocket records with the matching property.

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "preview_matter_docket"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "preview_matter_docket",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/court_rules/matter_dockets/preview
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

// Raw JSON from upstream API

GETlist_matter_dockets/court_rules/matter_dockets

Return the data for all matter dockets

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter MatterDocket records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter MatterDocket records to those having the specified unique identifiers.
limit	string	No	A limit on the number of MatterDocket records to be returned. Limit can range between 1 and 200. Default: `200`.
matter_id	string	No	The unique identifier for a single Matter. The keyword `null` is not valid for this field. The list will be filtered to include only the MatterDocket records with the matching property.
matter_status	string	No	Filter MatterDocket records to those with Matters having a specific status.
order	string	No	Orders the MatterDocket records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
query	string	No	Wildcard search for `name` matching a given string.
service_type_id	string	No	The unique identifier for a single ServiceType. Use the keyword `null` to match those without a MatterDocket. The list will be filtered to include only the MatterDocket records with the matching property.
status	string	No	Filter MatterDocket records to those having a specific status.
updated_since	string	No	Filter MatterDocket records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_matter_dockets"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_matter_dockets",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/court_rules/matter_dockets
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_matter_docket/court_rules/matter_dockets

Creates a matter docket

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
jurisdiction	object	Yes
name	string	Yes
start_date	string	Yes
start_time	string	No
trigger	object	Yes

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_matter_docket"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_matter_docket",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/court_rules/matter_dockets
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "jurisdiction": "<jurisdiction>",
  "name": "<name>",
  "start_date": "<start_date>",
  "start_time": "<start_time>",
  "trigger": "<trigger>"
}

Response

{
  "data": null
}

GETget_matter_docket/court_rules/matter_dockets/:id

Return the data for the matter docket

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the MatterDocket.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_matter_docket"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_matter_docket",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/court_rules/matter_dockets/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

DELETEdelete_matter_docket/court_rules/matter_dockets/:id

Deletes the requested matter docket

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the MatterDocket.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_matter_docket"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_matter_docket",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/court_rules/matter_dockets/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_service_types/court_rules/service_types

Return the data for all service types

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter ServiceType records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter ServiceType records to those having the specified unique identifiers.
limit	string	No	A limit on the number of ServiceType records to be returned. Limit can range between 1 and 200. Default: `200`.
order	string	No	Orders the ServiceType records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
updated_since	string	No	Filter ServiceType records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_service_types"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_service_types",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/court_rules/service_types
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETget_service_type/court_rules/service_types/:id

Return the data for the service type

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the ServiceType.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_service_type"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_service_type",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/court_rules/service_types/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

GETlist_credit_memos/credit_memos

Return the data for all CreditMemos

Request

Query Parameters

Name	Type	Required	Description
contact_id	string	No	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 CreditMemo records with the matching property.
created_since	string	No	Filter CreditMemo records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter CreditMemo records to those having the specified unique identifiers.
limit	string	No	A limit on the number of CreditMemo records to be returned. Limit can range between 1 and 200. Default: `200`.
order	string	No	Orders the CreditMemo records by the given field. Default: `date(asc)`.
page_token	string	No	A token specifying which page to return.
updated_since	string	No	Filter CreditMemo records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_credit_memos"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_credit_memos",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/credit_memos
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETget_credit_memo/credit_memos/:id

Return the data for a single CreditMemo

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the CreditMemo.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_credit_memo"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_credit_memo",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/credit_memos/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

GETlist_currencies/currencies

Return the data for all Currencies

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter Currency records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter Currency records to those having the specified unique identifiers.
limit	string	No	A limit on the number of Currency records to be returned. Limit can range between 1 and 200. Default: `200`.
page_token	string	No	A token specifying which page to return.
updated_since	string	No	Filter Currency records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_currencies"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_currencies",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/currencies
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETlist_custom_fields/custom_fields

Return the data for all CustomFields

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter CustomField records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
deleted	string	No	Filter CustomField records to those that have been deleted for future use.
field_type	string	No	Field type of this custom field
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter CustomField records to those having the specified unique identifiers.
limit	string	No	A limit on the number of CustomField records to be returned. Limit can range between 1 and 200. Default: `200`.
order	string	No	Orders the CustomField records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
parent_type	string	No	Filter CustomField records to those that have the specified `parent_type`.
query	string	No	Wildcard search for `name` matching a given string.
updated_since	string	No	Filter CustomField records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).
visible_and_required	string	No	Filter CustomField records to those that are visible and required.

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_custom_fields"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_custom_fields",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/custom_fields
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_custom_field/custom_fields

Create a new CustomField

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
display_order	number	No
displayed	boolean	Yes
field_type	object	Yes
name	string	Yes
parent_type	object	Yes
picklist_options	array	No
required	boolean	Yes

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_custom_field"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_custom_field",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/custom_fields
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "display_order": 1,
  "displayed": "<displayed>",
  "field_type": "<field_type>",
  "name": "<name>",
  "parent_type": "<parent_type>"
}

Response

{
  "data": null
}

GETget_custom_field/custom_fields/:id

Return the data for a single CustomField

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the CustomField.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_custom_field"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_custom_field",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/custom_fields/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_custom_field/custom_fields/:id

Update a single CustomField

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the CustomField.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
display_order	number	No
displayed	boolean	Yes
name	string	No
picklist_options	array	No
required	boolean	Yes

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_custom_field"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_custom_field",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/custom_fields/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "display_order": 1,
  "displayed": "<displayed>",
  "name": "<name>",
  "picklist_options": "<picklist_options>",
  "required": "<required>"
}

Response

{
  "data": null
}

DELETEdelete_custom_field/custom_fields/:id

Delete a single CustomField

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the CustomField.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_custom_field"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_custom_field",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/custom_fields/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_custom_field_sets/custom_field_sets

Return the data for all CustomFieldSets

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter CustomFieldSet records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
displayed	string	No	Filter CustomFieldSet records to those that should be displayed by default.
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter CustomFieldSet records to those having the specified unique identifiers.
limit	string	No	A limit on the number of CustomFieldSet records to be returned. Limit can range between 1 and 200. Default: `200`.
order	string	No	Orders the CustomFieldSet records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
parent_type	string	No	Filter CustomFieldSet records to those that have the specified `parent_type`.
query	string	No	Wildcard search for `name` matching a given string.
updated_since	string	No	Filter CustomFieldSet records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_custom_field_sets"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_custom_field_sets",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/custom_field_sets
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_custom_field_set/custom_field_sets

Create a new CustomFieldSet

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
custom_field_ids	array	No
displayed	boolean	No
name	string	Yes
parent_type	object	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_custom_field_set"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_custom_field_set",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/custom_field_sets
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "custom_field_ids": "<custom_field_ids>",
  "displayed": "<displayed>",
  "name": "<name>",
  "parent_type": "<parent_type>"
}

Response

{
  "data": null
}

GETget_custom_field_set/custom_field_sets/:id

Return the data for a single CustomFieldSet

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the CustomFieldSet.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_custom_field_set"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_custom_field_set",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/custom_field_sets/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_custom_field_set/custom_field_sets/:id

Update a single CustomFieldSet

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the CustomFieldSet.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
custom_field_ids	array	No
displayed	boolean	No
name	string	No
parent_type	object	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_custom_field_set"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_custom_field_set",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/custom_field_sets/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "custom_field_ids": "<custom_field_ids>",
  "displayed": "<displayed>",
  "name": "<name>",
  "parent_type": "<parent_type>"
}

Response

{
  "data": null
}

DELETEdelete_custom_field_set/custom_field_sets/:id

Delete a single CustomFieldSet

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the CustomFieldSet.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_custom_field_set"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_custom_field_set",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/custom_field_sets/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_custom_actions/custom_actions

Return the data for all CustomActions

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter CustomAction records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter CustomAction records to those having the specified unique identifiers.
limit	string	No	A limit on the number of CustomAction records to be returned. Limit can range between 1 and 200. Default: `200`.
page_token	string	No	A token specifying which page to return.
updated_since	string	No	Filter CustomAction records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_custom_actions"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_custom_actions",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/custom_actions
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_custom_action/custom_actions

Create a new CustomAction

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
label	string	Yes
target_url	string	Yes
ui_reference	object	Yes

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_custom_action"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_custom_action",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/custom_actions
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "label": "<label>",
  "target_url": "<target_url>",
  "ui_reference": "<ui_reference>"
}

Response

{
  "data": null
}

GETget_custom_action/custom_actions/:id

Return the data for a single CustomAction

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the CustomAction.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_custom_action"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_custom_action",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/custom_actions/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_custom_action/custom_actions/:id

Update a single CustomAction

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the CustomAction.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
label	string	No
target_url	string	No
ui_reference	object	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_custom_action"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_custom_action",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/custom_actions/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "label": "<label>",
  "target_url": "<target_url>",
  "ui_reference": "<ui_reference>"
}

Response

{
  "data": null
}

DELETEdelete_custom_action/custom_actions/:id

Delete a single CustomAction

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the CustomAction.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_custom_action"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_custom_action",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/custom_actions/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_damages/damages

Return the data for all Damages

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter Damage records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter Damage records to those having the specified unique identifiers.
limit	string	No	A limit on the number of Damage records to be returned. Limit can range between 1 and 200. Default: `200`.
page_token	string	No	A token specifying which page to return.
updated_since	string	No	Filter Damage records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_damages"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_damages",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/damages
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_damage/damages

Creating a Damage

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
amount	number	Yes
damage_type	object	Yes
description	string	Yes
matter_id	number	Yes

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_damage"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_damage",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/damages
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "amount": 1,
  "damage_type": "<damage_type>",
  "description": "<description>",
  "matter_id": 1
}

Response

{
  "data": null
}

GETget_damage/damages/:id

Return a specific Damage

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Damage.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_damage"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_damage",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/damages/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_damage/damages/:id

Updating a Damage

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Damage.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
amount	number	No
damage_type	object	No
description	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_damage"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_damage",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/damages/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "amount": 1,
  "damage_type": "<damage_type>",
  "description": "<description>"
}

Response

{
  "data": null
}

DELETEdelete_damage/damages/:id

Deleting a Damage

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Damage.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_damage"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_damage",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/damages/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_expense_categories/expense_categories

Return the data for all ExpenseCategories

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter ExpenseCategory records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
entry_type	string	No	Filter ExpenseCategory records to those that match the given type.
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
limit	string	No	A limit on the number of ExpenseCategory records to be returned. Limit can range between 1 and 200. Default: `200`.
order	string	No	Orders the ExpenseCategory records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
query	string	No	Allows matching search on expense category name.
updated_since	string	No	Filter ExpenseCategory records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_expense_categories"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_expense_categories",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/expense_categories
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_expense_category/expense_categories

Create a new ExpenseCategory

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
currency	object	No
entry_type	object	No
groups	array	No
name	string	Yes
rate	number	No
utbms_code	object	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_expense_category"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_expense_category",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/expense_categories
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "currency": "<currency>",
  "entry_type": "<entry_type>",
  "groups": "<groups>",
  "name": "<name>",
  "rate": 1
}

Response

{
  "data": null
}

GETget_expense_category/expense_categories/:id

Return the data for a single ExpenseCategory

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the ExpenseCategory.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_expense_category"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_expense_category",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/expense_categories/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_expense_category/expense_categories/:id

Update a single ExpenseCategory

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the ExpenseCategory.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
currency	object	No
entry_type	object	No
groups	array	No
name	string	No
rate	number	No
utbms_code	object	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_expense_category"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_expense_category",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/expense_categories/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "currency": "<currency>",
  "entry_type": "<entry_type>",
  "groups": "<groups>",
  "name": "<name>",
  "rate": 1
}

Response

{
  "data": null
}

DELETEdelete_expense_category/expense_categories/:id

Delete a single ExpenseCategory

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the ExpenseCategory.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_expense_category"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_expense_category",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/expense_categories/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_grants/grants

Return the data for all grants

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter Grant records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter Grant records to those having the specified unique identifiers.
limit	string	No	A limit on the number of Grant records to be returned. Limit can range between 1 and 200. Default: `200`.
name	string	No	Filter Grant records to those that match the given name.
page_token	string	No	A token specifying which page to return.
updated_since	string	No	Filter Grant records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_grants"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_grants",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/grants
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_grant/grants

Create a new grant

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required	Description
name	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_grant"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_grant",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/grants
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "name": "<name>"
}

Response

{
  "data": null
}

GETget_grant/grants/:id

Return the data for a single grant

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Grant.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_grant"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_grant",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/grants/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_grant/grants/:id

Update a single grant

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Grant.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required	Description
name	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_grant"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_grant",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/grants/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "name": "<name>"
}

Response

{
  "data": null
}

DELETEdelete_grant/grants/:id

Deletes a single grant

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Grant.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_grant"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_grant",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/grants/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_grant_funding_sources/grant_funding_sources

Return the data for all grant funding sources

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter GrantFundingSource records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter GrantFundingSource records to those having the specified unique identifiers.
limit	string	No	A limit on the number of GrantFundingSource records to be returned. Limit can range between 1 and 200. Default: `200`.
name	string	No	Filter GrantFundingSource records to those that match the given name.
page_token	string	No	A token specifying which page to return.
updated_since	string	No	Filter GrantFundingSource records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_grant_funding_sources"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_grant_funding_sources",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/grant_funding_sources
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_grant_funding_source/grant_funding_sources

Create a new grant funding source

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required	Description
name	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_grant_funding_source"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_grant_funding_source",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/grant_funding_sources
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "name": "<name>"
}

Response

{
  "data": null
}

PATCHupdate_grant_funding_source/grant_funding_sources/:id

Update a single grant funding source

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the GrantFundingSource.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required	Description
name	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_grant_funding_source"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_grant_funding_source",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/grant_funding_sources/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "name": "<name>"
}

Response

{
  "data": null
}

DELETEdelete_grant_funding_source/grant_funding_sources/:id

Delete a single grant funding source

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the GrantFundingSource.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required	Description
name	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_grant_funding_source"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_grant_funding_source",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/grant_funding_sources/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "name": "<name>"
}

Response

{
  "data": null
}

GETlist_groups/groups

Return the data for all Groups

Request

Query Parameters

Name	Type	Required	Description
archived	string	No	Filter archived Group records.
created_since	string	No	Filter Group records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter Group records to those having the specified unique identifiers.
limit	string	No	A limit on the number of Group records to be returned. Limit can range between 1 and 200. Default: `200`.
name	string	No	Filter Group records to those that match the given name.
order	string	No	Orders the Group records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
query	string	No	Wildcard search for `name` matching a given string.
type	string	No	Filter Group records to those that match the given type.
updated_since	string	No	Filter Group records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).
user_id	string	No	The unique identifier for a single User. The keyword `null` is not valid for this field. The list will be filtered to include only the Group records with the matching property.

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_groups"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_groups",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/groups
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_group/groups

Create a new Group

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required	Description
name	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_group"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_group",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/groups
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "name": "<name>"
}

Response

{
  "data": null
}

GETget_group/groups/:id

Return the data for a single Group

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Group.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_group"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_group",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/groups/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_group/groups/:id

Update a single Group

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Group.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required	Description
name	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_group"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_group",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/groups/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "name": "<name>"
}

Response

{
  "data": null
}

DELETEdelete_group/groups/:id

Delete a single Group

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Group.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_group"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_group",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/groups/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_event_metrics/internal_notifications/event_metrics

Unread in-app notification events

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_event_metrics"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_event_metrics",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/internal_notifications/event_metrics
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETlist_my_events/internal_notifications/my_events

Return the data for all of my in-app notification events

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
limit	string	No	A limit on the number of MyEvent records to be returned. Limit can range between 1 and 200. Default: `200`.
page_token	string	No	A token specifying which page to return.

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_my_events"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_my_events",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/internal_notifications/my_events
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

PATCHupdate_my_event/internal_notifications/my_events/:id

Mark a single in-app notification event as read/unread

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the MyEvent.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required	Description
marked_as_read	boolean	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_my_event"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_my_event",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/internal_notifications/my_events/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "marked_as_read": "<marked_as_read>"
}

Response

{
  "data": null
}

DELETEdelete_my_event/internal_notifications/my_events/:id

Clear (delete) a single in-app notification event

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the MyEvent.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_my_event"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_my_event",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/internal_notifications/my_events/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_interest_charges/interest_charges

Return the data for all InterestCharges

Request

Query Parameters

Name	Type	Required	Description
bill_id	string	No	The unique identifier for a single Bill. The keyword `null` is not valid for this field. The list will be filtered to include only the InterestCharge records with the matching property.
created_since	string	No	Filter InterestCharge records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
exclude_ids[]	string	No	Array containing InterestCharge identifiers that should be excluded from the query.
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter InterestCharge records to those having the specified unique identifiers.
limit	string	No	A limit on the number of InterestCharge records to be returned. Limit can range between 1 and 200. Default: `200`.
page_token	string	No	A token specifying which page to return.
updated_since	string	No	Filter InterestCharge records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_interest_charges"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_interest_charges",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/interest_charges
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

DELETEdelete_interest_charge/interest_charges/:id

Delete a single InterestCharge

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the InterestCharge.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_interest_charge"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_interest_charge",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/interest_charges/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_line_items/line_items

Return the data for all LineItems

Request

Query Parameters

Name	Type	Required	Description
activity_id	string	No	The unique identifier for a single Activity. Use the keyword `null` to match those without a LineItem. The list will be filtered to include only the LineItem records with the matching property.
bill_id	string	No	The unique identifier for a single Bill. The keyword `null` is not valid for this field. The list will be filtered to include only the LineItem records with the matching property.
created_since	string	No	Filter LineItem records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
display	string	No	Set this flag to true to return only LineItems displayed on the bill.
exclude_ids[]	string	No	Array containing LineItem identifiers that should be excluded from the query.
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
group_ordering	string	No	Filters LineItem records to match given group ordering.
ids[]	string	No	Filter LineItem records to those having the specified unique identifiers.
kind	string	No	The kind of LineItem.
limit	string	No	A limit on the number of LineItem records to be returned. Limit can range between 1 and 200. Default: `200`.
matter_id	string	No	The unique identifier for a single Matter. Use the keyword `null` to match those without a LineItem. The list will be filtered to include only the LineItem records with the matching property.
page_token	string	No	A token specifying which page to return.
query	string	No	Wildcard search for `description` or `note` matching a given string.
updated_since	string	No	Filter LineItem records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_line_items"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_line_items",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/line_items
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

PATCHupdate_line_item/line_items/:id

Update a single LineItem

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the LineItem.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
activity	object	No
bill	object	No
date	string	No
description	string	No
discount	object	No
group_ordering	number	No
kind	object	No
matter	object	No
note	string	No
price	number	No
quantity	number	No
secondary_taxable	boolean	No
taxable	boolean	No
update_original_record	boolean	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_line_item"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_line_item",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/line_items/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "activity": "<activity>",
  "bill": "<bill>",
  "date": "<date>",
  "description": "<description>",
  "discount": "<discount>"
}

Response

{
  "data": null
}

DELETEdelete_line_item/line_items/:id

Delete a single LineItem

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the LineItem.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_line_item"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_line_item",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/line_items/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_log_entries/log_entries

Return the data for all LogEntries

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter LogEntry records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter LogEntry records to those having the specified unique identifiers.
limit	string	No	A limit on the number of LogEntry records to be returned. Limit can range between 1 and 200. Default: `200`.
order	string	No	Orders the LogEntry records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
updated_since	string	No	Filter LogEntry records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_log_entries"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_log_entries",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/log_entries
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETget_client/matters/:matter_id/client

Return the client data for a single matter

Request

Path Parameters

Name	Type	Required	Description
matter_id	string	Yes	Filters Client data by matter.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_client"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_client",
      "params": {
        "matter_id": "<matter_id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/matters/:matter_id/client
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

GETlist_related_contacts/matters/:matter_id/related_contacts

Return the related contact data for a single matter

Request

Path Parameters

Name	Type	Required	Description
matter_id	string	Yes	Filters RelatedContacts data by matter.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
limit	string	No	A limit on the number of RelatedContacts records to be returned. Limit can range between 1 and 200. Default: `200`.
order	string	No	Orders the RelatedContacts records by the given field. Note that `id` is ordered by the `id` of the nested Relationship record. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_related_contacts"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_related_contacts",
      "params": {
        "matter_id": "<matter_id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/matters/:matter_id/related_contacts
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETlist_matter_contacts/matters/:matter_id/contacts

Return the related contact data for a single matter

Request

Path Parameters

Name	Type	Required	Description
matter_id	string	Yes	Filters contact data by matter.

Query Parameters

Name	Type	Required	Description
custom_field_ids[]	string	No	IDs of custom fields to include in results.
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
limit	string	No	A limit on the number of MatterContacts records to be returned. Limit can range between 1 and 200. Default: `200`.
order	string	No	Orders the MatterContacts records by the given field. Note that `id` is ordered by the `id` of the nested Relationship record. Default: `is_client(asc)`.
page_token	string	No	A token specifying which page to return.

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_matter_contacts"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_matter_contacts",
      "params": {
        "matter_id": "<matter_id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/matters/:matter_id/contacts
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETlist_matters/matters

Return the data for all Matters

Request

Query Parameters

Name	Type	Required	Description
billable	string	No	Filter Matter records to those which are billable.
client_id	string	No	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.
close_date[]	string	No	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.
created_since	string	No	Filter Matter records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
currency_id	string	No	Filter Matter records to those of a specific currency.
custom_field_ids[]	string	No	Filter Matter's custom_field_values to only include values for the given custom field unique identifiers.
custom_field_values	string	No	Filter records to only those with the given custom field(s) set. The value is compared using the operator provided, or, if 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. The key for the custom field value filter is the custom_field.id. e.g. `custom_field_values[12345]` If an operator is used for a type that does not support it, an `400 Bad Request` is returned. Supported operators: * `checkbox`, `contact`, `matter`, `picklist` : `=` e.g. `?custom_field_values[1]=42` * `currency`, `date`, `time`, `numeric` : `=`, `<`, `>`, `<=`, `>=` 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]`
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
grant_id	string	No	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.
group_id	string	No	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.
ids[]	string	No	Filter Matter records to those having the specified unique identifiers.
limit	string	No	A limit on the number of Matter records to be returned. Limit can range between 1 and 200. Default: `200`.
notification_event_subscriber_user_id	string	No	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.
open_date[]	string	No	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.
order	string	No	Orders the Matter records by the given field. Default: `id(asc)`.
originating_attorney_id	string	No	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.
page_token	string	No	A token specifying which page to return.
pending_date[]	string	No	Filter Matter records by the pending date. The date should be provided in the format YYYY-MM-DD. e.g. `?pending_date==2020-01-01`, `?pending_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. `?pending_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.
practice_area_id	string	No	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.
query	string	No	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.
responsible_attorney_id	string	No	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.
responsible_staff_id	string	No	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.
status	string	No	Filter Matter records to those with a given status. It accepts comma-separated statuses, e.g. `open,pending`.
subscriber_user_id	string	No	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.
updated_since	string	No	Filter Matter records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_matters"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_matters",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/matters
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_matter/matters

Create a new Matter

Request

Query Parameters

Name	Type	Required	Description
custom_field_ids[]	string	No	Filter Matter's custom_field_values to only include values for the given custom field unique identifiers.
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
billable	boolean	Yes
client	object	Yes
client_reference	string	No
close_date	string	No
currency	object	No
custom_field_set_associations	array	No
custom_field_values	array	No
custom_rate	object	No
description	string	Yes
display_number	string	No
evergreen_retainer	object	No
group	object	No
kyc_field_values	array	No
location	string	No
matter_budget	object	No
matter_stage	object	No
open_date	string	No
originating_attorney	object	No
pending_date	string	No
practice_area	object	No
relationships	array	No
reset_matter_number	boolean	Yes
responsible_attorney	object	No
responsible_staff	object	No
split_invoice_payers	array	No
status	object	No
statute_of_limitations	object	No
task_template_list_instances	array	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_matter"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_matter",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/matters
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "billable": "<billable>",
  "client": "<client>",
  "client_reference": "<client_reference>",
  "close_date": "<close_date>",
  "currency": "<currency>"
}

Response

{
  "data": null
}

GETget_matter/matters/:id

Return the data for a single Matter

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Matter.

Query Parameters

Name	Type	Required	Description
custom_field_ids[]	string	No	Filter Matter's custom_field_values to only include values for the given custom field unique identifiers.
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_matter"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_matter",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/matters/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_matter/matters/:id

Update a single Matter

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Matter.

Query Parameters

Name	Type	Required	Description
custom_field_ids[]	string	No	Filter Matter's custom_field_values to only include values for the given custom field unique identifiers.
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
billable	boolean	Yes
client	object	No
client_reference	string	No
close_date	string	No
currency	object	No
custom_field_set_associations	array	No
custom_field_values	array	No
custom_rate	object	No
description	string	No
display_number	string	No
evergreen_retainer	object	No
group	object	No
kyc_field_values	array	No
location	string	No
matter_budget	object	No
matter_stage	object	No
open_date	string	No
originating_attorney	object	No
pending_date	string	No
practice_area	object	No
relationships	array	No
reset_matter_number	boolean	Yes
responsible_attorney	object	No
responsible_staff	object	No
split_invoice_payers	array	No
status	object	No
statute_of_limitations	object	No
task_template_list_instances	array	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_matter"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_matter",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/matters/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "billable": "<billable>",
  "client": "<client>",
  "client_reference": "<client_reference>",
  "close_date": "<close_date>",
  "currency": "<currency>"
}

Response

{
  "data": null
}

DELETEdelete_matter/matters/:id

Delete a single Matter

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Matter.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_matter"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_matter",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/matters/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_matter_stages/matter_stages

Return the data for all MatterStages

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter MatterStage records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter MatterStage records to those having the specified unique identifiers.
limit	string	No	A limit on the number of MatterStage records to be returned. Limit can range between 1 and 200. Default: `200`.
page_token	string	No	A token specifying which page to return.
practice_area_id	string	No	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 MatterStage records with the matching property.
updated_since	string	No	Filter MatterStage records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_matter_stages"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_matter_stages",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/matter_stages
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

PATCHupdate_medical_record/medical_records/:id

Updating a Medical Record

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the MedicalRecord.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required	Description
end_date	string	No
start_date	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_medical_record"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_medical_record",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/medical_records/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "end_date": "<end_date>",
  "start_date": "<start_date>"
}

Response

{
  "data": null
}

DELETEdelete_medical_record/medical_records/:id

Destroying a Medical Record

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the MedicalRecord.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_medical_record"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_medical_record",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/medical_records/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_medical_records_requests/medical_records_details

Return the data for all Medical Records Details

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter MedicalRecordsRequest records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter MedicalRecordsRequest records to those having the specified unique identifiers.
limit	string	No	A limit on the number of Medical Records Detail records to be returned. Limit can range between 1 and 200. Default: `200`.
page_token	string	No	A token specifying which page to return.
treatment_end_date	string	No	Filters Medical Records data by treatment end date.
treatment_start_date	string	No	Filters Medical Records data by treatment start date.
updated_since	string	No	Filter MedicalRecordsRequest records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_medical_records_requests"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_medical_records_requests",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/medical_records_details
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_medical_records_request/medical_records_details

Creating a Medical Records Detail, Medical Records and Medical Bills

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
bills_follow_up_date	string	No
bills_request_date	string	No
bills_status	object	Yes
description	string	No
in_treatment	boolean	Yes
matter_id	number	Yes
medical_bills	array	No
medical_provider_id	number	Yes
medical_records	array	No
records_follow_up_date	string	No
records_request_date	string	No
records_status	object	Yes
treatment_end_date	string	No
treatment_start_date	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_medical_records_request"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_medical_records_request",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/medical_records_details
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "bills_follow_up_date": "<bills_follow_up_date>",
  "bills_request_date": "<bills_request_date>",
  "bills_status": "<bills_status>",
  "description": "<description>",
  "in_treatment": "<in_treatment>"
}

Response

{
  "data": null
}

GETget_medical_records_request/medical_records_details/:id

Return the data for a single Medical Records Detail

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Medical Records Detail.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_medical_records_request"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_medical_records_request",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/medical_records_details/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_medical_records_request/medical_records_details/:id

Updating a Medical Records Detail

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Medical Records Detail.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
bills_follow_up_date	string	No
bills_request_date	string	No
bills_status	object	No
description	string	No
in_treatment	boolean	No
medical_bills	array	No
medical_provider_id	number	No
medical_records	array	No
records_follow_up_date	string	No
records_request_date	string	No
records_status	object	No
treatment_end_date	string	No
treatment_start_date	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_medical_records_request"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_medical_records_request",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/medical_records_details/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "bills_follow_up_date": "<bills_follow_up_date>",
  "bills_request_date": "<bills_request_date>",
  "bills_status": "<bills_status>",
  "description": "<description>",
  "in_treatment": "<in_treatment>"
}

Response

{
  "data": null
}

DELETEdelete_medical_records_request/medical_records_details/:id

Destroying a Medical Records Detail

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Medical Records Detail.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_medical_records_request"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_medical_records_request",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/medical_records_details/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

PATCHupdate_medical_bill/medical_bills/:id

Updating a Medical Bill

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Medical Bill.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
adjustment	number	No
amount	number	No
balance	number	No
bill_date	string	No
bill_received_date	string	No
mark_balance_type_as	object	No
name	string	No
payers	array	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_medical_bill"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_medical_bill",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/medical_bills/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "adjustment": 1,
  "amount": 1,
  "balance": 1,
  "bill_date": "<bill_date>",
  "bill_received_date": "<bill_received_date>"
}

Response

{
  "data": null
}

DELETEdelete_medical_bill/medical_bills/:id

Destroying a Medical Bill

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Medical Bill.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_medical_bill"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_medical_bill",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/medical_bills/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_notes/notes

Return the data for all Notes

Request

Query Parameters

Name	Type	Required	Description
contact_id	string	No	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 Note records with the matching property.
created_since	string	No	Filter Note records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
has_time_entries	string	No	Filter Note records to those with or without associated time entries.
ids[]	string	No	Filter Note records to those having the specified unique identifiers.
limit	string	No	A limit on the number of Note records to be returned. Limit can range between 1 and 200. Default: `200`.
matter_id	string	No	The unique identifier for a single Matter. The keyword `null` is not valid for this field. The list will be filtered to include only the Note records with the matching property.
order	string	No	Orders the Note records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
query	string	No	Wildcard search across note subject and detail.
type	string	No	Filter Note records to those of the specified type.
updated_since	string	No	Filter Note records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_notes"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_notes",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/notes
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_note/notes

Create a new Note

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
contact	object	Yes
date	string	No
detail	string	No
detail_text_type	string	Yes
matter	object	Yes
notification_event_subscribers	array	No
subject	string	No
type	object	Yes

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_note"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_note",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/notes
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "contact": "<contact>",
  "date": "<date>",
  "detail": "<detail>",
  "detail_text_type": "<detail_text_type>",
  "matter": "<matter>"
}

Response

{
  "data": null
}

GETget_note/notes/:id

Return the data for a single Note

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Note.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_note"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_note",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/notes/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_note/notes/:id

Update a single Note

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Note.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
date	string	No
detail	string	No
detail_text_type	string	Yes
notification_event_subscribers	array	No
subject	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_note"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_note",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/notes/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "date": "<date>",
  "detail": "<detail>",
  "detail_text_type": "<detail_text_type>",
  "notification_event_subscribers": "<notification_event_subscribers>",
  "subject": "<subject>"
}

Response

{
  "data": null
}

DELETEdelete_note/notes/:id

Delete a single Note

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Note.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_note"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_note",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/notes/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_outstanding_client_balances/outstanding_client_balances

Return the data for all OutstandingClientBalances

Request

Query Parameters

Name	Type	Required	Description
contact_id	string	No	The unique identifier for a single Contact. Use the keyword `null` to match those without a OutstandingClientBalance. The list will be filtered to include only the OutstandingClientBalance records with the matching property.
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
last_paid_end_date	string	No	Filter OutstandingClientBalance records for those whose bills have been paid before the specified date
last_paid_start_date	string	No	Filter OutstandingClientBalance records for those whose bills have been paid after the specified date
limit	string	No	A limit on the number of OutstandingClientBalance records to be returned. Limit can range between 1 and 200. Default: `200`.
newest_bill_due_end_date	string	No	Filter OutstandingClientBalance records for the contact's newest bill due date before the specified date
newest_bill_due_start_date	string	No	Filter OutstandingClientBalance records for the contact's newest bill due date after the specified date
originating_attorney_id	string	No	Filters OutstandingClientBalance records to those with matters that have a matching originating attorney.
page_token	string	No	A token specifying which page to return.
responsible_attorney_id	string	No	Filter OutstandingClientBalance records to those with matters that have a matching responsible attorney

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_outstanding_client_balances"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_outstanding_client_balances",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/outstanding_client_balances
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETlist_practice_areas/practice_areas

Return the data for all PracticeAreas

Request

Query Parameters

Name	Type	Required	Description
code	string	No	Filter PracticeArea records to those that match the given code.
created_since	string	No	Filter PracticeArea records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter PracticeArea records to those having the specified unique identifiers.
limit	string	No	A limit on the number of PracticeArea records to be returned. Limit can range between 1 and 200. Default: `200`.
matter_id	string	No	Filter PracticeArea records to exclude Legal Aid UK Practice Areas when activities exist on the matter.
name	string	No	Filter PracticeArea records to those that match the given name.
order	string	No	Orders the PracticeArea records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
updated_since	string	No	Filter PracticeArea records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_practice_areas"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_practice_areas",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/practice_areas
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_practice_area/practice_areas

Create a new PracticeArea

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
category	object	No
code	string	No
name	string	Yes

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_practice_area"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_practice_area",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/practice_areas
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "category": "<category>",
  "code": "<code>",
  "name": "<name>"
}

Response

{
  "data": null
}

GETget_practice_area/practice_areas/:id

Return the data for a single PracticeArea

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the PracticeArea.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_practice_area"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_practice_area",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/practice_areas/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_practice_area/practice_areas/:id

Update a single PracticeArea

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the PracticeArea.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
category	object	No
code	string	No
name	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_practice_area"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_practice_area",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/practice_areas/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "category": "<category>",
  "code": "<code>",
  "name": "<name>"
}

Response

{
  "data": null
}

DELETEdelete_practice_area/practice_areas/:id

Delete a single PracticeArea

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the PracticeArea.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_practice_area"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_practice_area",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/practice_areas/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_relationships/relationships

Return the data for all Relationships

Request

Query Parameters

Name	Type	Required	Description
contact_id	string	No	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 Relationship records with the matching property.
created_since	string	No	Filter Relationship records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter Relationship records to those having the specified unique identifiers.
limit	string	No	A limit on the number of Relationship records to be returned. Limit can range between 1 and 200. Default: `200`.
matter_id	string	No	The unique identifier for a single Matter. The keyword `null` is not valid for this field. The list will be filtered to include only the Relationship records with the matching property.
page_token	string	No	A token specifying which page to return.
updated_since	string	No	Filter Relationship records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_relationships"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_relationships",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/relationships
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_relationship/relationships

Create a new Relationship

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
contact	object	No
description	string	No
matter	object	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_relationship"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_relationship",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/relationships
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "contact": "<contact>",
  "description": "<description>",
  "matter": "<matter>"
}

Response

{
  "data": null
}

GETget_relationship/relationships/:id

Return the data for a single Relationship

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Relationship.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_relationship"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_relationship",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/relationships/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_relationship/relationships/:id

Update a single Relationship

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Relationship.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
contact	object	No
description	string	No
matter	object	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_relationship"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_relationship",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/relationships/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "contact": "<contact>",
  "description": "<description>",
  "matter": "<matter>"
}

Response

{
  "data": null
}

DELETEdelete_relationship/relationships/:id

Delete a single Relationship

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Relationship.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_relationship"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_relationship",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/relationships/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_reminders/reminders

Return the data for all Reminders

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter Reminder records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter Reminder records to those having the specified unique identifiers.
limit	string	No	A limit on the number of Reminder records to be returned. Limit can range between 1 and 200. Default: `200`.
notification_method_id	string	No	The unique identifier for a single NotificationMethod. The keyword `null` is not valid for this field. The list will be filtered to include only the Reminder records with the matching property.
order	string	No	Orders the Reminder records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
state	string	No	Filter Reminder records to those with a given state.
subject_id	string	No	The unique identifier for a single CalendarEntry or Task. The keyword `null` is not valid for this field. The list will be filtered to include only the Reminder records with the matching property.
subject_type	string	No	Filter Reminder records to those of a given subject type, required if using subject_id.
updated_since	string	No	Filter Reminder records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).
user_id	string	No	The unique identifier for a single User. The keyword `null` is not valid for this field. The list will be filtered to include only the Reminder records with the matching property.

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_reminders"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_reminders",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/reminders
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_reminder/reminders

Create a new Reminder

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
duration_unit	object	No
duration_value	number	No
notification_method	object	Yes
subject	object	Yes

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_reminder"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_reminder",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/reminders
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "duration_unit": "<duration_unit>",
  "duration_value": 1,
  "notification_method": "<notification_method>",
  "subject": "<subject>"
}

Response

{
  "data": null
}

GETget_reminder/reminders/:id

Return the data for a single Reminder

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Reminder.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_reminder"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_reminder",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/reminders/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_reminder/reminders/:id

Update a single Reminder

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Reminder.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
duration_unit	object	No
duration_value	number	No
notification_method	object	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_reminder"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_reminder",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/reminders/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "duration_unit": "<duration_unit>",
  "duration_value": 1,
  "notification_method": "<notification_method>"
}

Response

{
  "data": null
}

DELETEdelete_reminder/reminders/:id

Delete a single Reminder

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Reminder.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_reminder"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_reminder",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/reminders/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETdownload_report/reports/:id/download

Download the completed Report

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Report.

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "download_report"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "download_report",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/reports/:id/download
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

// Raw JSON from upstream API

GETlist_reports/reports

Return the data for all Reports

Request

Query Parameters

Name	Type	Required	Description
category	string	No	Filters Report data by category.
created_before	string	No	Filters Report data by date. (Expects an ISO-8601 date).
created_since	string	No	Filter Report records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter Report records to those having the specified unique identifiers.
kind	string	No	Filters Report data by kind.
limit	string	No	A limit on the number of Report records to be returned. Limit can range between 1 and 200. Default: `200`.
output_format	string	No	Filters Report data by format.
page_token	string	No	A token specifying which page to return.
query	string	No	Wildcard search for Report name.
source	string	No	Filters Report data by source.
state	string	No	Filters Report data by state.
updated_since	string	No	Filter Report records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_reports"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_reports",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/reports
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_report/reports

Create a new Report

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
client	object	No
end_date	string	No
format	object	Yes
kind	object	Yes
matter	object	No
originating_attorney	object	No
practice_area	object	No
responsible_attorney	object	No
start_date	string	No
user	object	No
year	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_report"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_report",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/reports
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "client": "<client>",
  "end_date": "<end_date>",
  "format": "<format>",
  "kind": "<kind>",
  "matter": "<matter>"
}

Response

{
  "data": null
}

GETget_report/reports/:id

Return the data for a single Report

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Report.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_report"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_report",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/reports/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

POSTgenerate_report_preset_report/report_presets/:id/generate_report

Generate a new report for a given preset

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the ReportPreset.

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "generate_report_preset_report"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "generate_report_preset_report",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/report_presets/:id/generate_report
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

GETlist_report_presets/report_presets

Return the data for all ReportPresets

Request

Query Parameters

Name	Type	Required	Description
category	string	No	Filters ReportPreset data by category.
created_since	string	No	Filter ReportPreset records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
has_schedule	string	No	Filters ReportPreset records to those that have or do not have a Report Schedule.
ids[]	string	No	Filter ReportPreset records to those having the specified unique identifiers.
limit	string	No	A limit on the number of ReportPreset records to be returned. Limit can range between 1 and 200. Default: `200`.
order	string	No	Orders the ReportPreset records by the given field. Default: `id(asc)`.
output_format	string	No	Filters ReportPreset data by format.
page_token	string	No	A token specifying which page to return.
query	string	No	Wildcard search for ReportPreset name.
schedule_frequency	string	No	Filters ReportPreset records to those that have a Report Schedule of the specified frequency.
updated_since	string	No	Filter ReportPreset records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_report_presets"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_report_presets",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/report_presets
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_report_preset/report_presets

Create a new ReportPreset

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
format	object	Yes
kind	object	Yes
name	string	Yes
options	string	Yes

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_report_preset"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_report_preset",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/report_presets
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "format": "<format>",
  "kind": "<kind>",
  "name": "<name>",
  "options": "<options>"
}

Response

{
  "data": null
}

GETget_report_preset/report_presets/:id

Return the data for a single ReportPreset

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the ReportPreset.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_report_preset"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_report_preset",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/report_presets/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_report_preset/report_presets/:id

Update a single ReportPreset

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the ReportPreset.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
format	object	No
kind	object	No
name	string	No
options	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_report_preset"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_report_preset",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/report_presets/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "format": "<format>",
  "kind": "<kind>",
  "name": "<name>",
  "options": "<options>"
}

Response

{
  "data": null
}

DELETEdelete_report_preset/report_presets/:id

Delete a single ReportPreset

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the ReportPreset.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_report_preset"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_report_preset",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/report_presets/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_report_schedules/report_schedules

Return the data for all ReportSchedules

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter ReportSchedule records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter ReportSchedule records to those having the specified unique identifiers.
limit	string	No	A limit on the number of ReportSchedule records to be returned. Limit can range between 1 and 200. Default: `200`.
page_token	string	No	A token specifying which page to return.
updated_since	string	No	Filter ReportSchedule records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_report_schedules"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_report_schedules",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/report_schedules
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_report_schedule/report_schedules

Create a new ReportSchedule

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
day_of_month	number	No
days_of_week	array	No
effective_from	string	No
every_no_of_months	number	No
frequency	object	Yes
report_preset_id	number	Yes
time_of_day	string	Yes
time_zone	object	Yes

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_report_schedule"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_report_schedule",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/report_schedules
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "day_of_month": 1,
  "days_of_week": "<days_of_week>",
  "effective_from": "<effective_from>",
  "every_no_of_months": 1,
  "frequency": "<frequency>"
}

Response

{
  "data": null
}

GETget_report_schedule/report_schedules/:id

Return the data for a single ReportSchedule

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the ReportSchedule.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_report_schedule"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_report_schedule",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/report_schedules/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_report_schedule/report_schedules/:id

Update a single ReportSchedule

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the ReportSchedule.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
day_of_month	number	No
days_of_week	array	No
effective_from	string	No
every_no_of_months	number	No
frequency	object	No
report_preset_id	number	No
time_of_day	string	No
time_zone	object	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_report_schedule"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_report_schedule",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/report_schedules/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "day_of_month": 1,
  "days_of_week": "<days_of_week>",
  "effective_from": "<effective_from>",
  "every_no_of_months": 1,
  "frequency": "<frequency>"
}

Response

{
  "data": null
}

DELETEdelete_report_schedule/report_schedules/:id

Delete a single ReportSchedule

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the ReportSchedule.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_report_schedule"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_report_schedule",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/report_schedules/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETget_billing_setting/settings/billing

Return the billing settings

Request

Query Parameters

Name	Type	Required	Description
duration	string	No	Duration string for time rounding, conforming to the Chronic date parser. For example: '3h' or '2:15'.
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_billing_setting"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_billing_setting",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/settings/billing
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

GETlist_text_snippets/settings/text_snippets

Return all text snippets

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter TextSnippet records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter TextSnippet records to those having the specified unique identifiers.
limit	string	No	A limit on the number of TextSnippet records to be returned. Limit can range between 1 and 200. Default: `200`.
order	string	No	Orders the TextSnippet records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
query	string	No	Wildcard search for `snippet` or `phrase` matching a given string.
updated_since	string	No	Filter TextSnippet records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_text_snippets"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_text_snippets",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/settings/text_snippets
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_text_snippet/settings/text_snippets

Create a text snippet

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
phrase	string	Yes
snippet	string	Yes
whole_word	boolean	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_text_snippet"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_text_snippet",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/settings/text_snippets
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "phrase": "<phrase>",
  "snippet": "<snippet>",
  "whole_word": "<whole_word>"
}

Response

{
  "data": null
}

GETget_text_snippet/settings/text_snippets/:id

Return the data for the text snippet

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the TextSnippet.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_text_snippet"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_text_snippet",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/settings/text_snippets/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_text_snippet/settings/text_snippets/:id

Update a text snippet

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the TextSnippet.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
phrase	string	No
snippet	string	No
whole_word	boolean	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_text_snippet"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_text_snippet",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/settings/text_snippets/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "phrase": "<phrase>",
  "snippet": "<snippet>",
  "whole_word": "<whole_word>"
}

Response

{
  "data": null
}

DELETEdelete_text_snippet/settings/text_snippets/:id

Destroy a text snippet

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the TextSnippet.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_text_snippet"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_text_snippet",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/settings/text_snippets/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_tasks/tasks

Return the data for all Tasks

Request

Query Parameters

Name	Type	Required	Description
assignee_id	string	No	The unique identifier for a single User or Contact. Use the keyword `null` to match those without a Task. The list will be filtered to include only the Task records with the matching property.
assignee_type	string	No	Filter Task records to those with a specific assignee. Must be passed if filtering by assignee.
assigner_id	string	No	The unique identifier for a single User. Use the keyword `null` to match those without a Task. The list will be filtered to include only the Task records with the matching property.
cascading_source_id	string	No	Filter Task records to those with a parent task that has the specified ID.
client_id	string	No	The unique identifier for a single Contact. Use the keyword `null` to match those without a Task. The list will be filtered to include only the Task records with the matching property.
complete	string	No	Filter Task records to those which are complete or not.
created_since	string	No	Filter Task records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
due_at_from	string	No	Start of date range when querying by due_at in a range. (Expects an ISO-8601 date).
due_at_present	string	No	Filter Task records to those that have a due date specified, or not.
due_at_to	string	No	End of date range when querying by due_at in a range. (Expects an ISO-8601 date).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter Task records to those having the specified unique identifiers.
limit	string	No	A limit on the number of Task records to be returned. Limit can range between 1 and 200. Default: `200`.
matter_id	string	No	The unique identifier for a single Matter. Use the keyword `null` to match those without a Task. The list will be filtered to include only the Task records with the matching property.
order	string	No	Orders the Task records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
permission	string	No	Filter Task records to those with the given permission. Returns all tasks by default.
priority	string	No	Filter Task records to those with the given priority.
query	string	No	Wildcard search for `name` or `description` matching a given string.
responsible_attorney_id	string	No	Filter Task records to those that have an associated matter with a responsible attorney ID.
status	string	No	Filter Task records to those with the given status. Users without advanced tasks enabled may only specify 'complete' or 'pending'.
statuses[]	string	No	Filter Task records to those with the given statuses. Users without advanced tasks enabled may only specify 'complete' or 'pending'.
statute_of_limitations	string	No	Filter Task records to those which are a statute of limitations or not.
task_type_id	string	No	The unique identifier for a single TaskType. Use the keyword `null` to match those without a Task. The list will be filtered to include only the Task records with the matching property.
time_entries_present	string	No	Filter Task records to those that have associated time entries, or not.
updated_since	string	No	Filter Task records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_tasks"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_tasks",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/tasks
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_task/tasks

Create a new Task

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
assignee	object	Yes
cascading	boolean	No
cascading_offset	number	No
cascading_offset_polarity	object	No
cascading_offset_type	object	No
cascading_source	number	No
description	string	Yes
description_text_type	object	No
due_at	string	No
matter	object	No
name	string	Yes
notify_assignee	boolean	No
notify_completion	boolean	No
permission	object	No
priority	object	No
status	object	No
statute_of_limitations	boolean	No
task_type	object	No
time_estimated	number	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_task"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_task",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/tasks
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "assignee": "<assignee>",
  "cascading": "<cascading>",
  "cascading_offset": 1,
  "cascading_offset_polarity": "<cascading_offset_polarity>",
  "cascading_offset_type": "<cascading_offset_type>"
}

Response

{
  "data": null
}

GETget_task/tasks/:id

Return the data for a single Task

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Task.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_task"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_task",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/tasks/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_task/tasks/:id

Update a single Task

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Task.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
assignee	object	No
cascading	boolean	No
cascading_offset	number	No
cascading_offset_polarity	object	No
cascading_offset_type	object	No
cascading_source	number	No
description	string	No
description_text_type	object	No
due_at	string	No
matter	object	No
name	string	No
notify_assignee	boolean	No
notify_completion	boolean	No
permission	object	No
priority	object	No
status	object	No
task_type	object	No
time_estimated	number	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_task"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_task",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/tasks/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "assignee": "<assignee>",
  "cascading": "<cascading>",
  "cascading_offset": 1,
  "cascading_offset_polarity": "<cascading_offset_polarity>",
  "cascading_offset_type": "<cascading_offset_type>"
}

Response

{
  "data": null
}

DELETEdelete_task/tasks/:id

Delete a single Task

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Task.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_task"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_task",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/tasks/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_calendar_visibilities/task_calendars

Return the data for all CalendarVisibilities

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter CalendarVisibility records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter CalendarVisibility records to those having the specified unique identifiers.
limit	string	No	A limit on the number of CalendarVisibility records to be returned. Limit can range between 1 and 200. Default: `200`.
page_token	string	No	A token specifying which page to return.
updated_since	string	No	Filter CalendarVisibility records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_calendar_visibilities"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_calendar_visibilities",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/task_calendars
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETget_calendar_visibility/task_calendars/:id

Return the data for a single CalendarVisibility

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the CalendarVisibility.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_calendar_visibility"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_calendar_visibility",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/task_calendars/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_calendar_visibility/task_calendars/:id

Update a single CalendarVisibility

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the CalendarVisibility.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required	Description
color	object	No
visible	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_calendar_visibility"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_calendar_visibility",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/task_calendars/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "color": "<color>",
  "visible": "<visible>"
}

Response

{
  "data": null
}

GETlist_task_templates/task_templates

Return the data for all TaskTemplates

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter TaskTemplate records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter TaskTemplate records to those having the specified unique identifiers.
limit	string	No	A limit on the number of TaskTemplate records to be returned. Limit can range between 1 and 200. Default: `200`.
order	string	No	Orders the TaskTemplate records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
priority	string	No	Filter TaskTemplate records to those with the given priority.
query	string	No	Wildcard search for `name` matching a given string.
task_template_list_id	string	No	The unique identifier for a single TaskTemplateList. The keyword `null` is not valid for this field. The list will be filtered to include only the TaskTemplate records with the matching property.
updated_since	string	No	Filter TaskTemplate records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_task_templates"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_task_templates",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/task_templates
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_task_template/task_templates

Create a new TaskTemplate

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
cascading	boolean	No
cascading_offset	number	No
cascading_offset_polarity	object	No
cascading_offset_type	object	No
cascading_source	object	No
description	string	No
description_text_type	object	No
name	string	Yes
priority	object	No
private	boolean	No
reminder_templates	array	No
task_template_list	object	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_task_template"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_task_template",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/task_templates
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "cascading": "<cascading>",
  "cascading_offset": 1,
  "cascading_offset_polarity": "<cascading_offset_polarity>",
  "cascading_offset_type": "<cascading_offset_type>",
  "cascading_source": "<cascading_source>"
}

Response

{
  "data": null
}

GETget_task_template/task_templates/:id

Return the data for a single TaskTemplate

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the TaskTemplate.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_task_template"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_task_template",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/task_templates/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_task_template/task_templates/:id

Update a single TaskTemplate

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the TaskTemplate.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
cascading	boolean	No
cascading_offset	number	No
cascading_offset_polarity	object	No
cascading_offset_type	object	No
cascading_source	object	No
description	string	No
description_text_type	object	No
name	string	No
priority	object	No
private	boolean	No
reminder_templates	array	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_task_template"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_task_template",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/task_templates/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "cascading": "<cascading>",
  "cascading_offset": 1,
  "cascading_offset_polarity": "<cascading_offset_polarity>",
  "cascading_offset_type": "<cascading_offset_type>",
  "cascading_source": "<cascading_source>"
}

Response

{
  "data": null
}

DELETEdelete_task_template/task_templates/:id

Delete a single TaskTemplate

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the TaskTemplate.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_task_template"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_task_template",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/task_templates/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

POSTcopy_task_template_list/task_template_lists/:id/copy

Copy a TaskTemplateList

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the TaskTemplateList.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
description	string	No
name	string	No
practice_area	object	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "copy_task_template_list"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "copy_task_template_list",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/task_template_lists/:id/copy
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "description": "<description>",
  "name": "<name>",
  "practice_area": "<practice_area>"
}

Response

{
  "data": null
}

GETlist_task_template_lists/task_template_lists

Return the data for all TaskTemplateLists

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter TaskTemplateList records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
empty	string	No	Filter TaskTemplateList records to those that either contain at least one task template or contain none.
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter TaskTemplateList records to those having the specified unique identifiers.
limit	string	No	A limit on the number of TaskTemplateList records to be returned. Limit can range between 1 and 200. Default: `200`.
order	string	No	Orders the TaskTemplateList records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
practice_area_id	string	No	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.
query	string	No	Wildcard search for `name` matching a given string.
updated_since	string	No	Filter TaskTemplateList records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_task_template_lists"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_task_template_lists",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/task_template_lists
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_task_template_list/task_template_lists

Create a new TaskTemplateList

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
description	string	Yes
name	string	Yes
practice_area	object	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_task_template_list"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_task_template_list",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/task_template_lists
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "description": "<description>",
  "name": "<name>",
  "practice_area": "<practice_area>"
}

Response

{
  "data": null
}

GETget_task_template_list/task_template_lists/:id

Return the data for a single TaskTemplateList

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the TaskTemplateList.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_task_template_list"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_task_template_list",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/task_template_lists/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_task_template_list/task_template_lists/:id

Update a single TaskTemplateList

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the TaskTemplateList.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
description	string	No
name	string	No
practice_area	object	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_task_template_list"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_task_template_list",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/task_template_lists/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "description": "<description>",
  "name": "<name>",
  "practice_area": "<practice_area>"
}

Response

{
  "data": null
}

DELETEdelete_task_template_list/task_template_lists/:id

Delete a single TaskTemplateList

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the TaskTemplateList.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_task_template_list"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_task_template_list",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/task_template_lists/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_task_types/task_types

Return the data for all TaskTypes

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter TaskType records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
enabled	string	No	Filter TaskType records to those that are enabled or disabled.
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter TaskType records to those having the specified unique identifiers.
limit	string	No	A limit on the number of TaskType records to be returned. Limit can range between 1 and 200. Default: `200`.
name	string	No	Filter TaskType records to those with the given name.
order	string	No	Orders the TaskType records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
query	string	No	Wildcard search for `name` matching a given string.
updated_since	string	No	Filter TaskType records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_task_types"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_task_types",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/task_types
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_task_type/task_types

Create a new TaskType

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required	Description
deleted_at	string	No
name	string	Yes

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_task_type"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_task_type",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/task_types
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "deleted_at": "<deleted_at>",
  "name": "<name>"
}

Response

{
  "data": null
}

GETget_task_type/task_types/:id

Return the data for a single TaskType

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the TaskType.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_task_type"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_task_type",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/task_types/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_task_type/task_types/:id

Update a single TaskType

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the TaskType.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required	Description
deleted_at	string	No
name	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_task_type"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_task_type",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/task_types/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "deleted_at": "<deleted_at>",
  "name": "<name>"
}

Response

{
  "data": null
}

GETget_timer/timer

Return the data for a single Timer

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_timer"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_timer",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/timer
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

DELETEdelete_timer/timer

Delete a single Timer

Request

No input parameters.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_timer"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_timer",
      "params": {}
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/timer
Authorization: Bearer <your-api-key>
Content-Type: application/json

POSTcreate_timer/timer

Create a new Timer

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required	Description
activity	object	Yes

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_timer"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_timer",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/timer
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "activity": "<activity>"
}

Response

{
  "data": null
}

GETlist_trust_line_items/trust_line_items

Return the data for all TrustLineItems

Request

Query Parameters

Name	Type	Required	Description
bill_id	string	No	The unique identifier for a single Bill. The keyword `null` is not valid for this field. The list will be filtered to include only the TrustLineItem records with the matching property.
created_since	string	No	Filter TrustLineItem records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter TrustLineItem records to those having the specified unique identifiers.
limit	string	No	A limit on the number of TrustLineItem records to be returned. Limit can range between 1 and 200. Default: `200`.
matter_id	string	No	The unique identifier for a single Matter. Use the keyword `null` to match those without a TrustLineItem. The list will be filtered to include only the TrustLineItem records with the matching property.
order	string	No	Orders the TrustLineItem records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
updated_since	string	No	Filter TrustLineItem records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_trust_line_items"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_trust_line_items",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/trust_line_items
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

PATCHupdate_trust_line_item/trust_line_items/:id

Update a single TrustLineItem

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the TrustLineItem.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
date	string	No
note	string	No
total	number	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_trust_line_item"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_trust_line_item",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/trust_line_items/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "date": "<date>",
  "note": "<note>",
  "total": 1
}

Response

{
  "data": null
}

POSTcreate_trust_request/trust_requests

Create a new TrustRequest

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
approved	boolean	Yes
client_id	number	Yes
currency_id	number	No
due_date	string	Yes
issue_date	string	Yes
matter	array	No
note	string	No
trust_amount	number	Yes
trust_type	object	Yes

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_trust_request"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_trust_request",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/trust_requests
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "approved": "<approved>",
  "client_id": 1,
  "currency_id": 1,
  "due_date": "<due_date>",
  "issue_date": "<issue_date>"
}

Response

{
  "data": null
}

GETget_current_user/users/who_am_i

Return the data for the current User

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_current_user"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_current_user",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/users/who_am_i
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

GETlist_users/users

Return the data for all Users

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter User records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
enabled	string	No	Filter User records to those that are enabled or disabled.
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter User records to those having the specified unique identifiers.
include_co_counsel	string	No	Filter User to include co-counsel users
limit	string	No	A limit on the number of User records to be returned. Limit can range between 1 and 2000. Default: `2000`.
name	string	No	Filter User records to those with the given name.
order	string	No	Orders the User records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
pending_setup	string	No	Filter User records based on whether or not they are still being setup.
role	string	No	Filter User records to those with a specific role.
subscription_type	string	No	Filter User records to those with a specific subscription type.
updated_since	string	No	Filter User records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_users"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_users",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/users
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETget_user/users/:id

Return the data for a single User

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the User.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_user"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_user",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/users/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

GETlist_utbms_sets/utbms/sets

Return the data for all the utbms sets

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter UtbmsSet records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter UtbmsSet records to those having the specified unique identifiers.
limit	string	No	A limit on the number of UtbmsSet records to be returned. Limit can range between 1 and 200. Default: `200`.
order	string	No	Orders the UtbmsSet records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
updated_since	string	No	Filter UtbmsSet records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_utbms_sets"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_utbms_sets",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/utbms/sets
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETlist_utbms_codes/utbms/codes

Return the data for all UtbmsCodes

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter UtbmsCode records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter UtbmsCode records to those having the specified unique identifiers.
limit	string	No	A limit on the number of UtbmsCode records to be returned. Limit can range between 1 and 200. Default: `200`.
order	string	No	Orders the UtbmsCode records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
type	string	No	Filter UtbmsCode records to those of a given type.
updated_since	string	No	Filter UtbmsCode records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).
utbms_set_id	string	No	The unique identifier for a single UtbmsSet. Use the keyword `null` to match those without a UtbmsCode. The list will be filtered to include only the UtbmsCode records with the matching property.

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_utbms_codes"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_utbms_codes",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/utbms/codes
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETget_utbms_code/utbms/codes/:id

Return the data for a single UtbmsCode

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the UtbmsCode.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_utbms_code"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_utbms_code",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/utbms/codes/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

GETlist_webhooks/webhooks

Return the data for all Webhooks

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter Webhook records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter Webhook records to those having the specified unique identifiers.
limit	string	No	A limit on the number of Webhook records to be returned. Limit can range between 1 and 200. Default: `200`.
order	string	No	Orders the Webhook records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
updated_since	string	No	Filter Webhook records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_webhooks"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_webhooks",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/webhooks
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_webhook/webhooks

Create a new Webhook

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
events	array	No
expires_at	string	No
fields	string	Yes
model	object	Yes
url	string	Yes

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_webhook"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_webhook",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/webhooks
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "events": "<events>",
  "expires_at": "<expires_at>",
  "fields": "<fields>",
  "model": "<model>",
  "url": "<url>"
}

Response

{
  "data": null
}

GETget_webhook/webhooks/:id

Return the data for a single Webhook

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Webhook.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_webhook"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_webhook",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/webhooks/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_webhook/webhooks/:id

Update a single Webhook

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Webhook.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
events	array	No
expires_at	string	No
fields	string	No
model	object	No
url	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_webhook"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_webhook",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/webhooks/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "events": "<events>",
  "expires_at": "<expires_at>",
  "fields": "<fields>",
  "model": "<model>",
  "url": "<url>"
}

Response

{
  "data": null
}

DELETEdelete_webhook/webhooks/:id

Delete a single Webhook

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Webhook.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_webhook"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_webhook",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/webhooks/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_lauk_civil_certificated_rates/lauk_civil_certificated_rates

List Civil Certificated Rates

Request

Query Parameters

Name	Type	Required	Description
activity	string	No	Filter by activity.
activity_sub_category	string	No	Filter by activity sub-category.
attended_several_hearings_for_multiple_clients	string	No	Filter by whether multiple hearings were attended for multiple clients.
category_of_law	string	No	Filter by category of law.
change_of_solicitor	string	No	Filter by change of solicitor status.
court	string	No	Filter by court.
eligible_for_sqm	string	No	Filter by SQM eligibility.
fee_scheme	string	No	Fee scheme
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
first_conducting_solicitor	string	No	Filter by first conducting solicitor status.
key	string	No	Filter by key.
limit	string	No	A limit on the number of LaukCivilCertificatedRate records to be returned. Limit can range between 1 and 200. Default: `200`.
number_of_clients	string	No	Filter by number of clients.
page_token	string	No	A token specifying which page to return.
party	string	No	Filter by party.
post_transfer_clients_represented	string	No	Filter by post-transfer clients represented.
rate_type	string	No	Filter by rate type.
region	string	No	Filter by region.
session_type	string	No	Filter by session type.
user_type	string	No	Filter by user type.

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_lauk_civil_certificated_rates"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_lauk_civil_certificated_rates",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/lauk_civil_certificated_rates
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETlist_lauk_civil_controlled_rates/lauk_civil_controlled_rates

List Civil Controlled Rates

Request

Query Parameters

Name	Type	Required	Description
activity	string	No	Filter by activity.
category_of_law	string	No	Filter by category of law.
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
key	string	No	Filter by key.
limit	string	No	A limit on the number of LaukCivilControlledRate records to be returned. Limit can range between 1 and 200. Default: `200`.
matter_type_1	string	No	Filter by matter type 1.
matter_type_2	string	No	Filter by matter type 2.
page_token	string	No	A token specifying which page to return.
rate_type	string	No	Filter by rate type.
region	string	No	Filter by region.

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_lauk_civil_controlled_rates"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_lauk_civil_controlled_rates",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/lauk_civil_controlled_rates
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETlist_lauk_criminal_controlled_rates/lauk_criminal_controlled_rates

List Criminal Controlled Rates

Request

Query Parameters

Name	Type	Required	Description
activity	string	No	Filter by activity.
category_of_law	string	No	Filter by category of law.
counsel	string	No	Filter by counsel.
court	string	No	Filter by court.
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
key	string	No	Filter by key.
limit	string	No	A limit on the number of LaukCriminalControlledRate records to be returned. Limit can range between 1 and 200. Default: `200`.
page_token	string	No	A token specifying which page to return.
rate_type	string	No	Filter by rate type.
region	string	No	Filter by region.
solicitor_type	string	No	Filter by solicitor type.
standard_fee_category	string	No	Filter by standard fee category.

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_lauk_criminal_controlled_rates"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_lauk_criminal_controlled_rates",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/lauk_criminal_controlled_rates
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETlist_lauk_expense_categories/lauk_expense_categories

List Expense Categories

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
key	string	No	Filter by key.
limit	string	No	A limit on the number of LaukExpenseCategory records to be returned. Limit can range between 1 and 200. Default: `200`.
name	string	No	Filter by expense name.
page_token	string	No	A token specifying which page to return.
practice_area	string	No	Filter by expense practice area.
region	string	No	Sets the expense rate returned based on the region. If the region is set to London, it will return the London rate; otherwise, it will return the non-London rate.

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_lauk_expense_categories"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_lauk_expense_categories",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/lauk_expense_categories
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETlist_comments/comments

Return the data for all Comments

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter Comment records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
item_id	string	No	The ID of the Document or Folder this Comment belongs to
limit	string	No	A limit on the number of Comment records to be returned. Limit can range between 1 and 200. Default: `200`.
page_token	string	No	A token specifying which page to return.
updated_since	string	No	Filter Comment records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_comments"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_comments",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/comments
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_comment/comments

Create a new Comment

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required	Description
item	object	Yes
message	string	Yes

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_comment"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_comment",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/comments
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "item": "<item>",
  "message": "<message>"
}

Response

{
  "data": null
}

GETget_comment/comments/:id

Return the data for a single Comment

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Comment.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_comment"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_comment",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/comments/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_comment/comments/:id

Update a single Comment

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Comment.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required	Description
item	object	No
message	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_comment"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_comment",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/comments/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "item": "<item>",
  "message": "<message>"
}

Response

{
  "data": null
}

DELETEdelete_comment/comments/:id

Delete a single Comment

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Comment.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_comment"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_comment",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/comments/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETdownload_document_archive/document_archives/:id/download

Download the DocumentArchive. Will return a 303 See Other redirecting to the download URL for the DocumentArchive

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the DocumentArchive.

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "download_document_archive"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "download_document_archive",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/document_archives/:id/download
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

// Raw JSON from upstream API

POSTcreate_document_archive/document_archives

Create a new DocumentArchive

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required	Description
items	array	Yes

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_document_archive"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_document_archive",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/document_archives
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "items": "<items>"
}

Response

{
  "data": null
}

GETget_document_archive/document_archives/:id

Return the data for a single DocumentArchive

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the DocumentArchive.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_document_archive"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_document_archive",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/document_archives/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

GETdownload_document/documents/:id/download

Download the Document. Will return a 303 See Other redirecting to the download URL for the Document

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Document.

Query Parameters

Name	Type	Required	Description
document_version_id	string	No	The unique identifier for a DocumentVersion to be downloaded. Defaults to the latest.

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "download_document"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "download_document",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/documents/:id/download
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

// Raw JSON from upstream API

POSTcopy_document/documents/:id/copy

Copy a Document

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Document.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
communication_id	number	No
document_category	object	No
external_properties	array	No
filename	string	Yes
name	string	No
parent	object	Yes
received_at	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "copy_document"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "copy_document",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/documents/:id/copy
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "communication_id": 1,
  "document_category": "<document_category>",
  "external_properties": "<external_properties>",
  "filename": "<filename>",
  "name": "<name>"
}

Response

{
  "data": null
}

POSTsave_document_version_as_latest/documents/:id/versions/:document_version_id/save_as_latest_version

Save a specific document version as the latest version of the document

Request

Path Parameters

Name	Type	Required	Description
document_version_id	string	Yes	ID of the Document Version
id	string	Yes	ID of the Document

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "save_document_version_as_latest"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "save_document_version_as_latest",
      "params": {
        "document_version_id": "<document_version_id>",
        "id": "<id>"
      }
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/documents/:id/versions/:document_version_id/save_as_latest_version
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

// Raw JSON from upstream API

GETlist_document_versions/documents/:id/versions

Return the data for all DocumentVersions

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	ID of the Document

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
fully_uploaded	string	No	Filter DocumentVersion records to those with the given `fully_uploaded` status.
id	string	No	The unique identifier for the DocumentVersion.
limit	string	No	A limit on the number of DocumentVersion records to be returned. Limit can range between 1 and 200. Default: `200`.
page_token	string	No	A token specifying which page to return.

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_document_versions"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_document_versions",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/documents/:id/versions
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETlist_documents/documents

Return the data for all Documents

Request

Query Parameters

Name	Type	Required	Description
contact_id	string	No	The unique identifier for a single Contact. Use the keyword `null` to match those without a Document. The list will be filtered to include only the Document records with the matching property.
created_since	string	No	Filter Document records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
document_category_id	string	No	The unique identifier for a single DocumentCategory. Use the keyword `null` to match those without a Document. The list will be filtered to include only the Document records with the matching property.
external_property_name	string	No	Filter records to only those with the given external property(s) name set. e.g. `?external_property_name=Name`
external_property_value	string	No	Filter records to only those with the given external property(s) value set. Requires external property name as well. e.g. `?external_property_name=Name&external_property_value=Value`
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter Document records to those having the specified unique identifiers.
include_deleted	string	No	Allow trashed Document record to be included.
limit	string	No	A limit on the number of Document records to be returned. Limit can range between 1 and 200. Default: `200`.
locked	string	No	Filter Document records to those that are locked.
matter_id	string	No	The unique identifier for a single Matter. Use the keyword `null` to match those without a Document. The list will be filtered to include only the Document records with the matching property.
order	string	No	Orders the Document records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
parent_id	string	No	The unique identifier for a single Folder. Use the keyword `null` to match those without a Document. The list will be filtered to include only the Document records with the matching property.
query	string	No	Wildcard search for `name` matching the given string.
scope	string	No	Filters Document record to those being a child of the parent Folder, or a descendant of the parent Folder. Default is `children`.
show_uncompleted	string	No	Allow Document record being uploaded to be included.
updated_since	string	No	Filter Document records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_documents"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_documents",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/documents
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_document/documents

Create a new Document

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
communication_id	number	No
content_type	string	No
document_category	object	No
external_properties	array	No
filename	string	Yes
multiparts	array	No
name	string	Yes
parent	object	Yes
received_at	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_document"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_document",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/documents
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "communication_id": 1,
  "content_type": "<content_type>",
  "document_category": "<document_category>",
  "external_properties": "<external_properties>",
  "filename": "<filename>"
}

Response

{
  "data": null
}

GETget_document/documents/:id

Return the data for a single Document

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Document.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_document"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_document",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/documents/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_document/documents/:id

Update a single Document

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Document.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
communication_id	number	No
copy_version	boolean	No
document_category	object	No
external_properties	array	No
fully_uploaded	boolean	No
multiparts	array	No
name	string	No
parent	object	No
received_at	string	No
restore	boolean	No
uuid	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_document"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_document",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/documents/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "communication_id": 1,
  "copy_version": "<copy_version>",
  "document_category": "<document_category>",
  "external_properties": "<external_properties>",
  "fully_uploaded": "<fully_uploaded>"
}

Response

{
  "data": null
}

DELETEdelete_document/documents/:id

Delete a single Document

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Document.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_document"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_document",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/documents/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_document_automations/document_automations

Return the data for all DocumentAutomations

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter DocumentAutomation records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter DocumentAutomation records to those having the specified unique identifiers.
limit	string	No	A limit on the number of DocumentAutomation records to be returned. Limit can range between 1 and 200. Default: `200`.
order	string	No	Orders the DocumentAutomation records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
updated_since	string	No	Filter DocumentAutomation records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_document_automations"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_document_automations",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/document_automations
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_document_automation/document_automations

Create a new DocumentAutomation

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
document_template	object	Yes
filename	string	Yes
formats	array	Yes
matter	object	Yes

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_document_automation"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_document_automation",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/document_automations
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "document_template": "<document_template>",
  "filename": "<filename>",
  "formats": "<formats>",
  "matter": "<matter>"
}

Response

{
  "data": null
}

GETget_document_automation/document_automations/:id

Return the data for a single DocumentAutomation

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the DocumentAutomation.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_document_automation"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_document_automation",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/document_automations/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

GETlist_document_categories/document_categories

Return the data for all DocumentCategories

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter DocumentCategory records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter DocumentCategory records to those having the specified unique identifiers.
limit	string	No	A limit on the number of DocumentCategory records to be returned. Limit can range between 1 and 200. Default: `200`.
order	string	No	Orders the DocumentCategory records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
query	string	No	Wildcard search for `name` matching a given string.
updated_since	string	No	Filter DocumentCategory records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_document_categories"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_document_categories",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/document_categories
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_document_category/document_categories

Create a new DocumentCategory

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required	Description
name	string	Yes

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_document_category"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_document_category",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/document_categories
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "name": "<name>"
}

Response

{
  "data": null
}

GETget_document_category/document_categories/:id

Return the data for a single DocumentCategory

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the DocumentCategory.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_document_category"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_document_category",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/document_categories/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_document_category/document_categories/:id

Update a single DocumentCategory

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the DocumentCategory.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required	Description
name	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_document_category"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_document_category",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/document_categories/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "name": "<name>"
}

Response

{
  "data": null
}

DELETEdelete_document_category/document_categories/:id

Delete a single DocumentCategory

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the DocumentCategory.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_document_category"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_document_category",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/document_categories/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETdownload_document_template/document_templates/:id/download

Get the contents of the DocumentTemplate

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the DocumentTemplate.

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "download_document_template"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "download_document_template",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/document_templates/:id/download
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

// Raw JSON from upstream API

GETlist_document_templates/document_templates

Return the data for all DocumentTemplates

Request

Query Parameters

Name	Type	Required	Description
created_since	string	No	Filter DocumentTemplate records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter DocumentTemplate records to those having the specified unique identifiers.
limit	string	No	A limit on the number of DocumentTemplate records to be returned. Limit can range between 1 and 200. Default: `200`.
order	string	No	Orders the DocumentTemplate records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
updated_since	string	No	Filter DocumentTemplate records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_document_templates"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_document_templates",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/document_templates
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_document_template/document_templates

Create a new DocumentTemplate

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
document_category	object	No
file	string	Yes
filename	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_document_template"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_document_template",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/document_templates
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "document_category": "<document_category>",
  "file": "<file>",
  "filename": "<filename>"
}

Response

{
  "data": null
}

GETget_document_template/document_templates/:id

Return the data for a single DocumentTemplate

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the DocumentTemplate.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_document_template"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_document_template",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/document_templates/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_document_template/document_templates/:id

Update a single DocumentTemplate

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the DocumentTemplate.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
document_category	object	No
file	string	No
filename	string	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_document_template"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_document_template",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/document_templates/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "document_category": "<document_category>",
  "file": "<file>",
  "filename": "<filename>"
}

Response

{
  "data": null
}

DELETEdelete_document_template/document_templates/:id

Delete a single DocumentTemplate

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the DocumentTemplate.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_document_template"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_document_template",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/document_templates/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_folder_contents/folders/list

Return the data of the contents of a Folder

Request

Query Parameters

Name	Type	Required	Description
contact_id	string	No	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.
created_since	string	No	Filter Folder records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
document_category_id	string	No	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.
external_property_name	string	No	Filter records to only those with the given external property(s) name set. e.g. `?external_property_name=Name`
external_property_value	string	No	Filter records to only those with the given external property(s) value set. Requires external property name as well. e.g. `?external_property_name=Name&external_property_value=Value`
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter Folder records to those having the specified unique identifiers.
include_deleted	string	No	Allow trashed Folder record to be included.
limit	string	No	A limit on the number of Folder records to be returned. Limit can range between 1 and 200. Default: `200`.
matter_id	string	No	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.
order	string	No	Orders the Folder records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
parent_id	string	No	The unique identifier for a single Folder. When returning the data of the contents of a Folder, the keyword `null` is not valid for this field. If no Folder is provided, it will default to the account's root Folder. When returning the data for all Folders, use the keyword `null` to match those without a Folder. The list will be filtered to include only the Folder records with the matching property.
query	string	No	Wildcard search for `name` matching the given string.
scope	string	No	Filters Folder record to those being a child of the parent Folder, or a descendant of the parent Folder. Default is `children`.
show_uncompleted	string	No	Allow Folder record being uploaded to be included.
updated_since	string	No	Filter Folder records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_folder_contents"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_folder_contents",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/folders/list
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

GETlist_folders/folders

Return the data for all Folders

Request

Query Parameters

Name	Type	Required	Description
contact_id	string	No	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.
created_since	string	No	Filter Folder records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
document_category_id	string	No	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.
external_property_name	string	No	Filter records to only those with the given external property(s) name set. e.g. `?external_property_name=Name`
external_property_value	string	No	Filter records to only those with the given external property(s) value set. Requires external property name as well. e.g. `?external_property_name=Name&external_property_value=Value`
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
ids[]	string	No	Filter Folder records to those having the specified unique identifiers.
include_deleted	string	No	Allow trashed Folder record to be included.
limit	string	No	A limit on the number of Folder records to be returned. Limit can range between 1 and 200. Default: `200`.
matter_id	string	No	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.
order	string	No	Orders the Folder records by the given field. Default: `id(asc)`.
page_token	string	No	A token specifying which page to return.
parent_id	string	No	The unique identifier for a single Folder. When returning the data of the contents of a Folder, the keyword `null` is not valid for this field. If no Folder is provided, it will default to the account's root Folder. When returning the data for all Folders, use the keyword `null` to match those without a Folder. The list will be filtered to include only the Folder records with the matching property.
query	string	No	Wildcard search for `name` matching the given string.
scope	string	No	Filters Folder record to those being a child of the parent Folder, or a descendant of the parent Folder. Default is `children`.
updated_since	string	No	Filter Folder records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).

Response

itemsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "list_folders"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "list_folders",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/folders
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

[
  {
    "items": []
  }
]

POSTcreate_folder/folders

Create a new Folder

Request

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
document_category	object	No
external_properties	array	No
name	string	Yes
parent	object	Yes
restore	boolean	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "create_folder"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "create_folder",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/clio/folders
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "document_category": "<document_category>",
  "external_properties": "<external_properties>",
  "name": "<name>",
  "parent": "<parent>",
  "restore": "<restore>"
}

Response

{
  "data": null
}

GETget_folder/folders/:id

Return the data for a single Folder

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Folder.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "get_folder"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "get_folder",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/clio/folders/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "data": null
}

PATCHupdate_folder/folders/:id

Update a single Folder

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Folder.

Query Parameters

Name	Type	Required	Description
fields	string	No	The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).

Body Parameters

Name	Type	Required
document_category	object	No
external_properties	array	No
name	string	No
parent	object	No
restore	boolean	No

Response

dataobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "update_folder"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "update_folder",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

PATCH https://app.ferrule.io/api/v1/clio/folders/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json

{
  "document_category": "<document_category>",
  "external_properties": "<external_properties>",
  "name": "<name>",
  "parent": "<parent>",
  "restore": "<restore>"
}

Response

{
  "data": null
}

DELETEdelete_folder/folders/:id

Delete a single Folder

Request

Path Parameters

Name	Type	Required	Description
id	string	Yes	The unique identifier for the Folder.

Response

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "clio",
      "method": "delete_folder"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_clio",
    "arguments": {
      "method": "delete_folder",
      "params": {
        "id": "<id>"
      }
    }
  }
}

Request

DELETE https://app.ferrule.io/api/v1/clio/folders/:id
Authorization: Bearer <your-api-key>
Content-Type: application/json