Clio Grow API Documentation (v2)

Download OpenAPI specification:Download

Clio Grow API Support: api@clio.com License: Proprietary

Developer Support and Feedback

Clio takes the availability and stability of our API seriously; please report any degradations or breakages to Clio Grow's API Support team at api@clio.com.
For business and partnership inquiries, contact our API Partnerships team at api.partnerships@clio.com.
For best practices and tips from the Clio development community, join the conversation in the Clio Developer Slack Channel.

Getting Started

Note: The API is available at region specific URLs for the Australia, EU, Canada and US regions.

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

Contacts

Operations for managing contacts and contact notes

List contacts

Returns a paginated list of contacts

query Parameters

query	string Search across contact names, emails, and phone numbers
page_token	string Opaque token for cursor-based pagination
created_since	string <date-time> Filter results created on or after this time (ISO-8601 timestamp)
updated_since	string <date-time> Filter results updated on or after this time (ISO-8601 timestamp)
ids[]	Array of integers <int64> [ 1 .. 50 ] items [ items <int64 > ] Filter by resource IDs (max 50)

Responses

Response samples

200
400
401
403
429

Content type

application/json

{"data": [{"id": 123,
"global_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"clio_id": 456,
"name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"emails": ["john@example.com"
],
"phone_numbers": ["+15551234567"
],
"type": "Person",
"status": "Hired",
"matters": [{"id": 0
}
],
"addresses": [{"street": "123 Main St",
"city": "San Francisco",
"province": "CA",
"postal_code": "94102",
"country": "USA"
}
],
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-02-20T14:45:00Z"
}
],
"meta": {"paging": {"next": "https://grow.clio.com/api/v2/contacts?page_token=abc123",
"previous": "http://example.com"
}
}
}

Get a contact

Returns a single contact by ID

path Parameters

id

required

integer <int64>

The unique identifier for the Contact

Responses

Response samples

Content type

application/json

{"data": {"id": 123,
"global_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"clio_id": 456,
"name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"emails": ["john@example.com"
],
"phone_numbers": ["+15551234567"
],
"type": "Person",
"status": "Hired",
"matters": [{"id": 0
}
],
"addresses": [{"street": "123 Main St",
"city": "San Francisco",
"province": "CA",
"postal_code": "94102",
"country": "USA"
}
],
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-02-20T14:45:00Z"
}
}

List notes for a contact

Returns a paginated list of notes for a contact

path Parameters

contact_id

required

integer <int64>

The unique identifier for the Contact

query Parameters

page_token	string Opaque token for cursor-based pagination
created_since	string <date-time> Filter results created on or after this time (ISO-8601 timestamp)
updated_since	string <date-time> Filter results updated on or after this time (ISO-8601 timestamp)
ids[]	Array of integers <int64> [ 1 .. 50 ] items [ items <int64 > ] Filter by resource IDs (max 50)

Responses

Response samples

Content type

application/json

{"data": [{"id": 123,
"subject": "API request",
"body": "Making a matter note from the API",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-02-20T14:45:00Z"
}
],
"meta": {"paging": {"next": "https://grow.clio.com/api/v2/contacts?page_token=abc123",
"previous": "http://example.com"
}
}
}

Create a note for a contact

Creates a new note for a contact

path Parameters

contact_id

required

integer <int64>

The unique identifier for the Contact

Request Body schema: application/json
required

required

object

subject required	string <= 255 characters Subject line of the note
body required	string <= 65535 characters Body content of the note

Responses

Request samples

Payload

Content type

application/json

{"data": {"subject": "Follow-up call",
"body": "Discussed project timeline and next steps."
}
}

Response samples

Content type

application/json

{"data": {"id": 123,
"subject": "API request",
"body": "Making a matter note from the API",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-02-20T14:45:00Z"
}
}

Custom Actions

Custom Actions are a mechanism to add a link to certain dropdowns in the Clio Grow user interface. When this link is clicked by a Grow user, a new tab opens in their browser and they are sent to the URL provided during that Custom Action's creation. Clio will attach contextual parameters to the URL to enable the integration that created the custom action to call the API afterward.

Security

Confirming a User's Action

Because custom actions require an unauthorized GET request made from a user's browser, it's important to validate that a user has actually performed an action within Clio.

When a request is sent to the URL specified on the custom action, Clio includes a unique custom_action_nonce parameter. If you send the custom_action_nonce in your next request to the API as a query parameter, Clio will use it to validate that the user who clicked the custom action matches your oauth token request. If the nonce does not match, a 403 Forbidden error will be returned.

The nonce value is a single-use code and has an expiry of 60 seconds.

List custom actions

Returns a paginated list of custom actions

query Parameters

page_token	string Opaque token for cursor-based pagination
created_since	string <date-time> Filter custom actions created on or after this time (ISO-8601 timestamp)
updated_since	string <date-time> Filter custom actions updated on or after this time (ISO-8601 timestamp)
ids[]	Array of integers <int64> <= 50 items [ items <int64 > ] Filter by custom action IDs (max 50)

Responses

Response samples

Content type

application/json

{"data": [{"id": 123,
"label": "Send Email",
"target_url": "https://www.clio.com/api/v2/custom_actions/123/execute",
"ui_reference": "matters/show",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-02-20T14:45:00Z"
}
],
"meta": {"paging": {"next": "https://grow.clio.com/api/v2/contacts?page_token=abc123",
"previous": "http://example.com"
}
}
}

Create a custom action

Creates a new custom action

Request Body schema: application/json
required

required

object

label required	string [ 6 .. 32 ] characters The label of the custom action
target_url required	string <uri> ^https://.+ The target URL of the custom action
ui_reference required	string (CustomActionUIReference) Value: "matters/show" The UI reference of the custom action. Currently only "matters/show" is supported.

Responses

Request samples

Payload

Content type

application/json

{"data": {"label": "Send Email",
"target_url": "https://www.clio.com/api/v2/custom_actions/123/execute",
"ui_reference": "matters/show"
}
}

Response samples

Content type

application/json

{"data": {"id": 123,
"label": "Send Email",
"target_url": "https://www.clio.com/api/v2/custom_actions/123/execute",
"ui_reference": "matters/show",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-02-20T14:45:00Z"
}
}

Delete a custom action

Deletes a single custom action by ID

path Parameters

id

required

integer <int64>

The unique identifier for the Custom Action

Responses

Response samples

Content type

application/json

{"error": {"status": "string",
"message": "string"
}
}

Inbox Leads

Operations for managing inbox leads

List inbox leads

Returns a paginated list of inbox leads filtered by state

query Parameters

state required	string Enum: "untriaged" "ignored" Filter leads by state
query	string Search string for filtering leads
page_token	string Opaque token for cursor-based pagination
created_since	string <date-time> Filter results created on or after this time (ISO-8601 timestamp)
updated_since	string <date-time> Filter results updated on or after this time (ISO-8601 timestamp)
ids[]	Array of integers <int64> [ 1 .. 50 ] items [ items <int64 > ] Filter by resource IDs (max 50)

Responses

Response samples

200
400
401
403
429

Content type

application/json

{"data": [{"id": 123,
"first_name": "Jane",
"last_name": "Smith",
"email": "jane@example.com",
"phone_number": "+15551234567",
"state": "untriaged",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-02-20T14:45:00Z"
}
],
"meta": {"paging": {"next": "https://grow.clio.com/api/v2/contacts?page_token=abc123",
"previous": "http://example.com"
}
}
}

Create an inbox lead

Creates a new inbox lead

Request Body schema: application/json
required

required

object

first_name required	string First name of the lead
last_name required	string Last name of the lead
from_message required	string Message content from the lead
referring_url required	string <uri> URL the lead came from
from_source required	string Source of the lead
email	string <email> Email address of the lead (optional)
phone_number	string Phone number of the lead (optional)

Responses

Request samples

Payload

Content type

application/json

{"data": {"first_name": "Jane",
"last_name": "Smith",
"from_message": "I'm interested in your services",
"referring_url": "https://example.com/contact",
"from_source": "website_chat",
"email": "jane@example.com",
"phone_number": "+15551234567"
}
}

Response samples

Content type

application/json

{"data": {"id": 123,
"first_name": "Jane",
"last_name": "Smith",
"email": "jane@example.com",
"phone_number": "+15551234567",
"state": "untriaged",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-02-20T14:45:00Z",
"from_message": "I'm interested in your services",
"from_source": "website_chat",
"referring_url": "https://example.com/contact"
}
}

Get an inbox lead

Returns a single inbox lead by ID

path Parameters

id

required

integer <int64>

The unique identifier for the Inbox Lead

Responses

Response samples

Content type

application/json

{"data": {"id": 123,
"first_name": "Jane",
"last_name": "Smith",
"email": "jane@example.com",
"phone_number": "+15551234567",
"state": "untriaged",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-02-20T14:45:00Z"
}
}

Matters

Operations for managing matters and matter notes

List matters

Returns a paginated list of matters

query Parameters

page_token	string Opaque token for cursor-based pagination
created_since	string <date-time> Filter results created on or after this time (ISO-8601 timestamp)
updated_since	string <date-time> Filter results updated on or after this time (ISO-8601 timestamp)
ids[]	Array of integers <int64> [ 1 .. 50 ] items [ items <int64 > ] Filter by resource IDs (max 50)
inbox_lead_id	integer <int64> Filter matters by inbox lead ID
submitted_only	boolean Filter to only matters submitted by the current application

Responses

Response samples

200
400
401
403
429

Content type

application/json

{"data": [{"id": 789,
"description": "Personal injury case",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-02-20T14:45:00Z",
"clio_id": 456,
"global_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"projected_value": 500000,
"first_letter_sent_date": "2024-03-01T09:00:00Z",
"first_appointment_created_at": "2024-02-15T14:00:00Z",
"inbox_lead_id": 321,
"hired_date": "2024-04-01",
"location": "Main Office",
"type": "Personal Injury",
"status": "Open",
"status_category": "intake",
"client": {"id": 123,
"full_name": "Jane Doe",
"phone_number": "+15551234567",
"primary_email": "jane@example.com",
"address": {"street": "123 Main St",
"city": "San Francisco",
"province": "CA",
"postal_code": "94102",
"country": "USA"
}
},
"primary_contact": {"id": 123,
"full_name": "Jane Doe",
"phone_number": "+15551234567",
"primary_email": "jane@example.com",
"address": {"street": "123 Main St",
"city": "San Francisco",
"province": "CA",
"postal_code": "94102",
"country": "USA"
}
}
}
],
"meta": {"paging": {"next": "https://grow.clio.com/api/v2/contacts?page_token=abc123",
"previous": "http://example.com"
}
}
}

Get a matter

Returns a single matter by ID

path Parameters

id

required

integer <int64>

The unique identifier for the Matter

Responses

Response samples

Content type

application/json

{"data": {"id": 789,
"description": "Personal injury case",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-02-20T14:45:00Z",
"clio_id": 456,
"global_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"projected_value": 500000,
"first_letter_sent_date": "2024-03-01T09:00:00Z",
"first_appointment_created_at": "2024-02-15T14:00:00Z",
"inbox_lead_id": 321,
"hired_date": "2024-04-01",
"location": "Main Office",
"type": "Personal Injury",
"status": "Open",
"status_category": "intake",
"client": {"id": 123,
"full_name": "Jane Doe",
"phone_number": "+15551234567",
"primary_email": "jane@example.com",
"address": {"street": "123 Main St",
"city": "San Francisco",
"province": "CA",
"postal_code": "94102",
"country": "USA"
}
},
"primary_contact": {"id": 123,
"full_name": "Jane Doe",
"phone_number": "+15551234567",
"primary_email": "jane@example.com",
"address": {"street": "123 Main St",
"city": "San Francisco",
"province": "CA",
"postal_code": "94102",
"country": "USA"
}
}
}
}

List matter notes

Returns a paginated list of notes for a matter

path Parameters

matter_id

required

integer <int64>

The unique identifier for the Matter

query Parameters

page_token	string Opaque token for cursor-based pagination
created_since	string <date-time> Filter results created on or after this time (ISO-8601 timestamp)
updated_since	string <date-time> Filter results updated on or after this time (ISO-8601 timestamp)
ids[]	Array of integers <int64> [ 1 .. 50 ] items [ items <int64 > ] Filter by resource IDs (max 50)

Responses

Response samples

Content type

application/json

{"data": [{"id": 123,
"subject": "API request",
"body": "Making a matter note from the API",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-02-20T14:45:00Z"
}
],
"meta": {"paging": {"next": "https://grow.clio.com/api/v2/contacts?page_token=abc123",
"previous": "http://example.com"
}
}
}

Create a matter note

Creates a new note for a matter

path Parameters

matter_id

required

integer <int64>

The unique identifier for the Matter

Request Body schema: application/json
required

required

object

subject required	string <= 255 characters Subject line of the note
body required	string <= 65535 characters Body content of the note

Responses

Request samples

Payload

Content type

application/json

{"data": {"subject": "API request",
"body": "Making a matter note from the API"
}
}

Response samples

Content type

application/json

{"data": {"id": 123,
"subject": "API request",
"body": "Making a matter note from the API",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-02-20T14:45:00Z"
}
}

Users

Operations for managing users

List users

Returns a paginated list of users in the current account

query Parameters

page_token	string Opaque token for cursor-based pagination
created_since	string <date-time> Filter results created on or after this time (ISO-8601 timestamp)
updated_since	string <date-time> Filter results updated on or after this time (ISO-8601 timestamp)
ids[]	Array of integers <int64> [ 1 .. 50 ] items [ items <int64 > ] Filter by resource IDs (max 50)

Responses

Response samples

200
400
401
403
429

Content type

application/json

{"data": [{"id": 123,
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-02-20T14:45:00Z",
"account": {"id": 456,
"firm_name": "Doe & Associates"
}
}
],
"meta": {"paging": {"next": "https://grow.clio.com/api/v2/contacts?page_token=abc123",
"previous": "http://example.com"
}
}
}

Get current user

Returns the currently authenticated user

Responses

Response samples

200
401
403
429

Content type

application/json

{"data": {"id": 123,
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-02-20T14:45:00Z",
"account": {"id": 456,
"firm_name": "Doe & Associates"
}
}
}

Clio Grow API Documentation (v2)

Developer Support and Feedback

Getting Started

Contacts

List contacts

query Parameters

Responses

Response samples

Get a contact

path Parameters

Responses

Response samples

List notes for a contact

path Parameters

query Parameters

Responses

Response samples

Create a note for a contact

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Custom Actions

Security

Confirming a User's Action

List custom actions

query Parameters

Responses

Response samples

Create a custom action

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete a custom action

path Parameters

Responses

Response samples

Inbox Leads

List inbox leads

query Parameters

Responses

Response samples

Create an inbox lead

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get an inbox lead

path Parameters

Responses

Response samples

Matters

List matters

query Parameters

Responses

Response samples

Get a matter

path Parameters

Responses

Response samples

List matter notes

path Parameters

query Parameters

Responses

Response samples

Create a matter note

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Users

List users

query Parameters

Responses

Response samples

Get current user

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required