{"info":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.23.0","description":"

Welcome to the Official Lawmatics RESTful API Documentation.

Like the Lawmatics Platform, our API is under active development!
For any API related questions or feedback, reach out to us at api@lawmatics.com.

CHANGELOG

05/26/2026 - 1.22.0

Add new endpoint: GET Collections
\n
Add new endpoint: GET Collection
\n
Add new endpoint: POST Collection
\n
Add new endpoint: PUT Collection
\n
Add new endpoint: DELETE Collection
\n
Add new endpoint: GET Collection Items
\n
Add new endpoint: GET Collection Item
\n
Add new endpoint: POST Collection Item
\n
Add new endpoint: PUT Collection Item
\n
Add new endpoint: DELETE Collection Item
\n

05/26/2026 - 1.21.15

Per-firm rate limiting (500 requests/minute, returns 429 with Retry-After: 60) is now enforced.

05/04/2026 - 1.21.14

Fixed Custom Field lookup_type validation: User is now accepted; Client and PracticeArea are no longer accepted.

04/27/2026 - 1.21.13

Company create/update now accepts custom_fields as an alias for custom_field_values.

12/03/2025 - 1.21.12

Add send_receipt param to Transaction create.

11/04/2025 - 1.21.11

The Custom Email endpoint now serves records from a different underlying model. All record ids have changed.

10/27/2025 - 1.21.10

Task GET index: filter_by=user_id with a null/blank filter operator now returns unassigned Tasks.

03/31/2025 - 1.21.9

Rewrote phone number lookup on the Contact, Company, and Matter Finder endpoints (find_by_phone): a blank phone number now returns 400 instead of 404.

10/21/2024 - 1.21.8

Add unsubscribed param to Contact create/update.

10/04/2024 - 1.21.7

Add expires_in query param to GET File, this controls how long the returned download URL stays valid (default 3600 seconds, max 604800 seconds).

08/29/2024 - 1.21.6

Canceling an Event now attributes the resulting timeline activity to the API caller, instead of always the Event's original creator.

08/12/2024 - 1.21.5

Add sync_email param to Relationship Type create/update.

08/07/2024 - 1.21.4

Add canceled_at field to the Event API.

08/02/2024 - 1.21.3

Contact and Matter create: when a firm has Match Contacts by Email enabled, submitting an email that matches an existing Contact now returns that existing record instead of creating a new one.

04/25/2024 - 1.21.2

Expenses and Time Entries: lowercase contactable_type values now work (previously only exact Prospect/Contact/Company casing was accepted).
\n
Expenses and Time Entries: missing contactable_type now returns a 422 validation error.
\n

04/12/2024 - 1.21.1

Expenses and Time Entries create now return 201 Created on success (previously 200).

03/04/2024 - 1.21.0

Add new endpoint: POST Time Entry.
\n
Add new endpoint: PUT Time Entry.
\n
Add new endpoint: GET Expenses.
\n
Add new endpoint: GET Expense
\n
Add new endpoint: POST Expense
\n
Add new endpoint: PUT Expense
\n
Add new endpoint: DEL Expense
\n

02/08/2024 - 1.20.5

Custom Field update no longer requires re-sending type or lookup_type when updating other fields.

01/11/2024 - 1.20.4

Add path param to Folder create (an array of folder names describing a nested path, creating or reusing each folder in the chain.)

01/10/2024 - 1.20.3

Creating a Folder with a name that's already taken in the same parent folder now returns a 409 error.

10/11/2023 - 1.20.2

Add notes param to Company create/update.

10/10/2023 - 1.20.1

Company create/update now accepts street, street2, city, state, country, zipcode, email, and phone directly (creates/updates the Company's primary Address, Email, and Phone Number).

10/04/2023 - 1.20.0

Add new endpoint: GET Time Entry.
\n
Add new endpoint: GET Time Entries.
\n
Add new endpoint: DEL Time Entry.
\n

09/29/2023 - 1.19.0

Add Company Finder endpoints, they behave the same as the Contact Finder endpoints, but return a Company.
\n
Add new endpoint: GET Find Company by Name.
\n
Add new endpoint: GET Find Company by Email.
\n
Add new endpoint: GET Find Company by Phone.
\n
Update Filter Operator capabilities for presence checking: e.g. \"null\", \"not_null\"
\n

09/27/2023 - 1.18.0

Add new endpoint: POST Matter Sub Status.
\n
Add new endpoint: PUT Matter Sub Status.
\n
Add new endpoint: DEL Matter Sub Status.
\n

09/21/2023 - 1.17.0

Add new endpoint: GET Custom Contact Type.
\n
Add new endpoint: GET Custom Contact Types.
\n
Add new endpoint: POST Custom Contact Type.
\n
Add new endpoint: PUT Custom Contact Type.
\n
Add new endpoint: DEL Custom Contact Type.
\n

7/07/2023 - 1.16.0

Add new endpoint: GET Email Campaign.
\n
Add new endpoint: GET Email Campaigns.
\n
Add new endpoint: GET Email Campaign Stats.
\n

7/07/2023 - 1.15.0

Add new endpoint: GET Folder.
\n
Add new endpoint: GET Folders.
\n
Add new endpoint: POST Folder.
\n
Add new endpoint: PUT Folder.
\n
Add new endpoint: DEL Folder.
\n
Update Task endpoints to create/read/update/delete Task recurrence_rule.
\n
Expose assigned_by_id on Task endpoints.
\n
Add new endpoint: GET Task Status.
\n
Add new endpoint: GET Task Statuses.
\n
Add new endpoint: POST Task Status.
\n
Add new endpoint: PUT Task Status.
\n
Add new endpoint: DEL Task Status.
\n
Add new endpoint: GET Subtask.
\n
Add new endpoint: GET Subtasks.
\n
Add new endpoint: POST Subtask.
\n
Add new endpoint: PUT Subtask.
\n
Add new endpoint: DEL Subtask.
\n
Add new endpoint: GET Comment.
\n
Add new endpoint: GET Comments.
\n
Add new endpoint: POST Comment.
\n
Add new endpoint: PUT Comment.
\n
Add new endpoint: DEL Comment.
\n

3/23/2023 - 1.14.1

Update Tag endpoints to support attaching, detaching, and filtering by Tasks.

11/11/2022 - 1.14.0

Add new endpoint: POST User.
\n
Add new endpoint: PUT User.
\n
Add new endpoint: DELETE User.
\n

10/3/2022 - 1.13.1

Expose creating Company Matters by name, passing company_name to POST Matters
\n
Expose creating Company Matters by passing Company ID to POST Matters
\n
Improve Contact deduplication (if matches on email or phone) on POST Matters
\n
NOTE - Any passed Contact Info (phone/email/address) for a Company Matter will be set on a found/created Contact as the Company Matter's P.o.C (primary_contact)
\n

9/19/2022 - 1.13.0

Add new endpoint: GET Company.
\n
Add new endpoint: GET Companies.
\n
Add new endpoint: PUT Company.
\n
Add new endpoint: POST Company.
\n
Add new endpoint: DEL Company.
\n
Add new endpoint: GET Interaction.
\n
Add new endpoint: GET Interactions.
\n
Add new endpoint: PUT Interaction.
\n
Add new endpoint: POST Interaction.
\n
Add new endpoint: DEL Interaction.
\n

8/8/2022 - 1.12.0

Add new endpoint: GET Relationship Types.
\n
Add new endpoint: GET Relationship Type.
\n
Add new endpoint: PUT Relationship Type.
\n
Add new endpoint: POST Relationship Type.
\n
Add new endpoint: GET Relationships.
\n
Add new endpoint: GET Relationship.
\n
Add new endpoint: PUT Relationship.
\n
Add new endpoint: POST Relationship.
\n
Add new endpoint: DEL Relationship.
\n

8/4/2022 - 1.11.0

Add new endpoint: PUT File.
\n
Add new endpoint: DEL File.
\n

7/20/2022 - 1.10.0

Add new endpoint: GET Phone Numbers.
\n
Add new endpoint: GET Phone Number.
\n
Add new endpoint: PUT Phone Number.
\n
Add new endpoint: POST Phone Number.
\n
Add new endpoint: DEL Phone Number.
\n
Add new endpoint: GET Email Addresses.
\n
Add new endpoint: GET Email Address.
\n
Add new endpoint: PUT Email Address.
\n
Add new endpoint: POST Email Address.
\n
Add new endpoint: DEL Email Address.
\n

6/26/2022 - 1.9.0

Add new endpoint: GET Event Type.
\n
Add new endpoint: PUT Event Type.
\n
Add new endpoint: POST Event Type.
\n
Add new endpoint: DEL Event Type.
\n
Improve validations, and error handling on many endpoints.
\n

6/25/2022 - 1.7.0

Add new endpoint: PUT Address.
\n
Add new endpoint: POST Address.
\n
Add new endpoint: DEL Address.
\n
Add new endpoint: POST Upload File.
\n
Improve validations, and error handling on many endpoints.
\n

6/19/2022 - 1.6.0

Add new endpoint: GET Event.
\n
Add new endpoint: GET Custom Field.
\n
Add new endpoint: GET Custom Fields.
\n
Add new endpoint: PUT Custom Field.
\n
Add new endpoint: POST Custom Field.
\n
Add new endpoint: DEL Custom Field.
\n
Add new endpoint: GET Practice Area.
\n
Add new endpoint: GET Practice Areas.
\n
Add new endpoint: PUT Practice Area.
\n
Add new endpoint: POST Practice Area.
\n
Add new endpoint: DEL Practice Area.
\n
Add new endpoint: GET Note.
\n
Add new endpoint: GET Note.
\n
Add new endpoint: PUT Note.
\n
Add new endpoint: POST Note.
\n
Add new endpoint: DEL Note.
\n
Add new endpoint: GET Address.
\n
Add new endpoint: GET Addresses.
\n
Add new endpoint: GET File.
\n
Add new endpoint: GET Files.
\n
Add new endpoint: GET Download File.
\n
Add ability to filter list GET endpoints by contact_id, matter_id, client_id, company_id on polymorphic relationships.
\n
Add type specific custom field value attribute keys to Matter payload (e.g. value_string, value_int, value_datetime).
\n
Update documentation.
\n

5/9/2022 - 1.5.1

Add support for submitting Originating Attorney, Lead Attorney, Salesperson, Assigned Staff fields on PUT/POST Prospect endpoints.

5/8/2022 - 1.5.0

Add new endpoint: GET Task.
\n
Add new endpoint: GET Tasks.
\n
Add new endpoint: PUT Task.
\n
Add new endpoint: POST Task.
\n
Add new endpoint: DEL Task.
\n

4/27/2022 - 1.4.6

Add new endpoint: GET Invoice.
\n
Add new endpoint: GET Invoices.
\n
Add new endpoint: GET Transaction.
\n
Add new endpoint: GET Transactions.
\n
Add new endpoint: POST Transaction.
\n

8/28/2019 - 1.4.5

Add new endpoint: POST Event.
\n
Add new endpoint: DELETE Event
\n

6/21/2019 - 1.4.4

Add new endpoint: GET Locations.
\n
Add new endpoint: GET Events.
\n
Add new endpoint: GET Event Types.
\n

4/5/2019 - 1.4.3

Fix bug with '.' included in email param for GET Contact find_by_email endpoint.
\n
Fix bug with '.' included in email param for GET Matter find_by_email endpoint.
\n

4/1/2019 - 1.4.2

This update allows you to get more information about firm Pipelines or a specific Pipeline.

Add new endpoint: GET Pipeline by id
\n
Add new endpoint: GET Pipelines.
\n
Update documentation.
\n

3/31/2019 - 1.4.1

This update allows you to search for a Contact and adds an important field to Stages.

Update GET Stages endpoint to return its Pipeline Relationship with fields=pipeline.
\n
Add Contact Finder endpoints, they behave the same as the Matter Finder endpoints, but return a Contact.
\n
Update documentation.
\n

3/27/2019 - 1.4.0

This update adds the ability to create a Matter for an existing Contact.

Add contact_id option to the POST Matter (Create) endpoint.
\n
Add match_contact_by option to the POST Matter (Create) endpoint.
\n

CUSTOM FORM NOTE:

If you just are looking for info on submitting Custom Forms, you do not need to make a devloper app.
Disregard the authentication info below, and use our Unauthenticated Custom Form Submit endpoint: https://docs.lawmatics.com/?version=latest#c34ea101-b7af-46ac-a6c7-d185495af4f4
You will not need to create a developer app, and you do not need to go through the OAuth2.0 grant flow!

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"26379991","collectionId":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","publishedId":"2sA3JM7gbw","public":true,"customColor":{"top-bar":"EEEEEE","right-sidebar":"242628","highlight":"3E85BE"},"publishDate":"2026-09-22T17:59:35.000Z"},"item":[{"name":"Getting Started With Auth","item":[],"id":"a85134d5-1849-49c5-abe5-b597662cd74c","description":"

Lawmatics' REST API uses the standard OAuth2.0 token grant flow.

API Authentication: OAuth2.0 Setup Guide

Creating a new OAuth2 Lawmatics Developer App:

\n
To create a new developer app, you must have a Lawmatics account with developer settings. If your account does not have developer settings, you can contact our team at support@lawmatics.com.
\n

While logged in to your Lawmatics account, go to Settings > Developers.

To get credentials for programmatic access, click Create New Application. You'll enter the Name, Description, and Logo that users will see when connecting through your app, as well as the Callback URL (redirect URI) they'll be redirected back to after granting your app access to their account.

This is also where Lawmatics sends the temporary authorization code, so the redirect URI you provide needs to point somewhere your app can actually capture that code (e.g. an endpoint on your server that reads it from the query string).

Authenticating with your Client App:

To authenticate, users of your application click your authorize link, log into their Lawmatics account, and then grant or deny your Client App access to act on their behalf. Once granted, Lawmatics redirects the user back to your application with a grant code included as a query param.

STEP 1: Getting a Grant Code

Our authorize url: https://app.lawmatics.com/oauth/authorize.

This url must pass the following Query Params:

client_id: The app id shown in developer settings.
\n
redirect_uri: The Callback URL you set when creating your developer app (also shown in Developer Settings). Lawmatics redirects the user here along with the grant code.
\n
response_type: This should always be set to 'code'
\n
state (optional): This can be sent by your application to maintain state between the request and the callback.
\n

All together, a valid request link will look something like this:

https://app.lawmatics.com/oauth/authorize?client_id=&redirect_uri=&response_type=code.

Once the user authenticates and grants access, Lawmatics redirects them back to your Callback URL with a code query parameter:

GET https://www.callbackurl.com/?code=f2da562a94981e24d610b021aedaae03eb286acab7cd855013f9165aebbeef48

This code is short-lived (10 minutes/600 seconds,) and your backend needs to capture it and exchange it for an access_token:

STEP 2: Getting an Access Token

From your backend, make a POST request to https://api.lawmatics.com/oauth/token.

The POST body must contain the following required params:

client_id: Your app's Client ID (from Developer Settings)
\n
client_secret: Your app's Client Secret (from Developer Settings)
\n
grant_type: authorization_code
\n
code: The authorization code returned in the redirect from Step 1
\n
redirect_uri: The same Callback URL used in the authorization request from Step 1
\n

This returns a non-expiring access_token, which you should save and associate with that user.

   HTTP/1.1 200 OK\n   {\n     \"token_type\":\"bearer\",\n     \"access_token\":\"YOUR_ACCESS_TOKEN\",\n     \"created_at\": 1539723267\n   }\n\n

This token can now be passed as an Authorization header to authenticate all of our endpoints on behalf of that tokens user:

Authorization: Bearer YOUR_ACCESS_TOKEN\n\n

Limitations

We have a 500 req/min per-firm rate limit on all endpoints. Exceeding this limit returns a 429 error with `Retry-After: 60` header
\n
We currently do not support scopes. Access granted is based on the authorizing user's role for record-level visibility, but is not fully restricted by all permission settings on the account.
\n
We do not have a deauthorization endpoint. To revoke access, firms can contact us at support@lawmatics.com to have specific tokens revoked.
\n
Access tokens do not expire, so we do not provide a refresh token.
\n

\n","_postman_id":"a85134d5-1849-49c5-abe5-b597662cd74c","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"redirect_uri","value":""},{"key":"grant_type","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.23.0","type":"collection"}}},{"name":"Param Guide","item":[{"name":"Field Selection","item":[],"id":"57432387-4186-4d94-99eb-442a93e37885","description":"

Field Selection allows you to shape the response data to only include fields that are needed for your development. A \"field\" refers to either an attribute on the record or an association to another record.

Field Selection can only return data one level deep.

Field Selection works on every Lawmatics endpoint unless specified otherwise.

A valid ?fields= value is a comma separated list of attributes/relationships.

e.g. ?fields=first_name,last_name,source,custom_fields.

Fields are returned in the order you select them.

Requests that don't include the fields param will return a small set of commonly used default attributes (e.g. name, email).

Requesting an associated field only returns that record's id and type. To get more data about that related record, use its id to query the relevant endpoint directly.

An Example of Attribute Selection:

You want to get more information about Prospect 74's related, Source data.

First, request the association:

GET https://api.lawmatics.com/v1/prospects/74?fields=source\nAuthorization: Bearer <access_token>\n

This returns:

{\n    \"data\": {\n        \"id\": \"74\",\n        \"type\": \"prospect\",\n        \"attributes\": {},\n        \"relationships\": {\n            \"source\": {\n                \"data\": {\n                    \"id\": \"3\",\n                    \"type\": \"source\"\n                }\n            }\n        }\n    }\n}\n\n

Then use that id to query the Source directly:
https://api.lawmatics.com/v1/sources/3?fields=all

This exposes all available attributes and relationships on that Source.

fields=all is meant for exploring what fields/relationships are available. Once you know which fields you need, request just those instead to keep your responses lean.

\n","_postman_id":"57432387-4186-4d94-99eb-442a93e37885","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"redirect_uri","value":""},{"key":"grant_type","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.23.0","type":"collection"}}},{"name":"Pagination","item":[],"id":"5426df0c-8863-4678-b52f-79522bb471ee","description":"

Pagination meta information is found at the bottom of any List response.

You can change pages by passing ?page=X, where X is the page number, as a query param appended to the endpoint URL.

E.g. to see page 3 you would pass ?page=3

\n","_postman_id":"5426df0c-8863-4678-b52f-79522bb471ee","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"redirect_uri","value":""},{"key":"grant_type","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.23.0","type":"collection"}}},{"name":"Sorting","item":[],"id":"b6af127d-2a61-4e7c-8faa-79d8ec04eb5b","description":"

By default, List responses are sorted by id, descending (biggest to smallest.)

Customizing the sort order of the response works with two query params:

sort_by: The field to sort on
\n
sort_order: asc or desc
\n

Available sort_by columns are:
id, created_at, updated_at
As well as most fields listed by the fields='all' response.

If you use sort_order without sort_by, sort_by defaults to sort by id.

\n","_postman_id":"b6af127d-2a61-4e7c-8faa-79d8ec04eb5b","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"redirect_uri","value":""},{"key":"grant_type","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.23.0","type":"collection"}}},{"name":"Filtering","item":[{"name":"Filtering Examples","item":[{"name":"Matters Filtered by specific Practice Area","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["pm.sendRequest(`${pm.environment.get('host')}/v1/prospects?fields=practice_area`, function (err, response) {\n pm.globals.set(\"practice_area_id\", response.json().data.find(({relationships}) => relationships?.practice_area?.data?.type == 'practice_area').relationships.practice_area.data.id);\n});\n\n"]}}],"id":"7b1aa98c-cd9a-4836-a69f-df647962247c","request":{"method":"GET","header":[],"url":"{{host}}/v1/prospects?fields=practice_area,first_name&filter_by=practice_area_id&filter_on={{practice_area_id}}","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"redirect_uri","value":""},{"key":"grant_type","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.23.0","type":"collection"}},"urlObject":{"path":["v1","prospects"],"host":["{{host}}"],"query":[{"key":"fields","value":"practice_area,first_name"},{"key":"filter_by","value":"practice_area_id"},{"key":"filter_on","value":"{{practice_area_id}}"}],"variable":[]}},"response":[{"id":"c147cf9e-1a5c-4156-a4e5-4e0badb1515e","name":"GET Matters of a specific Practice Area","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v1/prospects?fields=practice_area,first_name&filter_by=practice_area_id&filter_on=986","host":["{{host}}"],"path":["v1","prospects"],"query":[{"key":"fields","value":"practice_area,first_name"},{"key":"filter_by","value":"practice_area_id"},{"key":"filter_on","value":"986"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 07 Jan 2019 06:18:51 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=woUKst5L3inzYl6CcyGcHzFRJJrhX03P+y/KJB4BN1pD10+84hQN3N53kdgumoevVQvtbNZaPHuKHspEnwy4Mx1+2Pw3usjJoRIUEgDLX6sLrgOUG43abAbR0/W5; Expires=Mon, 14 Jan 2019 06:18:51 GMT; Path=/"},{"key":"ETag","value":"W/\"f226dae2807433146a1a9e8daf1b8e86\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"29855f4e-f627-4c35-b562-0e1fb16dd16c"},{"key":"X-Runtime","value":"0.015704"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"57802\",\n \"type\": \"prospect\",\n \"attributes\": {\n \"first_name\": \"Annatest\"\n },\n \"relationships\": {\n \"practice_area\": {\n \"data\": {\n \"id\": \"986\",\n \"type\": \"practice_area\"\n }\n }\n }\n },\n {\n \"id\": \"55881\",\n \"type\": \"prospect\",\n \"attributes\": {\n \"first_name\": \"Hazel\"\n },\n \"relationships\": {\n \"practice_area\": {\n \"data\": {\n \"id\": \"986\",\n \"type\": \"practice_area\"\n }\n }\n }\n },\n {\n \"id\": \"15396\",\n \"type\": \"prospect\",\n \"attributes\": {\n \"first_name\": \"Anna\"\n },\n \"relationships\": {\n \"practice_area\": {\n \"data\": {\n \"id\": \"986\",\n \"type\": \"practice_area\"\n }\n }\n }\n }\n ],\n \"meta\": {\n \"total_pages\": 1,\n \"limit_per_page\": 25,\n \"total_entries\": 3\n },\n \"links\": {\n \"self\": \"/v1/prospect?page=1\"\n }\n}"}],"_postman_id":"7b1aa98c-cd9a-4836-a69f-df647962247c"},{"name":"Matters Filtered by Actual Value > $0.00","id":"4c3a0584-0bf6-46e5-a4ef-007d5bc9f72c","request":{"method":"GET","header":[],"url":"{{host}}/v1/prospects?fields=first_name,actual_value_cents&filter_by=actual_value_cents&filter_on=0&filter_with=>&sort_by=actual_value_cents&sort_order=asc","description":"

Filtering AND sorting by the actual_value_cents column.

Using the not equals (!=) filter operator.

Matter Filtering Examples

\n
Stage
\n

https://api.lawmatics.com/v1/prospects?filter_by=stage_id&filter_on=123\n\n

\n
Case Title (case insensitive, exact match)
\n

https://api.lawmatics.com/v1/prospects?filter_by=case_title&filter_on=Sauls+Wild+Ride\n\n

\n
Case Title (case sensitive, starts with, fuzzy matches the end)
\n

https://api.lawmatics.com/v1/prospects?filter_by=case_title&filter_on=Sauls+Wi%&filter_operator=like\n\n

\n
Case Title (case insensitive, ends with, fuzzy matches the start)
\n

https://api.lawmatics.com/v1/prospects?filter_by=case_title&filter_on=%uls+Wild+Ride\n\n

\n
Case Title (case insensitive, fuzzy matches both ends)
\n

https://api.lawmatics.com/v1/prospects?filter_by=case_title&filter_on=%ls+Wild+Ri%\n\n

\n
Estimated Value Less Than or Equal to 100 Dollars
\n

https://api.lawmatics.com/v1/prospects?filter_by=estimated_value_cents&filter_on=10000&filter_operator=<=\n\n

\n
First Name
\n

https://api.lawmatics.com/v1/prospects?filter_by=first_name&filter_on=Mat%\n\n

","_postman_id":"4fc12758-23b9-4577-b1ed-5274058b0734","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"redirect_uri","value":""},{"key":"grant_type","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.23.0","type":"collection"}}}],"id":"ee57a574-9381-414c-9b04-7105b1d25146","description":"

By default List responses will return all records without any filters.

Filtering the request works by appending these query params:

filter_by or filter_field: This specifies the field name to filter on.
\n
filter_on or filter_value: This is the value to filter on.
\n
filter_with or filter_operator: (Optional) This is the operator used to filter. (default: '=')
\n

Filterable fields:

Most standard fields listed in the fields='all' response.
\n
Currency attributes are filtered in cents.
\n
Association attributes require _id to be appended (e.g. practice_area_id). This applies to a resource's direct, single-type relationships. For resources that can belong to multiple different parent types, see Polymorphic Filter Shortcuts below.
\n

Polymorphic Filter Shortcuts

Some resources can belong to more than one parent type. For example, a Note can belong to a Matter, Contact, or Company. Internally, this is stored as a type/ID pair (e.g. notable_type/notable_id), which normally can't be filtered in one step.
\n
For these resources, you can use a shortcut instead: filter_by=matter_id, prospect_id, contact_id, or company_id. The API automatically resolves it to the correct type/ID pair for you. This shortcut isn't available on every resource. Each endpoint's reference below lists its own valid shortcuts, if any.
\n

Operators:

Valid values for filter_operator: =, !=, <=, <, >=, >, like, ilike
\n
For presence checks, use null or not_null (aliases: empty, present, blank.) These don't require a filter_value.
\n
Default operator depends on the field's type: ilike for text/string fields, = for all other field types.
\n
like and ilike do fuzzy string matching (ilike is case-insensitive). When using either, add % to filter_value where you want fuzzy matching to apply. Remember to URL-encode it, since % becomes %.
\n

\"Updated Records Only\" Filtering

You can filter any List response down to only records that have been edited since creation, using updated_only=true:

GET {{host}}/v1/prospects?updated_only=true\n\n

This excludes freshly created records (where created_at and updated_at are still identical) and returns only records that have been modified at least once.
\n
Works on virtually every List endpoint, except GET /v1/forms
\n
This can be combined with a regular filter_by/filter_on filter:
\n

GET {{host}}/v1/contacts?updated_only=true&filter_by=last_name&filter_on=Smith&filter_with=ilike\n\n

\n
Note: updated_only is triggered by the presence of the param, not its value. Any non-empty value (including updated_only=false) will still apply the filter. The only way to disable it is to omit the param entirely.
\n

Additional Notes:

If you use filter_by without filter_on, we will return an error response.
\n
You do not need to have the field selected, for it to be filterable.
\n
Currently only one filter is supported at a time.
\n

\n","_postman_id":"ee57a574-9381-414c-9b04-7105b1d25146","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"redirect_uri","value":""},{"key":"grant_type","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.23.0","type":"collection"}}}],"id":"e797b9a0-ff19-47fb-b435-527de471545f","description":"

We currently support the following query parameter options to modify results on any request:

Field Selection
\n
Pagination
\n
Sorting
\n
Filtering
\n

There are two types of queries,

Single Object queries: These return one record. These only support Field Selection.
\n
List queries: These return multiple records. These support all four query param types.
\n

\n","_postman_id":"e797b9a0-ff19-47fb-b435-527de471545f","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"redirect_uri","value":""},{"key":"grant_type","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.23.0","type":"collection"}}},{"name":"Addresses","item":[{"name":"Address","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is Successful\", function () {\n pm.response.to.be.ok\n});"]}},{"listen":"prerequest","script":{"type":"text/javascript","exec":["pm.sendRequest(`${pm.environment.get('host')}/v1/addresses`, function (err, response) {\n pm.globals.set(\"address_id\", response.json().data[0].id);\n});\n\n"]}}],"id":"df24ad9b-aae6-4c58-ac9c-db1a2ae0298b","request":{"method":"GET","header":[],"url":"{{host}}/v1/addresses/:address_id","description":"

A specific Address, by id

A paginated list of all Addresses in Lawmatics

Filter Options (See our Filtering params)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Notes
`label`	string
`street`	string
`city`	string
`state`	string
`zipcode`	string
`country`	string

Valid Shortcuts: contact_id, company_id

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"redirect_uri","value":""},{"key":"grant_type","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.23.0","type":"collection"}},"urlObject":{"path":["v1","addresses"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"b4d00267-efbb-45d1-80be-675cfb2c8525","name":"GET Addresses","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v1/addresses?fields=all","host":["{{host}}"],"path":["v1","addresses"],"query":[{"key":"fields","value":"all"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept, Origin"},{"key":"ETag","value":"W/\"0a0f4ad0870405d6fe1372cb5833b19d\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"5518c191-a0f5-4017-b5f1-feda9343b800"},{"key":"X-Runtime","value":"0.077484"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"105\",\n \"type\": \"address\",\n \"attributes\": {\n \"label\": \"Primary\",\n \"street\": \"1234 Fake Street\",\n \"street2\": null,\n \"city\": null,\n \"state\": null,\n \"zipcode\": null,\n \"country\": null,\n \"full_address\": \"1234 Fake Street\",\n \"full_street\": \"1234 Fake Street\",\n \"second_half\": \"\",\n \"city_state_zip\": \"\",\n \"created_at\": \"2022-03-29T22:03:55.343-07:00\",\n \"updated_at\": \"2022-03-29T22:03:55.343-07:00\"\n },\n \"relationships\": {\n \"addressable\": {\n \"data\": {\n \"id\": \"127\",\n \"type\": \"contact\"\n }\n },\n \"locations\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"104\",\n \"type\": \"address\",\n \"attributes\": {\n \"label\": \"test\",\n \"street\": \"\",\n \"street2\": null,\n \"city\": null,\n \"state\": null,\n \"zipcode\": null,\n \"country\": null,\n \"full_address\": \"\",\n \"full_street\": \"\",\n \"second_half\": \"\",\n \"city_state_zip\": \"\",\n \"created_at\": \"2022-02-09T13:56:33.557-08:00\",\n \"updated_at\": \"2022-02-09T13:56:33.557-08:00\"\n },\n \"relationships\": {\n \"addressable\": {\n \"data\": {\n \"id\": \"116\",\n \"type\": \"contact\"\n }\n },\n \"locations\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"103\",\n \"type\": \"address\",\n \"attributes\": {\n \"label\": \"Primary\",\n \"street\": \"123\",\n \"street2\": null,\n \"city\": null,\n \"state\": null,\n \"zipcode\": null,\n \"country\": null,\n \"full_address\": \"123\",\n \"full_street\": \"123\",\n \"second_half\": \"\",\n \"city_state_zip\": \"\",\n \"created_at\": \"2022-02-09T13:56:33.548-08:00\",\n \"updated_at\": \"2022-02-09T13:56:33.548-08:00\"\n },\n \"relationships\": {\n \"addressable\": {\n \"data\": {\n \"id\": \"116\",\n \"type\": \"contact\"\n }\n },\n \"locations\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"102\",\n \"type\": \"address\",\n \"attributes\": {\n \"label\": \"Primary\",\n \"street\": \"1234 fake street\",\n \"street2\": \"suite 2\",\n \"city\": \"San Diego\",\n \"state\": \"CA\",\n \"zipcode\": \"92104\",\n \"country\": \"United States\",\n \"full_address\": \"1234 fake street, suite 2, San Diego, CA 92104, United States\",\n \"full_street\": \"1234 fake street, suite 2\",\n \"second_half\": \"San Diego, CA 92104, United States\",\n \"city_state_zip\": \"San Diego, CA 92104\",\n \"created_at\": \"2021-11-08T14:06:20.224-08:00\",\n \"updated_at\": \"2021-11-08T14:06:20.224-08:00\"\n },\n \"relationships\": {\n \"addressable\": {\n \"data\": {\n \"id\": \"2\",\n \"type\": \"firm\"\n }\n },\n \"locations\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"101\",\n \"type\": \"address\",\n \"attributes\": {\n \"label\": \"Miami St\",\n \"street\": \"1234 Miami\",\n \"street2\": null,\n \"city\": \"Miami\",\n \"state\": \"FL\",\n \"zipcode\": \"12345\",\n \"country\": \"United States\",\n \"full_address\": \"1234 Miami, Miami, FL 12345, United States\",\n \"full_street\": \"1234 Miami\",\n \"second_half\": \"Miami, FL 12345, United States\",\n \"city_state_zip\": \"Miami, FL 12345\",\n \"created_at\": \"2021-10-31T19:59:35.424-07:00\",\n \"updated_at\": \"2021-10-31T19:59:35.424-07:00\"\n },\n \"relationships\": {\n \"addressable\": {\n \"data\": {\n \"id\": \"2\",\n \"type\": \"firm\"\n }\n },\n \"locations\": {\n \"data\": [\n {\n \"id\": \"1\",\n \"type\": \"location\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"100\",\n \"type\": \"address\",\n \"attributes\": {\n \"label\": \"Primary\",\n \"street\": \"99 Fake Rd\",\n \"street2\": null,\n \"city\": \"City 1\",\n \"state\": \"CA\",\n \"zipcode\": \"90219\",\n \"country\": \"United States\",\n \"full_address\": \"99 Fake Rd, City 1, CA 90219, United States\",\n \"full_street\": \"99 Fake Rd\",\n \"second_half\": \"City 1, CA 90219, United States\",\n \"city_state_zip\": \"City 1, CA 90219\",\n \"created_at\": \"2021-10-26T15:47:48.382-07:00\",\n \"updated_at\": \"2021-10-26T15:47:48.382-07:00\"\n },\n \"relationships\": {\n \"addressable\": {\n \"data\": {\n \"id\": \"100\",\n \"type\": \"contact\"\n }\n },\n \"locations\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"99\",\n \"type\": \"address\",\n \"attributes\": {\n \"label\": \"Primary\",\n \"street\": \"98 Fake Rd\",\n \"street2\": null,\n \"city\": \"City 3\",\n \"state\": \"IL\",\n \"zipcode\": \"55126\",\n \"country\": \"United States\",\n \"full_address\": \"98 Fake Rd, City 3, IL 55126, United States\",\n \"full_street\": \"98 Fake Rd\",\n \"second_half\": \"City 3, IL 55126, United States\",\n \"city_state_zip\": \"City 3, IL 55126\",\n \"created_at\": \"2021-10-26T15:47:48.119-07:00\",\n \"updated_at\": \"2021-10-26T15:47:48.119-07:00\"\n },\n \"relationships\": {\n \"addressable\": {\n \"data\": {\n \"id\": \"99\",\n \"type\": \"contact\"\n }\n },\n \"locations\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"98\",\n \"type\": \"address\",\n \"attributes\": {\n \"label\": \"Primary\",\n \"street\": \"97 Fake Rd\",\n \"street2\": null,\n \"city\": \"City 2\",\n \"state\": \"IL\",\n \"zipcode\": \"60633\",\n \"country\": \"United States\",\n \"full_address\": \"97 Fake Rd, City 2, IL 60633, United States\",\n \"full_street\": \"97 Fake Rd\",\n \"second_half\": \"City 2, IL 60633, United States\",\n \"city_state_zip\": \"City 2, IL 60633\",\n \"created_at\": \"2021-10-26T15:47:47.890-07:00\",\n \"updated_at\": \"2021-10-26T15:47:47.890-07:00\"\n },\n \"relationships\": {\n \"addressable\": {\n \"data\": {\n \"id\": \"98\",\n \"type\": \"contact\"\n }\n },\n \"locations\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"97\",\n \"type\": \"address\",\n \"attributes\": {\n \"label\": \"Primary\",\n \"street\": \"96 Fake Rd\",\n \"street2\": null,\n \"city\": \"City 2\",\n \"state\": \"IL\",\n \"zipcode\": \"60633\",\n \"country\": \"United States\",\n \"full_address\": \"96 Fake Rd, City 2, IL 60633, United States\",\n \"full_street\": \"96 Fake Rd\",\n \"second_half\": \"City 2, IL 60633, United States\",\n \"city_state_zip\": \"City 2, IL 60633\",\n \"created_at\": \"2021-10-26T15:47:47.639-07:00\",\n \"updated_at\": \"2021-10-26T15:47:47.639-07:00\"\n },\n \"relationships\": {\n \"addressable\": {\n \"data\": {\n \"id\": \"97\",\n \"type\": \"contact\"\n }\n },\n \"locations\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"96\",\n \"type\": \"address\",\n \"attributes\": {\n \"label\": \"Primary\",\n \"street\": \"95 Fake Rd\",\n \"street2\": null,\n \"city\": \"City 3\",\n \"state\": \"CA\",\n \"zipcode\": \"55126\",\n \"country\": \"United States\",\n \"full_address\": \"95 Fake Rd, City 3, CA 55126, United States\",\n \"full_street\": \"95 Fake Rd\",\n \"second_half\": \"City 3, CA 55126, United States\",\n \"city_state_zip\": \"City 3, CA 55126\",\n \"created_at\": \"2021-10-26T15:47:46.875-07:00\",\n \"updated_at\": \"2021-10-26T15:47:46.875-07:00\"\n },\n \"relationships\": {\n \"addressable\": {\n \"data\": {\n \"id\": \"96\",\n \"type\": \"contact\"\n }\n },\n \"locations\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"95\",\n \"type\": \"address\",\n \"attributes\": {\n \"label\": \"Primary\",\n \"street\": \"94 Fake Rd\",\n \"street2\": null,\n \"city\": \"City 3\",\n \"state\": \"CA\",\n \"zipcode\": \"90219\",\n \"country\": \"United States\",\n \"full_address\": \"94 Fake Rd, City 3, CA 90219, United States\",\n \"full_street\": \"94 Fake Rd\",\n \"second_half\": \"City 3, CA 90219, United States\",\n \"city_state_zip\": \"City 3, CA 90219\",\n \"created_at\": \"2021-10-26T15:47:46.595-07:00\",\n \"updated_at\": \"2021-10-26T15:47:46.595-07:00\"\n },\n \"relationships\": {\n \"addressable\": {\n \"data\": {\n \"id\": \"95\",\n \"type\": \"contact\"\n }\n },\n \"locations\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"94\",\n \"type\": \"address\",\n \"attributes\": {\n \"label\": \"Primary\",\n \"street\": \"93 Fake Rd\",\n \"street2\": null,\n \"city\": \"City 3\",\n \"state\": \"CA\",\n \"zipcode\": \"55126\",\n \"country\": \"United States\",\n \"full_address\": \"93 Fake Rd, City 3, CA 55126, United States\",\n \"full_street\": \"93 Fake Rd\",\n \"second_half\": \"City 3, CA 55126, United States\",\n \"city_state_zip\": \"City 3, CA 55126\",\n \"created_at\": \"2021-10-26T15:47:46.277-07:00\",\n \"updated_at\": \"2021-10-26T15:47:46.277-07:00\"\n },\n \"relationships\": {\n \"addressable\": {\n \"data\": {\n \"id\": \"94\",\n \"type\": \"contact\"\n }\n },\n \"locations\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"93\",\n \"type\": \"address\",\n \"attributes\": {\n \"label\": \"Primary\",\n \"street\": \"92 Fake Rd\",\n \"street2\": null,\n \"city\": \"City 1\",\n \"state\": \"MN\",\n \"zipcode\": \"60633\",\n \"country\": \"United States\",\n \"full_address\": \"92 Fake Rd, City 1, MN 60633, United States\",\n \"full_street\": \"92 Fake Rd\",\n \"second_half\": \"City 1, MN 60633, United States\",\n \"city_state_zip\": \"City 1, MN 60633\",\n \"created_at\": \"2021-10-26T15:47:45.923-07:00\",\n \"updated_at\": \"2021-10-26T15:47:45.923-07:00\"\n },\n \"relationships\": {\n \"addressable\": {\n \"data\": {\n \"id\": \"93\",\n \"type\": \"contact\"\n }\n },\n \"locations\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"92\",\n \"type\": \"address\",\n \"attributes\": {\n \"label\": \"Primary\",\n \"street\": \"91 Fake Rd\",\n \"street2\": null,\n \"city\": \"City 1\",\n \"state\": \"MN\",\n \"zipcode\": \"60633\",\n \"country\": \"United States\",\n \"full_address\": \"91 Fake Rd, City 1, MN 60633, United States\",\n \"full_street\": \"91 Fake Rd\",\n \"second_half\": \"City 1, MN 60633, United States\",\n \"city_state_zip\": \"City 1, MN 60633\",\n \"created_at\": \"2021-10-26T15:47:45.619-07:00\",\n \"updated_at\": \"2021-10-26T15:47:45.619-07:00\"\n },\n \"relationships\": {\n \"addressable\": {\n \"data\": {\n \"id\": \"92\",\n \"type\": \"contact\"\n }\n },\n \"locations\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"91\",\n \"type\": \"address\",\n \"attributes\": {\n \"label\": \"Primary\",\n \"street\": \"90 Fake Rd\",\n \"street2\": null,\n \"city\": \"City 1\",\n \"state\": \"CA\",\n \"zipcode\": \"60633\",\n \"country\": \"United States\",\n \"full_address\": \"90 Fake Rd, City 1, CA 60633, United States\",\n \"full_street\": \"90 Fake Rd\",\n \"second_half\": \"City 1, CA 60633, United States\",\n \"city_state_zip\": \"City 1, CA 60633\",\n \"created_at\": \"2021-10-26T15:47:44.989-07:00\",\n \"updated_at\": \"2021-10-26T15:47:44.989-07:00\"\n },\n \"relationships\": {\n \"addressable\": {\n \"data\": {\n \"id\": \"91\",\n \"type\": \"contact\"\n }\n },\n \"locations\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"90\",\n \"type\": \"address\",\n \"attributes\": {\n \"label\": \"Primary\",\n \"street\": \"89 Fake Rd\",\n \"street2\": null,\n \"city\": \"City 1\",\n \"state\": \"MN\",\n \"zipcode\": \"60633\",\n \"country\": \"United States\",\n \"full_address\": \"89 Fake Rd, City 1, MN 60633, United States\",\n \"full_street\": \"89 Fake Rd\",\n \"second_half\": \"City 1, MN 60633, United States\",\n \"city_state_zip\": \"City 1, MN 60633\",\n \"created_at\": \"2021-10-26T15:47:44.732-07:00\",\n \"updated_at\": \"2021-10-26T15:47:44.732-07:00\"\n },\n \"relationships\": {\n \"addressable\": {\n \"data\": {\n \"id\": \"90\",\n \"type\": \"contact\"\n }\n },\n \"locations\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"89\",\n \"type\": \"address\",\n \"attributes\": {\n \"label\": \"Primary\",\n \"street\": \"88 Fake Rd\",\n \"street2\": null,\n \"city\": \"City 1\",\n \"state\": \"MN\",\n \"zipcode\": \"90219\",\n \"country\": \"United States\",\n \"full_address\": \"88 Fake Rd, City 1, MN 90219, United States\",\n \"full_street\": \"88 Fake Rd\",\n \"second_half\": \"City 1, MN 90219, United States\",\n \"city_state_zip\": \"City 1, MN 90219\",\n \"created_at\": \"2021-10-26T15:47:44.432-07:00\",\n \"updated_at\": \"2021-10-26T15:47:44.432-07:00\"\n },\n \"relationships\": {\n \"addressable\": {\n \"data\": {\n \"id\": \"89\",\n \"type\": \"contact\"\n }\n },\n \"locations\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"88\",\n \"type\": \"address\",\n \"attributes\": {\n \"label\": \"Primary\",\n \"street\": \"87 Fake Rd\",\n \"street2\": null,\n \"city\": \"City 1\",\n \"state\": \"MN\",\n \"zipcode\": \"55126\",\n \"country\": \"United States\",\n \"full_address\": \"87 Fake Rd, City 1, MN 55126, United States\",\n \"full_street\": \"87 Fake Rd\",\n \"second_half\": \"City 1, MN 55126, United States\",\n \"city_state_zip\": \"City 1, MN 55126\",\n \"created_at\": \"2021-10-26T15:47:44.158-07:00\",\n \"updated_at\": \"2021-10-26T15:47:44.158-07:00\"\n },\n \"relationships\": {\n \"addressable\": {\n \"data\": {\n \"id\": \"88\",\n \"type\": \"contact\"\n }\n },\n \"locations\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"87\",\n \"type\": \"address\",\n \"attributes\": {\n \"label\": \"Primary\",\n \"street\": \"86 Fake Rd\",\n \"street2\": null,\n \"city\": \"City 3\",\n \"state\": \"MN\",\n \"zipcode\": \"60633\",\n \"country\": \"United States\",\n \"full_address\": \"86 Fake Rd, City 3, MN 60633, United States\",\n \"full_street\": \"86 Fake Rd\",\n \"second_half\": \"City 3, MN 60633, United States\",\n \"city_state_zip\": \"City 3, MN 60633\",\n \"created_at\": \"2021-10-26T15:47:43.410-07:00\",\n \"updated_at\": \"2021-10-26T15:47:43.410-07:00\"\n },\n \"relationships\": {\n \"addressable\": {\n \"data\": {\n \"id\": \"87\",\n \"type\": \"contact\"\n }\n },\n \"locations\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"86\",\n \"type\": \"address\",\n \"attributes\": {\n \"label\": \"Primary\",\n \"street\": \"85 Fake Rd\",\n \"street2\": null,\n \"city\": \"City 1\",\n \"state\": \"MN\",\n \"zipcode\": \"90219\",\n \"country\": \"United States\",\n \"full_address\": \"85 Fake Rd, City 1, MN 90219, United States\",\n \"full_street\": \"85 Fake Rd\",\n \"second_half\": \"City 1, MN 90219, United States\",\n \"city_state_zip\": \"City 1, MN 90219\",\n \"created_at\": \"2021-10-26T15:47:43.068-07:00\",\n \"updated_at\": \"2021-10-26T15:47:43.068-07:00\"\n },\n \"relationships\": {\n \"addressable\": {\n \"data\": {\n \"id\": \"86\",\n \"type\": \"contact\"\n }\n },\n \"locations\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"85\",\n \"type\": \"address\",\n \"attributes\": {\n \"label\": \"Primary\",\n \"street\": \"84 Fake Rd\",\n \"street2\": null,\n \"city\": \"City 3\",\n \"state\": \"IL\",\n \"zipcode\": \"55126\",\n \"country\": \"United States\",\n \"full_address\": \"84 Fake Rd, City 3, IL 55126, United States\",\n \"full_street\": \"84 Fake Rd\",\n \"second_half\": \"City 3, IL 55126, United States\",\n \"city_state_zip\": \"City 3, IL 55126\",\n \"created_at\": \"2021-10-26T15:47:42.519-07:00\",\n \"updated_at\": \"2021-10-26T15:47:42.519-07:00\"\n },\n \"relationships\": {\n \"addressable\": {\n \"data\": {\n \"id\": \"85\",\n \"type\": \"contact\"\n }\n },\n \"locations\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"84\",\n \"type\": \"address\",\n \"attributes\": {\n \"label\": \"Primary\",\n \"street\": \"83 Fake Rd\",\n \"street2\": null,\n \"city\": \"City 3\",\n \"state\": \"CA\",\n \"zipcode\": \"90219\",\n \"country\": \"United States\",\n \"full_address\": \"83 Fake Rd, City 3, CA 90219, United States\",\n \"full_street\": \"83 Fake Rd\",\n \"second_half\": \"City 3, CA 90219, United States\",\n \"city_state_zip\": \"City 3, CA 90219\",\n \"created_at\": \"2021-10-26T15:47:42.294-07:00\",\n \"updated_at\": \"2021-10-26T15:47:42.294-07:00\"\n },\n \"relationships\": {\n \"addressable\": {\n \"data\": {\n \"id\": \"84\",\n \"type\": \"contact\"\n }\n },\n \"locations\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"83\",\n \"type\": \"address\",\n \"attributes\": {\n \"label\": \"Primary\",\n \"street\": \"82 Fake Rd\",\n \"street2\": null,\n \"city\": \"City 3\",\n \"state\": \"MN\",\n \"zipcode\": \"55126\",\n \"country\": \"United States\",\n \"full_address\": \"82 Fake Rd, City 3, MN 55126, United States\",\n \"full_street\": \"82 Fake Rd\",\n \"second_half\": \"City 3, MN 55126, United States\",\n \"city_state_zip\": \"City 3, MN 55126\",\n \"created_at\": \"2021-10-26T15:47:42.069-07:00\",\n \"updated_at\": \"2021-10-26T15:47:42.069-07:00\"\n },\n \"relationships\": {\n \"addressable\": {\n \"data\": {\n \"id\": \"83\",\n \"type\": \"contact\"\n }\n },\n \"locations\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"82\",\n \"type\": \"address\",\n \"attributes\": {\n \"label\": \"Primary\",\n \"street\": \"81 Fake Rd\",\n \"street2\": null,\n \"city\": \"City 3\",\n \"state\": \"CA\",\n \"zipcode\": \"60633\",\n \"country\": \"United States\",\n \"full_address\": \"81 Fake Rd, City 3, CA 60633, United States\",\n \"full_street\": \"81 Fake Rd\",\n \"second_half\": \"City 3, CA 60633, United States\",\n \"city_state_zip\": \"City 3, CA 60633\",\n \"created_at\": \"2021-10-26T15:47:41.832-07:00\",\n \"updated_at\": \"2021-10-26T15:47:41.832-07:00\"\n },\n \"relationships\": {\n \"addressable\": {\n \"data\": {\n \"id\": \"82\",\n \"type\": \"contact\"\n }\n },\n \"locations\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"81\",\n \"type\": \"address\",\n \"attributes\": {\n \"label\": \"Primary\",\n \"street\": \"80 Fake Rd\",\n \"street2\": null,\n \"city\": \"City 3\",\n \"state\": \"CA\",\n \"zipcode\": \"60633\",\n \"country\": \"United States\",\n \"full_address\": \"80 Fake Rd, City 3, CA 60633, United States\",\n \"full_street\": \"80 Fake Rd\",\n \"second_half\": \"City 3, CA 60633, United States\",\n \"city_state_zip\": \"City 3, CA 60633\",\n \"created_at\": \"2021-10-26T15:47:41.082-07:00\",\n \"updated_at\": \"2021-10-26T15:47:41.082-07:00\"\n },\n \"relationships\": {\n \"addressable\": {\n \"data\": {\n \"id\": \"81\",\n \"type\": \"contact\"\n }\n },\n \"locations\": {\n \"data\": []\n }\n }\n }\n ],\n \"meta\": {\n \"total_pages\": 5,\n \"limit_per_page\": 25,\n \"total_entries\": 105\n },\n \"links\": {\n \"self\": \"/v1/addresses?page=1\",\n \"next\": \"/v1/addresses?page=2\"\n }\n}"}],"_postman_id":"42149cc3-dd6f-478e-a038-4a2a34284edf"},{"name":"Create Address","id":"86b91320-a157-4b27-ae29-edc5acfdb369","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"label\": \"Home\",\n\t\"street\": \"1234 Fake Street\",\n\t\"street2\": \"Apt 1\",\n\t\"city\": \"Fake Town\",\n\t\"state\": \"CA\",\n\t\"zipcode\": \"92104\",\n \"addressable_type\": \"Firm\"\n}","options":{"raw":{"language":"text"}}},"url":"{{host}}/v1/addresses?fields=all","description":"

Create a new Address

Request Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Example	Notes
`label`	string	Yes	`\"Primary\"`
`street`	string	Yes	`\"1234 Fake Street\"`
`street2`	string	No	`\"Apt 1\"`
`city`	string	No	`\"Fake Town\"`
`state`	string	No	`\"CA\"`
`zipcode`	string	No	`\"92104\"`
`country`	string	No	`\"United States\"`
`addressable_type`	string	Yes	`\"Contact\"`	One of `Prospect`, `Contact`, `Company`, `Firm` (case-insensitive; `matter` also accepted)
`addressable_id`	id	Conditional	`\"12345\"`	Required for all `addressable_type` values except `Firm`

\n
Note: Setting the Address on a Prospect (Matter) sets it on the Matter's linked Contact/Company, not the Matter itself.
\n

\n
Note: For addressable_type: \"Firm\", addressable_id is ignored.
\n

Updates an Address by ID

Deletes the Address. It will no longer appear in any future GET responses.

address_id is the Address's own ID

An Address is a physical/mailing/street address that belongs to a Firm, Contact, or Company.

\n","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Response time is less than 400ms\", function () {\n pm.expect(pm.response.responseTime).to.be.below(1400);\n});"]}}],"_postman_id":"654d4925-54fa-4632-9cb2-e407d91c4185","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"redirect_uri","value":""},{"key":"grant_type","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.23.0","type":"collection"}}},{"name":"Collections","item":[{"name":"Collections","item":[{"name":"Collections","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.sendRequest(`${pm.environment.get('host')}/v1/collections`, function (err, response) {\n pm.globals.set(\"collection_id\", response.json().data[0].id);\n});\n "]}}],"id":"06fcd7e1-25c7-4fa5-bd82-a48fb6eb8fdb","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{host}}/v1/collections","description":"

Returns a paginated list of all Collections in the Lawmatics account.

Endpoint

GET {{host}}/v1/collections

Authentication

This request uses OAuth 2.0. Ensure a valid access_token is set in the active environment.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
Content-Type	application/json

Response

Returns a JSON object with a data array. Each item in the array represents a Collection and includes:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`id`	string	Unique identifier for the collection
`type`	string	Resource type — always `\"collection\"`
`attributes.name`	string	Name of the collection
`attributes.custom_fields`	array	List of custom fields associated with the collection
`attributes.created_at`	string (ISO 8601)	Timestamp when the collection was created
`attributes.updated_at`	string (ISO 8601)	Timestamp when the collection was last updated

Custom Field Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`id`	string	Unique identifier for the custom field
`name`	string	Display name of the custom field
`field_type`	string	Type of field (e.g., `list`, `multi_picklist`, `currency`)
`visibility`	string	Visibility setting (e.g., `default`)
`type`	string	Parent resource type — always `\"Collection\"`
`list_options`	array	Available options for list/picklist fields
`created_at`	string (ISO 8601)	Timestamp when the field was created
`updated_at`	string (ISO 8601)	Timestamp when the field was last updated

Retrieves a single Collection by, id

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n

Variable	Description
`collection_id`	The unique identifier of the collection to retrieve.

Response

Returns a data object representing the collection with the following attributes:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`id`	string	Unique identifier of the collection.
`type`	string	Resource type (`\"collection\"`).
`attributes.name`	string	Name of the collection.
`attributes.custom_fields`	array	List of custom fields defined for the collection.
`attributes.created_at`	string	ISO 8601 timestamp of when the collection was created.
`attributes.updated_at`	string	ISO 8601 timestamp of when the collection was last updated.

Custom Field Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`id`	string	Unique identifier of the custom field.
`name`	string	Display name of the custom field.
`field_type`	string	Data type of the field (e.g., `text`, `currency`, `list`).
`visibility`	string	Visibility setting of the field.
`type`	string	Resource type (`\"Collection\"`).
`list_options`	array	Available options for `list` type fields.
`created_at`	string	ISO 8601 timestamp of when the field was created.
`updated_at`	string	ISO 8601 timestamp of when the field was last updated.

Creates a new Collection in Lawmatics.

Request Body

The request body must be a JSON object with the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`name`	string	Yes	The name of the collection to create.
`custom_fields`	array	Yes	An array of custom field definitions to attach to the collection.

Custom Field Object

Each object in the custom_fields array supports the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`name`	string	Yes	The display name of the custom field.
`field_type`	string	Yes	The type of the field. Supported values: `integer`, `boolean`, `string`, `text`, `currency`, `date`, `time`, `datetime`, `list`, `lookup`, `multi_picklist`
`list_options`	array	Only for `list` and `multi_picklist` types	An array of at least two option objects, each with a `name` property, defining the selectable values for a list field.

Response

Returns 201 Created on success with a JSON object containing the created collection's data under the data key.

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`data.id`	string	The unique ID of the newly created collection.
`data.type`	string	The resource type (`collection`).
`data.attributes.name`	string	The name of the collection.
`data.attributes.custom_fields`	array	The list of custom fields created for this collection, each including `id`, `name`, `field_type`, `visibility`, `created_at`, and `updated_at`.
`data.attributes.created_at`	string	ISO 8601 timestamp of when the collection was created.
`data.attributes.updated_at`	string	ISO 8601 timestamp of when the collection was last updated.

Updates an existing Collection, by id. Allows you to modify the collection's associated custom fields.

collection_id is the Collection's own id.

URL Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`id`	integer	The unique identifier of the collection to update. Provided as a path segment (e.g., `2` in `/v1/collections/2`).

Request Body

Send a JSON object with the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`custom_fields`	array of objects	Yes	List of custom fields to associate with the collection.

`custom_fields` Object Properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`id`	string	The unique identifier of the custom field (e.g., `\"298\"`).
`field_type`	string	The type of the custom field (e.g., `\"text\"`).

Deletes the Collection. It will no longer appear in any future GET responses.

collection_id is the Collection's own id.

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n

Variable	Description
`collection_id`	The unique identifier of the collection to delete.

Response

Returns a 200 OK with the deleted collection's data on success, including:

id – The collection's unique identifier.
\n
type – Resource type (collection).
\n
attributes – Collection attributes:
\n
- name – Name of the collection.
  \n
- custom_fields – Array of custom fields associated with the collection.
  \n
- created_at – Timestamp when the collection was created.
  \n
- updated_at – Timestamp when the collection was last updated.
  \n
\n

A Collection is a firm-level, reusable set of custom fields. To actually attach that field-set and real values to a Matter, you create a Collection Item linking the Collection to that Matter.

\n","_postman_id":"173d8b86-842a-464e-95bf-27339e8f7306","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"redirect_uri","value":""},{"key":"grant_type","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.23.0","type":"collection"}}},{"name":"Collection Items","item":[{"name":"Collection Items","id":"66a994c0-44d0-4f64-96a6-4742783e8cf4","request":{"method":"GET","header":[],"url":"{{host}}/v1/collection_items","description":"

Returns a paginated list of all Collection Items.

Query Parameters

Supports standard Lawmatics query parameters for filtering, sorting, pagination, and field selection.

Response

Returns a 200 OK with an array of collection item objects under data. Each item includes:

id – The collection item's unique identifier.
\n
type – Resource type (collection_item).
\n
attributes – Collection item attributes:
\n
- collection_id – The ID of the parent collection.
  \n
- contactable_type – The type of the associated record (e.g., Prospect, Contact).
  \n
- contactable_id – The ID of the associated record.
  \n
- custom_field_values – Array of custom field values for this item.
  \n
- created_at – Timestamp when the item was created.
  \n
- updated_at – Timestamp when the item was last updated.
  \n
\n

Returns a single collection item, by id.

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n

Variable	Description
`collection_item_id`	The unique identifier of the collection item to retrieve.

Response

Returns a 200 OK with the collection item object under data, including:

id – The collection item's unique identifier.
\n
type – Resource type (collection_item).
\n
attributes – Collection item attributes:
\n
- collection_id – The ID of the parent collection.
  \n
- contactable_type – The type of the associated record (e.g., Prospect, Contact).
  \n
- contactable_id – The ID of the associated record.
  \n
- custom_field_values – Array of custom field values for this item.
  \n
- created_at – Timestamp when the item was created.
  \n
- updated_at – Timestamp when the item was last updated.
  \n
\n

Creates a new collection item, associating a matter record with a collection and optionally setting custom field values.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`contactable_type`	string	Yes	The type of the associated record. Only accepted value: `Prospect` (not Matter)
`contactable_id`	integer	Yes	The ID of the associated Prospect.
`collection_id`	integer	Yes	The ID of the collection to add the item to.
`custom_field_values`	array	No	Array of custom field value objects to set on the item.

`custom_field_values` Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`id`	integer	The ID of the custom field.
`value`	string	The value to set for the custom field.

Example Request Body

{\n    \"contactable_type\": \"Prospect\",\n    \"contactable_id\": 185,\n    \"collection_id\": 1,\n    \"custom_field_values\": [\n        {\n            \"id\": 295,\n            \"value\": \"The Matrix\"\n        },\n        {\n            \"id\": 296,\n            \"value\": \"1999-03-31\"\n        }\n    ]\n}\n\n

Response

Returns a 201 Created with the newly created collection item object under data.

Updates an existing Collection item, by id. Updates an existing collection item's custom field values.

collection_item_id is the Collection item's own id.

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n

Variable	Description
`collection_item_id`	The unique identifier of the collection item to update.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`custom_field_values`	array	Yes	Array of custom field value objects to update on the item.

`custom_field_values` Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`id`	string	The ID of the custom field.
`name`	string	The name of the custom field.
`value`	string	The new value to set for the custom field.

Response

Returns a 200 OK with the updated collection item object under data.

Deletes the Collection Item. It will no longer appear in any future GET responses.

collection_item_id is the Collection Item's own id.

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n

Variable	Description
`collection_item_id`	The unique identifier of the collection item to delete.

Response

Returns a 200 OK with the deleted collection item's data on success, including:

id – The collection item's unique identifier.
\n
type – Resource type (collection_item).
\n
attributes – Collection item attributes:
\n
- collection_id – The ID of the parent collection.
  \n
- contactable_type – The type of the associated record.
  \n
- contactable_id – The ID of the associated record.
  \n
- custom_field_values – Array of custom field values associated with the item.
  \n
- created_at – Timestamp when the item was created.
  \n
- updated_at – Timestamp when the item was last updated.
  \n
\n

A Collection Item links a Collection to a specific Matter, holding the actual field values for that Matter.

\n","_postman_id":"4ba6c347-92cd-46a3-9ccf-be952d26cac9","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"redirect_uri","value":""},{"key":"grant_type","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.23.0","type":"collection"}}}],"id":"2e8da48c-dadb-42ca-939a-579dc9ea8c73","_postman_id":"2e8da48c-dadb-42ca-939a-579dc9ea8c73","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"redirect_uri","value":""},{"key":"grant_type","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.23.0","type":"collection"}}},{"name":"Contacts","item":[{"name":"Contact Finders","item":[{"name":"Find Contact By Phone Number","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["pm.sendRequest(`${pm.environment.get('host')}/v1/contacts`, function (err, response) {\n pm.globals.set(\"phone\", response.json().data.find(({attributes}) => attributes.phone).attributes.phone);\n});\n\n"]}}],"id":"fb82e799-8f52-4f50-aa07-254ad1fd88f9","request":{"method":"GET","header":[],"url":"{{host}}/v1/contacts/find_by_phone/:phone_number","description":"

Fuzzy find a specific Contact by Phone Number.

Fuzzy find a specific Contact by Email Address.

Fuzzy find (case-insensitive) a specific Contact by their Name. You can pass either '{first_name} {last_name}' or simply '{first_name}'

The following endpoints are fuzzy find endpoints, returning the first Contact which matches the passed values.

\n","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Response has a body with an id\", function () {\n const body = pm.response.json()\n pm.expect(body.data).have.property('id');\n});"]}}],"_postman_id":"db823222-9e60-4f37-ac3e-709adc15a803","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"redirect_uri","value":""},{"key":"grant_type","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.23.0","type":"collection"}}},{"name":"Custom Contact Types","item":[{"name":"Custom Contact Type","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["pm.sendRequest(`${pm.environment.get('host')}/v1/custom_contact_types`, function (err, response) {\n pm.globals.set(\"custom_contact_type_id\", response.json().data[0].id);\n});\n\n"]}}],"id":"615c62af-9032-4b3d-a4ca-6303b366d4f4","request":{"method":"GET","header":[],"url":"{{host}}/v1/custom_contact_types/:custom_contact_type_id","description":"

A specific Custom Contact Type by ID

A paginated list of all Custom Contact Types in Lawmatics

Filter Options (See our Filtering params)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Notes
`name`	string

Create a new Custom Contact Type

Request Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Example	Notes
`name`	string	Yes	`\"Vendor\"`	Must be unique per firm (case-sensitive; `\"vendor\"` and `\"Vendor\"` can coexist).

\n
Note: Leading/trailing whitespace is automatically trimmed (internal whitespace, e.g. the space in \"Additional Contact\", is left untouched)
\n

Update an existing Custom Contact Type by id.

Delete an existing Custom Contact Type by id. It will no longer appear in any future GET responses.

Note: Contacts currently using this type are not affected or reassigned. They'll continue referencing the deleted value.

A Custom Contact Type is a user defined type to assign to a contact.

\n","_postman_id":"45187b74-35e3-43ad-9668-fc17dcd6bf91","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"redirect_uri","value":""},{"key":"grant_type","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.23.0","type":"collection"}}},{"name":"Contact","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["pm.sendRequest(`${pm.environment.get('host')}/v1/contacts`, function (err, response) {\n pm.globals.set(\"contact_id\", response.json().data[0].id);\n});"]}}],"id":"34b71609-a19e-4cda-b30e-82144067c40c","request":{"method":"GET","header":[],"url":"{{host}}/v1/contacts/:contact_id","description":"

A specific Contact by id

A paginated list of all Contacts in Lawmatics

Filter Options (See our Filtering params)

Field	Type	Notes
`first_name`	string
`last_name`	string
`middle_name`	string
`name_prefix`	string
`name_suffix`	string
`informal_name`	string
`title`	string
`bio`	text
`birthdate`	date
`gender`	string
`marital_status`	string
`citizenship`	string
`driver_license`	string
`social_security`	string
`employer`	string
`occupation`	string
`timezone`	string
`hobbies`	text
`unsubscribed`	boolean
`custom_contact_type_id`	id
`matter_status`	integer	Only the raw integer works here: `no_matters` = `0` `hired` = `1` `lost` = `2` `pnc` = `3`

","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"redirect_uri","value":""},{"key":"grant_type","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.23.0","type":"collection"}},"urlObject":{"path":["v1","contacts"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"a7d9e651-e5df-4fce-ae49-6ec120b8115c","name":"GET Contacts","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.lawmatics.com/v1/contacts?page=6","protocol":"https","host":["api","lawmatics","com"],"path":["v1","contacts"],"query":[{"key":"page","value":"6"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Type","value":"application/json; charset=utf-8","description":"The mime type of this content"},{"key":"ETag","value":"W/\"c631d7df222996f8c0e3e2a1ce126a4d\"","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Transfer-Encoding","value":"chunked","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"Vary","value":"Origin","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Request-Id","value":"4518a758-bd86-4d3a-bee1-3e51e2b2e0c2","description":"Custom header"},{"key":"X-Runtime","value":"0.162715","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"data\":[{\"id\":\"136\",\"type\":\"contact\",\"attributes\":{\"first_name\":\"Linda\",\"last_name\":\"Baker\",\"email\":\"Linda35@gmail.com\",\"created_at\":\"2018-03-20T15:12:57.664-07:00\",\"updated_at\":\"2018-07-16T15:12:57.669-07:00\"},\"relationships\":{}},{\"id\":\"135\",\"type\":\"contact\",\"attributes\":{\"first_name\":\"James\",\"last_name\":\"Lee\",\"email\":\"James34@gmail.com\",\"created_at\":\"2018-04-18T15:12:57.598-07:00\",\"updated_at\":\"2018-07-16T15:12:57.605-07:00\"},\"relationships\":{}},{\"id\":\"134\",\"type\":\"contact\",\"attributes\":{\"first_name\":\"Barbara\",\"last_name\":\"Martiniez\",\"email\":\"Barbara33@gmail.com\",\"created_at\":\"2018-06-21T15:12:57.524-07:00\",\"updated_at\":\"2018-07-16T15:12:57.529-07:00\"},\"relationships\":{}},{\"id\":\"133\",\"type\":\"contact\",\"attributes\":{\"first_name\":\"Charles\",\"last_name\":\"Williams\",\"email\":\"Charles32@gmail.com\",\"created_at\":\"2018-03-19T15:12:57.445-07:00\",\"updated_at\":\"2018-07-16T15:12:57.450-07:00\"},\"relationships\":{}},{\"id\":\"132\",\"type\":\"contact\",\"attributes\":{\"first_name\":\"Joseph\",\"last_name\":\"Moore\",\"email\":\"Joseph31@gmail.com\",\"created_at\":\"2018-06-28T15:12:57.380-07:00\",\"updated_at\":\"2018-07-16T15:12:57.384-07:00\"},\"relationships\":{}},{\"id\":\"131\",\"type\":\"contact\",\"attributes\":{\"first_name\":\"Joseph\",\"last_name\":\"Rodriguez\",\"email\":\"Joseph30@gmail.com\",\"created_at\":\"2018-06-10T15:12:57.310-07:00\",\"updated_at\":\"2018-07-16T15:12:57.317-07:00\"},\"relationships\":{}},{\"id\":\"130\",\"type\":\"contact\",\"attributes\":{\"first_name\":\"Susan\",\"last_name\":\"Smith\",\"email\":\"Susan29@gmail.com\",\"created_at\":\"2018-04-16T15:12:57.232-07:00\",\"updated_at\":\"2018-07-16T15:12:57.238-07:00\"},\"relationships\":{}},{\"id\":\"129\",\"type\":\"contact\",\"attributes\":{\"first_name\":\"Richard\",\"last_name\":\"Miller\",\"email\":\"Richard28@gmail.com\",\"created_at\":\"2018-06-23T15:12:57.164-07:00\",\"updated_at\":\"2018-07-16T15:12:57.169-07:00\"},\"relationships\":{}},{\"id\":\"128\",\"type\":\"contact\",\"attributes\":{\"first_name\":\"Barbara\",\"last_name\":\"Moore\",\"email\":\"Barbara27@gmail.com\",\"created_at\":\"2018-05-01T15:12:57.102-07:00\",\"updated_at\":\"2018-07-16T15:12:57.107-07:00\"},\"relationships\":{}},{\"id\":\"127\",\"type\":\"contact\",\"attributes\":{\"first_name\":\"William\",\"last_name\":\"Walker\",\"email\":\"William26@gmail.com\",\"created_at\":\"2018-04-04T15:12:57.039-07:00\",\"updated_at\":\"2018-07-16T15:12:57.044-07:00\"},\"relationships\":{}},{\"id\":\"126\",\"type\":\"contact\",\"attributes\":{\"first_name\":\"Patricia\",\"last_name\":\"Jones\",\"email\":\"Patricia25@gmail.com\",\"created_at\":\"2018-02-14T14:12:56.978-08:00\",\"updated_at\":\"2018-07-16T15:12:56.983-07:00\"},\"relationships\":{}},{\"id\":\"125\",\"type\":\"contact\",\"attributes\":{\"first_name\":\"Sarah\",\"last_name\":\"Wilson\",\"email\":\"Sarah24@gmail.com\",\"created_at\":\"2018-04-09T15:12:56.918-07:00\",\"updated_at\":\"2018-07-16T15:12:56.923-07:00\"},\"relationships\":{}},{\"id\":\"124\",\"type\":\"contact\",\"attributes\":{\"first_name\":\"Susan\",\"last_name\":\"Davis\",\"email\":\"Susan23@gmail.com\",\"created_at\":\"2018-01-26T14:12:56.855-08:00\",\"updated_at\":\"2018-07-16T15:12:56.860-07:00\"},\"relationships\":{}},{\"id\":\"123\",\"type\":\"contact\",\"attributes\":{\"first_name\":\"Richard\",\"last_name\":\"Taylor\",\"email\":\"Richard22@gmail.com\",\"created_at\":\"2018-05-02T15:12:56.790-07:00\",\"updated_at\":\"2018-07-16T15:12:56.796-07:00\"},\"relationships\":{}},{\"id\":\"122\",\"type\":\"contact\",\"attributes\":{\"first_name\":\"Karen\",\"last_name\":\"Lee\",\"email\":\"Karen21@gmail.com\",\"created_at\":\"2018-07-04T15:12:56.724-07:00\",\"updated_at\":\"2018-07-16T15:12:56.729-07:00\"},\"relationships\":{}},{\"id\":\"121\",\"type\":\"contact\",\"attributes\":{\"first_name\":\"David\",\"last_name\":\"Martiniez\",\"email\":\"David20@gmail.com\",\"created_at\":\"2018-04-22T15:12:56.658-07:00\",\"updated_at\":\"2018-07-16T15:12:56.664-07:00\"},\"relationships\":{}},{\"id\":\"120\",\"type\":\"contact\",\"attributes\":{\"first_name\":\"Patricia\",\"last_name\":\"Martiniez\",\"email\":\"Patricia19@gmail.com\",\"created_at\":\"2018-01-28T14:12:56.585-08:00\",\"updated_at\":\"2018-07-16T15:12:56.591-07:00\"},\"relationships\":{}},{\"id\":\"119\",\"type\":\"contact\",\"attributes\":{\"first_name\":\"Susan\",\"last_name\":\"Lee\",\"email\":\"Susan18@gmail.com\",\"created_at\":\"2018-05-18T15:12:56.504-07:00\",\"updated_at\":\"2018-07-16T15:12:56.509-07:00\"},\"relationships\":{}},{\"id\":\"118\",\"type\":\"contact\",\"attributes\":{\"first_name\":\"Joseph\",\"last_name\":\"Lee\",\"email\":\"Joseph17@gmail.com\",\"created_at\":\"2018-02-01T14:12:56.442-08:00\",\"updated_at\":\"2018-07-16T15:12:56.446-07:00\"},\"relationships\":{}},{\"id\":\"117\",\"type\":\"contact\",\"attributes\":{\"first_name\":\"Joseph\",\"last_name\":\"Baker\",\"email\":\"Joseph16@gmail.com\",\"created_at\":\"2018-02-19T14:12:56.384-08:00\",\"updated_at\":\"2018-07-16T15:12:56.388-07:00\"},\"relationships\":{}},{\"id\":\"116\",\"type\":\"contact\",\"attributes\":{\"first_name\":\"Lisa\",\"last_name\":\"Johnson\",\"email\":\"Lisa15@gmail.com\",\"created_at\":\"2018-04-08T15:12:56.327-07:00\",\"updated_at\":\"2018-07-16T15:12:56.331-07:00\"},\"relationships\":{}},{\"id\":\"115\",\"type\":\"contact\",\"attributes\":{\"first_name\":\"Sarah\",\"last_name\":\"Brown\",\"email\":\"Sarah14@gmail.com\",\"created_at\":\"2018-06-06T15:12:56.269-07:00\",\"updated_at\":\"2018-07-16T15:12:56.273-07:00\"},\"relationships\":{}},{\"id\":\"114\",\"type\":\"contact\",\"attributes\":{\"first_name\":\"Robert\",\"last_name\":\"Jackson\",\"email\":\"Robert13@gmail.com\",\"created_at\":\"2018-05-08T15:12:56.212-07:00\",\"updated_at\":\"2018-07-16T15:12:56.216-07:00\"},\"relationships\":{}},{\"id\":\"113\",\"type\":\"contact\",\"attributes\":{\"first_name\":\"Sarah\",\"last_name\":\"Taylor\",\"email\":\"Sarah12@gmail.com\",\"created_at\":\"2018-04-03T15:12:56.151-07:00\",\"updated_at\":\"2018-07-16T15:12:56.156-07:00\"},\"relationships\":{}},{\"id\":\"112\",\"type\":\"contact\",\"attributes\":{\"first_name\":\"Lisa\",\"last_name\":\"Johnson\",\"email\":\"Lisa11@gmail.com\",\"created_at\":\"2018-03-01T14:12:56.087-08:00\",\"updated_at\":\"2018-07-16T15:12:56.092-07:00\"},\"relationships\":{}}],\"meta\":{\"total_pages\":11,\"limit_per_page\":25,\"total_entries\":261},\"links\":{\"self\":\"/v1/contact?page=6\",\"next\":\"/v1/contact?page=7\",\"prev\":\"/v1/contact?page=5\"}}"}],"_postman_id":"f7085e9c-2300-4906-8f4e-791b444f27a7"},{"name":"Create Contact","id":"795adafc-fbca-4ab8-acb6-f0477849fefe","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"first_name\": \"Lawmatics\",\n\t\"last_name\": \"Example\",\n\t\"email\": \"fake@lawmatics.com\",\n\t\"phone\": \"123-123-1234\",\n\t\"notes\": [\n\t\t{\n\t\t\t\"name\": \"Example Note\",\n\t\t\t\"body\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.\"\n\t\t}\n\t]\n}","options":{"raw":{"language":"text"}}},"url":"{{host}}/v1/contacts","description":"

Create a new Contact

Request Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Example	Notes
`first_name`	string	Yes	`\"Bob\"`
`last_name`	string	No	`\"Loblaw\"`
`middle_name`	string	No	`\"J\"`
`name_prefix`	string	No	`\"Mr.\"`
`name_suffix`	string	No	`\"Jr.\"`
`informal_name`	string	No	`\"Bobby\"`
`title`	string	No	`\"Esq.\"`
`bio`	text	No	`\"Experienced litigator focused on family law.\"`
`birthdate`	date	No	`\"1985-06-15\"`	ISO 8601, `yyyy-mm-dd`, or`mm/dd/yyyy`
`gender`	string	No	`\"Male\"`	In-app, this is a dropdown limited to Male/Female (or a longer list including Non Binary, Agender, Gender Fluid, Pangender, Two Spirit, Intersex, Other)
`marital_status`	string	No	`\"Married\"`	In-app, this is a dropdown limited to dropdown limited to Single, Married, Divorced, Separated, Widowed, Domestic Partnership
`citizenship`	string	No	`\"USA\"`
`driver_license`	string	No	`\"D1234567\"`
`social_security`	string	No	`\"123-45-6789\"`
`employer`	string	No	`\"Acme Corp\"`
`occupation`	string	No	`\"Engineer\"`
`timezone`	string	No	`\"America/Los_Angeles\"`	Should be a standard tz-database identifier
`hobbies`	text	No	`\"Golf, reading\"`
`unsubscribed`	boolean	No	`false`	Defaults to `false`
`custom_contact_type_id`	id	No	`4`
`created_by_id`	id	No	`2`	Allows attributing creation to another user
`created_at` / `updated_at`	datetime ISO 8601 with milliseconds and a UTC offset	No	`\"2023-01-01T00:00:00.000-08:00\"`	Allows backdating

Linked/Virtual Fields — these aren't real Contact columns; each one creates or updates a separate linked record:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Example	Notes
`street` / `street2` / `city` / `state` / `zipcode` / `country`	string	No	`\"1234 Fake Street\"`	Creates the Contact's primary Address (label `Primary`)
`email` or `email_address`	string	No	`\"bob@example.com\"`	Creates a linked Email Address record
`phone` or `phone_number`	string	No	`\"123-456-7890\"`	Creates a linked Phone Number record
`tags`	array of strings	No	`[\"VIP\", \"Referral\"]`	Tag names (matched to existing tags or created)
`custom_fields`	array of objects	No	`[{ \"id\": \"4788\", \"value\": \"Contact String\" }]`
`notes`	array of objects	No	`[{ \"name\": \"Intake Note\", \"body\": \"Met at conference.\" }]`

\n
Note: If your firm has email-matching enabled and the email you submit matches an existing Contact, this endpoint updates that Contact instead of creating a new one, and returns 200 instead of 201.
\n

\n
Note: If you don't pass a fields query param, the response only includes the fields you submitted (plus created_at/updated_at), not the full default field set.
\n

\n
Note: An invalid birthdate value returns 409, not 422.
\n

Update an existing Contact by ID.

\n
Note: Passing Custom Field id and value, will set the custom field value on the Contact, and overwrite any existing value. Passing null as the value will clear it out.
\n

Deletes the Contact, by id. It will no longer appear in any future GET responses.

Warning: This also deletes every Matter linked to this Contact, along with their Notes, Tasks, Events, and Signatures.

A Contact can be thought of as a collection of data about a \"Person\".

A Contact record is the base for all Contactables (Matters, Clients, and Companies).

Since Contact data reflects a person, and is a base record, it is shared via any Contactable associated with the Contact.

For Example:

You begin talks with an existing client into opening a new case. In Lawmatics, you would create a Matter selecting this Contact as the base.

If you update the email address on this Matter. It actually modifies the Matter's associated Contact. Thus, the updated email address, will be shown when you view the Contact directly. It will also show on any Client, Company with it as it's Primary Contact, or any other hired Matter.

\n","_postman_id":"585de9ac-c932-43eb-abd9-647ea2b70454","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"redirect_uri","value":""},{"key":"grant_type","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.23.0","type":"collection"}}},{"name":"Companies","item":[{"name":"Company Finders","item":[{"name":"Find Company By Phone Number","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["pm.sendRequest(`${pm.environment.get('host')}/v1/companies`, function (err, response) {\n pm.globals.set(\"phone_number\", response.json().data.find(({attributes}) => attributes.phone_number).attributes.phone_number\n .replace('.', '')\n );\n});\n\n"]}}],"id":"41a1badc-2c28-4ede-ae95-c2a1ee8e79ea","request":{"method":"GET","header":[],"url":"{{host}}/v1/companies/find_by_phone/:phone_number","description":"

Fuzzy find a specific Company by Phone Number. Will look for the Company Phone Number, then fallback to search though associated Contacts.

Any valid phone number. We strip all non digits when matching, and try with and without the leading 1 for US country codes.

\n","type":"text/plain"},"type":"any","value":"{{phone_number}}","key":"phone_number"}]}},"response":[{"id":"c3301cb8-29f6-4528-8245-a46a552b533f","name":"GET Find Company By Phone Number","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v1/companies/find_by_phone/:phone_number","host":["{{host}}"],"path":["v1","companies","find_by_phone",":phone_number"],"variable":[{"key":"phone_number","value":"707-986-0756","description":"Any valid phone number. We strip all non digits when matching, and try with and without the leading 1 for US country codes."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"0096fb0bd4bca933b7f3bd8fac84ab0c\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"8b9ce38d-cd7c-4d46-b9d7-8e285f975285"},{"key":"X-Runtime","value":"0.753325"},{"key":"vary","value":"Accept, Origin"},{"key":"x-rack-cors","value":"miss; no-origin"},{"key":"Content-Length","value":"421"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"1\",\n \"type\": \"company\",\n \"attributes\": {\n \"name\": \"Lawmatics\",\n \"email\": \"roey+lame@lawmatics.com\",\n \"address\": null,\n \"city\": null,\n \"state\": null,\n \"zipcode\": null,\n \"country\": null,\n \"addresses\": [],\n \"phone_number\": \"(707) 986-0756\",\n \"created_at\": \"2023-07-24T17:49:13.738-07:00\",\n \"updated_at\": \"2023-07-28T15:00:40.321-07:00\"\n },\n \"relationships\": {\n \"addresses\": {\n \"data\": []\n },\n \"emails\": {\n \"data\": []\n },\n \"created_by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"user\"\n }\n }\n }\n }\n}"}],"_postman_id":"41a1badc-2c28-4ede-ae95-c2a1ee8e79ea"},{"name":"Find Company By Email Address","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["pm.sendRequest(`${pm.environment.get('host')}/v1/companies`, function (err, response) {\n pm.globals.set(\"email_address\", response.json().data.find(({attributes}) => attributes.email).attributes.email);\n});\n\n"]}}],"id":"83ef39fc-510a-4139-b40c-c99d771a6eee","request":{"method":"GET","header":[],"url":"{{host}}/v1/companies/find_by_email/:email_address","description":"

Fuzzy find a specific Company by Email Address. Will look for the Company Email Address, then fallback to search though associated Contacts.

A valid email address

\n","type":"text/plain"},"type":"any","value":"{{email_address}}","key":"email_address"}]}},"response":[{"id":"38fd2833-2fea-4d63-9e25-cf7df3060d8b","name":"GET Find Company By Email Address","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v1/companies/find_by_email/:email_address","host":["{{host}}"],"path":["v1","companies","find_by_email",":email_address"],"variable":[{"key":"email_address","value":"help@lawmatics.com","description":"A valid email address"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"27af6a35438707e6d34a8ff314bf8561\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"0e5d92be-c2e3-49d9-a818-3ebbbee00dff"},{"key":"X-Runtime","value":"0.729296"},{"key":"vary","value":"Accept, Origin"},{"key":"x-rack-cors","value":"miss; no-origin"},{"key":"Content-Length","value":"885"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"2\",\n \"type\": \"company\",\n \"attributes\": {\n \"name\": \"Nike\",\n \"email\": \"roey+lame@lawmatics.com\",\n \"address\": \"4250 Executive Square, Suite 101, La Jolla, CA 92130, United States\",\n \"city\": \"La Jolla\",\n \"state\": \"CA\",\n \"zipcode\": \"92130\",\n \"country\": \"United States\",\n \"addresses\": [\n {\n \"id\": 2,\n \"street\": \"4250 Executive Square\",\n \"street2\": \"Suite 101\",\n \"city\": \"La Jolla\",\n \"state\": \"CA\",\n \"zipcode\": \"92130\",\n \"country\": \"United States\",\n \"created_at\": \"2023-08-23T16:16:49.043-07:00\",\n \"updated_at\": \"2023-08-23T16:16:49.043-07:00\",\n \"label\": \"Primary\",\n \"addressable_type\": \"Company\",\n \"addressable_id\": 2,\n \"firm_id\": 2,\n \"deleted_at\": null\n }\n ],\n \"phone_number\": \"(707) 986-0756\",\n \"created_at\": \"2023-08-23T16:16:48.974-07:00\",\n \"updated_at\": \"2023-09-15T15:14:25.499-07:00\"\n },\n \"relationships\": {\n \"addresses\": {\n \"data\": [\n {\n \"id\": \"2\",\n \"type\": \"address\"\n }\n ]\n },\n \"emails\": {\n \"data\": [\n {\n \"id\": \"3\",\n \"type\": \"email_address\"\n }\n ]\n },\n \"created_by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"user\"\n }\n }\n }\n }\n}"}],"_postman_id":"83ef39fc-510a-4139-b40c-c99d771a6eee"},{"name":"Find Company By Name","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["pm.sendRequest(`${pm.environment.get('host')}/v1/companies`, function (err, response) {\n pm.globals.set(\"name\", response.json().data.find(({attributes}) => attributes.name).attributes.name);\n});\n\n"]}}],"id":"822fa8a9-2580-4aac-8357-c424fbb4f790","request":{"method":"GET","header":[],"url":"{{host}}/v1/companies/find_by_name/:name","description":"

Fuzzy find (case-insensitive) a specific Company by Name

We return the closest match.

\n","type":"text/plain"},"type":"any","value":"{{name}}","key":"name"}]}},"response":[{"id":"82444abc-76aa-4fd7-83cb-06aab306098b","name":"GET Find Company By Name","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v1/companies/find_by_name/:name","host":["{{host}}"],"path":["v1","companies","find_by_name",":name"],"variable":[{"key":"name","value":"Nike","description":"We return the closest match."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"27af6a35438707e6d34a8ff314bf8561\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"a63a5803-fa8e-4919-9c86-8eec95ff4670"},{"key":"X-Runtime","value":"0.137311"},{"key":"vary","value":"Accept, Origin"},{"key":"x-rack-cors","value":"miss; no-origin"},{"key":"Content-Length","value":"885"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"2\",\n \"type\": \"company\",\n \"attributes\": {\n \"name\": \"Nike\",\n \"email\": \"roey+lame@lawmatics.com\",\n \"address\": \"4250 Executive Square, Suite 101, La Jolla, CA 92130, United States\",\n \"city\": \"La Jolla\",\n \"state\": \"CA\",\n \"zipcode\": \"92130\",\n \"country\": \"United States\",\n \"addresses\": [\n {\n \"id\": 2,\n \"street\": \"4250 Executive Square\",\n \"street2\": \"Suite 101\",\n \"city\": \"La Jolla\",\n \"state\": \"CA\",\n \"zipcode\": \"92130\",\n \"country\": \"United States\",\n \"created_at\": \"2023-08-23T16:16:49.043-07:00\",\n \"updated_at\": \"2023-08-23T16:16:49.043-07:00\",\n \"label\": \"Primary\",\n \"addressable_type\": \"Company\",\n \"addressable_id\": 2,\n \"firm_id\": 2,\n \"deleted_at\": null\n }\n ],\n \"phone_number\": \"(707) 986-0756\",\n \"created_at\": \"2023-08-23T16:16:48.974-07:00\",\n \"updated_at\": \"2023-09-15T15:14:25.499-07:00\"\n },\n \"relationships\": {\n \"addresses\": {\n \"data\": [\n {\n \"id\": \"2\",\n \"type\": \"address\"\n }\n ]\n },\n \"emails\": {\n \"data\": [\n {\n \"id\": \"3\",\n \"type\": \"email_address\"\n }\n ]\n },\n \"created_by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"user\"\n }\n }\n }\n }\n}"}],"_postman_id":"822fa8a9-2580-4aac-8357-c424fbb4f790"}],"id":"2304bce2-3538-4d05-a010-4e4abdbe26e1","description":"

The following endpoints are fuzzy find endpoints, returning the first Contact which matches the passed values.

\n","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Response has a body with an id\", function () {\n const body = pm.response.json()\n pm.expect(body.data).have.property('id');\n});"]}}],"_postman_id":"2304bce2-3538-4d05-a010-4e4abdbe26e1","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"redirect_uri","value":""},{"key":"grant_type","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.23.0","type":"collection"}}},{"name":"Company","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["pm.sendRequest(`${pm.environment.get('host')}/v1/companies`, function (err, response) {\n pm.globals.set(\"company_id\", response.json().data[0].id);\n});"]}}],"id":"174f1f41-0852-43b6-87b6-1a8125ca3768","request":{"method":"GET","header":[],"url":"{{host}}/v1/companies/:company_id","description":"

A specific Company by id

A paginated list of all Companies in Lawmatics

Filter Options (See our Filtering params)

","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"

Label	Field ID	Type
Company Name	company_name	string
Company Email	company_email	string
Company Phone	company_phone	string

Field ID	Type	Notes
utm_source	string	Matched against a firm Source's `utm_match` value. Sets the Matter's Source if found
utm_campaign	string	Matched against a Campaign under the matched Source's `utm_match` value. Only checked if Source matched first

Field	Type	Notes
`campaign_type`	enum	One of `MarketingCampaign`, `DateCampaign`, `RecurringCampaign`
`name`	string
`status`	enum	Accepts label directly: `run_once`, `inactive`, `active`. `run_once` only applies to Marketing campaigns; Recurring and Date campaigns only ever have `inactive`/`active`
`send_count`	integer	For Marketing/Date campaigns, this is that campaign's own send count. For Recurring campaigns, it's a running total across every send in the series
`sent_at`	datetime	For Marketing/Date campaigns, this is that campaign's own send time. For Recurring campaigns, it updates to the most recent send in the series
`campaign_id`	id

Field	Type	Notes
`name`	string
`primary_contact_id`	id
`matter_status`	integer	Only the raw integer works here: `no_matters` = `0` `hired` = `1` `lost` = `2` `pnc` = `3`

Field	Type	Required	Example	Notes
`name`	string	Yes	`\"Acme Legal\"`	Unique per firm
`primary_contact_id`	id	No	`12345`
`contact_ids`	array of ids	No	`[12345, 67890]`	Links existing Contacts to this Company; the first one added becomes the primary contact

Field	Type	Required	Example	Notes
`city` / `country` / `state` / `street` / `street2` / `zipcode`	string	No	`\"1234 Fake Street\"`	Creates the Company's primary Address
`email`	string	No	`\"info@acme.com\"`	Creates a linked primary Email Address
`phone`	string	No	`\"123-456-7890\"`	Creates a linked primary Phone Number
`addresses_attributes`	array of objects	No	`[{ \"label\": \"Office\", \"street\": \"1234 Fake Street\", \"city\": \"Fake Town\" }]`	For creating multiple linked addresses
`emails_attributes`	array of objects	No	`[{ \"label\": \"Billing\", \"info\": \"billing@acme.com\" }]`	For creating multiple linked email addresses
`phone_numbers_attributes`	array of objects	No	`[{ \"label\": \"Office\", \"info\": \"123-456-7890\" }]`	For creating multiple linked phone numbers

Field	Type	Notes
`name`	string
`subject`	string
`promotional`	boolean
`folder_id`	id

Field	Type	Notes
`type`	enum	Accepts label
`lookup_type`	enum	Accepts label
`custom_fieldable_type`	string
`field_type`	integer	Raw integer only: `integer`=0, `boolean`=1, `string`=2, `text`=3, `currency`=4, `date`=5, `time`=6, `datetime`=7, `list`=8, `lookup`=9, `multi_picklist`=10
`collection_id`	id
`name`	string

Field	Type	Required	Example	Notes
`name`	string	Yes	`\"Jurisdiction\"`
`type`	string	Yes	`\"Matter\"`	One of `Matter`, `Contact`, `Company`
`field_type`	string	Yes	`\"list\"`	One of `integer`, `boolean`, `string`, `text`, `currency`, `date`, `time`, `datetime`, `list`, `lookup`, `multi_picklist` (must be lowercase)
`list_options`	array of strings	Conditional	`[\"Option A\", \"Option B\"]`	Required (2+ options) if `field_type` is `list` or `multi_picklist`; must be omitted for every other `field_type`
`lookup_type`	string	Conditional	`\"Contact\"`	Required if `field_type` is `lookup`. One of `User`, `Contact`, `Company`, `Prospect`

Label	Field ID	Type	Notes
First name	first_name	string
Middle name	middle_name	string
Last name	last_name	string
Name prefix	name_prefix	string
Name suffix	name_suffix	string
Informal name	informal_name	string
Title	title	string
Bio	bio	text
Birthdate	birthdate	date
Gender	gender	lookup	Free text at the API/form-submission level. The rendered Lawmatics form limits the visible dropdown to a fixed list, but a direct submission isn't restricted to it
Marital Status	marital_status	lookup	Same as Gender, free text on submission, fixed list only enforced by the rendered form's dropdown
Citizenship	citizenship	string
Driver license	driver_license	string
Social security	social_security	string
Employer	employer	string
Occupation	occupation	string
Timezone	timezone	string
Hobbies	hobbies	text
Email (Primary)	email	string
Phone (Primary)	phone	string
Address (Primary) - Street	street	string
Address (Primary) - Street2	street2	string
Address (Primary) - City	city	string
Address (Primary) - State	state	string
Address (Primary) - Zipcode	zipcode	string
Address (Primary) - Country	country	string
Unsubscribed	unsubscribed	boolean	String-parsing (\"true\"/\"1\"/\"yes\" etc. → true, \"false\"/\"0\"/blank etc. → false)
Custom Contact Type	custom_contact_type	lookup	Needs the actual internal ID of one of the firm's Custom Contact Types, not its name

Label	Field ID	Type	Notes
Case Title	case_title	string
Case Blurb	case_blurb	text
Status	status	lookup	Accepts the label directly (\"hired\", \"pnc\", \"lost\")
Sub Status	sub_status	lookup	If the submitted value happens to be exactly \"hired\", \"pnc\", or \"lost\" (a top-level Status name), it redirects and sets the Matter's overall Status instead of Sub Status. Any other value requires the internal Sub Status ID
Stage	stage	lookup	Requires the internal ID, except sending exactly \"0\" is special-cased to mean \"No Stage\"
Practice Area	practice_area	lookup	Accepts either the internal ID or the Practice Area's name (case-insensitive exact match). If neither resolves, the whole submission fails with an \"Invalid Practice Area\" error
Type of Billing	type_of_billing	lookup	Accepts the label directly (\"hourly\", \"flat_fee\", \"contingency\")
Actual Value	actual_value	currency
Estimated Value	estimated_value	currency
Lead Cost	lead_cost	currency
Source	source	lookup	Requires the internal ID
Campaign	campaign	lookup	Requires the internal ID. If the Matter doesn't already have a Source set, submitting a valid Campaign ID auto-fills the Source from that Campaign's own linked Source
Referring Url	referring_url	string
Converted At	converted_date	datetime
Statute of Limitations	statute_of_limitations	date
Originating Attorney	originating_attorney	lookup	Requires the internal User ID
Lead Attorney	lead_attorney	lookup	Requires the internal User ID
Salesperson	salesperson	lookup	Requires the internal User ID
Owned By	owned_by	lookup	Requires the internal User ID
Assigned Staff	assigned_staff[]	multi_picklist	Matches against firm Users by internal ID
Tags	tag_ids	tags	Requires internal Tag IDs. Two accepted formats: A plain array of IDs ([1, 2, 3]) which replaces the contactable's tags entirely with whichever of those IDs actually belong to the firm. A hash with selected/baseline keys ({\"selected\": [1, 2, 3], \"baseline\": [1, 2]}) which enables a smarter merge mode. If selected is missing or explicitly null in the hash format, tags aren't touched at all (rather than accidentally clearing everything). This requires having the matter's tags before the form submission, sending them with the form submission.
Sync To OneDrive	sync_to_one_drive	boolean	String-parsing (\"true\"/\"1\"/\"yes\" etc. → true, \"false\"/\"0\"/blank etc. → false)

Field	Type	Notes
`label`	string
`info`	string	The actual email value
`informationable_type`	string	One of `Prospect`, `Matter`, `Contact`, `Company`, `Firm` case-insensitive
`informationable_id`	id

Field	Type	Notes
`name`	string
`start_date`	datetime	ISO 8601
`end_date`	datetime	ISO 8601
`all_day`	boolean
`event_type_id`	id
`location_id`	id

Field	Type	Required	Example	Notes
`name`	string	Yes	`\"Consultation\"`
`start_date`	datetime	Yes	`\"2024-08-01T09:00:00.000-07:00\"`	ISO 8601 datetime format
`end_date`	datetime	Conditional	`\"2024-08-01T10:00:00.000-07:00\"`	Required unless `event_type_id` is set — then it's derived from the event type's duration
`event_type_id`	id	Required	`3`
`all_day`	boolean	No	`false`	Default `false`
`description`	text	No	`\"Initial consultation\"`
`location_id`	id	No	`2`
`eventable_type`	string	No	`\"Contact\"`	One of `Prospect`, `Contact` (case-insensitive; `matter` also accepted)
`eventable_id`	id	Conditional	`\"12345\"`	Id of the `eventable_type` is set
`user_ids`	array of ids	No	`[2, 3]`	User(s) hosting the appointment. (`users` also works, but if both are sent `user_ids` wins)
`reminder_type`	string	No	`\"hours\"`	One of `minutes`, `hours`, `days`, `weeks`
`reminder_delay_length`	integer	No	`24`	Combined with `reminder_type` for how long to wait before sending a reminder
`send_invites`	boolean	No	`true`	Default `false`
`time_zone`	string	No	`\"America/Los_Angeles\"`	A valid tz identifier string; only validated if present

Field	Type	Notes
`name`	string
`address_id`	id	Optional — virtual meeting locations (Zoom, Teams) have no address

Field	Type	Notes
`name`	string
`duration`	integer	In minutes
`billing_activity_type_id`	id
`rate_cents`	integer
`type`	string (STI)	Discriminator column; defaults to `AppointmentEventType`, accepts `RegisterableEventType`
`default_maximum_registrants`	integer

Field	Type	Required	Example	Notes
`documentable_type`	string	No	\"matter\"	One of `firm`, `client`, `matter`, `contact`
`documentable_id`	id	Conditional	\"12345\"	Not needed for `firm`
`folder_id`	id	No	5	The Folder ID the file should be located in
`name`	string	No	\"Contract.pdf\"
`path`	array of strings	No	[\"Root\", \"Folder 1\", \"Folder 2\"]	Finds each folder by name or creates it if missing. Overrides `folder_id` if both are sent

Field	Type	Required	Example	Notes
`name`	string	Yes	`\"Discovery Documents\"`	Must be unique within the parent folder. A `/` in the name is silently converted to `:`
`documentable_type`	string	Yes	`\"Contact\"`	One of `Matter`/`Prospect`, `Contact`, `Client`, `Company` (case-insensitive). Note: `Firm` is not valid here (unlike Addresses/Emails/Phones) — returns a 404
`documentable_id`	id	Yes	`\"12345\"`
`folder_id`	id	No	`5`	Parent folder. Ignored if `path` is also sent
`path`	array of strings	No	`[\"Discovery\", \"2024\"]`	Creates/reuses each folder in the chain; overrides `folder_id` if both are sent
`created_at`	datetime	No	`\"2024-01-01T00:00:00.000-08:00\"`	ISO 8601

Field	Type	Required	Example	Notes
`documentable_type`	string	No	\"Contact\"	One of `matter`, `contact`
`documentable_id`	id	No	\"12345\"
`name`	string	No	\"Discovery Documents\"	Must be unique within the parent folder. Returns `409` if the name is already taken. A `/` in the name is silently converted to `:`
`folder_id`	id	No	5	Parent folder — use this if adding a subfolder
`path`	array of strings	No	[\"Root\", \"Folder 1\", \"Folder 2\"]	Finds each folder by name or creates it if missing. Moves the folder into the last folder in the path. Overrides `folder_id` if both are sent

Field	Type	Notes
`interactable_type`	string	Always `\"Prospect\"` in practice — Create Interaction only accepts `prospect_id`, so this can never be anything else through this API
`interactable_id`	id
`happened_at`	datetime
`interaction_type`	string	Free-form text — no fixed/enumerated value list
`body`	text

Field	Type	Required	Example	Notes
`prospect_id`	id	Yes	`\"12345\"`	The Matter this Interaction is logged against
`interaction_type`	string	Yes	`\"Made Phone Call\"`	Free-form text, not a fixed enum. The app's own \"Log Activity\" UI uses a fixed list — `Made Phone Call`, `Sent Email`, `Had In Person Meeting`, `Sent Text Message`, `Posted to Social Media`, `Physical Mail` — but the API does not enforce it; any string is accepted and stored as-is
`body`	text	Yes	`\"Discussed case status with client.\"`	Must be non-blank
`happened_at`	datetime	No	`\"2024-01-15T14:30:00.000-08:00\"`	ISO 8601. Defaults to the creation time for timeline ordering if omitted

Field	Type	Notes
`name`	string
`order`	integer	Display order within the pipeline
`color`	string	6-digit hex string, `#RRGGBB` — the app's color picker for Stages uses a fixed palette: `#000000`, `#757F8F`, `#7997C9`, `#6519FA`, `#1D196E`, `#70B08B`, `#A8CA45`, `#EDBE30`, `#A7783B`, `#DE5E1C`, `#80231C`, `#F70303`, `#9E4487`, `#DC438F`, `#5EB575`, `#27AE60`, `#E74C3C`, `#8E44AD`, `#16A085`, `#1F344C`
`track_time_in_stage`	boolean
`pipeline_id`	id	Which Pipeline this stage belongs to (see `GET /v1/pipelines`)
`created_by_id`	id	User id

Field	Type	Required	Example	Notes
`name`	string	Yes	`\"Family Law\"`	Unique per firm (case-insensitive)
`color`	string	No	`\"#bcc2c9\"`	No format validation at the API level, but the app's own color picker only offers a fixed palette: `#000000`, `#757F8F`, `#7997C9`, `#6519FA`, `#1D196E`, `#70B08B`, `#A8CA45`, `#EDBE30`, `#A7783B`, `#DE5E1C`, `#80231C`, `#F70303`, `#9E4487`, `#DC438F`, `#5EB575`, `#27AE60`, `#E74C3C`, `#8E44AD`, `#16A085`, `#1F344C`. Use one of these to match what the UI can produce. Note `#bcc2c9` (the DB default when omitted) isn't itself one of these preset options. If you explicitly send `null` it will fail (hits a NOT NULL constraint) — omit the key entirely instead
`statute_of_limitations_enabled`	boolean	No	`true`	Defaults to `false`

CHANGELOG

05/26/2026 - 1.22.0

05/26/2026 - 1.21.15

05/04/2026 - 1.21.14

04/27/2026 - 1.21.13

12/03/2025 - 1.21.12

11/04/2025 - 1.21.11

10/27/2025 - 1.21.10

03/31/2025 - 1.21.9

10/21/2024 - 1.21.8

10/04/2024 - 1.21.7

08/29/2024 - 1.21.6

08/12/2024 - 1.21.5

08/07/2024 - 1.21.4

08/02/2024 - 1.21.3

04/25/2024 - 1.21.2

04/12/2024 - 1.21.1

03/04/2024 - 1.21.0

02/08/2024 - 1.20.5

01/11/2024 - 1.20.4

01/10/2024 - 1.20.3

10/11/2023 - 1.20.2

10/10/2023 - 1.20.1

10/04/2023 - 1.20.0

09/29/2023 - 1.19.0

09/27/2023 - 1.18.0

09/21/2023 - 1.17.0

7/07/2023 - 1.16.0

7/07/2023 - 1.15.0

3/23/2023 - 1.14.1

11/11/2022 - 1.14.0

10/3/2022 - 1.13.1

9/19/2022 - 1.13.0

8/8/2022 - 1.12.0

8/4/2022 - 1.11.0

7/20/2022 - 1.10.0

6/26/2022 - 1.9.0

6/25/2022 - 1.7.0

6/19/2022 - 1.6.0

5/9/2022 - 1.5.1

5/8/2022 - 1.5.0

4/27/2022 - 1.4.6

8/28/2019 - 1.4.5

6/21/2019 - 1.4.4

4/5/2019 - 1.4.3

4/1/2019 - 1.4.2

3/31/2019 - 1.4.1

3/27/2019 - 1.4.0

CUSTOM FORM NOTE:

Creating a new OAuth2 Lawmatics Developer App:

Authenticating with your Client App:

Limitations

An Example of Attribute Selection:

Matter Filtering Examples

Endpoint

Authentication

Headers

Response

Custom Field Object

Path Variables

Response

Custom Field Object

Request Body

Custom Field Object

Response

Response Body

URL Parameters

Request Body

custom_fields Object Properties

Path Variables

Response

Query Parameters

Response

Path Variables

Response

Request Body

custom_field_values Object

Example Request Body

Response

Path Variables

`custom_fields` Object Properties

`custom_field_values` Object

`custom_field_values` Object

Field	Type	Required	Example	Notes
`name`	string	No	\"Family Law\"
`color`	string	No	\"#bcc2c9\"	No format validation at the API level, but the app's own color picker only offers a fixed palette: `#000000`, `#757F8F`, `#7997C9`, `#6519FA`, `#1D196E`, `#70B08B`, `#A8CA45`, `#EDBE30`, `#A7783B`, `#DE5E1C`, `#80231C`, `#F70303`, `#9E4487`, `#DC438F`, `#5EB575`, `#27AE60`, `#E74C3C`, `#8E44AD`, `#16A085`, `#1F344C`. Use one of these to match what the UI can produce
`statute_of_limitations_enabled`	boolean	No	`true`

Field	Type	Notes
`prospect_id`	id
`relationship_type_id`	id	From `GET /v1/relationship_types`
`contactable_id`	id	The related Contact's id
`custom_field_id`	id

Field	Type	Required	Example	Notes
`prospect_id`	id	Yes	`\"12345\"`	The Matter
`relationship_type_id`	id	Yes	`\"7\"`
`contact_id`	id	Yes	`\"67890\"`	Must be a Contact — Companies cannot be related through this endpoint

Field	Type	Notes
`name`	string
`is_repeatable`	boolean
`sync_email`	boolean
`created_by_id`	id	User id

Field	Type	Required	Example	Notes
`name`	string	Yes	`\"Emergency Contact\"`	Unique per firm (case-insensitive). A duplicate name returns a 422 with a different error shape than most other endpoints
`is_repeatable`	boolean	No	(send the key to enable)	Note: Not cast as a real boolean — the value is only checked for presence, so `true`, `false`, `\"false\"`, and `0` are all treated as \"enable it\". To leave it disabled, omit the key entirely rather than sending `false`
`sync_email`	boolean	No	(send the key to enable)	Note: Same presence-check trap as `is_repeatable` — any non-blank value enables it, `false` included. On top of that: the column's database default is `true`, but this endpoint always writes an explicit value, so omitting this field creates the record with `sync_email: false` — the opposite of the schema default. Send the key with any non-blank value to get `true`

Field	Type	Required	Example	Notes
`name`	string	Yes	`\"Awaiting Documents\"`	No uniqueness validation — duplicate names within a firm are allowed (unlike Practice Areas/Relationship Types/Custom Contact Types, which do enforce it)
`status`	string	No	`\"pnc\"`	One of `hired`, `pnc`, `lost` (case-insensitive). Defaults to `pnc`. Note: An invalid value here returns a 500, not a 422
`created_by_id`	id	No	`2`	Defaults to the API token's user

Field	Type	Required	Example	Notes
`case_title`	string	No	`\"Smith v. Jones\"`
`case_number`	string	No	`\"2024-CV-001\"`	Must be unique per firm, if provided
`case_blurb`	text	No	`\"Personal injury case\"`	Also called Case Description / Matter Description
`status`	integer	No	`1`	Raw integer only: `hired`=0, `pnc`=1, `lost`=2. Defaults to `pnc`. Overwritten if `sub_status_id` is set — see note
`sub_status_id`	id	No	`3`	Setting this overwrites `status` to match the sub status's status
`type_of_billing`	integer	No	`1`	Raw integer only: `flat_fee`=0, `hourly`=1, `contingency`=2
`actual_value_cents`	integer	No	`500000`	In cents
`estimated_value_cents`	integer	No	`750000`	In cents
`lead_cost_cents`	integer	No	`10000`	In cents
`converted_date`	datetime	No	`\"2024-01-15T00:00:00.000-08:00\"`	ISO 8601
`source_id`	id	No	`5`
`campaign_id`	id	No	`7`
`practice_area_id`	id	No	`2`
`stage_id`	id	No	`1`
`owned_by_id`	id	No	`3`
`originating_attorney_id`	id	No	`4`
`lead_attorney_id`	id	No	`4`
`salesperson_id`	id	No	`6`
`assigned_staff_ids`	array of ids	No	`[3, 4]`	Assigned after the Matter is created
`tags`	array of strings	No	`[\"Urgent\"]`	Tag names
`custom_fields`	array of objects	No	`[{ \"id\": \"1027\", \"value\": \"An important case\" }]`
`notes`	array of objects	No	`[{ \"name\": \"Intake\", \"body\": \"Initial consultation notes\" }]`
`created_by_id`	id	No	`2`	Allows attributing creation to another user
`created_at` / `updated_at`	datetime	No	`\"2024-01-01T00:00:00.000-08:00\"`	ISO 8601. Allows backdating

Field	Type	Required	Example	Notes
`contact_id`	id	One of these	`\"12345\"`	Link to an existing Contact
`company_id`	id	One of these	`\"6789\"`	Link to an existing Company
`company_name`	string	One of these	`\"Acme Legal\"`	Creates a new Company
`match_contact_by`	string	No	`\"email\"`	One of `email`, `name`, `phone` — a hint for which lookup to use below, not a requirement in itself

Field	Type	Required	Example	Notes
`name`	string	Yes	`\"Intake Note\"`
`body`	text	Yes	`\"Met at conference, interested in estate planning services.\"`
`notable_type`	string	Yes	`\"Contact\"`	One of `Prospect`, `Contact`, `Client`, `Company` (case-insensitive; `matter` also accepted)
`notable_id`	id	Yes	`\"12345\"`
`created_by_id`	id	No	`2`	If the id doesn't resolve to a user on the firm, the Note is silently attributed to the API token's user instead — no error either way
`created_at` / `updated_at`	datetime	No	`\"2024-01-01T00:00:00.000-08:00\"`	ISO 8601. Allows backdating

Field	Type	Notes
`number`	integer
`status`	string enum	Accepts label directly: `draft`, `sending`, `sent`, `paid`, `partially_paid`, `past_due`, `forwarded`, `processing`
`payment_terms`	string enum	Accepts label directly: `due_date`, `due_on_receipt`, `net15`, `net30`, `net60`, `installment`
`target_account_type`	integer	Raw integer only: `operating = 0`, `trust = 1`
`prospect_id`	id	Matter id
`invoice_type_id`	id
`created_by_id`	id	User id
`forwarded_to_id`	id	Invoice id
`invoiced_at`	date	ISO 8601
`due_at`	date	ISO 8601
`voided_at`	datetime	ISO 8601
`written_off_at`	datetime	ISO 8601
`note`	text
`contactable_name`	string
`contactable_address`	string
`is_lm_pay`	boolean
`enable_online_payment`	boolean
`enable_ach_payment`	boolean
`enable_cards_payment`	boolean
`enable_surcharge`	boolean
`send_trust_receipt`	boolean
`apply_account_trust_balance`	boolean
`apply_matter_trust_balance`	boolean
`include_balance_forward`	boolean
`include_statement_of_accounts`	boolean
`send_from`	string	Specific options include: `firm_default_invoice_email` `User-` (e.g. \"User-4821\") `custom_field_values-` (e.g. \"custom_field_values-77\") `created_by` `owned_by` `salesperson` `lead_attorney` `originating_attorney`