Skip to content

traviscrawford85/clio-python-client

BranchesTags

Repository files navigation

openapi-client

Developer Support and Feedback

  • Clio takes the availability and stability of our API seriously; please report any degradations or breakages to Clio's API Support team at [email protected].
  • For business and partnership inquiries, contact our API Partnerships team at [email protected].
  • For best practices and tips from the Clio development community, join the conversation in the Clio Developer Slack Channel.

A community-driven Clio Developers Stack Overflow Group also exists where you can connect and ask questions from other Clio API users.

Getting Started

Note: The API is available in four distinct data regions: Australia (au.app.clio.com), Canada (ca.app.clio.com), EU (eu.app.clio.com) and US (app.clio.com).

Likewise, the developer portal is available at region-specific links for the Australia, Canada, EU, and US regions.

This document assumes the US region is being used (app.clio.com). If you're building in one of the other regions, you should adapt the links and examples as necessary.

To start building on the Clio API, you’ll need a Clio account – you can review our Developer Handbook and follow the steps to sign up for an account.

Once you have an account, you can create a developer application from the Developer Portal and start building!

Authorization with OAuth 2.0

See our Authorization documentation →

Permissions

See our Permissions documentation →

Fields

See our Fields documentation →

Rate Limiting

See our Rate Limits documentation →

Paging

See our Pagination documentation →

ETags

See our ETags documentation →

Minor Versions

API v4 supports multiple minor versions. Versions are of the form '4.X.Y'. To request a specific version, you can use an X-API-VERSION header in your request, with the header value set to the API version you're requesting. If this header is omitted, it will be treated as a request for the default API version. If the header is present but invalid, it will return a 410 Gone response. If the header is present and valid, but it is no longer supported, it will return a 410 Gone response.

An X-API-VERSION will be included in all successful responses, with the value being set to the API version used.

You can find our API Versioning Policy and Guidelines in our documentation hub.

The API Changelog explains each version's changes in further detail.

  • 4.0.4

    Update quantity field to return values in seconds rather than hours for Activities

  • 4.0.5

    • Remove matter_balances field from Bills
    • Standardize status/state enum values
    • Add a Document association to completed DocumentAutomations
    • Add rate visibility handling for Activity's price and total

  • 4.0.6

    Remove document_versions collection field from Documents

  • 4.0.7

    Change secure link format

  • 4.0.8

    • Activity hours are redacted in the response based on the activity hours visibility setting for the user
    • Add quantity_redacted field to activities

  • 4.0.9

    This is the default version

    Contacts are filtered and redacted in the response based on the new 'Contacts Visibility' user permission setting.

  • 4.0.10

    Fixed validation of type query parameter when querying Notes

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: v4
  • Package version: 1.0.0
  • Generator version: 7.11.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.8+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import openapi_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import openapi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://app.clio.com/api/v4
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "https://app.clio.com/api/v4"
)



# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.ActivitiesApi(api_client)
    x_api_version = 'x_api_version_example' # str | The [API minor version](#section/Minor-Versions). Default: latest version. (optional)
    fields = 'fields_example' # str | The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields). (optional)
    activity_create_request = openapi_client.ActivityCreateRequest() # ActivityCreateRequest | Request Body for Activities (optional)

    try:
        # Create a new Activity
        api_response = api_instance.activity_create(x_api_version=x_api_version, fields=fields, activity_create_request=activity_create_request)
        print("The response of ActivitiesApi->activity_create:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ActivitiesApi->activity_create: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://app.clio.com/api/v4

Class Method HTTP request Description
ActivitiesApi activity_create POST /activities.json Create a new Activity
ActivitiesApi activity_destroy DELETE /activities/{id}.json Delete a single Activity
ActivitiesApi activity_index GET /activities.json Return the data for all Activities
ActivitiesApi activity_show GET /activities/{id}.json Return the data for a single Activity
ActivitiesApi activity_update PATCH /activities/{id}.json Update a single Activity
ActivityDescriptionsApi activity_description_create POST /activity_descriptions.json Create a new ActivityDescription
ActivityDescriptionsApi activity_description_destroy DELETE /activity_descriptions/{id}.json Delete a single ActivityDescription
ActivityDescriptionsApi activity_description_index GET /activity_descriptions.json Return the data for all ActivityDescriptions
ActivityDescriptionsApi activity_description_show GET /activity_descriptions/{id}.json Return the data for a single ActivityDescription
ActivityDescriptionsApi activity_description_update PATCH /activity_descriptions/{id}.json Update a single ActivityDescription
ActivityRatesApi activity_rate_create POST /activity_rates.json Create a new ActivityRate
ActivityRatesApi activity_rate_destroy DELETE /activity_rates/{id}.json Delete a single ActivityRate
ActivityRatesApi activity_rate_index GET /activity_rates.json Return the data for all ActivityRates
ActivityRatesApi activity_rate_show GET /activity_rates/{id}.json Return the data for a single ActivityRate
ActivityRatesApi activity_rate_update PATCH /activity_rates/{id}.json Update a single ActivityRate
AllocationsApi allocation_index GET /allocations.json Return the data for all Allocations
AllocationsApi allocation_show GET /allocations/{id}.json Return the data for a single Allocation
BankAccountsApi bank_account_create POST /bank_accounts.json Create a new BankAccount
BankAccountsApi bank_account_destroy DELETE /bank_accounts/{id}.json Delete a single BankAccount
BankAccountsApi bank_account_index GET /bank_accounts.json Return the data for all BankAccounts
BankAccountsApi bank_account_show GET /bank_accounts/{id}.json Return the data for a single BankAccount
BankAccountsApi bank_account_update PATCH /bank_accounts/{id}.json Update a single BankAccount
BankTransactionsApi bank_transaction_index GET /bank_transactions.json Return the data for all BankTransactions
BankTransactionsApi bank_transaction_show GET /bank_transactions/{id}.json Return the data for a single BankTransaction
BankTransfersApi bank_transfer_show GET /bank_transfers/{id}.json Return the data for a single BankTransfer
BillThemesApi bill_theme_index GET /bill_themes.json Return the data for all BillThemes
BillThemesApi bill_theme_update PATCH /bill_themes/{id}.json Update a single BillTheme
BillableClientsApi billable_client_index GET /billable_clients.json Return the data for all BillableClients
BillableMattersApi billable_matter_ids GET /billable_matters/ids.json Returns the unique identifiers of all BillableMatter
BillableMattersApi billable_matter_index GET /billable_matters.json Return the data for all BillableMatters
BillingSettingsApi billing_setting_show GET /settings/billing.json Return the billing settings
BillsApi bill_destroy DELETE /bills/{id}.json Delete or void a Bill
BillsApi bill_index GET /bills.json Return the data for all Bills
BillsApi bill_preview GET /bills/{id}/preview.json Returns the pre-rendered html for the Bill
BillsApi bill_show GET /bills/{id}.json Return the data for a single Bill
BillsApi bill_update PATCH /bills/{id}.json Update a single Bill
CalendarEntriesApi calendar_entry_create POST /calendar_entries.json Create a new CalendarEntry
CalendarEntriesApi calendar_entry_destroy DELETE /calendar_entries/{id}.json Delete a single CalendarEntry
CalendarEntriesApi calendar_entry_index GET /calendar_entries.json Return the data for all CalendarEntries
CalendarEntriesApi calendar_entry_show GET /calendar_entries/{id}.json Return the data for a single CalendarEntry
CalendarEntriesApi calendar_entry_update PATCH /calendar_entries/{id}.json Update a single CalendarEntry
CalendarEntryEventTypesApi calendar_entry_event_type_create POST /calendar_entry_event_types.json Create a new calendar entry event type
CalendarEntryEventTypesApi calendar_entry_event_type_destroy DELETE /calendar_entry_event_types/{id}.json Delete a single calendar entry event type
CalendarEntryEventTypesApi calendar_entry_event_type_index GET /calendar_entry_event_types.json Return the data for all calendar entry event types
CalendarEntryEventTypesApi calendar_entry_event_type_show GET /calendar_entry_event_types/{id}.json Return the data for a single calendar entry event type
CalendarEntryEventTypesApi calendar_entry_event_type_update PATCH /calendar_entry_event_types/{id}.json Update a single calendar entry event type
CalendarVisibilitiesApi calendar_visibility_index GET /task_calendars.json Return the data for all CalendarVisibilities
CalendarVisibilitiesApi calendar_visibility_show GET /task_calendars/{id}.json Return the data for a single CalendarVisibility
CalendarVisibilitiesApi calendar_visibility_update PATCH /task_calendars/{id}.json Update a single CalendarVisibility
CalendarsApi calendar_create POST /calendars.json Create a new Calendar
CalendarsApi calendar_destroy DELETE /calendars/{id}.json Delete a single Calendar
CalendarsApi calendar_index GET /calendars.json Return the data for all Calendars
CalendarsApi calendar_show GET /calendars/{id}.json Return the data for a single Calendar
CalendarsApi calendar_update PATCH /calendars/{id}.json Update a single Calendar
CivilCertificatedRatesApi lauk_civil_certificated_rate_index GET /lauk_civil_certificated_rates.json List Civil Certificated Rates
CivilControlledRatesApi lauk_civil_controlled_rate_index GET /lauk_civil_controlled_rates.json List Civil Controlled Rates
ClientsApi client_show GET /matters/{matter_id}/client.json Return the client data for a single matter
ClioPaymentsLinksApi clio_payments_link_create POST /clio_payments/links.json Create a new ClioPaymentsLink
ClioPaymentsLinksApi clio_payments_link_index GET /clio_payments/links.json Return the data for all ClioPaymentsLinks
ClioPaymentsLinksApi clio_payments_link_show GET /clio_payments/links/{id}.json Return the data for a single ClioPaymentsLink
ClioPaymentsLinksApi clio_payments_link_update PATCH /clio_payments/links/{id}.json Update a single ClioPaymentsLink
ClioPaymentsPaymentsApi clio_payments_payment_index GET /clio_payments/payments.json Return the data for all ClioPaymentsPayments
ClioPaymentsPaymentsApi clio_payments_payment_show GET /clio_payments/payments/{id}.json Return the data for a single ClioPaymentsPayment
CommentsApi comment_create POST /comments.json Create a new Comment
CommentsApi comment_destroy DELETE /comments/{id}.json Delete a single Comment
CommentsApi comment_index GET /comments.json Return the data for all Comments
CommentsApi comment_show GET /comments/{id}.json Return the data for a single Comment
CommentsApi comment_update PATCH /comments/{id}.json Update a single Comment
CommunicationsApi communication_create POST /communications.json Create a new Communication
CommunicationsApi communication_destroy DELETE /communications/{id}.json Delete a single Communication
CommunicationsApi communication_index GET /communications.json Return the data for all Communications
CommunicationsApi communication_show GET /communications/{id}.json Return the data for a single Communication
CommunicationsApi communication_update PATCH /communications/{id}.json Update a single Communication
ContactsApi contact_create POST /contacts.json Create a new Contact
ContactsApi contact_destroy DELETE /contacts/{id}.json Delete a single Contact
ContactsApi contact_index GET /contacts.json Return the data for all Contacts
ContactsApi contact_show GET /contacts/{id}.json Return the data for a single Contact
ContactsApi contact_update PATCH /contacts/{id}.json Update a single Contact
ConversationMessagesApi conversation_message_create POST /conversation_messages.json Create a new ConversationMessage
ConversationMessagesApi conversation_message_index GET /conversation_messages.json Return the data for all ConversationMessages
ConversationMessagesApi conversation_message_show GET /conversation_messages/{id}.json Return the data for a single ConversationMessage
ConversationsApi conversation_index GET /conversations.json Return the data for all Conversations
ConversationsApi conversation_show GET /conversations/{id}.json Return the data for a single Conversation
ConversationsApi conversation_update PATCH /conversations/{id}.json Update a single Conversation
CreditMemosApi credit_memo_index GET /credit_memos.json Return the data for all CreditMemos
CreditMemosApi credit_memo_show GET /credit_memos/{id}.json Return the data for a single CreditMemo
CriminalControlledRatesApi lauk_criminal_controlled_rate_index GET /lauk_criminal_controlled_rates.json List Criminal Controlled Rates
CurrenciesApi currency_index GET /currencies.json Return the data for all Currencies
CustomActionsApi custom_action_create POST /custom_actions.json Create a new CustomAction
CustomActionsApi custom_action_destroy DELETE /custom_actions/{id}.json Delete a single CustomAction
CustomActionsApi custom_action_index GET /custom_actions.json Return the data for all CustomActions
CustomActionsApi custom_action_show GET /custom_actions/{id}.json Return the data for a single CustomAction
CustomActionsApi custom_action_update PATCH /custom_actions/{id}.json Update a single CustomAction
CustomFieldSetsApi custom_field_set_create POST /custom_field_sets.json Create a new CustomFieldSet
CustomFieldSetsApi custom_field_set_destroy DELETE /custom_field_sets/{id}.json Delete a single CustomFieldSet
CustomFieldSetsApi custom_field_set_index GET /custom_field_sets.json Return the data for all CustomFieldSets
CustomFieldSetsApi custom_field_set_show GET /custom_field_sets/{id}.json Return the data for a single CustomFieldSet
CustomFieldSetsApi custom_field_set_update PATCH /custom_field_sets/{id}.json Update a single CustomFieldSet
CustomFieldsApi custom_field_create POST /custom_fields.json Create a new CustomField
CustomFieldsApi custom_field_destroy DELETE /custom_fields/{id}.json Delete a single CustomField
CustomFieldsApi custom_field_index GET /custom_fields.json Return the data for all CustomFields
CustomFieldsApi custom_field_show GET /custom_fields/{id}.json Return the data for a single CustomField
CustomFieldsApi custom_field_update PATCH /custom_fields/{id}.json Update a single CustomField
DamagesApi damage_create POST /damages.json Creating a Damage
DamagesApi damage_destroy DELETE /damages/{id}.json Deleting a Damage
DamagesApi damage_index GET /damages.json Return the data for all Damages
DamagesApi damage_show GET /damages/{id}.json Return a specific Damage
DamagesApi damage_update PATCH /damages/{id}.json Updating a Damage
DocumentArchivesApi document_archive_create POST /document_archives.json Create a new DocumentArchive
DocumentArchivesApi document_archive_download GET /document_archives/{id}/download.json Download the DocumentArchive
DocumentArchivesApi document_archive_show GET /document_archives/{id}.json Return the data for a single DocumentArchive
DocumentAutomationsApi document_automation_create POST /document_automations.json Create a new DocumentAutomation
DocumentAutomationsApi document_automation_index GET /document_automations.json Return the data for all DocumentAutomations
DocumentAutomationsApi document_automation_show GET /document_automations/{id}.json Return the data for a single DocumentAutomation
DocumentCategoriesApi document_category_create POST /document_categories.json Create a new DocumentCategory
DocumentCategoriesApi document_category_destroy DELETE /document_categories/{id}.json Delete a single DocumentCategory
DocumentCategoriesApi document_category_index GET /document_categories.json Return the data for all DocumentCategories
DocumentCategoriesApi document_category_show GET /document_categories/{id}.json Return the data for a single DocumentCategory
DocumentCategoriesApi document_category_update PATCH /document_categories/{id}.json Update a single DocumentCategory
DocumentTemplatesApi document_template_create POST /document_templates.json Create a new DocumentTemplate
DocumentTemplatesApi document_template_destroy DELETE /document_templates/{id}.json Delete a single DocumentTemplate
DocumentTemplatesApi document_template_download GET /document_templates/{id}/download.json Get the contents of the DocumentTemplate
DocumentTemplatesApi document_template_index GET /document_templates.json Return the data for all DocumentTemplates
DocumentTemplatesApi document_template_show GET /document_templates/{id}.json Return the data for a single DocumentTemplate
DocumentTemplatesApi document_template_update PATCH /document_templates/{id}.json Update a single DocumentTemplate
DocumentVersionsApi document_version_index GET /documents/{id}/versions.json Return the data for all DocumentVersions
DocumentsApi document_copy POST /documents/{id}/copy.json Copy a Document
DocumentsApi document_create POST /documents.json Create a new Document
DocumentsApi document_destroy DELETE /documents/{id}.json Delete a single Document
DocumentsApi document_download GET /documents/{id}/download.json Download the Document
DocumentsApi document_index GET /documents.json Return the data for all Documents
DocumentsApi document_show GET /documents/{id}.json Return the data for a single Document
DocumentsApi document_update PATCH /documents/{id}.json Update a single Document
EmailAddressesApi email_address_index GET /contacts/{contact_id}/email_addresses.json Return the data for all EmailAddresses
EventMetricsApi event_metrics_index GET /internal_notifications/event_metrics.json Unread in-app notification events
ExpenseCategoriesApi expense_category_create POST /expense_categories.json Create a new ExpenseCategory
ExpenseCategoriesApi expense_category_destroy DELETE /expense_categories/{id}.json Delete a single ExpenseCategory
ExpenseCategoriesApi expense_category_index GET /expense_categories.json Return the data for all ExpenseCategories
ExpenseCategoriesApi expense_category_show GET /expense_categories/{id}.json Return the data for a single ExpenseCategory
ExpenseCategoriesApi expense_category_update PATCH /expense_categories/{id}.json Update a single ExpenseCategory
ExpenseCategoriesApi lauk_expense_category_index GET /lauk_expense_categories.json List Expense Categories
FoldersApi folder_create POST /folders.json Create a new Folder
FoldersApi folder_destroy DELETE /folders/{id}.json Delete a single Folder
FoldersApi folder_index GET /folders.json Return the data for all Folders
FoldersApi folder_list GET /folders/list.json Return the data of the contents of a Folder
FoldersApi folder_show GET /folders/{id}.json Return the data for a single Folder
FoldersApi folder_update PATCH /folders/{id}.json Update a single Folder
GrantFundingSourcesApi grant_funding_source_create POST /grant_funding_sources.json Create a new grant funding source
GrantFundingSourcesApi grant_funding_source_destroy DELETE /grant_funding_sources/{id}.json Delete a single grant funding source
GrantFundingSourcesApi grant_funding_source_index GET /grant_funding_sources.json Return the data for all grant funding sources
GrantFundingSourcesApi grant_funding_source_update PATCH /grant_funding_sources/{id}.json Update a single grant funding source
GrantsApi grant_create POST /grants.json Create a new grant
GrantsApi grant_destroy DELETE /grants/{id}.json Deletes a single grant
GrantsApi grant_index GET /grants.json Return the data for all grants
GrantsApi grant_show GET /grants/{id}.json Return the data for a single grant
GrantsApi grant_update PATCH /grants/{id}.json Update a single grant
GroupsApi group_create POST /groups.json Create a new Group
GroupsApi group_destroy DELETE /groups/{id}.json Delete a single Group
GroupsApi group_index GET /groups.json Return the data for all Groups
GroupsApi group_show GET /groups/{id}.json Return the data for a single Group
GroupsApi group_update PATCH /groups/{id}.json Update a single Group
InterestChargesApi interest_charge_destroy DELETE /interest_charges/{id}.json Delete a single InterestCharge
InterestChargesApi interest_charge_index GET /interest_charges.json Return the data for all InterestCharges
JurisdictionsApi jurisdiction_index GET /court_rules/jurisdictions.json Return the data for all jurisdictions
JurisdictionsApi jurisdiction_show GET /court_rules/jurisdictions/{id}.json Return the data for the jurisdiction
JurisdictionsToTriggersApi jurisdictions_to_trigger_index GET /court_rules/jurisdictions/{jurisdiction_id}/triggers.json Return the data for all triggers
JurisdictionsToTriggersApi jurisdictions_to_trigger_show GET /court_rules/jurisdictions/{jurisdiction_id}/triggers/{id}.json Return the data for the trigger
LineItemsApi line_item_destroy DELETE /line_items/{id}.json Delete a single LineItem
LineItemsApi line_item_index GET /line_items.json Return the data for all LineItems
LineItemsApi line_item_update PATCH /line_items/{id}.json Update a single LineItem
LogEntriesApi log_entry_index GET /log_entries.json Return the data for all LogEntries
MatterContactsApi matter_contacts_index GET /matters/{matter_id}/contacts.json Return the related contact data for a single matter
MatterDocketsApi matter_docket_create POST /court_rules/matter_dockets.json Creates a matter docket
MatterDocketsApi matter_docket_destroy DELETE /court_rules/matter_dockets/{id}.json Deletes the requested matter docket
MatterDocketsApi matter_docket_index GET /court_rules/matter_dockets.json Return the data for all matter dockets
MatterDocketsApi matter_docket_preview GET /court_rules/matter_dockets/preview.json Preview calendar dates for the docket
MatterDocketsApi matter_docket_show GET /court_rules/matter_dockets/{id}.json Return the data for the matter docket
MatterStagesApi matter_stage_index GET /matter_stages.json Return the data for all MatterStages
MattersApi matter_create POST /matters.json Create a new Matter
MattersApi matter_destroy DELETE /matters/{id}.json Delete a single Matter
MattersApi matter_index GET /matters.json Return the data for all Matters
MattersApi matter_show GET /matters/{id}.json Return the data for a single Matter
MattersApi matter_update PATCH /matters/{id}.json Update a single Matter
MedicalBillsApi medical_bill_destroy DELETE /medical_bills/{id}.json Destroying a Medical Bill
MedicalBillsApi medical_bill_update PATCH /medical_bills/{id}.json Updating a Medical Bill
MedicalRecordsApi medical_record_destroy DELETE /medical_records/{id}.json Destroying a Medical Record
MedicalRecordsApi medical_record_update PATCH /medical_records/{id}.json Updating a Medical Record
MedicalRecordsDetailsApi medical_records_request_create POST /medical_records_details.json Creating a Medical Records Detail, Medical Records and Medical Bills
MedicalRecordsDetailsApi medical_records_request_destroy DELETE /medical_records_details/{id}.json Destroying a Medical Records Detail
MedicalRecordsDetailsApi medical_records_request_index GET /medical_records_details.json Return the data for all Medical Records Details
MedicalRecordsDetailsApi medical_records_request_show GET /medical_records_details/{id}.json Return the data for a single Medical Records Detail
MedicalRecordsDetailsApi medical_records_request_update PATCH /medical_records_details/{id}.json Updating a Medical Records Detail
MyEventsApi my_event_destroy DELETE /internal_notifications/my_events/{id}.json Clear (delete) a single in-app notification event
MyEventsApi my_event_index GET /internal_notifications/my_events.json Return the data for all of my in-app notification events
MyEventsApi my_event_update PATCH /internal_notifications/my_events/{id}.json Mark a single in-app notification event as read/unread
NotesApi note_create POST /notes.json Create a new Note
NotesApi note_destroy DELETE /notes/{id}.json Delete a single Note
NotesApi note_index GET /notes.json Return the data for all Notes
NotesApi note_show GET /notes/{id}.json Return the data for a single Note
NotesApi note_update PATCH /notes/{id}.json Update a single Note
OutstandingClientBalancesApi outstanding_client_balance_index GET /outstanding_client_balances.json Return the data for all OutstandingClientBalances
PhoneNumbersApi phone_number_index GET /contacts/{contact_id}/phone_numbers.json Return the data for all PhoneNumbers
PracticeAreasApi practice_area_create POST /practice_areas.json Create a new PracticeArea
PracticeAreasApi practice_area_destroy DELETE /practice_areas/{id}.json Delete a single PracticeArea
PracticeAreasApi practice_area_index GET /practice_areas.json Return the data for all PracticeAreas
PracticeAreasApi practice_area_show GET /practice_areas/{id}.json Return the data for a single PracticeArea
PracticeAreasApi practice_area_update PATCH /practice_areas/{id}.json Update a single PracticeArea
RelatedContactsApi related_contacts_index GET /matters/{matter_id}/related_contacts.json Return the related contact data for a single matter
RelationshipsApi relationship_create POST /relationships.json Create a new Relationship
RelationshipsApi relationship_destroy DELETE /relationships/{id}.json Delete a single Relationship
RelationshipsApi relationship_index GET /relationships.json Return the data for all Relationships
RelationshipsApi relationship_show GET /relationships/{id}.json Return the data for a single Relationship
RelationshipsApi relationship_update PATCH /relationships/{id}.json Update a single Relationship
RemindersApi reminder_create POST /reminders.json Create a new Reminder
RemindersApi reminder_destroy DELETE /reminders/{id}.json Delete a single Reminder
RemindersApi reminder_index GET /reminders.json Return the data for all Reminders
RemindersApi reminder_show GET /reminders/{id}.json Return the data for a single Reminder
RemindersApi reminder_update PATCH /reminders/{id}.json Update a single Reminder
ReportPresetsApi report_preset_create POST /report_presets.json Create a new ReportPreset
ReportPresetsApi report_preset_destroy DELETE /report_presets/{id}.json Delete a single ReportPreset
ReportPresetsApi report_preset_generate_report POST /report_presets/{id}/generate_report.json Generate a new report for a given preset
ReportPresetsApi report_preset_index GET /report_presets.json Return the data for all ReportPresets
ReportPresetsApi report_preset_show GET /report_presets/{id}.json Return the data for a single ReportPreset
ReportPresetsApi report_preset_update PATCH /report_presets/{id}.json Update a single ReportPreset
ReportSchedulesApi report_schedule_create POST /report_schedules.json Create a new ReportSchedule
ReportSchedulesApi report_schedule_destroy DELETE /report_schedules/{id}.json Delete a single ReportSchedule
ReportSchedulesApi report_schedule_index GET /report_schedules.json Return the data for all ReportSchedules
ReportSchedulesApi report_schedule_show GET /report_schedules/{id}.json Return the data for a single ReportSchedule
ReportSchedulesApi report_schedule_update PATCH /report_schedules/{id}.json Update a single ReportSchedule
ReportsApi report_create POST /reports.json Create a new Report
ReportsApi report_download GET /reports/{id}/download.json Download the completed Report
ReportsApi report_index GET /reports.json Return the data for all Reports
ReportsApi report_show GET /reports/{id}.json Return the data for a single Report
ServiceTypesApi service_type_index GET /court_rules/service_types.json Return the data for all service types
ServiceTypesApi service_type_show GET /court_rules/service_types/{id}.json Return the data for the service type
TaskTemplateListsApi task_template_list_copy POST /task_template_lists/{id}/copy.json Copy a TaskTemplateList
TaskTemplateListsApi task_template_list_create POST /task_template_lists.json Create a new TaskTemplateList
TaskTemplateListsApi task_template_list_destroy DELETE /task_template_lists/{id}.json Delete a single TaskTemplateList
TaskTemplateListsApi task_template_list_index GET /task_template_lists.json Return the data for all TaskTemplateLists
TaskTemplateListsApi task_template_list_show GET /task_template_lists/{id}.json Return the data for a single TaskTemplateList
TaskTemplateListsApi task_template_list_update PATCH /task_template_lists/{id}.json Update a single TaskTemplateList
TaskTemplatesApi task_template_create POST /task_templates.json Create a new TaskTemplate
TaskTemplatesApi task_template_destroy DELETE /task_templates/{id}.json Delete a single TaskTemplate
TaskTemplatesApi task_template_index GET /task_templates.json Return the data for all TaskTemplates
TaskTemplatesApi task_template_show GET /task_templates/{id}.json Return the data for a single TaskTemplate
TaskTemplatesApi task_template_update PATCH /task_templates/{id}.json Update a single TaskTemplate
TaskTypesApi task_type_create POST /task_types.json Create a new TaskType
TaskTypesApi task_type_index GET /task_types.json Return the data for all TaskTypes
TaskTypesApi task_type_show GET /task_types/{id}.json Return the data for a single TaskType
TaskTypesApi task_type_update PATCH /task_types/{id}.json Update a single TaskType
TasksApi task_create POST /tasks.json Create a new Task
TasksApi task_destroy DELETE /tasks/{id}.json Delete a single Task
TasksApi task_index GET /tasks.json Return the data for all Tasks
TasksApi task_show GET /tasks/{id}.json Return the data for a single Task
TasksApi task_update PATCH /tasks/{id}.json Update a single Task
TextSnippetsApi text_snippet_create POST /settings/text_snippets.json Create a text snippet
TextSnippetsApi text_snippet_destroy DELETE /settings/text_snippets/{id}.json Destroy a text snippet
TextSnippetsApi text_snippet_index GET /settings/text_snippets.json Return all text snippets
TextSnippetsApi text_snippet_show GET /settings/text_snippets/{id}.json Return the data for the text snippet
TextSnippetsApi text_snippet_update PATCH /settings/text_snippets/{id}.json Update a text snippet
TimersApi timer_create POST /timer.json Create a new Timer
TimersApi timer_destroy DELETE /timer.json Delete a single Timer
TimersApi timer_show GET /timer.json Return the data for a single Timer
TrustLineItemsApi trust_line_item_index GET /trust_line_items.json Return the data for all TrustLineItems
TrustLineItemsApi trust_line_item_update PATCH /trust_line_items/{id}.json Update a single TrustLineItem
TrustRequestsApi trust_request_create POST /trust_requests.json Create a new TrustRequest
UsersApi user_index GET /users.json Return the data for all Users
UsersApi user_show GET /users/{id}.json Return the data for a single User
UsersApi user_who_am_i GET /users/who_am_i.json Return the data for the current User
UtbmsCodesApi utbms_code_index GET /utbms/codes.json Return the data for all UtbmsCodes
UtbmsCodesApi utbms_code_show GET /utbms/codes/{id}.json Return the data for a single UtbmsCode
UtbmsSetsApi utbms_set_index GET /utbms/sets.json Return the data for all the utbms sets
WebhooksApi webhook_create POST /webhooks.json Create a new Webhook
WebhooksApi webhook_destroy DELETE /webhooks/{id}.json Delete a single Webhook
WebhooksApi webhook_index GET /webhooks.json Return the data for all Webhooks
WebhooksApi webhook_show GET /webhooks/{id}.json Return the data for a single Webhook
WebhooksApi webhook_update PATCH /webhooks/{id}.json Update a single Webhook

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

[email protected]

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

0 stars

Watchers

1 watching

Forks

2 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages