{"info":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.21.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

03/04/2023 - 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

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 devleoper app. So disregard auth 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":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-05-10T16:48:44.000Z"},"item":[{"name":"Getting Started With Auth","item":[],"id":"cffe80c1-7a6c-4da7-a2d4-b71f6c9357f8","description":"

Lawmatics' REST API uses the standard OAuth2.0 token grant flow. If you are familiar with OAuth2.0, auth should be straightforward. If you are not this webpage explains OAuth2.0 concisely: https://aaronparecki.com/oauth-2-simplified/

Creating a new OAuth2 Lawmatics Developer App:

To create a new developer app, you must first register a new Lawmatics account and have developer settings granted by a support rep. You can reach out via email, phone, or the chat on our homepage.
While logged in to your Lawmatics account, go to https://app.lawmatics.com/settings/developers.

You can see how it's done here: https://www.useloom.com/share/bfbfa6642b0b4b97aa3ef87d29817e0b

To get credentials for programatic access. Click 'New Application' and enter the Name, Description, and Logo that your app users will see when connecting through your app. As well as the Callback URL they will be redirected back to, after they grant your app access to their account.

Authenticating with your Client App:

In your application, users click the following authorize link. They will auth their Lawmatics account, and then grant or deny your Client App to make changes to their Lawmatics account on their behalf. Then we will redirect the user back to your website along with our grant token 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 that you set when creating your developer app, shown in developer settings, we will redirect the user to this url along with the grant token.
\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.

When the user authenticates, and grants access to your app, they will be redirected back to GET

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

along with a code query param. This code is a short lived grant token that needs to be captured by your backend and utilized to receive the access_token.

STEP 2: Getting an Access Token

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

The POST body must contain the following required params:

client_id: The app key from above
\n
client_secret: The app secret from above
\n
grant_type: \"authorization_code\"
\n
code: The authorization code returned from the redirect above
\n
redirect_uri: The callback URL used in the authorization request above
\n

This will create and return a non-expiring access_token that you should save associated with your user.

   HTTP/1.1 200 OK\n   {\n     \"token_type\":\"bearer\",\n     \"access_token\":\"WjR8HLdo847Z8kdfUtewJpCvkRX4JYLCIF2dUUul\",\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!

E.g. Authorization= Bearer

Limitations

We have a 1,000 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. Once a user authenticates your app, they are giving you full CRUD access to their account.
\n
We do not have a deauthorization endpoint.
\n
We do not give you a refresh token. Access tokens do not expire so they are not needed.
\n

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"1d069db3-cc83-4dc3-938f-c61de031f7e1"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"b377241d-2ed3-45c7-aab8-66ef6de44db0"}}],"_postman_id":"cffe80c1-7a6c-4da7-a2d4-b71f6c9357f8","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"authUrl","value":""},{"key":"accessTokenUrl","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"useBrowser","value":""},{"key":"redirect_uri","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.21.0","type":"collection"}}},{"name":"Param Guide","item":[{"name":"Field Selection","item":[],"id":"228f13e7-1100-498f-a672-b612d7c659bf","description":"

Field Selection allows you to shape the response data to only include fields that are needed for your development. A field is considered an association to the record, or attributes on the record itself. Field Selection can only return data one level deep (for now!).

Field Selection works on every Lawmatics endpoint unless specified otherwise.

A valid ?fields= value is a comma separated list of attributes/relationships. It could like this: ?fields=first_name,last_name,source,custom_fields. Fields are returned in the order you select them.

Requests that don't include the field param will return a small set of commonly used default attributes (such as name, or email).

Associated fields response data, will only return the id and type of the associated record. This means to get more data about a relationship record, the id from the response must be used to query the relationship endpoint.

An Example of Attribute Selection:

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

Start by making an authenticated curl to retrieve the association data.

curl -H \"Authorization: Bearer <access_token>\" -i https://api.lawmatics.com/v1/prospects/74?fields=source

returning:

{\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

Now call https://api.lawmatics.com/v1/sources/3?fields=all to expose all available related attributes and relationships about the Source.

It's efficient in production code to only request fields that are going to be used.

Note: If you are curious to the attributes/relationships available on a record, try the ?fields=all query param value on ANY endpoint unless stated otherwise.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"8cdbd3fa-0273-4900-b64c-3e594b46e070"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"6b7f75cd-3209-44a2-8bc7-20520600b8e8"}}],"_postman_id":"228f13e7-1100-498f-a672-b612d7c659bf","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"authUrl","value":""},{"key":"accessTokenUrl","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"useBrowser","value":""},{"key":"redirect_uri","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.21.0","type":"collection"}}},{"name":"Pagination","item":[],"id":"8c6d20ec-d964-46ed-af96-b2ae64505ff9","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","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"de18c97c-474f-4fcc-b76d-5721daaa2c4e"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"1feaae11-7c05-4e92-b42e-becf30ea7a7c"}}],"_postman_id":"8c6d20ec-d964-46ed-af96-b2ae64505ff9","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"authUrl","value":""},{"key":"accessTokenUrl","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"useBrowser","value":""},{"key":"redirect_uri","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.21.0","type":"collection"}}},{"name":"Sorting","item":[],"id":"390fd341-7c31-4194-a38d-7b7abbf4f71e","description":"

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

Customizing the sort order of the response works with Two Query Params:

sort_order: Can be asc or desc.
sort_by

Available sort_by columns are:\nid, created_at, updated_at\nAs 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","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"f691cb21-44a0-40a5-81b8-56d3db93134d"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"fd52df5a-b1c2-4383-938b-4f9b26872810"}}],"_postman_id":"390fd341-7c31-4194-a38d-7b7abbf4f71e","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"authUrl","value":""},{"key":"accessTokenUrl","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"useBrowser","value":""},{"key":"redirect_uri","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.21.0","type":"collection"}}},{"name":"Filtering","item":[{"name":"Filtering Examples","item":[{"name":"Filter Matter by specific Practice Area","event":[{"listen":"prerequest","script":{"exec":["pm.sendRequest(`${pm.environment.get('host')}/v1/prospects?fields=practice_area`, function (err, response) {"," pm.globals.set(\"practice_area_id\", response.json().data.find(({relationships}) => relationships?.practice_area?.data?.type == 'practice_area').relationships.practice_area.data.id);","});","",""],"type":"text/javascript","id":"d027a1b0-7007-4b9a-ba71-a8cb818805f8"}}],"id":"f88f056e-293f-4333-936e-bb895e892f40","protocolProfileBehavior":{"disableBodyPruning":true},"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":"authUrl","value":""},{"key":"accessTokenUrl","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"useBrowser","value":""},{"key":"redirect_uri","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.21.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":"2333fa01-bd7d-4281-b917-c5f84f50c16e","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":"f88f056e-293f-4333-936e-bb895e892f40"},{"name":"Filter for Matter Actual Value > 0","id":"d80e750c-ff1a-455c-b5ee-4c3e0c6cbe54","protocolProfileBehavior":{"disableBodyPruning":true},"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
Case Title (exact)
\n

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

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

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

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

https://api.lawmatics.com/v1/prospects?filter_by=case_title&filter_on=%uls Wild Ride\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
Estimated Value Less Than or Equal to 1000 Dollars
\n

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

\n
First Name
\n

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

","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"7f545943-fccc-42a6-ac33-2fe1fbcb0b37"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"ac1bbbef-816d-4e9f-9da2-881d6c77c189"}}],"_postman_id":"f036c2cd-2ab7-4499-8b6b-7f8959d8c754","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"authUrl","value":""},{"key":"accessTokenUrl","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"useBrowser","value":""},{"key":"redirect_uri","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.21.0","type":"collection"}}}],"id":"7f995af9-0042-49dd-a34f-2b1a1b6e2e7c","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.
filter_on or filter_value: This is the value to filter on.
filter_with or filter_operator: (Optional) This is the operator used to filter. (default: '=')

The available filter_by columns are:

Most (contact us) standard fields listed in the fields='all' response.
Currency attributes are by cents.
Association attributes require _id to be appended. E.g practice_area_id.

Additional Notes:

If you use filter_by without filter_on, we will return an error response.
\n
Valid filter_operators are one of: ['=', '!=', <=','<','>=','>','like','ilike']
\n
Additional validfilter_operators for checking presence:['null', 'not_null']
\n
- These do not require a filter_value
  \n
- Aliases: ['empty', 'present', 'blank']
  \n
\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

like and ilike are fuzzy String matching operators (ilike is case insensitive).
As a convenience ilike is the operator used by default when filtering on fields of String type.
If you are using a fuzzy matcher, you must put \"%\" on the filter_value, where you want the fuzzy matching to occur.

Note - (Keep in mind urls must encode special characters: so '%' becomes '%25')

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"f655b696-79d6-41b9-9c8e-c2727c03b3ad"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"81b1ade7-233d-47c0-91b0-e013c5b40865"}}],"_postman_id":"7f995af9-0042-49dd-a34f-2b1a1b6e2e7c","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"authUrl","value":""},{"key":"accessTokenUrl","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"useBrowser","value":""},{"key":"redirect_uri","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.21.0","type":"collection"}}}],"id":"e9a9649d-8d8a-45b0-88af-e710ed928fa9","description":"

We currently have three possible types of Query Param options that can be included with any request to modify the results.

Field Selection
Pagination
Sorting
Filtering

There are two types of Queries,

Queries that return a Single Object. These only have access to Field Selection Query Params.
Queries that return a List of Objects. These have access to all Query Params.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"4a3f0958-92f4-41bf-8780-c0f73cb090e6"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"8565b7e9-707b-4787-89c0-e8734fb3a01a"}}],"_postman_id":"e9a9649d-8d8a-45b0-88af-e710ed928fa9","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"authUrl","value":""},{"key":"accessTokenUrl","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"useBrowser","value":""},{"key":"redirect_uri","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.21.0","type":"collection"}}},{"name":"Addresses","item":[{"name":"Address","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is Successful\", function () {"," pm.response.to.be.ok","});"],"type":"text/javascript","id":"a05ff0a6-edeb-481d-bddd-ee4bac80ca37"}},{"listen":"prerequest","script":{"exec":["pm.sendRequest(`${pm.environment.get('host')}/v1/addresses`, function (err, response) {"," pm.globals.set(\"address_id\", response.json().data[0].id);","});","",""],"type":"text/javascript","id":"54420100-1e05-42fe-8beb-759e9e39ac42"}}],"id":"89450986-3cc6-4609-ab3a-a5910ac6edc9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v1/addresses/:address_id","description":"

A specific Stage by id

A paginated list of all Addresses in Lawmatics

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"authUrl","value":""},{"key":"accessTokenUrl","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"useBrowser","value":""},{"key":"redirect_uri","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.21.0","type":"collection"}},"urlObject":{"path":["v1","addresses"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"d77386c4-afcc-4faf-885b-d3feb667d92b","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":"03d19b5f-e2ff-47e8-ba56-1fef28d9975e"},{"name":"Create Address","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"5563ce52-6f35-4aa7-a3ff-50fa382fa2c3"}},{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"38a7d87d-05e4-4c25-989f-33f6fbdea1e5"}}],"id":"eab776b3-bf2c-4433-8c2f-3a07614c3918","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":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}"},"url":"{{host}}/v1/addresses?fields=all","description":"

Create a new Address

Required Fields: addressable, label, street

addressable_type: Prospect, Contact, Company, or Firm that the Address belongs to.

addressable_id: Id of Record. Firm type doesn't need an ID passed and it will be ignored.

Note - Setting the Address through a Prospect (Matter) will set the address on the Prospects' Contact/Company.

Updates an Address by ID

Delete an Address

address_id: ID of the Address to delete

An Address belongs to a Firm, a Contact, or Company.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"084f0b80-c857-4fa6-9655-01766fe75758"}},{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Response time is less than 400ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(1400);","});"],"id":"09ef3c52-7358-4aa5-b100-394f9ce832dc"}}],"_postman_id":"36a5d065-e72a-459c-8954-db31d8309730","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"authUrl","value":""},{"key":"accessTokenUrl","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"useBrowser","value":""},{"key":"redirect_uri","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.21.0","type":"collection"}}},{"name":"Contacts","item":[{"name":"Contact Finders","item":[{"name":"Find Contact By Phone Number","event":[{"listen":"prerequest","script":{"exec":["pm.sendRequest(`${pm.environment.get('host')}/v1/contacts`, function (err, response) {"," pm.globals.set(\"phone\", response.json().data.find(({attributes}) => attributes.phone).attributes.phone);","});","",""],"type":"text/javascript","id":"543a7440-fbb1-4fcb-95ff-e776382019f0"}}],"id":"a9dcf5d1-e663-4819-94ad-2533234d3ee5","protocolProfileBehavior":{"disableBodyPruning":true},"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":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"52338df2-f2a1-4d04-ab33-68be4f62bed8"}},{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Response has a body with an id\", function () {"," const body = pm.response.json()"," pm.expect(body.data).have.property('id');","});"],"id":"1ce4fa83-4e7b-466b-931f-83ddedd0d739"}}],"_postman_id":"db1f4363-3cbf-4a69-bd9f-e30f85459d1c","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"authUrl","value":""},{"key":"accessTokenUrl","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"useBrowser","value":""},{"key":"redirect_uri","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.21.0","type":"collection"}}},{"name":"Custom Contact Types","item":[{"name":"Custom Contact Type","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"761d9509-734b-4cda-8d76-0ae8c6f1ea87"}},{"listen":"prerequest","script":{"exec":["pm.sendRequest(`${pm.environment.get('host')}/v1/custom_contact_types`, function (err, response) {"," pm.globals.set(\"custom_contact_type_id\", response.json().data[0].id);","});","",""],"type":"text/javascript","id":"b03beedd-33fc-474c-97c4-beb479b721a9"}}],"id":"6e7a994f-52ff-4f04-8068-bb3090700246","protocolProfileBehavior":{"disableBodyPruning":true},"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 Type in Lawmatics

Create a new Custom Contact Type

Update an existing Custom Contact Type by ID.

Delete an existing Custom Contact Type by ID.

Warning: This is irreversible!

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

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b4376128-8964-47aa-8e32-970a1caf812a"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"fd644110-6c3c-4a5a-bb39-cd973770b687"}}],"_postman_id":"ccd1ca2a-554e-4540-840e-4c486d1c02ed","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"authUrl","value":""},{"key":"accessTokenUrl","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"useBrowser","value":""},{"key":"redirect_uri","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.21.0","type":"collection"}}},{"name":"Contact","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"31fefe65-018d-4f3a-9306-aa0a6235e0d8"}},{"listen":"prerequest","script":{"exec":["pm.sendRequest(`${pm.environment.get('host')}/v1/contacts`, function (err, response) {"," pm.globals.set(\"contact_id\", response.json().data[0].id);","});"],"type":"text/javascript","id":"76ab614b-580d-43aa-9b5b-1ebbf7e50035"}}],"id":"abc836dc-5926-4fa0-96bf-c807d380cb2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v1/contacts/:contact_id","description":"

A specific Contact by id

A paginated list of all Contacts in Lawmatics

Create a new Contact

Update an existing Contact by ID.

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.

Delete an existing Contact by ID.

Warning: This is irreversible!

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","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b1689b2f-fbbe-4b6e-a046-4c88618aa8c3"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"ffc47c3d-ed50-4fd4-af92-4552dbaee522"}}],"_postman_id":"7ff2ca2e-5b28-4415-9bb6-45030420047d","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"authUrl","value":""},{"key":"accessTokenUrl","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"useBrowser","value":""},{"key":"redirect_uri","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.21.0","type":"collection"}}},{"name":"Companies","item":[{"name":"Company Finders","item":[{"name":"Find Company By Phone Number","event":[{"listen":"prerequest","script":{"exec":["pm.sendRequest(`${pm.environment.get('host')}/v1/companies`, function (err, response) {"," pm.globals.set(\"phone_number\", response.json().data.find(({attributes}) => attributes.phone_number).attributes.phone_number"," .replace('.', '')"," );","});","",""],"type":"text/javascript","id":"53c7a257-0326-4ec5-bbf2-52ac240246fb"}}],"id":"49f8d13b-ad7e-481d-9553-e0078c222e79","protocolProfileBehavior":{"disableBodyPruning":true},"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":"93353f92-4ae6-4a75-9771-2255f287d26a","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":"49f8d13b-ad7e-481d-9553-e0078c222e79"},{"name":"Find Company By Email Address","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"a2cb2197-f1a5-4ee5-8ebf-8a9b3095be52"}},{"listen":"prerequest","script":{"exec":["pm.sendRequest(`${pm.environment.get('host')}/v1/companies`, function (err, response) {"," pm.globals.set(\"email_address\", response.json().data.find(({attributes}) => attributes.email).attributes.email);","});","",""],"type":"text/javascript","id":"342d86a7-ad90-43c7-8426-3bfc88377855"}}],"id":"38b7b535-fb5a-40ce-a366-1d4f7c77af54","protocolProfileBehavior":{"disableBodyPruning":true},"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":"2465f48f-4569-4da9-b2ea-d24c472d1bfa","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":"38b7b535-fb5a-40ce-a366-1d4f7c77af54"},{"name":"Find Company By Name","event":[{"listen":"prerequest","script":{"exec":["pm.sendRequest(`${pm.environment.get('host')}/v1/companies`, function (err, response) {"," pm.globals.set(\"name\", response.json().data.find(({attributes}) => attributes.name).attributes.name);","});","",""],"type":"text/javascript","id":"f14d167c-9fd4-402b-9ed4-3e34d902807f"}}],"id":"39fd5669-a5e3-406e-8885-aad59cbb585c","protocolProfileBehavior":{"disableBodyPruning":true},"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":"7c6147ad-b80f-4026-b678-f58f2fcc993d","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":"39fd5669-a5e3-406e-8885-aad59cbb585c"}],"id":"1b7913a3-aba5-4ab9-95a9-450866f0cd3e","description":"

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

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b555df7c-407f-4929-9dd8-3105d401d72b"}},{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Response has a body with an id\", function () {"," const body = pm.response.json()"," pm.expect(body.data).have.property('id');","});"],"id":"9263844e-7722-48b6-ac98-63705d059629"}}],"_postman_id":"1b7913a3-aba5-4ab9-95a9-450866f0cd3e","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"authUrl","value":""},{"key":"accessTokenUrl","value":""},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"useBrowser","value":""},{"key":"redirect_uri","value":""},{"key":"tokenName","value":""},{"key":"tokenType","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","id":"e2baf2ff-2068-4586-8a21-dacdeb82a8e5","name":"Lawmatics OAuth API v1.21.0","type":"collection"}}},{"name":"Company","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"f9117546-e8e0-4836-bbd8-a88e72d538c7"}},{"listen":"prerequest","script":{"exec":["pm.sendRequest(`${pm.environment.get('host')}/v1/companies`, function (err, response) {"," pm.globals.set(\"company_id\", response.json().data[0].id);","});"],"type":"text/javascript","id":"5e7b0c7e-aa75-4e19-a641-443a1e4b73f3"}}],"id":"79609d30-c41f-4239-ad7f-3c5fd4e9c79d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v1/companies/:company_id","description":"

A specific Company by id

A paginated list of all Companies in Lawmatics

Create a new Company

Update an existing Company by ID.

Passing Custom Field id and value, will set the custom field value on the Company, and overwrite any existing value. Passing null as the value will clear it out.

Delete an existing Company by ID.

Warning: This is irreversible!

A specific custom email by id showcasing the custom email statistics such as unique open count, send count, bounce count, open rate, send rate, and bounce rate.

A list of all custom emails in Lawmatics.

Specific Custom Field metadata by ID

A paginated list of all Custom Field metadata in Lawmatics

Create a new Custom Field

Name: Custom Field's name

Type: One of Matter, Contact, Company, Client, or PracticeArea

Visibility (optional): starred, hidden, default (default)

field_type: One of integer, boolean, string, text, currency, date, time, datetime, list, lookup, multi_picklist

list_options: Required if field_type is list or multi_picklist, two options at minimum

lookup_type: Required if field_type is lookup. One of User, Contact, Company or Prospect

practice_area: Name of practice area. Required if type is PracticeArea

Update an existing Custom Field by ID.

attribute	notes
case_title
case_number	String (overrides auto-numbering)
case_blurb	(Case Description)
contact_id	Required unless `match_contact_by` is set
match_contact_by	Create Matter Field: Valid values: 'email', 'phone', 'name' (Will attempt to match contact by passed info)
actual_value_cents
estimated_value_cents
lead_cost_cents
source_id
campaign_id
referrer_id
sub_status_id
custom_fields	Array of \"id\" and \"value\" objects: [ { \"id\": \"6433\", \"value\": true }, { \"id\": \"6434\", \"value\": \"Contact String\" } ]
practice_area_id
stage_id
owned_by_id	User ID
created_by_id	User ID
salesperson_id	User ID
lead_attorney_id	User ID
originating_attorney_id	User ID
assigned_staff_ids	Array of User IDs
tags	Array of Strings (tag name)
street	Creates/Updates Address with 'Primary' Label
street2	Creates/Updates Address with 'Primary' Label
city	Creates/Updates Address with 'Primary' Label
state	Creates/Updates Address with 'Primary' Label
zipcode	Creates/Updates Address with 'Primary' Label
country	Creates/Updates Address with 'Primary' Label
email	Creates/Updates with 'Primary' Label
phone	Creates/Updates with 'Primary' Label
first_name
last_name
middle_name
citizenship
driver_license
name_suffix
informal_name
bio
title
birthdate
gender
timezone
occupation
employer
social_security
name_prefix
marital_status
hobbies
birthdate
custom_contact_type_id

CHANGELOG

03/04/2023 - 1.21.0

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

Form Components:

Supported Standard Field IDs:

Supported Matter Fields