Ferrule

Lawmatics

86 tools • OpenAPI spec ↗

MCPREST
GETlist_prospects/prospects

List all prospects (matters/leads) with optional filters.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter by
filter_onstringNoValue to filter on
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_prospects",
      "params": {}
    }
  }
}
GETget_prospect/prospects/:id

Get a single prospect by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesProspect ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_prospect",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETfind_prospect_by_phone/prospects/find-by-phone/:phone_number

Find a prospect by phone number.

Request

Path Parameters

NameTypeRequiredDescription
phone_numberstringYesPhone number to search

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "find_prospect_by_phone",
      "params": {
        "phone_number": "<phone_number>"
      }
    }
  }
}
GETfind_prospect_by_email/prospects/find-by-email/:email_address

Find a prospect by email address.

Request

Path Parameters

NameTypeRequiredDescription
email_addressstringYesEmail address to search

Response

Response shape is not documented.

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "find_prospect_by_email",
      "params": {
        "email_address": "<email_address>"
      }
    }
  }
}
GETfind_prospect_by_name/prospects/find-by-name/:name

Find a prospect by name.

Request

Path Parameters

NameTypeRequiredDescription
namestringYesName to search

Response

Response shape is not documented.

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "find_prospect_by_name",
      "params": {
        "name": "<name>"
      }
    }
  }
}
GETlist_contacts/contacts

List all contacts.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

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

Get a single contact by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesContact ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_contact",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETfind_contact_by_phone/contacts/find-by-phone/:phone_number

Find a contact by phone number.

Request

Path Parameters

NameTypeRequiredDescription
phone_numberstringYesPhone number to search

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "find_contact_by_phone",
      "params": {
        "phone_number": "<phone_number>"
      }
    }
  }
}
GETfind_contact_by_email/contacts/find-by-email/:email_address

Find a contact by email address.

Request

Path Parameters

NameTypeRequiredDescription
email_addressstringYesEmail address to search

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "find_contact_by_email",
      "params": {
        "email_address": "<email_address>"
      }
    }
  }
}
GETfind_contact_by_name/contacts/find-by-name/:name

Find a contact by name.

Request

Path Parameters

NameTypeRequiredDescription
namestringYesName to search

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "find_contact_by_name",
      "params": {
        "name": "<name>"
      }
    }
  }
}
GETlist_companies/companies

List all companies.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

Response shape is not documented.

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_companies",
      "params": {}
    }
  }
}
GETget_company/companies/:id

Get a single company by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesCompany ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_company",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETfind_company_by_phone/companies/find-by-phone/:phone_number

Find a company by phone number.

Request

Path Parameters

NameTypeRequiredDescription
phone_numberstringYesPhone number to search

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "find_company_by_phone",
      "params": {
        "phone_number": "<phone_number>"
      }
    }
  }
}
GETfind_company_by_email/companies/find-by-email/:email_address

Find a company by email address.

Request

Path Parameters

NameTypeRequiredDescription
email_addressstringYesEmail address to search

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "find_company_by_email",
      "params": {
        "email_address": "<email_address>"
      }
    }
  }
}
GETfind_company_by_name/companies/find-by-name/:name

Find a company by name.

Request

Path Parameters

NameTypeRequiredDescription
namestringYesName to search

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "find_company_by_name",
      "params": {
        "name": "<name>"
      }
    }
  }
}
GETlist_addresses/addresses

List all addresses.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_addresses",
      "params": {}
    }
  }
}
GETget_address/addresses/:id

Get a single address by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesAddress ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_address",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_email_addresses/email-addresses

List all email addresses.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_email_addresses",
      "params": {}
    }
  }
}
GETget_email_address/email-addresses/:id

Get a single email address by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesEmail Address ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_email_address",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_phone_numbers/phone-numbers

List all phone numbers.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_phone_numbers",
      "params": {}
    }
  }
}
GETget_phone_number/phone-numbers/:id

Get a single phone number by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesPhone Number ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_phone_number",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_custom_contact_types/custom-contact-types

List all custom contact types.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_custom_contact_types",
      "params": {}
    }
  }
}
GETget_custom_contact_type/custom-contact-types/:id

Get a single custom contact type by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesCustom Contact Type ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_custom_contact_type",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_custom_fields/custom-fields

List all custom fields.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_custom_fields",
      "params": {}
    }
  }
}
GETget_custom_field/custom-fields/:id

Get a single custom field by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesCustom Field ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_custom_field",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_custom_emails/custom-emails

List all custom email templates.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

Response shape is not documented.

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_custom_emails",
      "params": {}
    }
  }
}
GETget_custom_email/custom-emails/:id

Get a single custom email template by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesCustom Email ID

Response

Response shape is not documented.

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_custom_email",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_forms/forms

List all forms.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_forms",
      "params": {}
    }
  }
}
GETget_form/forms/:id

Get a single form by UUID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesForm UUID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_form",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_form_entries/forms/:custom_form_uuid/entries

List all entries for a specific form.

Request

Path Parameters

NameTypeRequiredDescription
custom_form_uuidstringYesForm UUID

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_form_entries",
      "params": {
        "custom_form_uuid": "<custom_form_uuid>"
      }
    }
  }
}
GETlist_email_campaigns/email-campaigns

List all email campaigns.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

Response shape is not documented.

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_email_campaigns",
      "params": {}
    }
  }
}
GETget_email_campaign/email-campaigns/:id

Get a single email campaign by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesEmail Campaign ID

Response

Response shape is not documented.

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_email_campaign",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETget_email_campaign_stats/email-campaigns/:id/stats

Get statistics for an email campaign by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesEmail Campaign ID

Response

Response shape is not documented.

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_email_campaign_stats",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_events/events

List all events.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_events",
      "params": {}
    }
  }
}
GETget_event/events/:id

Get a single event by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesEvent ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_event",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_locations/locations

List all locations.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_locations",
      "params": {}
    }
  }
}
GETlist_event_types/event-types

List all event types.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

object

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_event_types",
      "params": {}
    }
  }
}
GETget_event_type/event-types/:id

Get a single event type by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesEvent Type ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_event_type",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_files/files

List all files.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_files",
      "params": {}
    }
  }
}
GETget_file/files/:id

Get a single file's metadata by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesFile ID

Response

Response shape is not documented.

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_file",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETdownload_file/files/:id/download

Download a file by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesFile ID

Response

This tool returns binary file content. No structured schema is available.

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "download_file",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_folders/folders

List all folders.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_folders",
      "params": {}
    }
  }
}
GETget_folder/folders/:id

Get a single folder by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesFolder ID

Response

Response shape is not documented.

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_folder",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_interactions/interactions

List all interactions.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_interactions",
      "params": {}
    }
  }
}
GETget_interaction/interactions/:id

Get a single interaction by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesInteraction ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_interaction",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_notes/notes

List all notes.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

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

Get a single note by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesNote ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_note",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_tasks/tasks

List all tasks.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_tasks",
      "params": {}
    }
  }
}
GETget_task/tasks/:id

Get a single task by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesTask ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_task",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_task_subtasks/tasks/:task_id/subtasks

List all subtasks for a task.

Request

Path Parameters

NameTypeRequiredDescription
task_idstringYesParent Task ID

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

Response shape is not documented.

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_task_subtasks",
      "params": {
        "task_id": "<task_id>"
      }
    }
  }
}
GETget_task_subtask/tasks/:task_id/subtasks/:subtask_id

Get a single subtask for a task.

Request

Path Parameters

NameTypeRequiredDescription
task_idstringYesParent Task ID
subtask_idstringYesSubtask ID

Response

Response shape is not documented.

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_task_subtask",
      "params": {
        "task_id": "<task_id>",
        "subtask_id": "<subtask_id>"
      }
    }
  }
}
GETlist_task_comments/tasks/:task_id/comments

List all comments for a task.

Request

Path Parameters

NameTypeRequiredDescription
task_idstringYesTask ID

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

Response shape is not documented.

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_task_comments",
      "params": {
        "task_id": "<task_id>"
      }
    }
  }
}
GETget_task_comment/tasks/:task_id/comments/:comment_id

Get a single comment for a task.

Request

Path Parameters

NameTypeRequiredDescription
task_idstringYesTask ID
comment_idstringYesComment ID

Response

Response shape is not documented.

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_task_comment",
      "params": {
        "task_id": "<task_id>",
        "comment_id": "<comment_id>"
      }
    }
  }
}
GETlist_task_statuses/task-statuses

List all task statuses.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

Response shape is not documented.

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_task_statuses",
      "params": {}
    }
  }
}
GETget_task_status/task-statuses/:id

Get a single task status by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesTask Status ID

Response

Response shape is not documented.

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_task_status",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_campaigns/campaigns

List all automation campaigns.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_campaigns",
      "params": {}
    }
  }
}
GETget_campaign/campaigns/:id

Get a single automation campaign by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesCampaign ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_campaign",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_sources/sources

List all lead sources.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_sources",
      "params": {}
    }
  }
}
GETget_source/sources/:id

Get a single lead source by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesSource ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_source",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_pipelines/pipelines

List all pipelines.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_pipelines",
      "params": {}
    }
  }
}
GETget_pipeline/pipelines/:id

Get a single pipeline by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesPipeline ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_pipeline",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_stages/stages

List all pipeline stages.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_stages",
      "params": {}
    }
  }
}
GETget_stage/stages/:id

Get a single pipeline stage by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesStage ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_stage",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_practice_areas/practice-areas

List all practice areas.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_practice_areas",
      "params": {}
    }
  }
}
GETget_practice_area/practice-areas/:id

Get a single practice area by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesPractice Area ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_practice_area",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_relationships/relationships

List all relationships.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_relationships",
      "params": {}
    }
  }
}
GETget_relationship/relationships/:id

Get a single relationship by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesRelationship ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_relationship",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_relationship_types/relationship-types

List all relationship types.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_relationship_types",
      "params": {}
    }
  }
}
GETget_relationship_type/relationship-types/:id

Get a single relationship type by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesRelationship Type ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_relationship_type",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_sub_statuses/sub-statuses

List all sub-statuses.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_sub_statuses",
      "params": {}
    }
  }
}
GETget_sub_status/sub-statuses/:id

Get a single sub-status by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesStatus ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_sub_status",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_tags/tags

List all tags.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_tags",
      "params": {}
    }
  }
}
GETget_tag/tags/:id

Get a single tag by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesTag ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_tag",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_invoices/invoices

List all invoices.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_invoices",
      "params": {}
    }
  }
}
GETget_invoice/invoices/:id

Get a single invoice by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesInvoice ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_invoice",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_expenses/expenses

List all expenses.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_expenses",
      "params": {}
    }
  }
}
GETget_expense/expenses/:id

Get a single expense by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesExpense ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_expense",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_time_entries/time-entries

List all time entries.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_time_entries",
      "params": {}
    }
  }
}
GETget_time_entry/time-entries/:id

Get a single time entry by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesTime Entry ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_time_entry",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_transactions/transactions

List all transactions.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_transactions",
      "params": {}
    }
  }
}
GETget_transaction/transactions/:id

Get a single transaction by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesTransaction ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_transaction",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETlist_activities/activities

List all activities. Can filter by matter_id, contact_id, type, or event.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField to filter by (matter_id, contact_id, type, or event)
filter_onstringNoValue to filter on
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

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

Get a single activity by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesActivity ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

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

List all users in the firm.

Request

Query Parameters

NameTypeRequiredDescription
sort_orderstringNoSort order: asc or desc (default: desc)
sort_bystringNoField to sort by (e.g. id, created_at, updated_at)
filter_bystringNoField name to filter on
filter_onstringNoValue to filter for
filter_withstringNoFilter operator: =, !=, <=, <, >=, >, like, ilike, null, not_null

Pagination

NameTypeRequiredDescription
pagestringNoPage number for pagination (default: 1)

Response

dataobject
metaobject
linksobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "list_users",
      "params": {}
    }
  }
}
GETget_user/users/:id

Get a single user by ID.

Request

Path Parameters

NameTypeRequiredDescription
idstringYesUser ID

Response

dataobject

Examples

1. Describe method

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

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_lawmatics",
    "arguments": {
      "method": "get_user",
      "params": {
        "id": "<id>"
      }
    }
  }
}
GETget_me/users/me

Get the currently authenticated user.

Request

No input parameters.

Response

dataobject

Examples

1. Describe method

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

2. Call method

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