openapi: 3.1.0 info: title: Lawmatics OAuth API version: 1.22.0 description: 'The official Lawmatics REST API for legal CRM, client intake and law firm automation. Manage matters (prospects), contacts, companies, custom forms and form entries, custom fields, events and appointments, tasks, notes, files, tags, users, time entries, expenses, invoices and transactions. Authentication is OAuth 2.0 authorization code grant; access tokens do not expire, there are no refresh tokens, and Lawmatics does not currently support scopes - an authorized app receives full CRUD access to the granted account. All list endpoints support the shared query-parameter grammar documented in the Param Guide: `fields` (field selection, one level deep, `fields=all` to expand), `page` (pagination), `sort_by`/`sort_order`, and `filter_by`/`filter_on`/`filter_with` (one filter at a time; operators `=`, `!=`, `<=`, `<`, `>=`, `>`, `like`, `ilike`, `null`, `not_null`). Responses follow a JSON:API-style `data` / `attributes` / `relationships` envelope.' contact: name: Lawmatics API Support email: api@lawmatics.com url: https://docs.lawmatics.com/ termsOfService: https://www.lawmatics.com/terms-of-use externalDocs: description: Official Lawmatics RESTful API documentation (Postman) url: https://docs.lawmatics.com/ servers: - url: https://api.lawmatics.com description: Lawmatics production API security: - oauth2: [] - bearerAuth: [] tags: - name: Addresses description: An Address belongs to a Firm, a Contact, or Company. - name: Collections - name: Contacts description: '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 be' - name: Companies - name: Custom Emails - name: Custom Fields - name: Custom Forms description: 'NOTE: Field IDs for fields that are not considered "Standard", such as General fields, and Custom fields, are referred to by special long-form uuids that are enumerated on the API details page of the Custom Form in Lawmatics. (E.g. https://app.lawmatics.com/custom-forms/:custom_form_id/api-details).' - name: Email Addresses description: A Email Address is contact information that belongs to a Firm, Contact, or Company. - name: Email Campaigns - name: Email Campaign Stats - name: Events (Appointments) description: Events are also referred to in the app as "Appointments" - name: Event Locations description: These are Firm related Locations (for events) that can be configured in Firm settings. - name: Event Types description: 'Event Types define Event defaults, and can trigger automations, for common types of Events created in Lawmatics. Configuring Calendar Availability defaults is not currently supported by the API. Go to Settings -> Event Settings to configure the Event Type in more detail.' - name: Files - name: Folders - name: Matters (Prospects) description: 'A Matter is a legal case, and the primary object in Lawmatics. NOTE: You may see Matters referenced as "Prospects" or "PNCs". This is for legacy reasons, and we are working to migrate away from these names internally. When creating a new Matter it will be in status PNC. This stands for Potential N' - name: Notes - name: Payment Invoices - name: Payment Expenses - name: Payment Time Entries - name: Payment Transactions - name: Phone Numbers description: A Phone Number is contact information that belongs to a Firm, Contact, or Company. - name: Tags - name: Tasks - name: Task Statuses - name: Timeline Activities - name: Users - name: Param Guide 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 Pa' paths: /v1/addresses/{address_id}: get: operationId: getAddress summary: Address description: A specific Stage by id tags: - Addresses parameters: - name: address_id in: path required: true description: The address id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getAddress: summary: GET Address value: data: id: '101' type: address attributes: label: Miami St street: 1234 Miami street2: null city: Miami state: FL zipcode: '12345' country: United States relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer put: operationId: updateAddress summary: Update Address description: Updates an Address by ID tags: - Addresses parameters: - name: address_id in: path required: true description: The address id schema: type: string requestBody: required: true content: application/json: schema: type: object example: label: Home street: 5555 Real Street street2: Apt 77 city: Real Town state: CA country: United States responses: '200': description: OK content: application/json: schema: type: object examples: putUpdateAddress: summary: PUT Update Address value: data: id: '122' type: address attributes: label: Home street: 5555 Real Street street2: Apt 77 city: Real Town state: CA zipcode: '92104' country: United States relationships: addressable: data: id: '1' type: contact '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: deleteAddress summary: Delete Address description: 'Delete an Address address_id: ID of the Address to delete' tags: - Addresses parameters: - name: address_id in: path required: true description: The address id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: deleteDeleteAddress: summary: DELETE Delete Address value: data: id: '122' type: address attributes: label: Home street: 5555 Real Street street2: Apt 77 city: Real Town state: CA zipcode: '92104' country: United States relationships: addressable: data: id: '1' type: contact '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/addresses: get: operationId: getAddresses summary: Addresses description: A paginated list of all Addresses in Lawmatics tags: - Addresses responses: '200': description: OK content: application/json: schema: type: object examples: getAddresses: summary: GET Addresses value: data: - id: '105' type: address attributes: label: Primary street: 1234 Fake Street street2: null city: null state: null zipcode: null country: null full_address: 1234 Fake Street full_street: 1234 Fake Street second_half: '' city_state_zip: '' created_at: '2022-03-29T22:03:55.343-07:00' updated_at: '2022-03-29T22:03:55.343-07:00' relationships: addressable: data: id: '127' type: contact locations: data: [] - id: '104' type: address attributes: label: test street: '' street2: null city: null state: null zipcode: null country: null full_address: '' full_street: '' second_half: '' city_state_zip: '' created_at: '2022-02-09T13:56:33.557-08:00' updated_at: '2022-02-09T13:56:33.557-08:00' relationships: addressable: data: id: '116' type: contact locations: data: [] - id: '103' type: address attributes: label: Primary street: '123' street2: null city: null state: null zipcode: null country: null full_address: '123' full_street: '123' second_half: '' city_state_zip: '' created_at: '2022-02-09T13:56:33.548-08:00' updated_at: '2022-02-09T13:56:33.548-08:00' relationships: addressable: data: id: '116' type: contact locations: data: [] - id: '102' type: address attributes: label: Primary street: 1234 fake street street2: suite 2 city: San Diego state: CA zipcode: '92104' country: United States full_address: 1234 fake street, suite 2, San Diego, CA 92104, United States full_street: 1234 fake street, suite 2 second_half: San Diego, CA 92104, United States city_state_zip: San Diego, CA 92104 created_at: '2021-11-08T14:06:20.224-08:00' updated_at: '2021-11-08T14:06:20.224-08:00' relationships: addressable: data: id: '2' type: firm locations: data: [] - id: '101' type: address attributes: label: Miami St street: 1234 Miami street2: null city: Miami state: FL zipcode: '12345' country: United States full_address: 1234 Miami, Miami, FL 12345, United States full_street: 1234 Miami second_half: Miami, FL 12345, United States city_state_zip: Miami, FL 12345 created_at: '2021-10-31T19:59:35.424-07:00' updated_at: '2021-10-31T19:59:35.424-07:00' relationships: addressable: data: id: '2' type: firm locations: data: - id: '1' type: location - id: '100' type: address attributes: label: Primary street: 99 Fake Rd street2: null city: City 1 state: CA zipcode: '90219' country: United States full_address: 99 Fake Rd, City 1, CA 90219, United States full_street: 99 Fake Rd second_half: City 1, CA 90219, United States city_state_zip: City 1, CA 90219 created_at: '2021-10-26T15:47:48.382-07:00' updated_at: '2021-10-26T15:47:48.382-07:00' relationships: addressable: data: id: '100' type: contact locations: data: [] - id: '99' type: address attributes: label: Primary street: 98 Fake Rd street2: null city: City 3 state: IL zipcode: '55126' country: United States full_address: 98 Fake Rd, City 3, IL 55126, United States full_street: 98 Fake Rd second_half: City 3, IL 55126, United States city_state_zip: City 3, IL 55126 created_at: '2021-10-26T15:47:48.119-07:00' updated_at: '2021-10-26T15:47:48.119-07:00' relationships: addressable: data: id: '99' type: contact locations: data: [] - id: '98' type: address attributes: label: Primary street: 97 Fake Rd street2: null city: City 2 state: IL zipcode: '60633' country: United States full_address: 97 Fake Rd, City 2, IL 60633, United States full_street: 97 Fake Rd second_half: City 2, IL 60633, United States city_state_zip: City 2, IL 60633 created_at: '2021-10-26T15:47:47.890-07:00' updated_at: '2021-10-26T15:47:47.890-07:00' relationships: addressable: data: id: '98' type: contact locations: data: [] - id: '97' type: address attributes: label: Primary street: 96 Fake Rd street2: null city: City 2 state: IL zipcode: '60633' country: United States full_address: 96 Fake Rd, City 2, IL 60633, United States full_street: 96 Fake Rd second_half: City 2, IL 60633, United States city_state_zip: City 2, IL 60633 created_at: '2021-10-26T15:47:47.639-07:00' updated_at: '2021-10-26T15:47:47.639-07:00' relationships: addressable: data: id: '97' type: contact locations: data: [] - id: '96' type: address attributes: label: Primary street: 95 Fake Rd street2: null city: City 3 state: CA zipcode: '55126' country: United States full_address: 95 Fake Rd, City 3, CA 55126, United States full_street: 95 Fake Rd second_half: City 3, CA 55126, United States city_state_zip: City 3, CA 55126 created_at: '2021-10-26T15:47:46.875-07:00' updated_at: '2021-10-26T15:47:46.875-07:00' relationships: addressable: data: id: '96' type: contact locations: data: [] - id: '95' type: address attributes: label: Primary street: 94 Fake Rd street2: null city: City 3 state: CA zipcode: '90219' country: United States full_address: 94 Fake Rd, City 3, CA 90219, United States full_street: 94 Fake Rd second_half: City 3, CA 90219, United States city_state_zip: City 3, CA 90219 created_at: '2021-10-26T15:47:46.595-07:00' updated_at: '2021-10-26T15:47:46.595-07:00' relationships: addressable: data: id: '95' type: contact locations: data: [] - id: '94' type: address attributes: label: Primary street: 93 Fake Rd street2: null city: City 3 state: CA zipcode: '55126' country: United States full_address: 93 Fake Rd, City 3, CA 55126, United States full_street: 93 Fake Rd second_half: City 3, CA 55126, United States city_state_zip: City 3, CA 55126 created_at: '2021-10-26T15:47:46.277-07:00' updated_at: '2021-10-26T15:47:46.277-07:00' relationships: addressable: data: id: '94' type: contact locations: data: [] - id: '93' type: address attributes: label: Primary street: 92 Fake Rd street2: null city: City 1 state: MN zipcode: '60633' country: United States full_address: 92 Fake Rd, City 1, MN 60633, United States full_street: 92 Fake Rd second_half: City 1, MN 60633, United States city_state_zip: City 1, MN 60633 created_at: '2021-10-26T15:47:45.923-07:00' updated_at: '2021-10-26T15:47:45.923-07:00' relationships: addressable: data: id: '93' type: contact locations: data: [] - id: '92' type: address attributes: label: Primary street: 91 Fake Rd street2: null city: City 1 state: MN zipcode: '60633' country: United States full_address: 91 Fake Rd, City 1, MN 60633, United States full_street: 91 Fake Rd second_half: City 1, MN 60633, United States city_state_zip: City 1, MN 60633 created_at: '2021-10-26T15:47:45.619-07:00' updated_at: '2021-10-26T15:47:45.619-07:00' relationships: addressable: data: id: '92' type: contact locations: data: [] - id: '91' type: address attributes: label: Primary street: 90 Fake Rd street2: null city: City 1 state: CA zipcode: '60633' country: United States full_address: 90 Fake Rd, City 1, CA 60633, United States full_street: 90 Fake Rd second_half: City 1, CA 60633, United States city_state_zip: City 1, CA 60633 created_at: '2021-10-26T15:47:44.989-07:00' updated_at: '2021-10-26T15:47:44.989-07:00' relationships: addressable: data: id: '91' type: contact locations: data: [] - id: '90' type: address attributes: label: Primary street: 89 Fake Rd street2: null city: City 1 state: MN zipcode: '60633' country: United States full_address: 89 Fake Rd, City 1, MN 60633, United States full_street: 89 Fake Rd second_half: City 1, MN 60633, United States city_state_zip: City 1, MN 60633 created_at: '2021-10-26T15:47:44.732-07:00' updated_at: '2021-10-26T15:47:44.732-07:00' relationships: addressable: data: id: '90' type: contact locations: data: [] - id: '89' type: address attributes: label: Primary street: 88 Fake Rd street2: null city: City 1 state: MN zipcode: '90219' country: United States full_address: 88 Fake Rd, City 1, MN 90219, United States full_street: 88 Fake Rd second_half: City 1, MN 90219, United States city_state_zip: City 1, MN 90219 created_at: '2021-10-26T15:47:44.432-07:00' updated_at: '2021-10-26T15:47:44.432-07:00' relationships: addressable: data: id: '89' type: contact locations: data: [] - id: '88' type: address attributes: label: Primary street: 87 Fake Rd street2: null city: City 1 state: MN zipcode: '55126' country: United States full_address: 87 Fake Rd, City 1, MN 55126, United States full_street: 87 Fake Rd second_half: City 1, MN 55126, United States city_state_zip: City 1, MN 55126 created_at: '2021-10-26T15:47:44.158-07:00' updated_at: '2021-10-26T15:47:44.158-07:00' relationships: addressable: data: id: '88' type: contact locations: data: [] - id: '87' type: address attributes: label: Primary street: 86 Fake Rd street2: null city: City 3 state: MN zipcode: '60633' country: United States full_address: 86 Fake Rd, City 3, MN 60633, United States full_street: 86 Fake Rd second_half: City 3, MN 60633, United States city_state_zip: City 3, MN 60633 created_at: '2021-10-26T15:47:43.410-07:00' updated_at: '2021-10-26T15:47:43.410-07:00' relationships: addressable: data: id: '87' type: contact locations: data: [] - id: '86' type: address attributes: label: Primary street: 85 Fake Rd street2: null city: City 1 state: MN zipcode: '90219' country: United States full_address: 85 Fake Rd, City 1, MN 90219, United States full_street: 85 Fake Rd second_half: City 1, MN 90219, United States city_state_zip: City 1, MN 90219 created_at: '2021-10-26T15:47:43.068-07:00' updated_at: '2021-10-26T15:47:43.068-07:00' relationships: addressable: data: id: '86' type: contact locations: data: [] - id: '85' type: address attributes: label: Primary street: 84 Fake Rd street2: null city: City 3 state: IL zipcode: '55126' country: United States full_address: 84 Fake Rd, City 3, IL 55126, United States full_street: 84 Fake Rd second_half: City 3, IL 55126, United States city_state_zip: City 3, IL 55126 created_at: '2021-10-26T15:47:42.519-07:00' updated_at: '2021-10-26T15:47:42.519-07:00' relationships: addressable: data: id: '85' type: contact locations: data: [] - id: '84' type: address attributes: label: Primary street: 83 Fake Rd street2: null city: City 3 state: CA zipcode: '90219' country: United States full_address: 83 Fake Rd, City 3, CA 90219, United States full_street: 83 Fake Rd second_half: City 3, CA 90219, United States city_state_zip: City 3, CA 90219 created_at: '2021-10-26T15:47:42.294-07:00' updated_at: '2021-10-26T15:47:42.294-07:00' relationships: addressable: data: id: '84' type: contact locations: data: [] - id: '83' type: address attributes: label: Primary street: 82 Fake Rd street2: null city: City 3 state: MN zipcode: '55126' country: United States full_address: 82 Fake Rd, City 3, MN 55126, United States full_street: 82 Fake Rd second_half: City 3, MN 55126, United States city_state_zip: City 3, MN 55126 created_at: '2021-10-26T15:47:42.069-07:00' updated_at: '2021-10-26T15:47:42.069-07:00' relationships: addressable: data: id: '83' type: contact locations: data: [] - id: '82' type: address attributes: label: Primary street: 81 Fake Rd street2: null city: City 3 state: CA zipcode: '60633' country: United States full_address: 81 Fake Rd, City 3, CA 60633, United States full_street: 81 Fake Rd second_half: City 3, CA 60633, United States city_state_zip: City 3, CA 60633 created_at: '2021-10-26T15:47:41.832-07:00' updated_at: '2021-10-26T15:47:41.832-07:00' relationships: addressable: data: id: '82' type: contact locations: data: [] - id: '81' type: address attributes: label: Primary street: 80 Fake Rd street2: null city: City 3 state: CA zipcode: '60633' country: United States full_address: 80 Fake Rd, City 3, CA 60633, United States full_street: 80 Fake Rd second_half: City 3, CA 60633, United States city_state_zip: City 3, CA 60633 created_at: '2021-10-26T15:47:41.082-07:00' updated_at: '2021-10-26T15:47:41.082-07:00' relationships: addressable: data: id: '81' type: contact locations: data: [] meta: total_pages: 5 limit_per_page: 25 total_entries: 105 links: self: /v1/addresses?page=1 next: /v1/addresses?page=2 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createAddress summary: Create Address 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.' tags: - Addresses parameters: - name: fields in: query required: false schema: type: string example: all requestBody: required: true content: application/json: schema: type: object example: label: Home street: 1234 Fake Street street2: Apt 1 city: Fake Town state: CA zipcode: '92104' addressable_type: Firm responses: '201': description: Created content: application/json: schema: type: object examples: postCreateAddress: summary: POST Create Address value: data: id: '122' type: address attributes: label: Primary street: 1234 Fake Street street2: Apt 1 city: Fake Town state: CA zipcode: '92104' country: null full_address: 1234 Fake Street, Apt 1, Fake Town, CA 92104 full_street: 1234 Fake Street, Apt 1 second_half: Fake Town, CA 92104 city_state_zip: Fake Town, CA 92104 created_at: '2022-06-25T18:22:46.177-07:00' updated_at: '2022-06-25T18:22:46.177-07:00' relationships: addressable: data: id: '1' type: contact locations: data: [] '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/collections: get: operationId: getCollections summary: Collections description: 'Retrieves a 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 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: 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 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' tags: - Collections responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: collections: summary: Collections value: data: - id: '6' type: collection attributes: name: Test custom_fields: - id: '306' name: MultiTest field_type: multi_picklist visibility: default type: Collection list_options: - id: '56' name: One - id: '57' name: Two - id: '58' name: Three created_at: '2026-05-27T15:09:15.359-07:00' updated_at: '2026-05-27T15:09:15.359-07:00' created_at: '2026-05-27T15:09:15.354-07:00' updated_at: '2026-05-27T15:09:15.354-07:00' - id: '5' type: collection attributes: name: Bank Accounts custom_fields: - id: '305' name: Type field_type: list visibility: default type: Collection list_options: - id: '54' name: Checking - id: '55' name: Savings created_at: '2026-05-27T14:52:05.096-07:00' updated_at: '2026-05-27T14:52:05.096-07:00' - id: '304' name: Balance field_type: currency visibility: default type: Collection created_at: '2026-05-27T14:52:05.090-07:00' updated_at: '2026-05-27T14:52:05.090-07:00' - id: '303' name: Name field_type: text visibility: default type: Collection created_at: '2026-05-27T14:52:05.057-07:00' updated_at: '2026-05-27T14:52:05.057-07:00' created_at: '2026-05-27T14:52:05.019-07:00' updated_at: '2026-05-27T14:52:05.019-07:00' - id: '2' type: collection attributes: name: Albums custom_fields: - id: '299' name: Artist Name field_type: text visibility: default type: Collection created_at: '2026-05-26T16:10:41.056-07:00' updated_at: '2026-05-26T16:10:41.056-07:00' - id: '298' name: Name field_type: text visibility: default type: Collection created_at: '2026-05-26T16:09:11.640-07:00' updated_at: '2026-05-26T16:11:14.439-07:00' created_at: '2026-05-26T16:09:11.630-07:00' updated_at: '2026-05-26T16:09:11.630-07:00' - id: '1' type: collection attributes: name: Movies custom_fields: - id: '295' name: Name field_type: string visibility: default type: Collection created_at: '2026-05-26T13:09:49.162-07:00' updated_at: '2026-05-26T13:09:49.162-07:00' - id: '296' name: Director field_type: string visibility: default type: Collection created_at: '2026-05-26T13:09:49.168-07:00' updated_at: '2026-05-26T13:09:49.168-07:00' - id: '297' name: Genre field_type: list visibility: default type: Collection list_options: - id: '49' name: Horror - id: '50' name: Romance - id: '51' name: Action - id: '52' name: Comedy - id: '53' name: Drama created_at: '2026-05-26T13:09:49.192-07:00' updated_at: '2026-05-26T13:09:49.192-07:00' created_at: '2026-05-26T13:09:49.160-07:00' updated_at: '2026-05-26T13:09:49.160-07:00' meta: total_pages: 1 limit_per_page: 25 total_entries: 4 links: self: /v1/collections?page=1 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createCollection summary: Create Collection description: 'Creates a new Collection in Lawmatics. Collections are used to group and organize records (such as contacts or matters) with custom fields tailored to your needs. Request Body The request body must be a JSON object with the following fields: Field Type Required Description name string Yes The name of the collection to create. custom_fields array No 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: 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 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 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.' tags: - Collections requestBody: required: true content: application/json: schema: type: object example: name: Bank Accounts custom_fields: - name: Name field_type: text - name: Balance field_type: currency - name: Type field_type: list list_options: - name: Checking - name: Savings responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: createCollection: summary: Create Collection value: data: id: '7' type: collection attributes: name: Bank Accounts custom_fields: - id: '307' name: Name field_type: text visibility: default type: Collection created_at: '2026-05-28T11:10:33.113-07:00' updated_at: '2026-05-28T11:10:33.113-07:00' - id: '308' name: Balance field_type: currency visibility: default type: Collection created_at: '2026-05-28T11:10:33.236-07:00' updated_at: '2026-05-28T11:10:33.236-07:00' - id: '309' name: Type field_type: list visibility: default type: Collection list_options: - id: '59' name: Checking - id: '60' name: Savings created_at: '2026-05-28T11:10:33.249-07:00' updated_at: '2026-05-28T11:10:33.249-07:00' created_at: '2026-05-28T11:10:33.109-07:00' updated_at: '2026-05-28T11:10:33.109-07:00' '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/collections/{collection_id}: get: operationId: getCollection summary: Collection description: 'Retrieves a single Collection by its ID. Path Variables Variable Description collection_id The unique identifier of the collection to retrieve. Response Returns a data object representing the collection with the following attributes: 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 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.' tags: - Collections parameters: - name: collection_id in: path required: true description: The collection id schema: type: string responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: collection: summary: Collection value: data: id: '5' type: collection attributes: name: Bank Accounts custom_fields: - id: '305' name: Type field_type: list visibility: default type: Collection list_options: - id: '54' name: Checking - id: '55' name: Savings created_at: '2026-05-27T14:52:05.096-07:00' updated_at: '2026-05-27T14:52:05.096-07:00' - id: '304' name: Balance field_type: currency visibility: default type: Collection created_at: '2026-05-27T14:52:05.090-07:00' updated_at: '2026-05-27T14:52:05.090-07:00' - id: '303' name: Name field_type: text visibility: default type: Collection created_at: '2026-05-27T14:52:05.057-07:00' updated_at: '2026-05-27T14:52:05.057-07:00' created_at: '2026-05-27T14:52:05.019-07:00' updated_at: '2026-05-27T14:52:05.019-07:00' '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer put: operationId: updateCollection summary: Update Collection description: 'Updates an existing collection by its ID. This endpoint allows you to modify the collection''s associated custom fields. URL Parameters 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: Field Type Required Description custom_fields array of objects Yes List of custom fields to associate with the collection. custom_fields Object Properties 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").' tags: - Collections parameters: - name: collection_id in: path required: true description: The collection id schema: type: string requestBody: required: true content: application/json: schema: type: object example: custom_fields: - id: '{{collection_custom_field_id}}' name: Account Balance responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: updateCollection: summary: Update Collection value: data: id: '7' type: collection attributes: name: Bank Accounts custom_fields: - id: '309' name: Type field_type: list visibility: default type: Collection list_options: - id: '59' name: Checking - id: '60' name: Savings created_at: '2026-05-28T11:10:33.249-07:00' updated_at: '2026-05-28T11:10:33.249-07:00' - id: '308' name: Account Balance field_type: currency visibility: default type: Collection created_at: '2026-05-28T11:10:33.236-07:00' updated_at: '2026-05-28T11:12:08.285-07:00' - id: '307' name: Name field_type: text visibility: default type: Collection created_at: '2026-05-28T11:10:33.113-07:00' updated_at: '2026-05-28T11:10:33.113-07:00' created_at: '2026-05-28T11:10:33.109-07:00' updated_at: '2026-05-28T11:10:33.109-07:00' '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: deleteCollection summary: Delete Collection description: 'Deletes an existing collection by its ID. Path Variables 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. - type – Resource type (collection). - attributes – Collection attributes: - name – Name of the collection. - custom_fields – Array of custom fields associated with the collection. - created_at – Timestamp when the collection was created. - updated_at – Timestamp when the collection was last updated.' tags: - Collections parameters: - name: collection_id in: path required: true description: The collection id schema: type: string responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: deleteCollection: summary: Delete Collection value: data: id: '5' type: collection attributes: name: Bank Accounts custom_fields: [] created_at: '2026-05-27T14:52:05.019-07:00' updated_at: '2026-05-28T11:10:19.399-07:00' '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/collection_items: get: operationId: getCollectionItems summary: 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. - type – Resource type (collection_item). - attributes – Collection item attributes: - collection_id – The ID of the parent collection. - contactable_type – The type of the associated record (e.g., Prospect, Contact). - contactable_id – The ID of the associated record. - custom_field_values – Array of custom field values for this item. - created_at – Timestamp when the item was created. - updated_at – Timestamp when the item was last updated.' tags: - Collections responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: collectionItems: summary: Collection Items value: data: - id: '1' type: collection_item attributes: collection_id: 3 contactable_type: Prospect contactable_id: 184 custom_field_values: - id: '235' custom_field_id: '302' name: Name field_type: text value: The Matrix formatted_value: The Matrix created_at: '2026-05-29T16:02:51.434-07:00' updated_at: '2026-05-29T16:02:51.482-07:00' meta: total_pages: 1 limit_per_page: 25 total_entries: 1 links: self: /v1/collection_items?page=1 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createCollectionItem summary: Create Collection Item description: "Creates a new collection item, associating a contact or matter record with a collection\ \ and optionally setting custom field values.\n\nRequest Body\n\nField\nType\nRequired\nDescription\n\ \ncontactable_type\nstring\nYes\nThe type of the associated record. Accepted values: Prospect,\ \ Contact.\n\ncontactable_id\ninteger\nYes\nThe ID of the associated record.\n\ncollection_id\n\ integer\nYes\nThe ID of the collection to add the item to.\n\ncustom_field_values\narray\nNo\n\ Array of custom field value objects to set on the item.\n\ncustom_field_values Object\n\nField\n\ Type\nDescription\n\nid\ninteger\nThe ID of the custom field.\n\nvalue\nstring\nThe value to set\ \ for the custom field.\n\nExample Request Body\n{\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\nReturns a 201 Created with the newly created collection item object under data." tags: - Collections responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: createCollectionItem: summary: Create Collection Item value: data: id: '4' type: collection_item attributes: collection_id: 1 contactable_type: Prospect contactable_id: 185 custom_field_values: - id: '240' custom_field_id: '295' name: Name field_type: string value: The Matrix formatted_value: The Matrix - id: '241' custom_field_id: '296' name: Director field_type: string value: '1999-03-31' formatted_value: '1999-03-31' created_at: '2026-05-28T11:07:47.114-07:00' updated_at: '2026-05-28T11:07:47.172-07:00' '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/collection_items/{collection_item_id}: get: operationId: getCollectionItem summary: Collection Item description: 'Returns a single collection item by its ID. Path Variables 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. - type – Resource type (collection_item). - attributes – Collection item attributes: - collection_id – The ID of the parent collection. - contactable_type – The type of the associated record (e.g., Prospect, Contact). - contactable_id – The ID of the associated record. - custom_field_values – Array of custom field values for this item. - created_at – Timestamp when the item was created. - updated_at – Timestamp when the item was last updated.' tags: - Collections parameters: - name: collection_item_id in: path required: true description: The collection item id schema: type: string responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: collectionItem: summary: Collection Item value: data: id: '1' type: collection_item attributes: collection_id: 3 contactable_type: Prospect contactable_id: 184 custom_field_values: - id: '235' custom_field_id: '302' name: Name field_type: text value: The Matrix formatted_value: The Matrix created_at: '2026-05-29T16:02:51.434-07:00' updated_at: '2026-05-29T16:02:51.482-07:00' '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer put: operationId: updateCollectionItem summary: Update Collection Item description: 'Updates an existing collection item''s custom field values. Path Variables Variable Description collection_item_id The unique identifier of the collection item to update. Request Body Field Type Required Description custom_field_values array Yes Array of custom field value objects to update on the item. custom_field_values Object 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.' tags: - Collections parameters: - name: collection_item_id in: path required: true description: The collection item id schema: type: string requestBody: required: true content: application/json: schema: type: object example: custom_field_values: - id: '{{custom_field_id}}' value: Wachowski Sisters responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: updateCollectionItem: summary: Update Collection Item value: data: id: '3' type: collection_item attributes: collection_id: 1 contactable_type: Prospect contactable_id: 185 custom_field_values: - id: '238' custom_field_id: '295' name: Name field_type: string value: The Matrix formatted_value: The Matrix - id: '239' custom_field_id: '296' name: Director field_type: string value: Wachowski Sisters formatted_value: Wachowski Sisters created_at: '2026-05-26T16:33:22.565-07:00' updated_at: '2026-05-26T16:39:00.126-07:00' '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: deleteCollectionItem summary: Delete Collection Item description: 'Deletes an existing collection item by its ID. Path Variables 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. - type – Resource type (collection_item). - attributes – Collection item attributes: - collection_id – The ID of the parent collection. - contactable_type – The type of the associated record. - contactable_id – The ID of the associated record. - custom_field_values – Array of custom field values associated with the item. - created_at – Timestamp when the item was created. - updated_at – Timestamp when the item was last updated.' tags: - Collections parameters: - name: collection_item_id in: path required: true description: The collection item id schema: type: string responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: deleteCollectionItem: summary: Delete Collection Item value: data: id: '3' type: collection_item attributes: collection_id: 1 contactable_type: Prospect contactable_id: 185 custom_field_values: [] created_at: '2026-05-26T16:33:22.565-07:00' updated_at: '2026-05-28T11:08:51.118-07:00' '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/contacts/find_by_phone/{phone_number}: get: operationId: findContactByPhoneNumber summary: Find Contact By Phone Number description: Fuzzy find a specific Contact by Phone Number. tags: - Contacts parameters: - name: phone_number in: path required: true description: The phone number schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getFindContactByPhoneNumber: summary: GET Find Contact By Phone Number value: data: id: '31556' type: contact attributes: first_name: test last_name: test email: test@nice.com phone: 123-123-1234 created_at: '2018-09-06T19:17:17.786-07:00' updated_at: '2018-09-10T16:31:58.836-07:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/contacts/find_by_email/{email_address}: get: operationId: findContactByEmailAddress summary: Find Contact By Email Address description: Fuzzy find a specific Contact by Email Address. tags: - Contacts parameters: - name: email_address in: path required: true description: The email address schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getFindContactByEmailAddress: summary: GET Find Contact By Email Address value: data: id: '225' type: contact attributes: first_name: Existing last_name: Contact email: roey@lawmatics.com phone: 520-730-1042 created_at: '2018-07-17T10:32:50.009-07:00' updated_at: '2019-03-28T20:17:41.198-07:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/contacts/find_by_name/{name}: get: operationId: findContactByName summary: Find Contact By Name description: Fuzzy find (case-insensitive) a specific Contact by their Name. You can pass either '{first_name} {last_name}' or simply '{first_name}' tags: - Contacts parameters: - name: name in: path required: true description: The name schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getFindContactByName: summary: GET Find Contact By Name value: data: id: '76746' type: contact attributes: first_name: Roey last_name: Chasman email: null phone: null created_at: '2019-02-04T12:38:11.574-08:00' updated_at: '2019-02-04T12:38:11.574-08:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/custom_contact_types/{custom_contact_type_id}: get: operationId: getCustomContactType summary: Custom Contact Type description: A specific Custom Contact Type by ID tags: - Contacts parameters: - name: custom_contact_type_id in: path required: true description: The custom contact type id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getCustomContactType: summary: GET Custom Contact Type value: data: id: '15' type: custom_contact_type attributes: name: Judge created_at: '2023-09-21T15:52:24.996-07:00' updated_at: '2023-09-21T15:52:24.996-07:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: deleteCustomContactType summary: Delete Custom Contact Type description: 'Delete an existing Custom Contact Type by ID. Warning: This is irreversible!' tags: - Contacts parameters: - name: custom_contact_type_id in: path required: true description: The custom contact type id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: deleteDeleteCustomContactType: summary: DELETE Delete Custom Contact Type value: data: id: '15' type: custom_contact_type attributes: name: Pudge created_at: '2023-09-21T15:49:44.773-07:00' updated_at: '2023-09-21T15:52:02.257-07:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/custom_contact_types: get: operationId: getCustomContactTypes summary: Custom Contact Types description: A paginated list of all Custom Contact Type in Lawmatics tags: - Contacts responses: '200': description: OK content: application/json: schema: type: object examples: getCustomContactTypes: summary: GET Custom Contact Types value: data: - id: '15' type: custom_contact_type attributes: name: Judge created_at: '2023-09-21T15:31:26.656-07:00' updated_at: '2023-09-21T15:31:26.656-07:00' relationships: {} - id: '12' type: custom_contact_type attributes: name: test2 created_at: '2023-09-21T11:00:26.002-07:00' updated_at: '2023-09-21T11:00:26.002-07:00' relationships: {} - id: '10' type: custom_contact_type attributes: name: test created_at: '2023-09-05T10:50:34.586-07:00' updated_at: '2023-09-21T11:00:04.446-07:00' relationships: {} - id: '7' type: custom_contact_type attributes: name: Cool Person created_at: '2023-08-10T21:13:53.027-07:00' updated_at: '2023-08-10T21:13:53.027-07:00' relationships: {} - id: '2' type: custom_contact_type attributes: name: Client created_at: '2023-07-21T14:56:35.146-07:00' updated_at: '2023-07-21T14:56:35.146-07:00' relationships: {} meta: total_pages: 1 limit_per_page: 25 total_entries: 5 links: self: /v1/custom_contact_types?page=1 getFilteredCustomContactTypes: summary: GET Filtered Custom Contact Types value: data: - id: '15' type: custom_contact_type attributes: name: Judge created_at: '2023-09-21T15:31:26.656-07:00' updated_at: '2023-09-21T15:31:26.656-07:00' relationships: {} meta: total_pages: 1 limit_per_page: 25 total_entries: 1 links: self: /v1/custom_contact_types?page=1 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createCustomContactType summary: Create Custom Contact Type description: Create a new Custom Contact Type tags: - Contacts requestBody: required: true content: application/json: schema: type: object example: name: Judge-6f3bc6c0-98c7-4473-be46-62976e472353 responses: '201': description: Created content: application/json: schema: type: object examples: postCreateCustomContactType: summary: POST Create Custom Contact Type value: data: id: '15' type: custom_contact_type attributes: name: Judge created_at: '2023-09-21T15:49:44.773-07:00' updated_at: '2023-09-21T15:49:44.773-07:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/custom_contact_types/{contact_id}: put: operationId: updateCustomContactType summary: Update Custom Contact Type description: Update an existing Custom Contact Type by ID. tags: - Contacts parameters: - name: contact_id in: path required: true description: The contact id schema: type: string requestBody: required: true content: application/json: schema: type: object example: name: Pudge responses: '200': description: OK content: application/json: schema: type: object examples: putPATCHUpdateCustomContactType: summary: PUT/PATCH Update Custom Contact Type value: data: id: '15' type: custom_contact_type attributes: name: Pudge created_at: '2023-09-21T11:00:26.002-07:00' updated_at: '2023-09-21T15:43:39.161-07:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/contacts/{contact_id}: get: operationId: getContact summary: Contact description: A specific Contact by id tags: - Contacts parameters: - name: contact_id in: path required: true description: The contact id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getContact: summary: GET Contact value: data: id: '25' type: contact attributes: first_name: Gregor last_name: Clegane email: gregor@clegane.com email_address: gregor@clegane.com phone: null phone_number: null birthdate: null name_prefix: null middle_name: null name_suffix: null informal_name: null employer: null occupation: null citizenship: null bio: null title: null hobbies: null social_security: null age: null driver_license: null gender: null marital_status: null timezone: null tracking_source_id: null date_of_last_contact: '2018-03-07T13:38:58.288-08:00' days_since_last_contact: 223 photo_url: https://lm.lawmatics.com/attachments/0f060d4bbd3d8a2488c3f0b3352ce3ec0c9b6f3c/store/a49240eaa2d0bb7355b82b010b07a2c8f72c4d514b70616198d522266d48/photo custom_fields: [] contact_type: PNC created_at: '2018-03-07T13:38:58.288-08:00' updated_at: '2018-03-13T08:09:50.696-07:00' relationships: prospects: data: - id: '21' type: prospect created_by: data: id: '15' type: user client: data: null company: data: null '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer put: operationId: updateContact summary: Update Contact description: '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.' tags: - Contacts parameters: - name: contact_id in: path required: true description: The contact id schema: type: string requestBody: required: true content: application/json: schema: type: object example: first_name: Lawmatics last_name: ExampleChanged email: roey+changed@lawmatics.com phone: 555-555-5555 notes: - name: Cool Note body: This is a long form sweet new note responses: '200': description: OK content: application/json: schema: type: object examples: putPATCHUpdateContact: summary: PUT/PATCH Update Contact value: data: id: '161260' type: contact attributes: first_name: Lawmatics last_name: ExampleChanged email: roey+changed@lawmatics.com custom_fields: - id: 4788 name: text field_type: string value: Changed String formatted_value: Changed String - id: 4788 name: text field_type: string value: Changed String formatted_value: Changed String relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: deleteContact summary: Delete Contact description: 'Delete an existing Contact by ID. Warning: This is irreversible!' tags: - Contacts parameters: - name: contact_id in: path required: true description: The contact id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: deleteDeleteContact: summary: DELETE Delete Contact value: data: id: '161260' type: contact attributes: first_name: Lawmatics last_name: ExampleChanged email: null phone: null created_at: '2021-08-27T15:36:02.920-07:00' updated_at: '2021-08-27T15:40:57.045-07:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/contacts: get: operationId: getContacts summary: Contacts description: A paginated list of all Contacts in Lawmatics tags: - Contacts responses: '200': description: OK content: application/json: schema: type: object examples: getContacts: summary: GET Contacts value: 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 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createContact summary: Create Contact description: Create a new Contact tags: - Contacts requestBody: required: true content: application/json: schema: type: object example: first_name: Lawmatics last_name: Example email: fake@lawmatics.com phone: 123-123-1234 notes: - name: Example Note 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. responses: '201': description: Created content: application/json: schema: type: object examples: postCreateContact: summary: POST Create Contact value: data: id: '161257' type: contact attributes: first_name: Lawmatics last_name: Example email: roey@lawmatics.com phone: 123-123-1234 custom_fields: - id: 4788 name: text field_type: string value: Contact String formatted_value: Contact String - id: 4788 name: text field_type: string value: Contact String formatted_value: Contact String relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/companies/find_by_phone/{phone_number}: get: operationId: findCompanyByPhoneNumber summary: Find Company By 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. tags: - Companies parameters: - name: phone_number in: path required: true description: Any valid phone number. We strip all non digits when matching, and try with and without the leading 1 for US country codes. schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getFindCompanyByPhoneNumber: summary: GET Find Company By Phone Number value: data: id: '1' type: company attributes: name: Lawmatics email: roey+lame@lawmatics.com address: null city: null state: null zipcode: null country: null addresses: [] phone_number: (707) 986-0756 created_at: '2023-07-24T17:49:13.738-07:00' updated_at: '2023-07-28T15:00:40.321-07:00' relationships: addresses: data: [] emails: data: [] created_by: data: id: '1' type: user '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/companies/find_by_email/{email_address}: get: operationId: findCompanyByEmailAddress summary: Find Company By 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. tags: - Companies parameters: - name: email_address in: path required: true description: A valid email address schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getFindCompanyByEmailAddress: summary: GET Find Company By Email Address value: data: id: '2' type: company attributes: name: Nike email: roey+lame@lawmatics.com address: 4250 Executive Square, Suite 101, La Jolla, CA 92130, United States city: La Jolla state: CA zipcode: '92130' country: United States addresses: - id: 2 street: 4250 Executive Square street2: Suite 101 city: La Jolla state: CA zipcode: '92130' country: United States created_at: '2023-08-23T16:16:49.043-07:00' updated_at: '2023-08-23T16:16:49.043-07:00' label: Primary addressable_type: Company addressable_id: 2 firm_id: 2 deleted_at: null phone_number: (707) 986-0756 created_at: '2023-08-23T16:16:48.974-07:00' updated_at: '2023-09-15T15:14:25.499-07:00' relationships: addresses: data: - id: '2' type: address emails: data: - id: '3' type: email_address created_by: data: id: '1' type: user '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/companies/find_by_name/{name}: get: operationId: findCompanyByName summary: Find Company By Name description: Fuzzy find (case-insensitive) a specific Company by Name tags: - Companies parameters: - name: name in: path required: true description: We return the closest match. schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getFindCompanyByName: summary: GET Find Company By Name value: data: id: '2' type: company attributes: name: Nike email: roey+lame@lawmatics.com address: 4250 Executive Square, Suite 101, La Jolla, CA 92130, United States city: La Jolla state: CA zipcode: '92130' country: United States addresses: - id: 2 street: 4250 Executive Square street2: Suite 101 city: La Jolla state: CA zipcode: '92130' country: United States created_at: '2023-08-23T16:16:49.043-07:00' updated_at: '2023-08-23T16:16:49.043-07:00' label: Primary addressable_type: Company addressable_id: 2 firm_id: 2 deleted_at: null phone_number: (707) 986-0756 created_at: '2023-08-23T16:16:48.974-07:00' updated_at: '2023-09-15T15:14:25.499-07:00' relationships: addresses: data: - id: '2' type: address emails: data: - id: '3' type: email_address created_by: data: id: '1' type: user '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/companies/{company_id}: get: operationId: getCompany summary: Company description: A specific Company by id tags: - Companies parameters: - name: company_id in: path required: true description: The company id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getCompany: summary: GET Company value: data: id: '2' type: company attributes: name: Company 3 email: company@limited.com address: Street Av, New York, NY 123456, United States city: New York state: NY zipcode: '123456' country: United States addresses: - id: 133 street: Street Av street2: null city: New York state: NY zipcode: '123456' country: United States created_at: '2022-08-11T11:29:33.157-07:00' updated_at: '2022-08-11T11:29:33.157-07:00' label: Primary addressable_type: Company addressable_id: 2 firm_id: 2 deleted_at: null phone_number: 555 555 555 created_at: '2022-07-28T08:46:47.470-07:00' updated_at: '2022-08-11T11:29:33.529-07:00' relationships: created_by: data: id: '23' type: user '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer put: operationId: updateCompany summary: Update Company description: '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.' tags: - Companies parameters: - name: company_id in: path required: true description: The company id schema: type: string requestBody: required: true content: application/json: schema: type: object example: name: Lawmatics Company email: primary_email_2@lawmatics.com emails_attributes: - info: jasmine+3@lawmatics.com - label: Home info: jasmine+4@lawmatics.com phone: 800-555-4321 phone_numbers_attributes: - info: 916-235-5678 - label: Home info: 916-234-5674 street: 100 Black Water street2: Street city: San Diego state: CA country: United States zipcode: '55123' addresses_attributes: - label: test street: 7190 White Water street2: Way city: Sacramento state: CA country: United States zipcode: '23422' responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: putPATCHUpdateCompany: summary: PUT/PATCH Update Company value: data: id: '28' type: company attributes: name: Lawmatics Company email: david1@example.com address: 128 White Water, Way, Elk Grove, CA 23422, United States city: Elk Grove state: CA zipcode: '23422' country: United States addresses: - addressable_id: 28 label: test city: Sacramento country: United States state: CA street: 7190 White Water street2: Way zipcode: '23422' addressable_type: Company firm_id: 2 id: 267 created_at: '2022-08-23T16:51:11.778-07:00' updated_at: '2022-08-23T17:03:08.444-07:00' deleted_at: null - id: 266 street: 128 White Water street2: Way city: Elk Grove state: CA zipcode: '23422' country: United States created_at: '2022-08-23T16:51:11.769-07:00' updated_at: '2022-08-23T16:51:11.769-07:00' label: Primary addressable_type: Company addressable_id: 28 firm_id: 2 deleted_at: null phone_number: 619-555-2855 created_at: '2022-08-23T16:51:11.755-07:00' updated_at: '2022-08-23T17:03:08.856-07:00' relationships: created_by: data: id: '2' type: user '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: deleteCompany summary: Delete Company description: 'Delete an existing Company by ID. Warning: This is irreversible!' tags: - Companies parameters: - name: company_id in: path required: true description: The company id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: deleteCompany: summary: Delete Company value: data: id: '27' type: company attributes: name: Lawmatics Company email: david1@example.com address: null city: null state: null zipcode: null country: null addresses: [] phone_number: 619-555-2855 created_at: '2022-08-23T15:38:24.009-07:00' updated_at: '2022-08-23T16:50:37.867-07:00' relationships: created_by: data: id: '2' type: user '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/companies: get: operationId: getCompanies summary: Companies description: A paginated list of all Companies in Lawmatics tags: - Companies responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: getCompanies: summary: GET Companies value: data: - id: '7' type: company attributes: name: Lawmatics Company email: jasmine+1@lawmatics.com address: 128 White Water, Way, Elk Grove, CA 23422, United States city: Elk Grove state: CA zipcode: '23422' country: United States addresses: - id: 129 street: 128 White Water street2: Way city: Elk Grove state: CA zipcode: '23422' country: United States created_at: '2022-09-01T14:43:10.307-07:00' updated_at: '2022-09-01T14:43:10.307-07:00' label: Primary addressable_type: Company addressable_id: 7 firm_id: 1 deleted_at: null - id: 130 street: 7190 White Water street2: Way city: Sacramento state: CA zipcode: '23422' country: United States created_at: '2022-09-01T14:43:10.319-07:00' updated_at: '2022-09-01T14:43:10.319-07:00' label: Home addressable_type: Company addressable_id: 7 firm_id: 1 deleted_at: null phone_number: 916-235-5678 created_at: '2022-09-01T14:43:10.254-07:00' updated_at: '2022-09-01T15:53:10.038-07:00' relationships: created_by: data: id: '1' type: user - id: '2' type: company attributes: name: Client Company email: client@example.com address: 879 F St, Newman, CA 30291, United States city: Newman state: CA zipcode: '30291' country: United States addresses: - id: 137 street: 879 F St street2: null city: Newman state: CA zipcode: '30291' country: United States created_at: '2022-09-07T10:26:46.349-07:00' updated_at: '2022-09-07T10:26:46.349-07:00' label: Primary addressable_type: Company addressable_id: 2 firm_id: 1 deleted_at: null phone_number: '5551235432' created_at: '2022-07-29T11:12:33.207-07:00' updated_at: '2022-09-07T10:26:46.421-07:00' relationships: created_by: data: id: '1' type: user meta: total_pages: 1 limit_per_page: 25 total_entries: 2 links: self: /v1/companies?page=1 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createCompany summary: Create Company description: Create a new Company tags: - Companies parameters: - name: fields in: query required: false schema: type: string example: all requestBody: required: true content: application/json: schema: type: object example: name: Lawmatics Company email: primary_email@lawmatics.com emails_attributes: - info: jasmine+1@lawmatics.com - label: Home info: jasmine+2@lawmatics.com phone: 800-555-1234 phone_numbers_attributes: - info: 916-235-5678 - label: Home info: 916-234-5677 street: 999 Black Water street2: Road city: San Diego state: CA country: United States zipcode: '99999' addresses_attributes: - street: 128 White Water street2: Way city: Elk Grove state: CA country: United States zipcode: '23422' - label: Home street: 7190 White Water street2: Way city: Sacramento state: CA country: United States zipcode: '23422' responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: postCreateCompany: summary: POST Create Company value: data: id: '28' type: company attributes: name: Lawmatics Company email: david1@example.com address: 128 White Water, Way, Elk Grove, CA 23422, United States city: Elk Grove state: CA zipcode: '23422' country: United States addresses: - id: 266 street: 128 White Water street2: Way city: Elk Grove state: CA zipcode: '23422' country: United States created_at: '2022-08-23T16:51:11.769-07:00' updated_at: '2022-08-23T16:51:11.769-07:00' label: Primary addressable_type: Company addressable_id: 28 firm_id: 2 deleted_at: null - id: 267 street: 7190 White Water street2: Way city: Sacramento state: CA zipcode: '23422' country: United States created_at: '2022-08-23T16:51:11.778-07:00' updated_at: '2022-08-23T16:51:11.778-07:00' label: Home addressable_type: Company addressable_id: 28 firm_id: 2 deleted_at: null phone_number: 619-555-2855 created_at: '2022-08-23T16:51:11.755-07:00' updated_at: '2022-08-23T16:51:11.809-07:00' relationships: created_by: data: id: '2' type: user '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/custom_emails/{custom_email_id}: get: operationId: getCustomEmail summary: Custom Email description: 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. tags: - Custom Emails parameters: - name: custom_email_id in: path required: true description: The custom email id schema: type: string responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: getCustomEmail: summary: GET Custom Email value: data: id: '24' type: custom_email attributes: name: Welcome Email subject: Welcome! opens: 80 sends: 334 bounces: 8 clicks: 58 open_rate: 0.23952095808383234 click_rate: 0.017964071856287425 bounce_rate: 0.1467065868263473 delivered_rate: 0.7994011976047904 promotional: true created_at: '2023-06-29T15:04:44.943-07:00' updated_at: '2023-06-29T15:04:44.943-07:00' '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/custom_emails: get: operationId: getCustomEmails summary: Custom Emails description: A list of all custom emails in Lawmatics. tags: - Custom Emails responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: getCustomEmails: summary: GET Custom Emails value: data: - id: '24' type: custom_email attributes: name: Welcome Email subject: Welcome! opens: 80 sends: 334 bounces: 8 clicks: 58 open_rate: 0.23952095808383234 click_rate: 0.017964071856287425 bounce_rate: 0.1467065868263473 delivered_rate: 0.7994011976047904 promotional: true created_at: '2023-06-29T15:04:44.943-07:00' updated_at: '2023-06-29T15:04:44.943-07:00' - id: '1' type: custom_email attributes: name: onboarding email subject: Thank you for Reaching out! opens: null sends: null bounces: null clicks: null open_rate: null click_rate: null bounce_rate: null delivered_rate: null promotional: false created_at: '2023-02-13T10:06:44.671-08:00' updated_at: '2023-02-13T10:06:44.671-08:00' meta: total_pages: 1 limit_per_page: 25 total_entries: 2 links: self: /v1/custom_emails?page=1 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/custom_fields/{custom_field_id}: get: operationId: getCustomField summary: Custom Field description: Specific Custom Field metadata by ID tags: - Custom Fields parameters: - name: custom_field_id in: path required: true description: The custom field id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getCustomField: summary: GET Custom Field value: data: id: '13' type: custom_field attributes: name: Jurisdiction type: PracticeArea field_type: list practice_area: Criminal Defense list_options: - id: 4 name: West County - id: 3 name: East County - id: 2 name: South County - id: 1 name: North County created_at: '2018-01-08T10:05:25.432-08:00' updated_at: '2018-01-08T10:05:25.432-08:00' '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer put: operationId: updateCustomField summary: Update Custom Field description: Update an existing Custom Field by ID. tags: - Custom Fields parameters: - name: custom_field_id in: path required: true description: The custom field id schema: type: string requestBody: required: true content: application/json: schema: type: object example: name: Jurisprudence 6ada4e0f-2d2b-4915-90dd-60851e0cb64b type: Contact field_type: multi_picklist list_options: - 10 - 20 - 30 responses: '200': description: OK content: application/json: schema: type: object examples: putUpdateCustomField: summary: PUT Update Custom Field value: data: id: '7' type: custom_field attributes: name: Jurisprudence type: Contact field_type: multi_picklist list_options: - id: 18 name: '10' - id: 19 name: '20' - id: 20 name: '30' created_at: '2022-06-02T12:03:29.977-07:00' updated_at: '2022-06-02T12:06:07.154-07:00' visibility: default '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: deleteCustomField summary: Delete Custom Field tags: - Custom Fields parameters: - name: custom_field_id in: path required: true description: The custom field id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: deleteDeleteCustomField: summary: DELETE Delete Custom Field value: data: id: '7' type: custom_field attributes: name: Jurisprudence type: Contact field_type: multi_picklist list_options: [] created_at: '2022-06-02T12:03:29.977-07:00' updated_at: '2022-06-02T12:10:42.915-07:00' visibility: default '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/custom_fields: get: operationId: getCustomFields summary: Custom Fields description: A paginated list of all Custom Field metadata in Lawmatics tags: - Custom Fields parameters: - name: fields in: query required: false schema: type: string example: all responses: '200': description: OK content: application/json: schema: type: object examples: getCustomFields: summary: GET Custom Fields value: data: - id: '4638' type: custom_field attributes: name: Test Date field_type: date visibility: default type: Prospect created_at: '2018-09-24T12:31:05.231-07:00' updated_at: '2018-10-12T14:23:23.732-07:00' - id: '1' type: custom_field attributes: name: Test Practice Area Checkbox field_type: boolean visibility: default type: PracticeArea created_at: '2018-07-17T15:27:16.765-07:00' updated_at: '2018-10-12T14:24:58.670-07:00' - id: '4627' type: custom_field attributes: name: Test User Lookup field_type: lookup visibility: default type: Prospect lookup_type: User created_at: '2018-08-28T17:19:04.897-07:00' updated_at: '2018-10-12T14:22:00.976-07:00' - id: '4639' type: custom_field attributes: name: Test Time field_type: time visibility: default type: Prospect created_at: '2018-09-24T12:31:15.295-07:00' updated_at: '2018-10-12T14:23:35.585-07:00' - id: '4644' type: custom_field attributes: name: Test Contact String field_type: string visibility: default type: Contact created_at: '2018-10-10T17:38:24.915-07:00' updated_at: '2018-10-12T14:24:42.034-07:00' - id: '4631' type: custom_field attributes: name: Test DateTime field_type: datetime visibility: hidden type: Prospect created_at: '2018-09-06T16:33:22.026-07:00' updated_at: '2018-10-12T14:23:43.570-07:00' - id: '7' type: custom_field attributes: name: Test Client String field_type: string visibility: default type: Client created_at: '2018-07-22T13:37:40.043-07:00' updated_at: '2018-10-12T14:24:01.079-07:00' - id: '4' type: custom_field attributes: name: Test Client Currency field_type: currency visibility: default type: Client created_at: '2018-07-22T13:00:57.587-07:00' updated_at: '2018-10-12T14:24:08.556-07:00' - id: '2' type: custom_field attributes: name: Status field_type: list visibility: default type: Prospect list_options: - id: 1 name: Open - id: 2 name: Closed Won - id: 3 name: Closed Lost created_at: '2018-07-21T10:30:31.322-07:00' updated_at: '2018-08-23T16:53:20.710-07:00' - id: '5' type: custom_field attributes: name: Test Practice Area Text field_type: text visibility: default type: PracticeArea created_at: '2018-07-22T13:01:26.681-07:00' updated_at: '2018-10-12T14:24:48.621-07:00' - id: '8' type: custom_field attributes: name: Test Money Field field_type: currency visibility: default type: Prospect created_at: '2018-07-22T14:25:40.345-07:00' updated_at: '2018-08-23T16:53:20.807-07:00' - id: '9' type: custom_field attributes: name: Test PNC Lookup field_type: lookup visibility: starred type: Prospect lookup_type: Prospect created_at: '2018-08-03T18:12:09.181-07:00' updated_at: '2018-10-12T14:22:44.470-07:00' - id: '6' type: custom_field attributes: name: Test PNC Picklist field_type: list visibility: starred type: Prospect list_options: - id: 9 name: Blue - id: 11 name: Red created_at: '2018-07-22T13:17:19.943-07:00' updated_at: '2018-08-23T16:53:20.791-07:00' '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createCustomField summary: Create Custom Field description: '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' tags: - Custom Fields requestBody: required: true content: application/json: schema: type: object example: name: Jurisdiction b50ceffa-1b5b-40c8-8a36-248485ee0eaf type: PracticeArea field_type: list practice_area: Divorce list_options: - one - two - three responses: '201': description: Created content: application/json: schema: type: object examples: postCreateCustomField: summary: POST Create Custom Field value: data: id: '5' type: custom_field attributes: name: Jurisdiction type: Prospect field_type: list practice_area: High Treason list_options: - id: 7 name: one - id: 8 name: two - id: 9 name: three created_at: '2022-06-01T16:09:06.943-07:00' updated_at: '2022-06-01T16:09:06.943-07:00' visibility: default '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/forms/{custom_form_uuid}: get: operationId: getCustomForm summary: Custom Form description: 'This Unauthenticated endpoint takes a Custom Form id and returns metadata about that Custom Form. This metadata can be used to recreate a Lawmatics Custom Form to be filled using your own html code. This endpoint is marked `noauth` in the published collection: public custom-form submission does not require an OAuth access token.' tags: - Custom Forms parameters: - name: custom_form_uuid in: path required: true description: The custom form uuid schema: type: string - name: fields in: query required: false schema: type: string example: all security: [] responses: '200': description: OK content: application/json: schema: type: object examples: getCustomForm: summary: GET Custom Form value: data: id: 31a81c7b-378f-4d5f-8d03-57c2fb43fe3c type: custom_form attributes: name: Lawmatics Intake Form type: Prospect created_at: '2018-09-12T16:42:41.024-07:00' updated_at: '2018-10-12T15:16:53.787-07:00' rows: - components: - id: first_name field_type: string label: First Name component_type: field required: true - id: last_name field_type: string label: Last Name component_type: field required: true - components: - id: Q3VzdG9tRm9ybUNvbXBvbmVudDo6QWR2YW5jZWQtZ2VuZXJhbF9maWVsZC0yMDE4LTA4LTI3VDE3OjMxOjU5LjE0NVo= field_type: list label: General Field component_type: general_field required: false list_options: - label: '1' value: 0 - label: '2' value: 1 - components: - id: Q3VzdG9tRm9ybUNvbXBvbmVudDo6QWR2YW5jZWQtaG9yaXpvbnRhbF9kaXZpZGVyLTIwMTgtMDgtMjdUMjA6Mzk6MTAuNjMzWg== component_type: horizontal_divider - components: - id: Q3VzdG9tRm9ybUNvbXBvbmVudDo6QWR2YW5jZWQtaW5zdHJ1Y3Rpb25zLTIwMTgtMDgtMjdUMjA6Mzk6MDIuNDUxWg== label:

Instructions text

component_type: instructions - components: - id: Q3VzdG9tRm9ybUNvbXBvbmVudDo6QWR2YW5jZWQtZ2VuZXJhbF9maWVsZC0yMDE4LTA4LTI3VDE4OjI2OjAzLjI5Mlo= field_type: boolean label: Is Lawmatics Awesome? component_type: general_field required: false - id: RmllbGRzOjpTdGFuZGFyZEZpZWxkLUNvbnRhY3QtbGFzdF9uYW1l field_type: integer label: Integer Custom Field component_type: field required: false - id: birthdate field_type: date label: Birthdate component_type: field required: false '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/forms: get: operationId: getCustomForms summary: Custom Forms description: A paginated list of all Custom Forms in Lawmatics tags: - Custom Forms responses: '200': description: OK content: application/json: schema: type: object examples: getCustomForms: summary: GET Custom Forms value: data: - id: ad79c099-6c37-47d0-9452-cdbeb297559f type: custom_form attributes: name: Test Prospect Intake Form type: Prospect created_at: '2018-09-12T16:42:41.024-07:00' updated_at: '2018-10-12T15:16:53.787-07:00' rows: - components: - id: first_name field_type: string label: First name component_type: field required: true - id: last_name field_type: string label: Last name component_type: field required: true - components: - id: RmllbGRzOjpDdXN0b21GaWVsZC1DdXN0b21GaWVsZDo6UHJhY3RpY2VBcmVhLTU= field_type: text label: Test Practice Area Text component_type: field required: false - components: - id: Q3VzdG9tRm9ybUNvbXBvbmVudDo6QWR2YW5jZWQtaW5zdHJ1Y3Rpb25zLTIwMTgtMDktMTJUMjM6NDI6NDUuNjMxWg== label:

Instructions

required: false component_type: instructions '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/forms/{custom_form_uuid}/entries: get: operationId: getCustomFormEntries summary: Custom Form Entries description: A paginated list of all Custom Form Entries in Lawmatics by Custom Form uuid tags: - Custom Forms parameters: - name: custom_form_uuid in: path required: true description: The custom form uuid schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getCustomFormEntries: summary: GET Custom Form Entries value: data: - id: '91' type: custom_form_entry attributes: body: - label: First name value: Bob - label: Last name value: test created_at: '2018-10-17T12:30:48.711-07:00' updated_at: '2018-10-17T12:30:48.711-07:00' relationships: custom_form: data: id: '4' type: custom_form contactable: data: id: '41869' type: prospect - id: '90' type: custom_form_entry attributes: body: - label: First name value: Bob - label: Last name value: test created_at: '2018-10-17T12:30:43.194-07:00' updated_at: '2018-10-17T12:30:43.194-07:00' relationships: custom_form: data: id: '4' type: custom_form contactable: data: id: '41868' type: prospect - id: '89' type: custom_form_entry attributes: body: - label: First name value: Bob - label: Last name value: test created_at: '2018-10-17T12:30:36.721-07:00' updated_at: '2018-10-17T12:30:36.721-07:00' relationships: custom_form: data: id: '4' type: custom_form contactable: data: id: '41867' type: prospect - id: '88' type: custom_form_entry attributes: body: - label: First name value: Bob - label: Last name value: test created_at: '2018-10-17T12:30:32.522-07:00' updated_at: '2018-10-17T12:30:32.522-07:00' relationships: custom_form: data: id: '4' type: custom_form contactable: data: id: '41866' type: prospect - id: '87' type: custom_form_entry attributes: body: - label: First name value: Bob - label: Last name value: test created_at: '2018-10-17T12:29:55.684-07:00' updated_at: '2018-10-17T12:29:55.684-07:00' relationships: custom_form: data: id: '4' type: custom_form contactable: data: id: '41865' type: prospect - id: '86' type: custom_form_entry attributes: body: - label: First name value: Bob - label: Last name value: test created_at: '2018-10-17T12:29:22.859-07:00' updated_at: '2018-10-17T12:29:22.859-07:00' relationships: custom_form: data: id: '4' type: custom_form contactable: data: id: '41864' type: prospect - id: '85' type: custom_form_entry attributes: body: - label: First name value: Bob - label: Last name value: test created_at: '2018-10-17T12:29:16.213-07:00' updated_at: '2018-10-17T12:29:16.213-07:00' relationships: custom_form: data: id: '4' type: custom_form contactable: data: id: '41863' type: prospect - id: '84' type: custom_form_entry attributes: body: - label: First name value: Bob - label: Last name value: test created_at: '2018-10-17T12:28:56.803-07:00' updated_at: '2018-10-17T12:28:56.803-07:00' relationships: custom_form: data: id: '4' type: custom_form contactable: data: id: '41862' type: prospect - id: '83' type: custom_form_entry attributes: body: - label: First name value: Bob - label: Last name value: test created_at: '2018-10-17T12:25:34.196-07:00' updated_at: '2018-10-17T12:25:34.196-07:00' relationships: custom_form: data: id: '4' type: custom_form contactable: data: id: '41861' type: prospect - id: '82' type: custom_form_entry attributes: body: - label: First name value: Bob - label: Last name value: test created_at: '2018-10-17T12:24:22.712-07:00' updated_at: '2018-10-17T12:24:22.712-07:00' relationships: custom_form: data: id: '4' type: custom_form contactable: data: id: '41860' type: prospect - id: '81' type: custom_form_entry attributes: body: - label: First name value: Bob - label: Last name value: test created_at: '2018-10-17T12:24:04.170-07:00' updated_at: '2018-10-17T12:24:04.170-07:00' relationships: custom_form: data: id: '4' type: custom_form contactable: data: id: '41859' type: prospect - id: '80' type: custom_form_entry attributes: body: - label: First name value: Bob - label: Last name value: test created_at: '2018-10-17T12:15:01.416-07:00' updated_at: '2018-10-17T12:15:01.416-07:00' relationships: custom_form: data: id: '4' type: custom_form contactable: data: id: '41858' type: prospect - id: '79' type: custom_form_entry attributes: body: - label: First name value: Bob - label: Last name value: test created_at: '2018-10-17T12:14:35.492-07:00' updated_at: '2018-10-17T12:14:35.492-07:00' relationships: custom_form: data: id: '4' type: custom_form contactable: data: id: '41857' type: prospect - id: '78' type: custom_form_entry attributes: body: - label: First name value: Bob - label: Last name value: test created_at: '2018-10-17T12:11:51.273-07:00' updated_at: '2018-10-17T12:11:51.273-07:00' relationships: custom_form: data: id: '4' type: custom_form contactable: data: id: '41856' type: prospect - id: '77' type: custom_form_entry attributes: body: - label: First name value: Bob - label: Last name value: test created_at: '2018-10-17T12:10:33.065-07:00' updated_at: '2018-10-17T12:10:33.065-07:00' relationships: custom_form: data: id: '4' type: custom_form contactable: data: id: '41855' type: prospect - id: '76' type: custom_form_entry attributes: body: - label: First name value: Bob - label: Last name value: test created_at: '2018-10-17T12:10:08.431-07:00' updated_at: '2018-10-17T12:10:08.431-07:00' relationships: custom_form: data: id: '4' type: custom_form contactable: data: id: '41854' type: prospect - id: '75' type: custom_form_entry attributes: body: - label: First name value: Bob - label: Last name value: test created_at: '2018-10-17T12:09:46.031-07:00' updated_at: '2018-10-17T12:09:46.031-07:00' relationships: custom_form: data: id: '4' type: custom_form contactable: data: id: '41853' type: prospect - id: '74' type: custom_form_entry attributes: body: - label: First name value: Bob - label: Last name value: test created_at: '2018-10-17T12:07:42.642-07:00' updated_at: '2018-10-17T12:07:42.642-07:00' relationships: custom_form: data: id: '4' type: custom_form contactable: data: id: '41852' type: prospect - id: '73' type: custom_form_entry attributes: body: - label: First name value: Bob - label: Last name value: test created_at: '2018-10-17T12:06:47.744-07:00' updated_at: '2018-10-17T12:06:47.744-07:00' relationships: custom_form: data: id: '4' type: custom_form contactable: data: id: '41851' type: prospect - id: '72' type: custom_form_entry attributes: body: - label: First name value: Bob - label: Last name value: test created_at: '2018-10-17T12:05:59.377-07:00' updated_at: '2018-10-17T12:05:59.377-07:00' relationships: custom_form: data: id: '4' type: custom_form contactable: data: id: '41850' type: prospect - id: '71' type: custom_form_entry attributes: body: - label: First name value: Bob - label: Last name value: test created_at: '2018-10-17T12:03:15.314-07:00' updated_at: '2018-10-17T12:03:15.314-07:00' relationships: custom_form: data: id: '4' type: custom_form contactable: data: id: '41849' type: prospect - id: '70' type: custom_form_entry attributes: body: - label: First name value: Bob - label: Last name value: test created_at: '2018-10-17T12:02:59.496-07:00' updated_at: '2018-10-17T12:02:59.496-07:00' relationships: custom_form: data: id: '4' type: custom_form contactable: data: id: '41848' type: prospect - id: '69' type: custom_form_entry attributes: body: - label: First name value: Bob - label: Last name value: test created_at: '2018-10-17T12:00:52.386-07:00' updated_at: '2018-10-17T12:00:52.386-07:00' relationships: custom_form: data: id: '4' type: custom_form contactable: data: id: '41847' type: prospect - id: '63' type: custom_form_entry attributes: body: - label: First name value: Bob - label: Last name value: Loblaw created_at: '2018-10-14T17:46:21.572-07:00' updated_at: '2018-10-14T17:46:21.572-07:00' relationships: custom_form: data: id: '4' type: custom_form contactable: data: id: '41811' type: prospect - id: '62' type: custom_form_entry attributes: body: - label: First name value: Bob - label: Last name value: Loblaw created_at: '2018-10-14T17:45:12.742-07:00' updated_at: '2018-10-14T17:45:12.742-07:00' relationships: custom_form: data: id: '4' type: custom_form contactable: data: id: '41810' type: prospect meta: total_pages: 2 limit_per_page: 25 total_entries: 50 links: self: /v1/custom_form_entry?page=1 next: /v1/custom_form_entry?page=2 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/forms/{custom_form_uuid}/submit: post: operationId: submitCustomFormEntryFormDataBody summary: Submit Custom Form Entry (Form Data Body) description: 'This Unauthenticated (YOU DO NOT NEED A DEVELOPER APP) endpoint submits Custom Form values. Keys for the values use the Custom Form field ids found in Lawmatics, or found via the GET endpoint. Data should be serialized via form-data (plain html5 forms) or JSON body (shown in next example) Any automations will trigger as expected when this Custom Form is submitted via the API. This endpoint is marked `noauth` in the published collection: public custom-form submission does not require an OAuth access token.' tags: - Custom Forms parameters: - name: custom_form_uuid in: path required: true description: The custom form uuid schema: type: string requestBody: required: true content: multipart/form-data: schema: type: object properties: first_name: type: string last_name: type: string utm_source: type: string utm_campaign: type: string referring_url: type: string RmllbGRzOjpDdXN0b21GaWVsZC1DdXN0b21GaWVsZDo6UHJvc3BlY3QtMTAyNw==: type: string custom_field_2263: type: string application/json: schema: type: object example: first_name: Another last_name: Test utm_source: facebook utm_campaign: test1 RmllbGRzOjpDdXN0b21GaWVsZC1DdXN0b21GaWVsZDo6UHJvc3BlY3QtMTAyNw==: An important case custom_field_2263: FILL ME IN security: [] responses: '201': description: Created content: application/json: schema: type: object examples: postSubmitCustomFormFormDataBody: summary: POST Submit Custom Form (Form Data Body) value: data: id: '58956' type: contact attributes: first_name: Bob last_name: Loblaw email: bob@loblaw.com created_at: '2018-10-17T12:43:21.570-07:00' updated_at: '2018-10-17T12:43:21.570-07:00' relationships: {} '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/email_addresses/{email_address_id}: get: operationId: getEmailAddress summary: Email Address description: A specific Email Address by id tags: - Email Addresses parameters: - name: email_address_id in: path required: true description: The email address id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getEmailAddress: summary: GET Email Address value: data: id: '123' type: email_address attributes: label: Primary info: susan61@gmail.com relationships: informationable: data: id: '62' type: contact '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer put: operationId: updateEmailAddress summary: Update Email Address description: Updates a Email Address by id tags: - Email Addresses parameters: - name: email_address_id in: path required: true description: The email address id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: putUpdateEmailAddress: summary: PUT Update Email Address value: data: id: '379' type: email_address attributes: label: New Label info: roey+changed@lawmatics.com relationships: informationable: data: id: '112' type: contact '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: deleteEmailAddress summary: Delete Email Address description: 'Delete a Email Address by ID email_address_id: ID of the Email Address to delete' tags: - Email Addresses parameters: - name: email_address_id in: path required: true description: The email address id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: deleteDeleteEmailAddress: summary: DELETE Delete Email Address value: data: id: '379' type: email_address attributes: label: New Label info: roey+changed@lawmatics.com relationships: informationable: data: id: '112' type: contact '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/email_addresses: get: operationId: getEmailAddresses summary: Email Addresses description: A paginated list of all Email Addresses in Lawmatics tags: - Email Addresses responses: '200': description: OK content: application/json: schema: type: object examples: getEmailAddresses: summary: GET Email Addresses value: data: - id: '363' type: email_address attributes: label: Primary info: zoobiedooby213123123@lawmatics.com relationships: informationable: data: id: '193' type: contact - id: '356' type: email_address attributes: label: Primary info: roey@lawmatics.com relationships: informationable: data: id: '189' type: contact - id: '304' type: email_address attributes: label: Primary info: roey@lawmatics.com relationships: informationable: data: id: '162' type: contact - id: '302' type: email_address attributes: label: Primary info: roey@lawmatics.com relationships: informationable: data: id: '161' type: contact - id: '300' type: email_address attributes: label: Primary info: roey@lawmatics.com relationships: informationable: data: id: '160' type: contact - id: '298' type: email_address attributes: label: Primary info: roey@lawmatics.com relationships: informationable: data: id: '159' type: contact - id: '296' type: email_address attributes: label: Primary info: roey@lawmatics.com relationships: informationable: data: id: '158' type: contact - id: '294' type: email_address attributes: label: Primary info: roey@lawmatics.com relationships: informationable: data: id: '157' type: contact - id: '292' type: email_address attributes: label: Primary info: roey@lawmatics.com relationships: informationable: data: id: '156' type: contact - id: '290' type: email_address attributes: label: Primary info: roey@lawmatics.com relationships: informationable: data: id: '155' type: contact - id: '288' type: email_address attributes: label: Primary info: roey+changed@lawmatics.com relationships: informationable: data: id: '154' type: contact - id: '286' type: email_address attributes: label: Primary info: roey@lawmatics.com relationships: informationable: data: id: '153' type: contact - id: '284' type: email_address attributes: label: Primary info: roey@lawmatics.com relationships: informationable: data: id: '152' type: contact - id: '276' type: email_address attributes: label: Primary info: roey+changed@lawmatics.com relationships: informationable: data: id: '148' type: contact - id: '274' type: email_address attributes: label: Primary info: roey@lawmatics.com relationships: informationable: data: id: '147' type: contact - id: '272' type: email_address attributes: label: Primary info: roey@lawmatics.com relationships: informationable: data: id: '146' type: contact - id: '270' type: email_address attributes: label: Primary info: roey@lawmatics.com relationships: informationable: data: id: '145' type: contact - id: '268' type: email_address attributes: label: Primary info: roey@lawmatics.com relationships: informationable: data: id: '144' type: contact - id: '266' type: email_address attributes: label: Primary info: roey@lawmatics.com relationships: informationable: data: id: '143' type: contact - id: '264' type: email_address attributes: label: Primary info: roey@lawmatics.com relationships: informationable: data: id: '142' type: contact - id: '260' type: email_address attributes: label: Primary info: roey@lawmatics.com relationships: informationable: data: id: '140' type: contact - id: '258' type: email_address attributes: label: Primary info: roey@lawmatics.com relationships: informationable: data: id: '139' type: contact - id: '256' type: email_address attributes: label: Primary info: roey@lawmatics.com relationships: informationable: data: id: '138' type: contact - id: '254' type: email_address attributes: label: Primary info: roey@lawmatics.com relationships: informationable: data: id: '137' type: contact - id: '252' type: email_address attributes: label: Primary info: roey@lawmatics.com relationships: informationable: data: id: '136' type: contact meta: total_pages: 6 limit_per_page: 25 total_entries: 138 links: self: /v1/email_addresses?page=1 next: /v1/email_addresses?page=2 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createEmailAddress summary: Create Email Address description: 'Create a new Email Address Required Fields: informationable, label, info info: The Email Address string. label: The Email Address''s label e.g. Primary. informationable_type: Prospect, Contact, Company, or Firm that the Email Address belongs to. informationable_id: Id of Record. Firm type doesn''t need an ID passed and it will be ignored. Note - Setting the Email Address through a Prospect (Matter) will set it on on the Prospects'' Contact/Company.' tags: - Email Addresses responses: '201': description: Created content: application/json: schema: type: object examples: postCreateEmailAddress: summary: POST Create Email Address value: data: id: '378' type: email_address attributes: label: Test info: roey+api@lawmatics.com relationships: informationable: data: id: '112' type: contact '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/email_campaigns/{id}: get: operationId: getEmailCampaign summary: Email Campaign description: 'Returns a specific campaign in Lawmatics. To retrieve a specific campaign, use the following format: TypeofCampaign-id An example of retrieving a marketing campaign would be: /v1/email_campaigns/MarketingCampaign-1 An example of retrieving a recurring campaign would be: /v1/email_campaigns/RecurringCampaign-1 An example of retrieving a date campaign would be: /v1/email_campaigns/DateCampaign-1' tags: - Email Campaigns parameters: - name: id in: path required: true description: The id schema: type: string responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: getEmailCampaign: summary: GET Email Campaign value: data: id: MarketingCampaign-1 type: marketing_campaign_view attributes: name: new campagin status: 0 open_rate: null send_count: 0 sent_at: null started_processing_at: '2023-04-17T11:36:37.108-07:00' campaign_type: MarketingCampaign created_at: '2023-04-17T10:47:32.675-07:00' relationships: audience: data: id: '1' type: audience custom_email: data: id: '23' type: custom_email '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/email_campaigns: get: operationId: getEmailCampaigns summary: Email Campaigns description: Returns all email campaigns in Lawmatics. tags: - Email Campaigns responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: getEmailCampaigns: summary: GET Email Campaigns value: data: - id: RecurringCampaign-1 type: marketing_campaign_view attributes: name: jasmine recurring status: 1 open_rate: null send_count: 0 sent_at: '2023-07-26T16:29:07.937-07:00' started_processing_at: '2023-07-26T16:28:19.471-07:00' campaign_type: RecurringCampaign created_at: '2023-07-24T11:28:27.459-07:00' relationships: audience: data: id: '1' type: audience custom_email: data: id: '25' type: custom_email - id: MarketingCampaign-1 type: marketing_campaign_view attributes: name: new campagin status: 0 open_rate: null send_count: 0 sent_at: null started_processing_at: '2023-04-17T11:36:37.108-07:00' campaign_type: MarketingCampaign created_at: '2023-04-17T10:47:32.675-07:00' relationships: audience: data: id: '1' type: audience custom_email: data: id: '23' type: custom_email meta: total_pages: 1 limit_per_page: 25 total_entries: 2 links: self: /v1/marketing_campaign_views?page=1 getEmailCampaignsByType: summary: GET Email Campaigns by Type value: data: - id: MarketingCampaign-2 type: email_campaign attributes: name: run once status: 0 open_rate: null send_count: 0 sent_at: null started_processing_at: '2023-07-28T07:41:18.465-07:00' campaign_type: MarketingCampaign created_at: '2023-07-28T07:41:14.484-07:00' relationships: audience: data: id: '1' type: audience custom_email: data: id: '1' type: custom_email - id: MarketingCampaign-15 type: email_campaign attributes: name: another marketing campaign status: 0 open_rate: null send_count: null sent_at: null started_processing_at: null campaign_type: MarketingCampaign created_at: '2023-08-09T14:32:34.630-07:00' relationships: audience: data: id: '1' type: audience custom_email: data: id: '1' type: custom_email meta: total_pages: 1 limit_per_page: 25 total_entries: 2 links: self: /v1/marketing_campaign_views?page=1 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/email_campaign_stats/{id}: get: operationId: getEmailCampaignStats summary: Email Campaign Stats description: 'Retrieves a statistics of a specific email campaign in Lawmatics. To retrieve a specific campaign, use the following format: TypeofCampaign-id An example of retrieving statistics of a marketing campaign would be: /v1/email_campaign_stats/MarketingCampaign-1 An example of retrieving statistics of a date campaign would be: /v1/email_campaign_stats/DateCampaign-1' tags: - Email Campaign Stats parameters: - name: id in: path required: true description: The id schema: type: string responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: getEmailCampaignStats: summary: GET Email Campaign Stats value: data: - id: null type: email_event attributes: contactable_id: 160 email: jasmine+3@lawmatics.com first_name: lastOne3 last_name: null delivered: false bounces: 0 clicks: 0 opens: 0 - id: null type: email_event attributes: contactable_id: 146 email: jasmine+2@lawmatics.com first_name: lastOne2 last_name: null delivered: false bounces: 0 clicks: 0 opens: 0 - id: null type: email_event attributes: contactable_id: 149 email: bran@example.com first_name: Bran last_name: Stark delivered: false bounces: 0 clicks: 0 opens: 0 - id: null type: email_event attributes: contactable_id: 145 email: jasmine+3@lawmatics.com first_name: lastOne3 last_name: null delivered: false bounces: 0 clicks: 0 opens: 0 - id: null type: email_event attributes: contactable_id: 221 email: jasmine+1@lawmatics.com first_name: lastOne last_name: null delivered: false bounces: 0 clicks: 0 opens: 0 - id: null type: email_event attributes: contactable_id: 151 email: jasmine+3@lawmatics.com first_name: lastOne3 last_name: null delivered: false bounces: 0 clicks: 0 opens: 0 - id: null type: email_event attributes: contactable_id: 152 email: jasmine+1@lawmatics.com first_name: lastOne last_name: null delivered: false bounces: 0 clicks: 0 opens: 0 - id: null type: email_event attributes: contactable_id: 144 email: jasmine+2@lawmatics.com first_name: lastOne2 last_name: null delivered: false bounces: 0 clicks: 0 opens: 0 - id: null type: email_event attributes: contactable_id: 155 email: jasmine+1@lawmatics.com first_name: lastOne last_name: null delivered: false bounces: 0 clicks: 0 opens: 0 - id: null type: email_event attributes: contactable_id: 132 email: sansastark@example.com first_name: Sansa last_name: Stark delivered: false bounces: 0 clicks: 0 opens: 0 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/events/{event_id}: get: operationId: getEvent summary: Event description: A paginated list of all Events in Lawmatics tags: - Events (Appointments) parameters: - name: event_id in: path required: true description: The event id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getEvent: summary: GET Event value: data: id: '14' type: event attributes: name: New Appointment description: API Appointment time_zone: America/Los_Angeles start_date: '2022-06-28T15:00:00.000-07:00' end_date: '2020-06-29T00:00:00.000-07:00' all_day: true reminder_type: minutes reminder_delay_length: 10 reminder_sent: false location: id: 1 name: Miami Location locationable_type: Firm locationable_id: 2 address_id: 101 firm_id: 2 created_at: '2021-10-31T19:59:38.874-07:00' updated_at: '2021-10-31T19:59:38.874-07:00' send_invites: true event_type_id: 4 attendee_name: Jennifer Lee attendee_email: jennifer1@gmail.com attendee_phone: 651-555-7796 location_name: Miami Location location_address: 1234 Miami, Miami, FL 12345, United States zoom_us_meeting_url: null created_at: '2022-05-10T15:19:38.947-07:00' updated_at: '2022-05-10T15:19:39.011-07:00' relationships: eventable: data: id: '2' type: prospect users: data: - id: '2' type: user event_type: data: id: '4' type: event_type address: data: id: '101' type: address '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer put: operationId: updateEvent summary: Update Event description: 'Update an existing Matter by ID. PATCH works for this endpoint as well as PUT.' tags: - Events (Appointments) parameters: - name: event_id in: path required: true description: The event id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: putUpdateEvent: summary: PUT Update Event value: data: id: '1' type: event attributes: name: New Appointment description: 'API Appointment Matter Phone: 619-555-7327' start_date: '2020-06-28T00:00:00.000-07:00' end_date: '2020-06-29T00:00:00.000-07:00' all_day: false reminder_type: minutes reminder_delay_length: 10 reminder_sent: false location: id: 1 name: Miami Location locationable_type: Firm locationable_id: 2 address_id: 101 firm_id: 2 created_at: '2021-10-31T19:59:38.874-07:00' updated_at: '2021-10-31T19:59:38.874-07:00' send_invites: true event_type_id: 5 time_zone: America/Los_Angeles relationships: users: data: - id: '3' type: user event_type: data: id: '5' type: event_type '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: cancelEvent summary: Cancel Event description: Cancels an existing Event/Appointment tags: - Events (Appointments) parameters: - name: event_id in: path required: true description: The event/appointment schema: type: string - name: notify_attendees in: query required: false schema: type: string example: 'true' responses: '200': description: OK content: application/json: schema: type: object examples: deleteCancelEvent: summary: DELETE Cancel Event value: data: id: '6' type: event attributes: name: New Appointment relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/events: get: operationId: getEvents summary: Events description: A paginated list of all Events in Lawmatics tags: - Events (Appointments) responses: '200': description: OK content: application/json: schema: type: object examples: getEvents: summary: GET Events value: data: - id: '5' type: event attributes: name: Initial Consultation description: test time_zone: America/Los_Angeles start_date: '2021-12-31T22:01:00.000-08:00' end_date: '2021-12-31T22:31:00.000-08:00' all_day: false reminder_type: minutes reminder_delay_length: null reminder_sent: false location: id: 1 name: Miami Location locationable_type: Firm locationable_id: 2 address_id: 101 firm_id: 2 created_at: '2021-10-31T19:59:38.874-07:00' updated_at: '2021-10-31T19:59:38.874-07:00' send_invites: null event_type_id: 5 relationships: eventable: data: id: '105' type: prospect users: data: - id: '5' type: user event_type: data: id: '5' type: event_type - id: '4' type: event attributes: name: Statute of Limitations description: null time_zone: America/Los_Angeles start_date: '2021-12-08T00:00:00.000-08:00' end_date: '2021-12-08T00:00:00.000-08:00' all_day: true reminder_type: null reminder_delay_length: null reminder_sent: false location: null send_invites: false event_type_id: 4 relationships: eventable: data: id: '101' type: prospect users: data: - id: '5' type: user event_type: data: id: '4' type: event_type - id: '3' type: event attributes: name: Initial Consultation description: 'test Matter Phone: 520-730-1042' time_zone: America/New_York start_date: '2021-11-11T14:43:00.000-08:00' end_date: '2021-11-11T15:13:00.000-08:00' all_day: false reminder_type: null reminder_delay_length: null reminder_sent: false location: id: 1 name: Miami Location locationable_type: Firm locationable_id: 2 address_id: 101 firm_id: 2 created_at: '2021-10-31T19:59:38.874-07:00' updated_at: '2021-10-31T19:59:38.874-07:00' send_invites: null event_type_id: 3 relationships: eventable: data: null users: data: - id: '5' type: user event_type: data: id: '3' type: event_type - id: '2' type: event attributes: name: New Appointment - Joseph Brown description: 'API Appointment Matter Phone: 619-555-7327' time_zone: America/Halifax start_date: '2020-06-28T00:00:00.000-07:00' end_date: '2020-06-29T00:00:00.000-07:00' all_day: false reminder_type: minutes reminder_delay_length: 10 reminder_sent: false location: id: 1 name: Miami Location locationable_type: Firm locationable_id: 2 address_id: 101 firm_id: 2 created_at: '2021-10-31T19:59:38.874-07:00' updated_at: '2021-10-31T19:59:38.874-07:00' send_invites: true event_type_id: 5 relationships: eventable: data: id: '3' type: prospect users: data: - id: '3' type: user event_type: data: id: '5' type: event_type - id: '1' type: event attributes: name: New Appointment description: 'API Appointment Matter Phone: 619-555-7327' time_zone: America/New_York start_date: '2020-06-28T00:00:00.000-07:00' end_date: '2020-06-29T00:00:00.000-07:00' all_day: false reminder_type: minutes reminder_delay_length: 10 reminder_sent: false location: id: 1 name: Miami Location locationable_type: Firm locationable_id: 2 address_id: 101 firm_id: 2 created_at: '2021-10-31T19:59:38.874-07:00' updated_at: '2021-10-31T19:59:38.874-07:00' send_invites: true event_type_id: 5 relationships: eventable: data: id: '3' type: prospect users: data: - id: '3' type: user event_type: data: id: '5' type: event_type meta: total_pages: 1 limit_per_page: 25 total_entries: 5 links: self: /v1/events?page=1 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createEvent summary: Create Event description: 'Create a new Event/Appointment Optional Fields: Reminder fields, Location fields, time_zone eventable_type, eventable_id: The Prospect, Contact, or Client that the appointment is with. user_ids: The Firm Users hosting the appointment. reminder_type: ''minutes'', ''hours'', ''days'', ''weeks'', months'' reminder_delay_length: Integer value (combined with reminder_type) for how long to wait to send a reminder send_invites: (default true) all_day: (default false) time_zone: a valid tz identifier string), (defaults to null)' tags: - Events (Appointments) responses: '201': description: Created content: application/json: schema: type: object examples: postCreateEvent: summary: POST Create Event value: data: id: '13918' type: event attributes: name: New Appointment description: API Appointment start_date: '2020-06-28T00:00:00.000-07:00' end_date: '2020-06-29T00:00:00.000-07:00' all_day: false reminder_type: minutes reminder_delay_length: 10 reminder_sent: false location: id: 1 name: LM Office locationable_type: Firm locationable_id: 15 address_id: 3588 firm_id: 15 created_at: '2018-09-07T09:18:55.353-07:00' updated_at: '2018-09-07T09:18:55.353-07:00' send_invites: false event_type_id: 23 time_zone: America/Los_Angeles relationships: event_type: data: id: '23' type: event_type '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/locations: get: operationId: getLocations summary: Locations description: A paginated list of all Firm Locations in Lawmatics tags: - Event Locations responses: '200': description: OK content: application/json: schema: type: object examples: getLocations: summary: GET Locations value: data: - id: '2985' type: location attributes: name: Zoom address: www.zoom.com created_at: '2021-09-23T11:37:21.602-07:00' updated_at: '2021-09-23T11:37:21.602-07:00' relationships: address: data: id: '1033526' type: address - id: '314' type: location attributes: name: Phone Conference address: 800-883-1105 ext. 2 created_at: '2019-05-15T14:07:18.373-07:00' updated_at: '2019-05-15T14:07:18.373-07:00' relationships: address: data: id: '82052' type: address - id: '3' type: location attributes: name: Spokane - Conference Room B address: 711 W. Indiana, Spokane, WA 99205, United States created_at: '2018-09-07T10:52:27.992-07:00' updated_at: '2018-09-07T10:52:27.992-07:00' relationships: address: data: id: '3590' type: address - id: '2' type: location attributes: name: Spokane - Conference Room A address: 711 W. Indiana, Spokane, WA 99205, United States created_at: '2018-09-07T10:49:00.735-07:00' updated_at: '2018-09-07T10:49:00.735-07:00' relationships: address: data: id: '3590' type: address - id: '1' type: location attributes: name: LM Office address: 4250 Executive Square, Suite 101, La Jolla, CA 92037, United States created_at: '2018-09-07T09:18:55.353-07:00' updated_at: '2018-09-07T09:18:55.353-07:00' relationships: address: data: id: '3588' type: address meta: total_pages: 1 limit_per_page: 25 total_entries: 5 links: self: /v1/locations?page=1 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/event_types/{event_type_id}: get: operationId: getEventType summary: Event Type description: A specific Event Type by id tags: - Event Types parameters: - name: event_type_id in: path required: true description: The event type id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getEventType: summary: GET Event Type value: data: id: '14' type: event_type attributes: name: test6 duration: 30 created_at: '2022-06-26T17:29:20.139-07:00' updated_at: '2022-06-26T17:29:20.139-07:00' relationships: events: data: [] '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer put: operationId: updateEventType summary: Update Event Type description: Updates an Event Type tags: - Event Types parameters: - name: event_type_id in: path required: true description: The event type id schema: type: string requestBody: required: true content: application/json: schema: type: object example: name: Different Event Type duration: 60 responses: '200': description: OK content: application/json: schema: type: object examples: putUpdateEventType: summary: PUT Update Event Type value: data: id: '17' type: event_type attributes: name: Different Event Type duration: 60 created_at: '2022-06-26T17:34:30.915-07:00' updated_at: '2022-06-26T17:35:02.532-07:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: deleteEventType summary: Delete Event Type description: Delete an Event Type tags: - Event Types parameters: - name: event_type_id in: path required: true description: The event type id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: delDeleteEventType: summary: DEL Delete Event Type value: data: id: '17' type: event_type attributes: name: Different Event Type duration: 60 created_at: '2022-06-26T17:34:30.915-07:00' updated_at: '2022-06-26T17:35:02.532-07:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/event_types: get: operationId: getEventTypes summary: Event Types description: A paginated list of all Event Types in Lawmatics tags: - Event Types responses: '200': description: OK '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createEventType summary: Create Event Type description: 'Create a new Event Type duration: Default event duration (in minutes) name: Name of the Event Type' tags: - Event Types requestBody: required: true content: application/json: schema: type: object example: name: Test Event Type duration: 30 responses: '201': description: Created content: application/json: schema: type: object examples: postCreateEventType: summary: POST Create Event Type value: data: id: '13' type: event_type attributes: name: test5 duration: 30 created_at: '2022-06-26T17:28:08.821-07:00' updated_at: '2022-06-26T17:28:08.821-07:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/files/{file_id}: get: operationId: getFile summary: File description: A specific File's metadata in Lawmatics tags: - Files parameters: - name: file_id in: path required: true description: The file id schema: type: string responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: getFile: summary: GET File value: data: id: '2' type: file attributes: name: unnamed.png file_size: 8833 file_url: https://api.lawmatics.com/attachments/962626ca7818b57e20da04a9ededcfa3dbe240dc/store/1d5cd6d1a447ec549b8dc91f584050c8f625c29b376a39f9e531a0d0b666/unnamed.png file_name: unnamed.png file_type: image/png created_at: '2022-06-14T16:59:22.915-07:00' updated_at: '2022-06-14T16:59:22.915-07:00' relationships: documentable: data: id: '2' type: firm '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer put: operationId: updateFileMetadata summary: Update File Metadata description: 'Updates an File by ID documentable_type: One of ["firm", "client", "matter", "contact"] documentable_id: The record ID, not needed for Firm documentable_type. file: File to upload folder_id: the Folder ID the file should be located in name: name for the File. Defaults to uploaded file name path: String Array. e.g. ["Root", "Folder 1", "Folder 2"]. Finds folder with name or creates it if it doesn''t exist. Path overrides folder_id if both given.' tags: - Files parameters: - name: file_id in: path required: true description: The file id schema: type: string requestBody: required: true content: multipart/form-data: schema: type: object properties: documentable_type: type: string documentable_id: type: string name: type: string file_name: type: string folder_id: type: string responses: '200': description: OK content: application/json: schema: type: object examples: putUpdateFileMetadata: summary: PUT Update File Metadata value: data: id: '48' type: file attributes: name: Changed Name.jpg file_url: https://bucket.s3.us-west-1.amazonaws.com/store/d494fe46a2bae430671b8de9e2e0d00720d4bf80a5f3e6d4d870c1579803?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223323Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=58ca60aa950be962522f7d59d1cbc3cc4bed1918984202d27d846a2e9936c301 file_size: 0 file_name: Wow.jpg file_type: image/jpeg folder_id: 456 created_at: '2022-08-04T14:55:13.759-07:00' updated_at: '2022-08-04T15:33:22.647-07:00' relationships: documentable: data: id: '3' type: prospect putMoveFileToFilePath: summary: PUT Move file to file path value: data: id: '48' type: file attributes: name: Changed Name.jpg file_url: https://bucket.s3.us-west-1.amazonaws.com/store/d494fe46a2bae430671b8de9e2e0d00720d4bf80a5f3e6d4d870c1579803?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223323Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=58ca60aa950be962522f7d59d1cbc3cc4bed1918984202d27d846a2e9936c301 file_size: 0 file_name: Wow.jpg file_type: image/jpeg folder_id: 789 created_at: '2022-08-04T14:55:13.759-07:00' updated_at: '2022-08-04T15:33:22.647-07:00' relationships: documentable: data: id: '3' type: prospect '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: deleteFile summary: Delete File description: Deletes a File by ID tags: - Files parameters: - name: file_id in: path required: true description: The file id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: deleteDeleteFile: summary: DELETE Delete File value: data: id: '48' type: file attributes: name: Changed Name file_url: https://bucket.s3.us-west-1.amazonaws.com/store/d494fe46a2bae430671b8de9e2e0d00720d4bf80a5f3e6d4d870c1579803?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223345Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=0d2ef50d2036f61041bad3cd7fd4ff83dc79ddd3e42b3baf2630fa30361201ec file_size: 0 file_name: Wow.jpg file_type: image/jpeg created_at: '2022-08-04T14:55:13.759-07:00' updated_at: '2022-08-04T15:33:45.619-07:00' relationships: documentable: data: id: '3' type: prospect '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/files: get: operationId: getFiles summary: Files description: 'A paginated list of all File metadata in Lawmatics Can be filtered by matter_id , prospect_id , contact_id , client_id and firm as well as all the regular fields as referenced by our Param Guide (most fields returned by?fields=all).' tags: - Files responses: '200': description: OK content: application/json: schema: type: object examples: getFiles: summary: GET Files value: data: - id: '48' type: file attributes: name: Lawmatics_LinkedIn_Header.jpg file_url: https://bucket.s3.us-west-1.amazonaws.com/store/d494fe46a2bae430671b8de9e2e0d00720d4bf80a5f3e6d4d870c1579803?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223139Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=f861eb81cb5e418a8a0d8553f47fdba3796dd8c0fdf7589784147fc322a06c9a file_size: 0 file_name: Lawmatics_LinkedIn_Header.jpg file_type: image/jpeg created_at: '2022-08-04T14:55:13.759-07:00' updated_at: '2022-08-04T14:55:13.759-07:00' relationships: documentable: data: id: '2' type: firm - id: '45' type: file attributes: name: spaceroey.png file_url: https://bucket.s3.us-west-1.amazonaws.com/store/d8638a97af376bbfe4c37a02b58bdc00be27412ba3df2c827ac2ef43c83d?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223139Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=d999a7c1f3826190e3b562fd60d7aa776503d8dbe540e7c51e043679e6cceb74 file_size: 0 file_name: spaceroey.png file_type: image/png created_at: '2022-08-04T09:54:25.820-07:00' updated_at: '2022-08-04T09:54:25.820-07:00' relationships: documentable: data: id: '231' type: contact - id: '44' type: file attributes: name: Bob Man - Form Submission 07/25/2022 03:28pm PDT - Internal Form.pdf file_url: https://bucket.s3.us-west-1.amazonaws.com/store/14ec6afab06c33e4380cabf1afae1e1d010a70d9ea15b18bbb6beaabe1ea?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223139Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=a70b8170ae975cdb5a6f9e02d0e678336c07f58fc12246070662088efbb1581b file_size: 0 file_name: bob_man_form_submission_1658788088_internal_form.pdf file_type: application/pdf created_at: '2022-07-25T15:28:12.293-07:00' updated_at: '2022-07-25T15:28:12.293-07:00' relationships: documentable: data: id: '191' type: prospect - id: '43' type: file attributes: name: Bob Man - Form Submission 07/25/2022 03:27pm PDT - Internal Form.pdf file_url: https://bucket.s3.us-west-1.amazonaws.com/store/027bfa7a400265118a10f0bb5b7ba5f628c3a822f931c7bec272a46ba84f?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223139Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=977832ca88970c3201a4cef9ccbb135260db161aa8e30d3d78691ba447e49f8a file_size: 0 file_name: bob_man_form_submission_1658788029_internal_form.pdf file_type: application/pdf created_at: '2022-07-25T15:27:12.733-07:00' updated_at: '2022-07-25T15:27:12.733-07:00' relationships: documentable: data: id: '190' type: prospect - id: '42' type: file attributes: name: Lisa Williams - Form Submission 07/25/2022 03:24pm PDT - Internal Form.pdf file_url: https://bucket.s3.us-west-1.amazonaws.com/store/e0dae1bf5bc8525a493b0095ac3cbb968ecb26288792a190f5cec10fdf7a?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223139Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=b871cf316e75f16e3efa502a3aa00a863f06dc645de2d1a01b5906d11806c204 file_size: 0 file_name: lisa_williams_form_submission_1658787883_internal_form.pdf file_type: application/pdf created_at: '2022-07-25T15:24:51.675-07:00' updated_at: '2022-07-25T15:24:51.675-07:00' relationships: documentable: data: id: '189' type: prospect - id: '41' type: file attributes: name: Cool!!asdasdasd.png.jpg file_url: https://bucket.s3.us-west-1.amazonaws.com/store/4ff0aeabc979f59d118a0c809c51533b0bf04305376d565aa820c364e924?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223139Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=02919ec93a8cdb656b2d35840733642e9b98bbee0d4e392b46748d082ae44720 file_size: 0 file_name: Cool!!asdasdasd.png.jpg file_type: image/jpeg created_at: '2022-07-25T10:35:42.954-07:00' updated_at: '2022-07-27T11:24:44.621-07:00' relationships: documentable: data: id: '2' type: firm - id: '40' type: file attributes: name: cool story.csv file_url: https://bucket.s3.us-west-1.amazonaws.com/store/2807232cdaa3d43e2089347172dbc5d123025e2ceb76439f9b0cc340ad66?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223140Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=fe592825976776b6998a547d2109ea3161636b8c0373b2229accf3431281928c file_size: 0 file_name: cool story.csv file_type: text/csv created_at: '2022-07-12T13:11:14.184-07:00' updated_at: '2022-07-12T17:01:17.287-07:00' relationships: documentable: data: id: '168' type: prospect - id: '39' type: file attributes: name: 'Invoice #1.pdf' file_url: https://bucket.s3.us-west-1.amazonaws.com/store/a6c745e68adfc23759b2456c8bc09ac9d98d527c98cf4ff740c33198413e?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223140Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=74798bd6e7f7619577c7d34a970b581f0f9f5627a929fa8ba140b71ddfe77ede file_size: 0 file_name: 'Invoice #1.pdf' file_type: application/pdf created_at: '2022-07-06T18:56:55.603-07:00' updated_at: '2022-07-06T18:56:55.603-07:00' relationships: documentable: data: id: '1' type: invoice - id: '38' type: file attributes: name: test - Form Submission 07/04/2022 05:48pm PDT - Rel Block.pdf file_url: https://bucket.s3.us-west-1.amazonaws.com/store/eae6f302adda6078a79fe611ffc5afccba774a4b3738b6c8a97026911c83?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223140Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=fd5d85259985e2d9a8c06adb59c7438144d2ed98ee1d6784c708a48f00d84530 file_size: 0 file_name: test_form_submission_1656982120_rel_block.pdf file_type: application/pdf created_at: '2022-07-04T17:48:43.286-07:00' updated_at: '2022-07-04T17:48:43.286-07:00' relationships: documentable: data: id: '168' type: prospect - id: '37' type: file attributes: name: Test Hello.pdf file_url: https://bucket.s3.us-west-1.amazonaws.com/store/5e1a9d6f5e98f728d178f4bc70555db8ba1ad9c9ef952b30bd9492ca3d2b?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223140Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=c5f3592ad48e309d92e11cb5a654105c7124ba43bc1de8e4d39413ac32023233 file_size: 0 file_name: Test Hello.pdf file_type: application/pdf created_at: '2022-07-03T18:19:29.673-07:00' updated_at: '2022-07-12T13:09:19.042-07:00' relationships: documentable: data: id: '168' type: prospect - id: '36' type: file attributes: name: test - Form Submission 07/03/2022 06:16pm PDT - Internal Form.pdf file_url: https://bucket.s3.us-west-1.amazonaws.com/store/c3e44f8bb947e82c1e8cb3959e3c34eac7dec8757684fa5f86067642cfbf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223140Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=7708eb3345e86ebfaf233cab40b3fd157d2e8bb7227564c663142e2ac6cdf62a file_size: 0 file_name: test_form_submission_1656897411_internal_form.pdf file_type: application/pdf created_at: '2022-07-03T18:16:58.807-07:00' updated_at: '2022-07-03T18:16:58.807-07:00' relationships: documentable: data: id: '167' type: prospect - id: '35' type: file attributes: name: Lawmatics_LinkedIn_Header.jpg file_url: https://bucket.s3.us-west-1.amazonaws.com/store/5ff972883ad42adbbe87a7cef1d5ce1cd5d31ccf1d7e702c8a724b24fef8?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223140Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=6627d0e5484239b97241f9e89de69b0aa723d370025d34e7071a8733ccdf99c5 file_size: 0 file_name: Lawmatics_LinkedIn_Header.jpg file_type: image/jpeg created_at: '2022-07-03T16:00:00.571-07:00' updated_at: '2022-07-03T16:00:00.571-07:00' relationships: documentable: data: id: '2' type: firm - id: '34' type: file attributes: name: stones.jpg file_url: https://bucket.s3.us-west-1.amazonaws.com/store/203d0529a67d9abf75f69733714a15a3f634f907b60082e4030c3e81bc2f?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223140Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=ff98e4c5fa2d418e608c61efbbc413b16ac2d070fd747fb04774daf147cae876 file_size: 0 file_name: stones.jpg file_type: image/jpeg created_at: '2022-07-01T10:28:01.073-07:00' updated_at: '2022-07-01T10:28:01.073-07:00' relationships: documentable: data: id: '189' type: contact - id: '33' type: file attributes: name: Folder.jpg file_url: https://bucket.s3.us-west-1.amazonaws.com/store/a83e5e0c6936fe3f0dc5421782dbc79ce8c6c7ecba3854a40e1ea67491b8?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223140Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=ffdd44a278b0bc912203a54ec73a117f9cb8f13bf95776cc8131fa785c16a594 file_size: 0 file_name: Folder.jpg file_type: image/jpeg created_at: '2022-07-01T10:20:23.803-07:00' updated_at: '2022-07-01T10:20:23.803-07:00' relationships: documentable: data: id: '189' type: contact - id: '32' type: file attributes: name: Lawmatics_LinkedIn_Header.jpg file_url: https://bucket.s3.us-west-1.amazonaws.com/store/095ab26b896eea101eab5a9c778607738f10ede4833a735886a7d1bd4bc2?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223140Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=8261cf5387a1b8d12e23f6a10aab78f25c21f80c3a45a7f85d43edb1de7bb4ad file_size: 0 file_name: Lawmatics_LinkedIn_Header.jpg file_type: image/jpeg created_at: '2022-06-26T15:31:41.098-07:00' updated_at: '2022-06-26T15:31:41.098-07:00' relationships: documentable: data: id: '2' type: firm - id: '31' type: file attributes: name: Lawmatics_LinkedIn_Header.jpg file_url: https://bucket.s3.us-west-1.amazonaws.com/store/9900cf727fb296b32d96c1db7247152cc9a131ba4300fee9b5c7979f203c?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223141Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=196b87bb17c4f8259b1ce8861c2dbfe207d56b34842cfdad5d4d5db81d4cc19e file_size: 0 file_name: Lawmatics_LinkedIn_Header.jpg file_type: image/jpeg created_at: '2022-06-26T15:30:53.907-07:00' updated_at: '2022-06-26T15:30:53.907-07:00' relationships: documentable: data: id: '1' type: prospect - id: '30' type: file attributes: name: Lawmatics_LinkedIn_Header.jpg file_url: https://bucket.s3.us-west-1.amazonaws.com/store/fade18ead85043c48ae4a4d1eb369f8a1a161ab828c0884d1b85a0abc7d4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223141Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=b7cd060b822570ec7a5a543fdb6713f0642c794070b354e450609e28406f8b36 file_size: 0 file_name: Lawmatics_LinkedIn_Header.jpg file_type: image/jpeg created_at: '2022-06-25T17:18:40.392-07:00' updated_at: '2022-06-25T17:18:40.392-07:00' relationships: documentable: data: id: '1' type: prospect - id: '29' type: file attributes: name: Lawmatics_LinkedIn_Header.jpg file_url: https://bucket.s3.us-west-1.amazonaws.com/store/be01f4136fc22d0d0ad721d4e8f622fab1b53f18bba33c5d4813784fad00?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223141Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=9543b444af2e36af1855d9c1e95e74aaa21320fedcabc3e5e0815a9d47942844 file_size: 0 file_name: Lawmatics_LinkedIn_Header.jpg file_type: image/jpeg created_at: '2022-06-25T10:02:41.453-07:00' updated_at: '2022-06-25T10:02:41.453-07:00' relationships: documentable: data: id: '1' type: prospect - id: '28' type: file attributes: name: Lawmatics_LinkedIn_Header.jpg file_url: https://bucket.s3.us-west-1.amazonaws.com/store/d5d211a740262b977e34de50464f050f2760e93f8a10c1403ba79a47f1b4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223141Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=7e50202a183abcb05e61ba8d4f9c625de56047e3e4048b6402214324b5489856 file_size: 0 file_name: Lawmatics_LinkedIn_Header.jpg file_type: image/jpeg created_at: '2022-06-25T10:01:20.655-07:00' updated_at: '2022-06-25T10:01:20.655-07:00' relationships: documentable: data: id: '1' type: prospect - id: '27' type: file attributes: name: Lawmatics_LinkedIn_Header.jpg file_url: https://bucket.s3.us-west-1.amazonaws.com/store/23e3f75eda7a156633835c9bb138da3b033879878e0117616d89dcaf0378?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223141Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=c406ffd1f797bfe849af963781bb8e4c9558c408e58d3cd85abe32063f6facd3 file_size: 0 file_name: Lawmatics_LinkedIn_Header.jpg file_type: image/jpeg created_at: '2022-06-24T19:25:43.550-07:00' updated_at: '2022-06-24T19:25:43.550-07:00' relationships: documentable: data: id: '1' type: prospect - id: '26' type: file attributes: name: Lawmatics_LinkedIn_Header.jpg file_url: https://bucket.s3.us-west-1.amazonaws.com/store/7f5fee8fa2873b2150d672f1be983d08286c0d5751618ead58a38ee630ff?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223141Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=4b3504f50db9cd2a50d2599d198bd95133a868761bc7d34f9fdbf141fc9c5d68 file_size: 0 file_name: Lawmatics_LinkedIn_Header.jpg file_type: image/jpeg created_at: '2022-06-24T19:25:00.768-07:00' updated_at: '2022-06-24T19:25:00.768-07:00' relationships: documentable: data: id: '2' type: firm - id: '25' type: file attributes: name: stones.jpg file_url: https://bucket.s3.us-west-1.amazonaws.com/store/ba1b760b74e7110cf64b8e1aec353a2a36678cd263ab79231912e0686a14?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223141Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=04b459f6d6de1e747aad63f3373d156080974b2ddc48c236e32042c107a58c73 file_size: 0 file_name: stones.jpg file_type: image/jpeg created_at: '2022-06-20T18:03:45.722-07:00' updated_at: '2022-06-20T18:03:45.722-07:00' relationships: documentable: data: id: '162' type: prospect - id: '24' type: file attributes: name: (opening title) Forsaken.mp3 file_url: https://bucket.s3.us-west-1.amazonaws.com/store/dd24455f01dd651fe073afaf1edfd995624f5b65f1cbba74a21fd83d4a34?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223141Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=d28d8755301fd9781d2b99bad2056540dddecf76d158c45629ad648c5deb481d file_size: 0 file_name: (opening title) Forsaken.mp3 file_type: audio/mpeg created_at: '2022-06-20T01:05:23.906-07:00' updated_at: '2022-06-20T01:05:23.906-07:00' relationships: documentable: data: id: '150' type: prospect - id: '23' type: file attributes: name: LM_Matter_import3 (1).csv file_url: https://bucket.s3.us-west-1.amazonaws.com/store/a1f4a97561c339a1f54d547b70a57c98226f0b5b554f088a035d79b3a34e?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223141Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=e8e1b5f45f41eed3d74f8a7ab82cd23d9208b5dcfa570a4b2e86003f2986e25c file_size: 0 file_name: LM_Matter_import3 (1).csv file_type: text/csv created_at: '2022-06-19T23:25:01.629-07:00' updated_at: '2022-06-19T23:46:30.803-07:00' relationships: documentable: data: id: '150' type: prospect - id: '22' type: file attributes: name: goosby_res_sdf-13.pdf file_url: https://bucket.s3.us-west-1.amazonaws.com/store/c31f89fa03259249fd13b037f2fbbb5cf1163099491c2b409a5af3c4e706?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T223142Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=0f4baaf819aead8e88b6c09fbb0f77902987953557a2d7d7fd053195cfda9d29 file_size: 0 file_name: goosby_res_sdf-13.pdf file_type: application/pdf created_at: '2022-06-19T23:15:31.597-07:00' updated_at: '2022-06-19T23:15:31.597-07:00' relationships: documentable: data: id: '150' type: prospect meta: total_pages: 2 limit_per_page: 25 total_entries: 45 links: self: /v1/documents?page=1 next: /v1/documents?page=2 default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: uploadFile summary: Upload File description: 'Uploads a file to a Firm, Matter, Contact or Client Max allowed file size is 1GB. However, we recommend to avoid files greater than 100MB. documentable_type: One of ["firm", "client", "matter", "contact"] documentable_id: The record ID, not needed for Firm documentable_type. file: File to upload folder_id: the Folder ID the file should be located in name: name for the File. Defaults to uploaded file name path: String Array. e.g. ["Root", "Folder 1", "Folder 2"]. Finds folder with name or creates it if it doesn''t exist. Path overrides folder_id if both given.' tags: - Files requestBody: required: true content: multipart/form-data: schema: type: object properties: documentable_type: type: string file: type: string format: binary responses: '201': description: Created content: application/json: schema: type: object examples: postUploadFile: summary: POST Upload File value: data: id: '48' type: file attributes: name: Lawmatics_LinkedIn_Header.jpg file_size: 504210 file_url: https://bucket.s3.us-west-1.amazonaws.com/store/d494fe46a2bae430671b8de9e2e0d00720d4bf80a5f3e6d4d870c1579803?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T215513Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=bf5c169514e8ac883b0240e019c2adf3390d03368db9580393499e89015bc49f file_name: Lawmatics_LinkedIn_Header.jpg file_type: image/jpeg created_at: '2022-08-04T14:55:13.759-07:00' updated_at: '2022-08-04T14:55:13.759-07:00' relationships: documentable: data: id: '2' type: firm postUploadFileToAFilePath: summary: POST Upload File to a file path value: data: id: '48' type: file attributes: name: Lawmatics_LinkedIn_Header.jpg file_size: 504210 file_url: https://bucket.s3.us-west-1.amazonaws.com/store/d494fe46a2bae430671b8de9e2e0d00720d4bf80a5f3e6d4d870c1579803?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T215513Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=bf5c169514e8ac883b0240e019c2adf3390d03368db9580393499e89015bc49f file_name: Lawmatics_LinkedIn_Header.jpg file_type: image/jpeg folder_id: 234 created_at: '2022-08-04T14:55:13.759-07:00' updated_at: '2022-08-04T14:55:13.759-07:00' relationships: documentable: data: id: '2' type: firm postUploadFileToASpecificFolder: summary: POST Upload File to a specific folder value: data: id: '48' type: file attributes: name: Lawmatics_LinkedIn_Header.jpg file_size: 504210 file_url: https://bucket.s3.us-west-1.amazonaws.com/store/d494fe46a2bae430671b8de9e2e0d00720d4bf80a5f3e6d4d870c1579803?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXX%2F20220804%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220804T215513Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=bf5c169514e8ac883b0240e019c2adf3390d03368db9580393499e89015bc49f file_name: Lawmatics_LinkedIn_Header.jpg folder_id: 123 file_type: image/jpeg created_at: '2022-08-04T14:55:13.759-07:00' updated_at: '2022-08-04T14:55:13.759-07:00' relationships: documentable: data: id: '2' type: firm '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/files/download/{id}: get: operationId: downloadFile summary: Download File description: '- When testing from Postman please click on ''Send and download'' option instead of ''Send''. - a 404 can be sent case the file isn''t found.' tags: - Files parameters: - name: id in: path required: true description: The id schema: type: string responses: '200': description: OK '404': description: Not Found content: application/json: schema: type: object examples: fileNotFound: summary: File Not Found value: errors: - status: 404 title: Not found detail: File with id invalidId was not found. '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/folders/{folder_id}: get: operationId: getFolder summary: Folder description: A specific Folder's metadata in Lawmatics tags: - Folders parameters: - name: folder_id in: path required: true description: The folder id schema: type: string responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: getFolder: summary: GET Folder value: data: id: '3' type: folder attributes: name: images created_at: '2023-07-06T15:58:41.855-07:00' updated_at: '2023-07-06T15:58:41.855-07:00' relationships: documentable: data: id: '144' type: prospect '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer put: operationId: updateFolder summary: Update Folder description: 'Updates a Folder by ID documentable_type: One of ["matter", "contact"] documentable_id: The record ID name: Folder name. Must be unique within parent folder. Returns 429 if name is already taken. Any slashes "/" in folder name will be replaces with colons ":" folder_id: Folder ID if adding a subfolder path: String Array. e.g. ["Root", "Folder 1", "Folder 2"]. Finds folders with the name or creates it if it doesn''t exist. Moves folder into the Folder with the last name in the path. path overrides folder_id if both given.' tags: - Folders parameters: - name: folder_id in: path required: true description: The folder id schema: type: string requestBody: required: true content: multipart/form-data: schema: type: object properties: documentable_type: type: string documentable_id: type: string name: type: string responses: '200': description: OK content: application/json: schema: type: object examples: putUpdateFolder: summary: PUT Update Folder value: data: id: '20' type: folder attributes: name: Changed name created_at: '2023-07-07T15:14:15.974-07:00' updated_at: '2023-07-07T15:29:39.922-07:00' relationships: documentable: data: id: '144' type: prospect folders: data: [] putUpdateSubfolder: summary: PUT Update Subfolder value: data: id: '20' type: folder attributes: name: Subfolder is now a root folder created_at: '2023-07-07T15:14:15.974-07:00' updated_at: '2023-07-10T10:03:45.312-07:00' relationships: documentable: data: id: '225' type: contact folders: data: [] files: data: [] putUpdateSubfolderByFolderPath: summary: PUT Update Subfolder by folder path value: data: id: '164' type: folder attributes: name: bar created_at: '2024-01-19T11:29:34.054-08:00' updated_at: '2024-01-19T11:41:57.557-08:00' relationships: documentable: data: id: '143' type: prospect folders: data: - id: '159' type: folder files: data: - id: '159' type: file '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: deleteFolder summary: Delete Folder description: Deletes a Folder by ID tags: - Folders parameters: - name: folder_id in: path required: true description: The folder id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: deleteFolder: summary: DELETE Folder value: data: id: '17' type: folder attributes: name: videos created_at: '2023-07-07T14:55:12.311-07:00' updated_at: '2023-07-07T14:55:37.861-07:00' relationships: documentable: data: id: '144' type: prospect folders: data: [] '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/folders: get: operationId: getFolders summary: Folders description: 'A paginated list of all Folder metadata in Lawmatics Can be filtered by matter_id , prospect_id , contact_id as well as all the regular fields as referenced by our Param Guide (most fields returned by?fields=all).' tags: - Folders responses: '200': description: OK content: application/json: schema: type: object examples: getFolders: summary: GET Folders value: data: - id: '11' type: folder attributes: name: eulogy created_at: '2023-07-06T16:10:00.232-07:00' updated_at: '2023-07-06T16:10:00.232-07:00' relationships: documentable: data: id: '142' type: prospect - id: '6' type: folder attributes: name: docs created_at: '2023-07-06T16:01:22.321-07:00' updated_at: '2023-07-06T16:01:22.321-07:00' relationships: documentable: data: id: '144' type: prospect - id: '3' type: folder attributes: name: images created_at: '2023-07-06T15:58:41.855-07:00' updated_at: '2023-07-06T15:58:41.855-07:00' relationships: documentable: data: id: '144' type: prospect meta: total_pages: 1 limit_per_page: 25 total_entries: 3 links: self: /v1/folders?page=1 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createFolder summary: Create Folder description: 'Creates a folder for a Matter or Contact documentable_type: One of ["matter", "contact"] documentable_id: The record ID name: Folder name. Must be unique within parent folder. Returns 429 if name is already taken. Any slashes "/" in folder name will be replaces with colons ":" folder_id: Folder ID if adding a subfolder path: String Array. e.g. ["Root", "Folder 1", "Folder 2"]. Finds the folder with the name or creates it if it doesn''t exist. Path overrides folder_id if both given.' tags: - Folders requestBody: required: true content: multipart/form-data: schema: type: object properties: documentable_type: type: string documentable_id: type: string name: type: string folder_id: type: string responses: '201': description: Created content: application/json: schema: type: object examples: postCreateFolder: summary: POST Create Folder value: data: id: '21' type: folder attributes: name: This is a folder created_at: '2023-07-07T15:19:05.673-07:00' updated_at: '2023-07-07T15:19:05.673-07:00' folder_id: 456 relationships: documentable: data: id: '144' type: prospect folders: data: [] default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/prospects/find_by_phone/{phone_number}: get: operationId: findMatterByPhoneNumber summary: Find Matter By Phone Number description: Fuzzy find a specific Matter by Phone Number. tags: - Matters (Prospects) parameters: - name: phone_number in: path required: true description: Any valid phone number. We strip all non digits when matching, and try with and without the leading 1 for US country codes. schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getFindMatterByPhoneNumber: summary: GET Find Matter By Phone Number value: data: id: '41871' type: prospect attributes: first_name: Roey last_name: Chasman email: roey+api@lawmatics.com phone: '5555555555' created_at: '2018-10-17T17:24:43.293-07:00' updated_at: '2018-10-17T17:24:43.293-07:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/prospects/find_by_email/{email_address}: get: operationId: findMatterByEmailAddress summary: Find Matter By Email Address description: Fuzzy find a specific Matter by Email Address. tags: - Matters (Prospects) parameters: - name: email_address in: path required: true description: A valid email address schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getFindMatterByEmailAddress: summary: GET Find Matter By Email Address value: data: id: '41871' type: prospect attributes: first_name: Roey last_name: Chasman email: roey+api@lawmatics.com phone: '5555555555' created_at: '2018-10-17T17:24:43.293-07:00' updated_at: '2018-10-17T17:24:43.293-07:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/prospects/find_by_name/{name}: get: operationId: findMatterByName summary: Find Matter By Name description: Fuzzy find (case-insensitive) a specific Matter by their Name. You can pass either '{first_name} {last_name}' or simply '{first_name}' tags: - Matters (Prospects) parameters: - name: name in: path required: true description: We return the closest match. For better results include the PNC Contact's last name. schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getFindMatterByName: summary: GET Find Matter By Name value: data: id: '41871' type: prospect attributes: first_name: Roey last_name: Chasman email: roey+api@lawmatics.com phone: '5555555555' created_at: '2018-10-17T17:24:43.293-07:00' updated_at: '2018-10-17T17:24:43.293-07:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/interactions/{interaction_id}: get: operationId: getInteraction summary: Interaction description: Retrieves an interaction by its ID tags: - Matters (Prospects) parameters: - name: interaction_id in: path required: true description: The interaction id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getInteraction: summary: GET Interaction value: data: id: '69' type: interaction attributes: interaction_type: One kind of interaction body: The one - cannot change. happened_at: '2019-03-01T14:00:00.000-08:00' created_at: '2022-08-23T20:19:47.926-07:00' updated_at: '2022-08-24T15:30:15.255-07:00' relationships: created_by: data: id: '2' type: user interactable: data: id: '144' type: prospect '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer put: operationId: updateInteraction summary: Update Interaction description: 'Update an existing Interaction by ID. PATCH works for this endpoint as well as PUT.' tags: - Matters (Prospects) parameters: - name: interaction_id in: path required: true description: The interaction id schema: type: string requestBody: required: true content: application/json: schema: type: object example: happened_at: '2019-02-29T15:00:00-07:00' body: The one - from 143 to 144 interaction_type: One kind of interaction responses: '200': description: OK content: application/json: schema: type: object examples: putUpdateInteraction: summary: PUT Update Interaction value: data: id: '69' type: interaction attributes: interaction_type: One kind of interaction body: A changed body. happened_at: '2019-03-01T14:00:00.000-08:00' created_at: '2022-08-23T20:19:47.926-07:00' updated_at: '2022-08-24T20:43:05.020-07:00' relationships: created_by: data: id: '2' type: user interactable: data: id: '144' type: prospect '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: deleteInteraction summary: Delete Interaction description: Deletes an existing interaction tags: - Matters (Prospects) parameters: - name: interaction_id in: path required: true description: The interaction id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: deleteInteraction: summary: DELETE Interaction value: data: id: '69' type: interaction attributes: interaction_type: One kind of interaction body: A changed body. happened_at: '2019-03-01T14:00:00.000-08:00' created_at: '2022-08-23T20:19:47.926-07:00' updated_at: '2022-08-24T20:43:25.148-07:00' relationships: created_by: data: id: '2' type: user interactable: data: id: '144' type: prospect '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/interactions: get: operationId: getInteractions summary: Interactions description: A paginated list of all Interactions in Lawmatics tags: - Matters (Prospects) responses: '200': description: OK content: application/json: schema: type: object examples: getInteractions: summary: GET Interactions value: data: - id: '70' type: interaction attributes: interaction_type: A type of interaction body: The two. happened_at: '2022-06-29T15:00:00.000-07:00' created_at: '2022-08-24T15:29:44.289-07:00' updated_at: '2022-08-24T15:29:44.289-07:00' relationships: created_by: data: id: '2' type: user interactable: data: id: '143' type: prospect - id: '69' type: interaction attributes: interaction_type: One kind of interaction body: The one - cannot change. happened_at: '2019-03-01T14:00:00.000-08:00' created_at: '2022-08-23T20:19:47.926-07:00' updated_at: '2022-08-24T15:30:15.255-07:00' relationships: created_by: data: id: '2' type: user interactable: data: id: '144' type: prospect - id: '68' type: interaction attributes: interaction_type: some type of Interaction body: Body of the Interaction. happened_at: '2022-06-29T15:00:00.000-07:00' created_at: '2022-08-19T07:08:05.717-07:00' updated_at: '2022-08-19T07:08:05.717-07:00' relationships: created_by: data: id: '2' type: user interactable: data: id: '143' type: prospect - id: '67' type: interaction attributes: interaction_type: some type of Interaction body: Body of the Interaction. happened_at: '2022-06-29T15:00:00.000-07:00' created_at: '2022-08-19T06:57:07.842-07:00' updated_at: '2022-08-19T06:57:07.842-07:00' relationships: created_by: data: id: '2' type: user interactable: data: id: '143' type: prospect - id: '65' type: interaction attributes: interaction_type: Phone Call body: '2016' happened_at: '2016-08-18T21:02:00.790-07:00' created_at: '2022-08-18T21:03:08.111-07:00' updated_at: '2022-08-18T21:03:08.111-07:00' relationships: created_by: data: id: '2' type: user interactable: data: id: '143' type: prospect - id: '33' type: interaction attributes: interaction_type: some type of Interaction body: Body of the Interaction. happened_at: '2022-06-29T15:00:00.000-07:00' created_at: '2022-08-17T07:45:22.510-07:00' updated_at: '2022-08-17T07:45:22.510-07:00' relationships: created_by: data: id: '2' type: user interactable: data: id: '12' type: prospect - id: '32' type: interaction attributes: interaction_type: some type of Interaction body: Body of the Interaction. happened_at: '2022-06-29T15:00:00.000-07:00' created_at: '2022-08-17T07:18:57.068-07:00' updated_at: '2022-08-17T07:18:57.068-07:00' relationships: created_by: data: id: '2' type: user interactable: data: id: '12' type: prospect - id: '31' type: interaction attributes: interaction_type: some type of Interaction body: Body of the Interaction. happened_at: '2022-06-29T15:00:00.000-07:00' created_at: '2022-08-17T07:18:20.243-07:00' updated_at: '2022-08-17T07:18:20.243-07:00' relationships: created_by: data: id: '2' type: user interactable: data: id: '12' type: prospect - id: '29' type: interaction attributes: interaction_type: some type of Interaction body: Body of the Interaction. happened_at: '2022-06-29T15:00:00.000-07:00' created_at: '2022-08-16T18:31:05.746-07:00' updated_at: '2022-08-16T18:31:05.748-07:00' relationships: created_by: data: id: '2' type: user interactable: data: id: '121' type: prospect - id: '28' type: interaction attributes: interaction_type: some type of Interaction body: Body of the Interaction. happened_at: '2022-06-29T15:00:00.000-07:00' created_at: '2022-08-16T18:31:00.704-07:00' updated_at: '2022-08-16T18:31:00.713-07:00' relationships: created_by: data: id: '2' type: user interactable: data: id: '12' type: prospect - id: '27' type: interaction attributes: interaction_type: some type of Interaction body: Body of the Interaction. happened_at: '2022-06-29T15:00:00.000-07:00' created_at: '2022-08-16T10:13:38.683-07:00' updated_at: '2022-08-16T10:13:38.685-07:00' relationships: created_by: data: id: '2' type: user interactable: data: id: '12' type: prospect - id: '26' type: interaction attributes: interaction_type: some type of Interaction too body: Body of the Interaction! happened_at: '2022-06-29T15:00:00.000-07:00' created_at: '2022-08-16T10:13:28.379-07:00' updated_at: '2022-08-16T10:13:28.381-07:00' relationships: created_by: data: id: '2' type: user interactable: data: id: '12' type: prospect - id: '25' type: interaction attributes: interaction_type: some type of Interaction body: Body of the Interaction! happened_at: '2022-06-29T15:00:00.000-07:00' created_at: '2022-08-16T10:13:20.531-07:00' updated_at: '2022-08-16T10:13:20.534-07:00' relationships: created_by: data: id: '2' type: user interactable: data: id: '12' type: prospect - id: '24' type: interaction attributes: interaction_type: some type of Interaction body: Body of the Interaction happened_at: '2022-06-29T15:00:00.000-07:00' created_at: '2022-08-16T10:13:16.189-07:00' updated_at: '2022-08-16T10:13:16.207-07:00' relationships: created_by: data: id: '2' type: user interactable: data: id: '12' type: prospect - id: '23' type: interaction attributes: interaction_type: some type of Interaction body: Body of the Interaction happened_at: '2022-06-29T15:00:00.000-07:00' created_at: '2022-08-16T10:04:07.490-07:00' updated_at: '2022-08-16T10:04:07.522-07:00' relationships: created_by: data: id: '2' type: user interactable: data: id: '12' type: prospect - id: '22' type: interaction attributes: interaction_type: some type of Interaction body: Body of the Interaction happened_at: '2022-06-29T15:00:00.000-07:00' created_at: '2022-08-16T09:52:39.900-07:00' updated_at: '2022-08-16T09:52:39.917-07:00' relationships: created_by: data: id: '2' type: user interactable: data: id: '12' type: prospect - id: '21' type: interaction attributes: interaction_type: '77777' body: '77777' happened_at: '2022-03-01T14:00:00.000-08:00' created_at: '2022-08-16T09:04:14.069-07:00' updated_at: '2022-08-16T09:12:12.824-07:00' relationships: created_by: data: id: '2' type: user interactable: data: id: '12' type: prospect - id: '6' type: interaction attributes: interaction_type: '77777' body: '77777' happened_at: '2022-03-01T14:00:00.000-08:00' created_at: '2022-08-16T08:23:18.610-07:00' updated_at: '2022-08-16T10:20:42.847-07:00' relationships: created_by: data: id: '2' type: user interactable: data: id: '12' type: prospect meta: total_pages: 1 limit_per_page: 25 total_entries: 18 links: self: /v1/interactions?page=1 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createInteraction summary: Create Interaction description: 'Create a new Interaction Required fields: happened_at: timestamp meaning when the interaction happened prospect_id: Integer value, id of the prospect this interaction is related to body: text describing the interaction interaction_type: a string describing the kind of interaction that happened' tags: - Matters (Prospects) responses: '201': description: Created content: application/json: schema: type: object examples: postCreateInteraction: summary: POST Create Interaction value: data: id: '71' type: interaction attributes: interaction_type: A type of interaction body: the body happened_at: '2022-06-29T15:00:00.000-07:00' created_at: '2022-08-24T20:42:19.343-07:00' updated_at: '2022-08-24T20:42:19.343-07:00' relationships: created_by: data: id: '2' type: user interactable: data: id: '143' type: prospect '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/campaigns/{campaign_id}: get: operationId: getCampaign summary: Campaign description: A specific Marketing Campaign by ID tags: - Matters (Prospects) parameters: - name: campaign_id in: path required: true description: The campaign id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getCampaign: summary: GET Campaign value: data: id: '192' type: campaign attributes: name: ClioCon 2018 description: ClioCon in New Orleans 2018 utm_match: clio_con tracking_number: '+18556347246' pnc_count: 9 created_at: '2018-10-04T10:35:00.880-07:00' updated_at: '2018-10-04T10:35:00.880-07:00' relationships: source: data: id: '2' type: source prospects: data: - id: '12505' type: prospect - id: '6017' type: prospect - id: '5977' type: prospect - id: '5974' type: prospect - id: '5971' type: prospect - id: '5968' type: prospect - id: '5966' type: prospect - id: '5963' type: prospect - id: '5959' type: prospect '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/campaigns: get: operationId: getCampaigns summary: Campaigns description: A paginated list of all Marketing Campaigns in Lawmatics tags: - Matters (Prospects) responses: '200': description: OK content: application/json: schema: type: object examples: getCampaigns: summary: GET Campaigns value: data: - id: '284' type: campaign attributes: name: Landing Page Ad 1 created_at: '2018-10-11T18:09:55.363-07:00' updated_at: '2018-10-11T18:09:55.363-07:00' relationships: {} - id: '285' type: campaign attributes: name: Blog Ad 1 created_at: '2018-10-12T15:28:16.893-07:00' updated_at: '2018-10-12T15:28:23.512-07:00' relationships: {} - id: '286' type: campaign attributes: name: Banner Ad 1 created_at: '2018-10-12T15:28:34.041-07:00' updated_at: '2018-10-12T15:28:34.041-07:00' relationships: {} - id: '287' type: campaign attributes: name: Banner Ad 2 created_at: '2018-10-12T15:28:41.512-07:00' updated_at: '2018-10-12T15:28:45.320-07:00' relationships: {} - id: '288' type: campaign attributes: name: Roey Chasman created_at: '2018-10-12T15:38:08.058-07:00' updated_at: '2018-10-12T15:38:08.058-07:00' relationships: {} meta: total_pages: 1 limit_per_page: 25 total_entries: 5 links: self: /v1/campaigns?page=1 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/sources/{source_id}: get: operationId: getSource summary: Source description: A specific Marketing Source by ID tags: - Matters (Prospects) parameters: - name: source_id in: path required: true description: The source id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getSource: summary: GET Source value: data: id: '243' type: source attributes: name: Facebook description: null color: '#F70303' utm_match: null spend_frequency: weekly tracking_number: null pnc_count: 0 created_at: '2018-09-20T10:45:21.681-07:00' updated_at: '2018-09-20T10:45:21.681-07:00' relationships: campaigns: data: - id: '174' type: campaign prospects: data: [] '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/sources: get: operationId: getSources summary: Sources description: A paginated list of all Marketing Sources in Lawmatics tags: - Matters (Prospects) responses: '200': description: OK content: application/json: schema: type: object examples: getSources: summary: GET Sources value: data: - id: '243' type: source attributes: name: Facebook created_at: '2018-09-20T10:45:21.681-07:00' updated_at: '2018-09-20T10:45:21.681-07:00' relationships: {} - id: '200' type: source attributes: name: Nolo created_at: '2018-08-29T15:14:15.629-07:00' updated_at: '2018-08-29T15:14:15.629-07:00' relationships: {} - id: '90' type: source attributes: name: ChatBot 101 created_at: '2018-07-20T09:44:43.821-07:00' updated_at: '2018-07-20T09:44:43.821-07:00' relationships: {} - id: '6' type: source attributes: name: Referrals created_at: '2018-03-04T02:17:45.924-08:00' updated_at: '2018-04-12T14:13:01.357-07:00' relationships: {} - id: '3' type: source attributes: name: Google created_at: '2018-01-24T10:44:54.260-08:00' updated_at: '2018-01-24T10:44:54.260-08:00' relationships: {} - id: '2' type: source attributes: name: Conferences created_at: '2018-01-08T10:47:20.997-08:00' updated_at: '2018-10-05T09:02:59.114-07:00' relationships: {} - id: '1' type: source attributes: name: Google PPC created_at: '2018-01-08T10:02:16.040-08:00' updated_at: '2018-10-05T07:29:39.386-07:00' relationships: {} meta: total_pages: 1 limit_per_page: 25 total_entries: 7 links: self: /v1/source?page=1 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/pipelines/{pipeline_id}: get: operationId: getPipeline summary: Pipeline description: A specific Pipeline by id tags: - Matters (Prospects) parameters: - name: pipeline_id in: path required: true description: The pipeline id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getPipeline: summary: GET Pipeline value: data: id: '4' type: pipeline attributes: name: Intake description: Intake Pipeline statuses: - pnc pipeline_type: intake matter_count: 174 estimated_value: $0.22 created_at: '2019-02-28T07:21:48.362-08:00' updated_at: '2019-02-28T07:21:48.362-08:00' relationships: stages: data: - id: '6' type: stage - id: '7' type: stage - id: '9' type: stage - id: '148' type: stage - id: '352' type: stage - id: '138' type: stage - id: '146' type: stage - id: '147' type: stage created_by: data: id: '14' type: user '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/pipelines: get: operationId: getPipelines summary: Pipelines description: A paginated list of all Pipelines in Lawmatics tags: - Matters (Prospects) responses: '200': description: OK content: application/json: schema: type: object examples: getPipelines: summary: GET Pipelines value: data: - id: '61' type: pipeline attributes: name: sdf description: sdfdfs statuses: - pnc pipeline_type: normal matter_count: 0 estimated_value: $0 created_at: '2019-04-01T13:47:21.156-07:00' updated_at: '2019-04-01T13:47:21.156-07:00' relationships: stages: data: [] created_by: data: id: '3' type: user - id: '60' type: pipeline attributes: name: test23 description: wow statuses: - pnc pipeline_type: intake matter_count: 0 estimated_value: $0 created_at: '2019-04-01T13:46:50.796-07:00' updated_at: '2019-04-01T13:46:50.796-07:00' relationships: stages: data: - id: '374' type: stage created_by: data: id: '3' type: user - id: '16' type: pipeline attributes: name: test description: test statuses: - pnc pipeline_type: intake matter_count: 0 estimated_value: $0 created_at: '2019-03-12T10:45:35.796-07:00' updated_at: '2019-03-12T10:45:35.796-07:00' relationships: stages: data: [] created_by: data: id: '3' type: user - id: '4' type: pipeline attributes: name: Intake description: Intake Pipeline statuses: - pnc pipeline_type: intake matter_count: 173 estimated_value: $0.22 created_at: '2019-02-28T07:21:48.362-08:00' updated_at: '2019-02-28T07:21:48.362-08:00' relationships: stages: data: - id: '6' type: stage - id: '7' type: stage - id: '9' type: stage - id: '148' type: stage - id: '352' type: stage - id: '138' type: stage - id: '146' type: stage - id: '147' type: stage created_by: data: id: '14' type: user meta: total_pages: 1 limit_per_page: 25 total_entries: 4 links: self: /v1/pipeline?page=1 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/stages/{stage_id}: get: operationId: getStage summary: Stage description: A specific Stage by id tags: - Matters (Prospects) parameters: - name: stage_id in: path required: true description: The stage id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getStage: summary: GET Stage value: data: id: '147' type: stage attributes: name: Initial Call color: '#bcc2c94d' order: 7 created_at: '2018-10-02T11:25:35.532-07:00' updated_at: '2019-02-28T19:28:40.101-08:00' relationships: prospects: data: - id: '50645' type: prospect pipeline: data: id: '4' type: pipeline '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/stages: get: operationId: getStages summary: Stages description: A paginated list of all Stages in Lawmatics tags: - Matters (Prospects) responses: '200': description: OK content: application/json: schema: type: object examples: getStagesFilteredByPipeline: summary: GET Stages Filtered By Pipeline value: data: - id: '352' type: stage attributes: name: test w relationships: pipeline: data: id: '4' type: pipeline - id: '148' type: stage attributes: name: Consult Completed relationships: pipeline: data: id: '4' type: pipeline - id: '147' type: stage attributes: name: Initial Call relationships: pipeline: data: id: '4' type: pipeline - id: '146' type: stage attributes: name: Consult Scheduled relationships: pipeline: data: id: '4' type: pipeline - id: '138' type: stage attributes: name: Really very way too long stage name relationships: pipeline: data: id: '4' type: pipeline - id: '9' type: stage attributes: name: Stage 3 relationships: pipeline: data: id: '4' type: pipeline - id: '7' type: stage attributes: name: Stage 2 relationships: pipeline: data: id: '4' type: pipeline - id: '6' type: stage attributes: name: Stage 1 relationships: pipeline: data: id: '4' type: pipeline meta: total_pages: 1 limit_per_page: 25 total_entries: 8 links: self: /v1/stage?page=1 getStages: summary: GET Stages value: data: - id: '352' type: stage attributes: name: test w color: '#757F8F' order: 4 created_at: '2019-01-10T16:13:55.733-08:00' updated_at: '2019-03-06T23:08:42.168-08:00' relationships: prospects: data: - id: '54736' type: prospect - id: '50661' type: prospect pipeline: data: id: '4' type: pipeline - id: '148' type: stage attributes: name: Consult Completed color: '#bcc2c94d' order: 3 created_at: '2018-10-02T11:25:36.329-07:00' updated_at: '2019-03-06T23:08:42.168-08:00' relationships: prospects: data: - id: '54747' type: prospect - id: '54787' type: prospect - id: '54748' type: prospect - id: '54749' type: prospect - id: '54750' type: prospect pipeline: data: id: '4' type: pipeline - id: '147' type: stage attributes: name: Initial Call color: '#bcc2c94d' order: 7 created_at: '2018-10-02T11:25:35.532-07:00' updated_at: '2019-02-28T19:28:40.101-08:00' relationships: prospects: data: - id: '50645' type: prospect pipeline: data: id: '4' type: pipeline - id: '146' type: stage attributes: name: Consult Scheduled color: '#bcc2c94d' order: 6 created_at: '2018-10-02T11:25:35.363-07:00' updated_at: '2019-02-28T19:28:40.096-08:00' relationships: prospects: data: - id: '79' type: prospect - id: '32' type: prospect - id: '10' type: prospect - id: '100' type: prospect - id: '46' type: prospect - id: '17877' type: prospect - id: '17683' type: prospect - id: '27' type: prospect pipeline: data: id: '4' type: pipeline - id: '138' type: stage attributes: name: Really very way too long stage name color: '#F70303' order: 5 created_at: '2018-08-07T16:55:52.659-07:00' updated_at: '2019-02-28T19:28:40.091-08:00' relationships: prospects: data: - id: '54688' type: prospect - id: '19' type: prospect - id: '54767' type: prospect - id: '45305' type: prospect - id: '6' type: prospect - id: '41789' type: prospect - id: '65' type: prospect - id: '45302' type: prospect - id: '16' type: prospect - id: '90' type: prospect - id: '93' type: prospect - id: '60' type: prospect pipeline: data: id: '4' type: pipeline - id: '9' type: stage attributes: name: Stage 3 color: '#70B08B' order: 2 created_at: '2018-07-17T17:40:21.805-07:00' updated_at: '2019-03-06T23:08:42.170-08:00' relationships: prospects: data: - id: '50662' type: prospect - id: '45306' type: prospect - id: '41788' type: prospect - id: '17682' type: prospect - id: '17681' type: prospect - id: '45303' type: prospect - id: '128' type: prospect - id: '21' type: prospect - id: '68' type: prospect - id: '26' type: prospect - id: '95' type: prospect - id: '52' type: prospect pipeline: data: id: '4' type: pipeline - id: '7' type: stage attributes: name: Stage 2 color: '#DC438F' order: 1 created_at: '2018-07-16T15:12:39.502-07:00' updated_at: '2019-03-06T23:08:40.445-08:00' relationships: prospects: data: - id: '40' type: prospect - id: '45310' type: prospect - id: '50649' type: prospect - id: '45311' type: prospect - id: '72' type: prospect - id: '63' type: prospect - id: '57' type: prospect - id: '23' type: prospect - id: '43' type: prospect - id: '35' type: prospect - id: '67' type: prospect - id: '62' type: prospect - id: '58' type: prospect - id: '12' type: prospect - id: '17' type: prospect - id: '20' type: prospect - id: '80' type: prospect - id: '55' type: prospect - id: '53' type: prospect - id: '77' type: prospect - id: '44' type: prospect - id: '99' type: prospect pipeline: data: id: '4' type: pipeline - id: '6' type: stage attributes: name: Stage 1 color: '#7997C9' order: 0 created_at: '2018-07-16T15:12:39.495-07:00' updated_at: '2019-02-28T07:21:48.506-08:00' relationships: prospects: data: - id: '54896' type: prospect - id: '54895' type: prospect - id: '54894' type: prospect - id: '54893' type: prospect - id: '54892' type: prospect - id: '54891' type: prospect - id: '54890' type: prospect - id: '54889' type: prospect - id: '54888' type: prospect - id: '54887' type: prospect - id: '54886' type: prospect - id: '54885' type: prospect - id: '54884' type: prospect - id: '54883' type: prospect - id: '54882' type: prospect - id: '54881' type: prospect - id: '54880' type: prospect - id: '54879' type: prospect - id: '54878' type: prospect - id: '54877' type: prospect - id: '54876' type: prospect - id: '54875' type: prospect - id: '54874' type: prospect - id: '54873' type: prospect - id: '54872' type: prospect - id: '54871' type: prospect - id: '54870' type: prospect - id: '54869' type: prospect - id: '54868' type: prospect - id: '54867' type: prospect - id: '54866' type: prospect - id: '54865' type: prospect - id: '54864' type: prospect - id: '54863' type: prospect - id: '54862' type: prospect - id: '54861' type: prospect - id: '54860' type: prospect - id: '54859' type: prospect - id: '54858' type: prospect - id: '54857' type: prospect - id: '54856' type: prospect - id: '54855' type: prospect - id: '54854' type: prospect - id: '54853' type: prospect - id: '54852' type: prospect - id: '54851' type: prospect - id: '54850' type: prospect - id: '54849' type: prospect - id: '54848' type: prospect - id: '54846' type: prospect - id: '54845' type: prospect - id: '54844' type: prospect - id: '54843' type: prospect - id: '54842' type: prospect - id: '54841' type: prospect - id: '54840' type: prospect - id: '54839' type: prospect - id: '54838' type: prospect - id: '54837' type: prospect - id: '54836' type: prospect - id: '54833' type: prospect - id: '54832' type: prospect - id: '54831' type: prospect - id: '54820' type: prospect - id: '54810' type: prospect - id: '54808' type: prospect - id: '54807' type: prospect - id: '54730' type: prospect - id: '54733' type: prospect - id: '50659' type: prospect - id: '50664' type: prospect - id: '50663' type: prospect - id: '50665' type: prospect - id: '45307' type: prospect - id: '122' type: prospect - id: '127' type: prospect - id: '45308' type: prospect - id: '45301' type: prospect - id: '28' type: prospect - id: '8' type: prospect - id: '87' type: prospect - id: '86' type: prospect - id: '82' type: prospect - id: '22' type: prospect - id: '18' type: prospect - id: '9' type: prospect - id: '98' type: prospect - id: '61' type: prospect - id: '7' type: prospect - id: '5' type: prospect - id: '74' type: prospect - id: '70' type: prospect - id: '69' type: prospect - id: '59' type: prospect - id: '51' type: prospect - id: '49' type: prospect - id: '42' type: prospect - id: '41' type: prospect - id: '36' type: prospect - id: '34' type: prospect - id: '30' type: prospect - id: '97' type: prospect - id: '94' type: prospect - id: '92' type: prospect - id: '91' type: prospect pipeline: data: id: '4' type: pipeline meta: total_pages: 1 limit_per_page: 25 total_entries: 8 links: self: /v1/stage?page=1 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/practice_areas/{practice_area_id}: get: operationId: getPracticeArea summary: Practice Area description: A specific Practice Area by id tags: - Matters (Prospects) parameters: - name: practice_area_id in: path required: true description: The practice area id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getPracticeArea: summary: GET Practice Area value: data: id: '63' type: practice_area attributes: name: Family Law color: '#bcc2c9' created_at: '2018-07-23T14:41:38.401-07:00' updated_at: '2018-07-23T14:41:38.401-07:00' '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer put: operationId: updatePracticeArea summary: Update Practice Area description: 'Updates an existing Practice Area Optional Fields: statute_of_limitations_enabled name: The Area name color: The Area color. Can be any CSS valid color (hex, rgb, hsl, colorname string, etc) statute_of_limitations_enabled: If Statute of Limitations is enabled' tags: - Matters (Prospects) parameters: - name: practice_area_id in: path required: true description: The practice area id schema: type: string requestBody: required: true content: application/json: schema: type: object example: name: New Name color: '#bcc2c9' statute_of_limitations_enabled: true responses: '201': description: Created content: application/json: schema: type: object examples: putUpdatePracticeArea: summary: PUT Update Practice Area value: data: id: '9' type: practice_area attributes: name: New Name color: '#bcc2c9' statute_of_limitations_enabled: true matter_count: 0 created_at: '2022-05-26T10:54:59.444-07:00' updated_at: '2022-05-26T11:27:35.598-07:00' relationships: prospects: data: [] '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: deletePracticeArea summary: Delete Practice Area description: Deletes an existing Practice Area tags: - Matters (Prospects) parameters: - name: practice_area_id in: path required: true description: The practice area id schema: type: string responses: '201': description: Created content: application/json: schema: type: object examples: deleteUpdatePracticeArea: summary: DELETE Update Practice Area value: data: id: '9' type: practice_area attributes: name: New Name created_at: '2022-05-26T10:54:59.444-07:00' updated_at: '2022-05-26T11:45:32.351-07:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/practice_areas: get: operationId: getPracticeAreas summary: Practice Areas description: A paginated list of all Practice Areas in Lawmatics tags: - Matters (Prospects) responses: '200': description: OK content: application/json: schema: type: object examples: getPracticeAreas: summary: GET Practice Areas value: data: - id: '4' type: practice_area attributes: name: Criminal Defense color: '#bcc2c9' created_at: '2018-07-16T15:13:04.112-07:00' updated_at: '2018-07-16T15:13:04.112-07:00' - id: '5' type: practice_area attributes: name: Intellectual Property color: '#bcc2c9' created_at: '2018-07-16T15:13:04.114-07:00' updated_at: '2018-07-16T15:13:04.114-07:00' - id: '6' type: practice_area attributes: name: Divorce color: '#bcc2c9' created_at: '2018-07-16T15:13:04.116-07:00' updated_at: '2018-07-16T15:13:04.116-07:00' - id: '63' type: practice_area attributes: name: Family Law color: '#bcc2c9' created_at: '2018-07-23T14:41:38.401-07:00' updated_at: '2018-07-23T14:41:38.401-07:00' - id: '64' type: practice_area attributes: name: Veterans Disability color: '#bcc2c9' created_at: '2018-07-23T14:41:38.691-07:00' updated_at: '2018-07-23T14:41:38.691-07:00' - id: '65' type: practice_area attributes: name: Estate Planning color: '#bcc2c9' created_at: '2018-07-23T14:41:39.193-07:00' updated_at: '2018-07-23T14:41:39.193-07:00' - id: '94' type: practice_area attributes: name: Expungement color: '#bcc2c9' created_at: '2018-08-07T16:49:06.060-07:00' updated_at: '2018-08-07T16:49:06.060-07:00' - id: '95' type: practice_area attributes: name: Dui color: '#bcc2c9' created_at: '2018-08-07T16:49:06.134-07:00' updated_at: '2018-08-07T16:49:06.134-07:00' - id: '96' type: practice_area attributes: name: Unknown color: '#bcc2c9' created_at: '2018-08-07T16:49:06.187-07:00' updated_at: '2018-08-07T16:49:06.187-07:00' - id: '97' type: practice_area attributes: name: Misdemeanor color: '#bcc2c9' created_at: '2018-08-07T16:49:06.221-07:00' updated_at: '2018-08-07T16:49:06.221-07:00' - id: '98' type: practice_area attributes: name: Non Practice Area color: '#bcc2c9' created_at: '2018-08-07T16:49:06.233-07:00' updated_at: '2018-08-07T16:49:06.233-07:00' - id: '99' type: practice_area attributes: name: Domestic Violence color: '#bcc2c9' created_at: '2018-08-07T16:49:06.302-07:00' updated_at: '2018-08-07T16:49:06.302-07:00' - id: '100' type: practice_area attributes: name: Felony color: '#bcc2c9' created_at: '2018-08-07T16:49:06.384-07:00' updated_at: '2018-08-07T16:49:06.384-07:00' - id: '101' type: practice_area attributes: name: Marijuana color: '#bcc2c9' created_at: '2018-08-07T16:49:06.691-07:00' updated_at: '2018-08-07T16:49:06.691-07:00' - id: '102' type: practice_area attributes: name: Asset Forfeiture color: '#bcc2c9' created_at: '2018-08-07T16:49:06.927-07:00' updated_at: '2018-08-07T16:49:06.927-07:00' - id: '103' type: practice_area attributes: name: Juvenile color: '#bcc2c9' created_at: '2018-08-07T16:49:07.191-07:00' updated_at: '2018-08-07T16:49:07.191-07:00' - id: '104' type: practice_area attributes: name: Marijuana Business color: '#bcc2c9' created_at: '2018-08-07T16:49:07.315-07:00' updated_at: '2018-08-07T16:49:07.315-07:00' - id: '105' type: practice_area attributes: name: Prop 64 color: '#bcc2c9' created_at: '2018-08-07T16:49:08.097-07:00' updated_at: '2018-08-07T16:49:08.097-07:00' - id: '106' type: practice_area attributes: name: Prop 57 color: '#bcc2c9' created_at: '2018-08-07T16:49:09.110-07:00' updated_at: '2018-08-07T16:49:09.110-07:00' - id: '107' type: practice_area attributes: name: Unassigned color: '#bcc2c9' created_at: '2018-08-07T16:49:09.644-07:00' updated_at: '2018-08-07T16:49:09.644-07:00' - id: '109' type: practice_area attributes: name: Business - Business General color: '#757F8F' created_at: '2018-08-24T16:36:17.715-07:00' updated_at: '2018-08-24T16:36:17.715-07:00' - id: '125' type: practice_area attributes: name: Paternity color: '#bcc2c9' created_at: '2018-10-08T14:26:25.945-07:00' updated_at: '2018-10-08T14:26:25.945-07:00' - id: '128' type: practice_area attributes: name: Limited Scope color: '#bcc2c9' created_at: '2018-10-11T10:11:54.969-07:00' updated_at: '2018-10-11T10:11:54.969-07:00' meta: total_pages: 1 limit_per_page: 25 total_entries: 23 links: self: /v1/practice_areas?page=1 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createPracticeArea summary: Create Practice Area description: 'Create a new Practice Area Optional Fields: statute_of_limitations_enabled name: The Area name color: The Area color. Can be any CSS valid color (hex, rgb, hsl, colorname string, etc) statute_of_limitations_enabled: If Statute of Limitations is enabled' tags: - Matters (Prospects) requestBody: required: true content: application/json: schema: type: object example: name: Test Practice Area c87d06a9-05b2-44ab-861f-43cd1ee1de67 color: '#bcc2c9' statute_of_limitations_enabled: true responses: '201': description: Created content: application/json: schema: type: object examples: postCreatePracticeArea: summary: POST Create Practice Area value: data: id: '9' type: practice_area attributes: name: New Area color: '#bcc2c9' statute_of_limitations_enabled: true matter_count: 0 created_at: '2022-05-26T10:54:59.444-07:00' updated_at: '2022-05-26T10:54:59.444-07:00' relationships: prospects: data: [] '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/relationships/{relationship_id}: get: operationId: getRelationship summary: Relationship description: A specific Relationship by ID tags: - Matters (Prospects) parameters: - name: relationship_id in: path required: true description: The relationship id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getRelationship: summary: GET Relationship value: data: id: '2' type: relationship attributes: name: Spouse prospect_id: 101 contact_id: 6 relationship_type_id: 1 created_at: '2021-10-31T19:34:53.641-07:00' updated_at: '2021-10-31T19:34:53.641-07:00' '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer put: operationId: updateRelationship summary: Update Relationship description: Update Relationship tags: - Matters (Prospects) parameters: - name: relationship_id in: path required: true description: The relationship id schema: type: string requestBody: required: true content: application/json: schema: type: object example: prospect_id: '{{prospect_id}}' contact_id: '{{contact_id}}' relationship_type_id: '{{relationship_type_id}}' responses: '201': description: Created content: application/json: schema: type: object examples: putUpdateRelationship: summary: PUT Update Relationship value: data: id: '19' type: relationship attributes: name: Aunties prospect_id: 99 contact_id: 7 created_at: '2021-10-31T23:17:44.457-07:00' updated_at: '2021-10-31T23:20:50.162-07:00' relationship_type_id: 9 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: deleteRelationship summary: Delete Relationship description: Delete a Relationship by ID tags: - Matters (Prospects) parameters: - name: relationship_id in: path required: true description: The relationship id schema: type: string responses: '204': description: No Content '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/relationships: get: operationId: getRelationships summary: Relationships description: A paginated list of all Relationships in Lawmatics tags: - Matters (Prospects) responses: '200': description: OK content: application/json: schema: type: object examples: getRelationships: summary: GET Relationships value: data: - id: '4' type: relationship attributes: name: Child prospect_id: 101 contact_id: 8 has_portal_access?: false created_at: '2021-10-31T20:26:39.243-07:00' updated_at: '2021-10-31T20:26:39.243-07:00' relationships: relationship_type: data: id: '3' type: relationship_type custom_field: data: id: '3' type: custom_field - id: '2' type: relationship attributes: name: Spouse prospect_id: 101 contact_id: 102 has_portal_access?: false created_at: '2021-10-31T19:34:53.637-07:00' updated_at: '2021-10-31T19:34:53.637-07:00' relationships: relationship_type: data: id: '1' type: relationship_type custom_field: data: id: '1' type: custom_field - id: '1' type: relationship attributes: name: Brother prospect_id: 101 contact_id: 101 has_portal_access?: true created_at: '2021-10-31T19:31:56.908-07:00' updated_at: '2021-10-31T19:31:56.908-07:00' relationships: relationship_type: data: id: '2' type: relationship_type custom_field: data: id: '2' type: custom_field meta: total_pages: 1 limit_per_page: 25 total_entries: 3 links: self: /v1/relationships?page=1 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createRelationship summary: Create Relationship description: 'Create a new Relationship If the Relationship Type allows multiple, you can create more than one Relationship per Matter.' tags: - Matters (Prospects) requestBody: required: true content: application/json: schema: type: object example: prospect_id: '{{prospect_id}}' contact_id: '{{contact_id}}' relationship_type_id: '{{relationship_type_id}}' responses: '201': description: Created content: application/json: schema: type: object examples: postCreateRelationship: summary: POST Create Relationship value: data: id: '21' type: relationship attributes: name: Brother prospect_id: 101 contact_id: 8 relationship_type_id: 2 created_at: '2021-10-31T23:21:53.269-07:00' updated_at: '2021-10-31T23:21:53.269-07:00' '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/relationship_types/{relationship_type_id}: get: operationId: getRelationshipType summary: Relationship Type description: A specific Relationship Type by ID tags: - Matters (Prospects) parameters: - name: relationship_type_id in: path required: true description: The relationship type id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getRelationship: summary: GET Relationship value: data: id: '2' type: relationship attributes: name: Spouse prospect_id: 101 contact_id: 6 relationship_type_id: 1 created_at: '2021-10-31T19:34:53.641-07:00' updated_at: '2021-10-31T19:34:53.641-07:00' '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer put: operationId: updateRelationshipType summary: Update Relationship Type description: Update Relationship tags: - Matters (Prospects) parameters: - name: relationship_type_id in: path required: true description: The relationship type id schema: type: string requestBody: required: true content: application/json: schema: type: object example: name: Sister responses: '200': description: OK content: application/json: schema: type: object examples: putUpdateRelationshipType: summary: PUT Update Relationship Type value: data: id: '2' type: relationship_type attributes: name: Changed Relationship Type is_repeatable: true created_at: '2021-10-31T16:22:05.472-07:00' updated_at: '2022-08-08T17:53:27.925-07:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/relationship_types: get: operationId: getRelationshipTypes summary: Relationship Types description: A paginated list of all Relationship Types in Lawmatics tags: - Matters (Prospects) responses: '200': description: OK content: application/json: schema: type: object examples: getRelationshipTypes: summary: GET Relationship Types value: data: - id: '3' type: relationship_type attributes: name: Child is_repeatable: true relationships: created_by: data: id: '5' type: user - id: '2' type: relationship_type attributes: name: Brother is_repeatable: true relationships: created_by: data: id: '5' type: user - id: '1' type: relationship_type attributes: name: Spouse is_repeatable: false relationships: created_by: data: id: '5' type: user meta: total_pages: 1 limit_per_page: 25 total_entries: 3 links: self: /v1/relationship_types?page=1 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createRelationshipType summary: Create Relationship Type description: Create a new Relationship Type tags: - Matters (Prospects) requestBody: required: true content: application/json: schema: type: object example: name: Spouse b07b09e7-7886-4e99-b833-44df2483b9cf is_repeatable: false responses: '201': description: Created content: application/json: schema: type: object examples: postCreateRelationshipType: summary: POST Create Relationship Type value: data: id: '9' type: relationship_type attributes: name: Aunties relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/sub_statuses/{status_id}: get: operationId: getSubStatus summary: Sub Status description: A specific Stage by id tags: - Matters (Prospects) parameters: - name: status_id in: path required: true description: The status id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getSubStatus: summary: GET Sub Status value: data: id: '3' type: sub_status attributes: {} relationships: prospects: data: - id: '116' type: prospect '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/sub_statuses: get: operationId: getSubStatuses summary: Sub Statuses description: A paginated list of all Stages in Lawmatics tags: - Matters (Prospects) responses: '200': description: OK content: application/json: schema: type: object examples: getSubStatuses: summary: GET Sub Statuses value: data: - id: '3' type: sub_status attributes: name: Divorced status: hired created_at: '2022-02-14T11:49:44.857-08:00' updated_at: '2022-02-14T11:49:44.857-08:00' relationships: {} - id: '2' type: sub_status attributes: name: Tickled status: pnc created_at: '2022-02-14T11:49:06.326-08:00' updated_at: '2022-02-14T11:49:06.326-08:00' relationships: {} - id: '1' type: sub_status attributes: name: Slapped status: lost created_at: '2022-02-14T11:48:54.191-08:00' updated_at: '2022-02-14T11:48:54.191-08:00' relationships: {} meta: total_pages: 1 limit_per_page: 25 total_entries: 3 links: self: /v1/sub_statuses?page=1 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createSubStatus summary: Create Sub Status description: 'Create a new Matter Sub Status Valid statusvalues: ''hired'', ''pnc'', ''lost'' (default ''pnc'') Accepts created_by_id' tags: - Matters (Prospects) requestBody: required: true content: application/json: schema: type: object example: name: Deal Closed 0249231e-774f-41dc-8133-d27c15900f3d status: hired responses: '201': description: Created content: application/json: schema: type: object examples: postCreateSubStatus: summary: POST Create Sub Status value: data: id: '8' type: prospect_sub_status attributes: name: Deal Closed status: hired created_at: '2023-09-27T14:35:12.604-07:00' updated_at: '2023-09-27T14:35:12.604-07:00' relationships: prospects: data: [] created_by: data: id: '1' type: user '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/sub_statuses/{sub_status_id}: put: operationId: updateSubStatus summary: Update Sub Status description: 'Update an existing Matter Sub Status by ID Valid statusvalues: ''hired'', ''pnc'', ''lost'' (default ''pnc'') Accepts created_by_id' tags: - Matters (Prospects) parameters: - name: sub_status_id in: path required: true description: The sub status id schema: type: string requestBody: required: true content: application/json: schema: type: object example: name: New Hired responses: '200': description: OK content: application/json: schema: type: object examples: putUpdateSubStatus: summary: PUT Update Sub Status value: data: id: '12' type: prospect_sub_status attributes: name: New Hired status: hired created_at: '2023-09-27T14:43:01.169-07:00' updated_at: '2023-09-27T14:43:27.373-07:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: deleteSubStatus summary: Delete Sub Status description: 'Delete an existing Matter Sub Status by ID. Warning: This is irreversible!' tags: - Matters (Prospects) parameters: - name: sub_status_id in: path required: true description: The sub status id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: delDeleteSubStatus: summary: DEL Delete Sub Status value: data: id: '13' type: prospect_sub_status attributes: name: Deal Closed status: hired created_at: '2023-09-27T14:43:55.410-07:00' updated_at: '2023-09-27T14:43:55.410-07:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/prospects: post: operationId: createMatter summary: Create Matter description: Create a new Matter tags: - Matters (Prospects) responses: '201': description: Created content: application/json: schema: type: object examples: postCreateMatter: summary: POST Create Matter value: data: id: '6446448' type: prospect attributes: first_name: Lawmatics last_name: Example case_title: null case_number: null case_blurb: null status: pnc type_of_billing: null email: roey@lawmatics.com phone: 123-123-1234 phone_number: 123-123-1234 email_address: roey@lawmatics.com address: null birthdate: null name_prefix: null middle_name: null name_suffix: null sub_status: Pnc informal_name: null employer: null occupation: null citizenship: null bio: bio field title: null hobbies: null social_security: null age: null referring_url: null driver_license: null gender: null marital_status: null timezone: null estimated_value_cents: 0 actual_value_cents: 0 lead_cost_cents: 0 date_of_last_contact: '2023-02-03T15:25:51.843-08:00' days_since_last_contact: 232 converted_date: null statute_of_limitations: null utm_source: null utm_campaign: null utm_medium: null utm_term: null street: null street2: null city: null state: null zipcode: null country: null full_street: null city_state_zip: null full_address: null photo_url: null custom_fields: - id: '6433' name: API TEST BOOLEAN (dont delete me) field_type: boolean value: true formatted_value: 'Yes' - id: '6435' name: API TEST PICKLIST (dont delete me) field_type: list value: '3240' formatted_value: '1' - id: '6434' name: API TEST STRING (dont delete me) field_type: string value: Contact String formatted_value: Contact String - id: '6470' name: Date Unsubscribed field_type: date value: '1991-06-28' formatted_value: June 28, 1991 - id: '4' name: Date of Accident field_type: datetime value: '2023-12-30T16:00:00.000-08:00' formatted_value: December 30, 2023 at 4:00pm PST custom_field_values: '4': id: '4' name: Date of Accident field_type: datetime value: '2023-12-30T16:00:00.000-08:00' formatted_value: December 30, 2023 at 4:00pm PST '6433': id: '6433' name: API TEST BOOLEAN (dont delete me) field_type: boolean value: true formatted_value: 'Yes' '6434': id: '6434' name: API TEST STRING (dont delete me) field_type: string value: Contact String formatted_value: Contact String '6435': id: '6435' name: API TEST PICKLIST (dont delete me) field_type: list value: '3240' formatted_value: '1' '6470': id: '6470' name: Date Unsubscribed field_type: date value: '1991-06-28' formatted_value: June 28, 1991 created_at: '2023-09-23T17:09:01.232-07:00' updated_at: '2023-09-23T17:09:01.360-07:00' last_contacted_date: '2023-02-03T15:25:51.843-08:00' relationships: source: data: null stage: data: null campaign: data: null practice_area: data: id: '986' type: practice_area salesperson: data: null lead_attorney: data: null originating_attorney: data: null owned_by: data: null created_by: data: id: '17' type: user contact: data: id: '3546976' type: contact company: data: null assigned_staff: data: [] events: data: [] file_requests: data: [] documents: data: [] notes: data: - id: '6726504' type: note tasks: data: [] emails: data: - id: '4503447' type: email_address phone_numbers: data: - id: '4503448' type: phone_number addresses: data: [] invoices: data: [] tags: data: - id: '17506' type: tag - id: '17507' type: tag relationships: data: [] '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer get: operationId: getMatters summary: Matters description: A paginated list of all Matters in Lawmatics tags: - Matters (Prospects) parameters: - name: fields in: query required: false schema: type: string example: all - name: filter_by in: query required: false schema: type: string example: practice_area_id - name: filter_on in: query required: false schema: type: string - name: filter_with in: query required: false schema: type: string example: '>' - name: sort_by in: query required: false schema: type: string example: actual_value_cents - name: sort_order in: query required: false schema: type: string example: asc responses: '200': description: OK content: application/json: schema: type: object examples: getMatters: summary: GET Matters value: data: - id: '1' type: prospect attributes: first_name: Roey last_name: Chasman email: roey+pnc@lawmatics.com created_at: '2018-01-05T17:18:09.735-08:00' updated_at: '2018-09-17T11:22:58.324-07:00' relationships: {} - id: '2' type: prospect attributes: first_name: Saul last_name: Goodman email: matt+saul@lawmatics.com created_at: '2018-01-06T10:04:29.517-08:00' updated_at: '2018-03-20T07:00:28.427-07:00' relationships: {} - id: '3' type: prospect attributes: first_name: Adam last_name: Tester email: adam@tester.com created_at: '2018-01-08T02:30:27.925-08:00' updated_at: '2018-03-20T07:00:28.092-07:00' relationships: {} - id: '4' type: prospect attributes: first_name: Kim last_name: Tester email: testergel@gmail.com created_at: '2018-01-08T10:10:03.043-08:00' updated_at: '2018-03-20T07:00:28.357-07:00' relationships: {} - id: '5' type: prospect attributes: first_name: Hunter last_name: Tester email: test@smokeball.com created_at: '2018-01-08T13:42:36.375-08:00' updated_at: '2018-03-20T07:00:28.495-07:00' relationships: {} - id: '6' type: prospect attributes: first_name: John last_name: Tester email: tester@gmail.com created_at: '2018-01-08T13:43:15.135-08:00' updated_at: '2018-09-21T13:27:24.267-07:00' relationships: {} - id: '7' type: prospect attributes: first_name: Jason last_name: Tester email: tester@gmail.com created_at: '2018-01-11T13:54:29.469-08:00' updated_at: '2018-03-20T07:00:28.378-07:00' relationships: {} - id: '8' type: prospect attributes: first_name: Mike last_name: Snow email: testerl@gmail.com created_at: '2018-01-23T14:56:18.406-08:00' updated_at: '2018-03-20T07:00:28.388-07:00' relationships: {} - id: '9' type: prospect attributes: first_name: James last_name: Tester email: test@gmail.com created_at: '2018-01-23T17:11:09.145-08:00' updated_at: '2018-03-20T07:00:28.408-07:00' relationships: {} - id: '10' type: prospect attributes: first_name: Gyi last_name: Tester email: test@lawmatics.com created_at: '2018-01-24T10:50:59.490-08:00' updated_at: '2018-03-20T07:00:28.511-07:00' relationships: {} - id: '15' type: prospect attributes: first_name: Joe last_name: Test email: tester@lawmatics.com created_at: '2018-02-05T16:47:54.276-08:00' updated_at: '2018-08-14T10:05:34.844-07:00' relationships: {} - id: '16' type: prospect attributes: first_name: Jeff last_name: Tester email: tester@lawmatics.com created_at: '2018-02-06T19:38:40.814-08:00' updated_at: '2018-03-20T07:00:28.603-07:00' relationships: {} - id: '17' type: prospect attributes: first_name: Sarah last_name: Tester email: sarah@lawmatics.com created_at: '2018-02-09T15:14:46.629-08:00' updated_at: '2018-03-20T07:00:28.461-07:00' relationships: {} - id: '18' type: prospect attributes: first_name: John last_name: Snow email: john@westeros.com created_at: '2018-03-06T06:09:22.068-08:00' updated_at: '2018-03-20T07:00:28.230-07:00' relationships: {} - id: '19' type: prospect attributes: first_name: Daenerys last_name: Targaryen email: motherofdragons@daenerys.com created_at: '2018-03-07T13:29:08.119-08:00' updated_at: '2018-03-26T12:28:22.505-07:00' relationships: {} - id: '20' type: prospect attributes: first_name: John last_name: Snow email: johnsnow@nightswatch.com created_at: '2018-03-07T13:32:00.708-08:00' updated_at: '2018-03-30T12:38:00.155-07:00' relationships: {} - id: '21' type: prospect attributes: first_name: Gregor last_name: Clegane email: gregor@clegane.com created_at: '2018-03-07T13:38:58.311-08:00' updated_at: '2018-03-20T07:00:28.690-07:00' relationships: {} - id: '25' type: prospect attributes: first_name: Tyrion last_name: Lannister email: tyrion@small.com created_at: '2018-03-07T13:51:38.789-08:00' updated_at: '2018-10-16T14:43:25.697-07:00' relationships: {} - id: '26' type: prospect attributes: first_name: Arya last_name: Stark email: arya@littlesword.com created_at: '2018-03-07T13:58:24.673-08:00' updated_at: '2018-03-20T07:00:28.588-07:00' relationships: {} - id: '27' type: prospect attributes: first_name: Sansa last_name: Stark email: matt.spiegel@gmail.com created_at: '2018-03-07T13:59:57.315-08:00' updated_at: '2018-06-18T14:51:36.116-07:00' relationships: {} - id: '28' type: prospect attributes: first_name: Khal last_name: Drogo email: khal@getripped.com created_at: '2018-03-07T14:04:11.582-08:00' updated_at: '2018-10-16T14:43:26.055-07:00' relationships: {} - id: '29' type: prospect attributes: first_name: Eddard last_name: Stark email: eddard@north.com created_at: '2018-03-08T06:04:52.771-08:00' updated_at: '2018-10-16T16:32:20.312-07:00' relationships: {} - id: '30' type: prospect attributes: first_name: Joffrey last_name: Baratheon email: joffrey@nobodylikesme.com created_at: '2018-03-08T06:10:41.420-08:00' updated_at: '2018-03-20T07:00:28.318-07:00' relationships: {} - id: '31' type: prospect attributes: first_name: Petyr last_name: Baelish email: littlefinger@backstabber.com created_at: '2018-03-08T06:11:58.640-08:00' updated_at: '2018-03-20T07:00:28.328-07:00' relationships: {} - id: '32' type: prospect attributes: first_name: Jaime last_name: Lannister email: jaime@ishegoodorbad.com created_at: '2018-03-08T06:43:07.974-08:00' updated_at: '2018-10-16T14:43:25.814-07:00' relationships: {} meta: total_pages: 11 limit_per_page: 25 total_entries: 265 links: self: /v1/prospect?page=1 next: /v1/prospect?page=2 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/prospects/{prospect_id}: get: operationId: getMatter summary: Matter description: Return one Matter by id tags: - Matters (Prospects) parameters: - name: prospect_id in: path required: true description: The prospect id schema: type: string - name: fields in: query required: false schema: type: string example: all responses: '200': description: OK content: application/json: schema: type: object examples: getMatter: summary: GET Matter value: data: id: '25' type: prospect attributes: first_name: Tyrion last_name: Lannister case_title: Drank bad wine case_blurb: Client drank a glass of wine and it made him sick status: active email: tyrion@small.com phone: null phone_number: null email_address: tyrion@small.com address: null birthdate: null name_prefix: null middle_name: null name_suffix: null sub_status: Active informal_name: null employer: null occupation: null citizenship: null bio: null title: null hobbies: null social_security: null age: null referring_url: null driver_license: null gender: null marital_status: null timezone: null estimated_value_cents: 250000 actual_value_cents: 500000 lead_cost_cents: 0 date_of_last_contact: '2018-03-07T13:51:38.789-08:00' days_since_last_contact: 223 photo_url: https://lm.lawmatics.com/attachments/421159fc72cbab9106329e36635b4939b8a1ad93/store/14da96fb7824ad411b34313189f4aaaba4192b6d7b0624f7948f218225e7/photo custom_fields: [] created_at: '2018-03-07T13:51:38.789-08:00' updated_at: '2018-10-16T14:43:25.697-07:00' relationships: source: data: id: '6' type: source stage: data: id: '2' type: stage campaign: data: id: '7' type: campaign practice_area: data: id: '3' type: practice_area owned_by: data: null created_by: data: id: '15' type: user events: data: [] documents: data: [] notes: data: [] tasks: data: - id: '51' type: task invoices: data: [] emails: data: - id: '29' type: email phone_numbers: data: [] addresses: data: [] relationships: data: [] '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer put: operationId: updateMatter summary: Update Matter description: 'Update an existing Matter by ID. Passing Custom Field id and value, will set the custom field value on the Matter, and overwrite any existing value. Passing null as the value will clear it out.' tags: - Matters (Prospects) parameters: - name: prospect_id in: path required: true description: The prospect id schema: type: string requestBody: required: true content: application/json: schema: type: object example: first_name: Lawmatics last_name: ExampleChanged email: carlo99@example.com phone: 123-123-1234 assigned_staff_ids: [] notes: - name: Cool Note body: This is a long form sweet new note tags: - Tag 1 - Tag 2 responses: '200': description: OK content: application/json: schema: type: object examples: putPATCHUpdateMatter: summary: PUT/PATCH Update Matter value: data: id: '2309744' type: prospect attributes: first_name: Lawmatics last_name: ExampleChanged email: roey+changed@lawmatics.com custom_fields: - id: 6434 name: API TEST STRING (dont delete me) field_type: string value: Contact String formatted_value: Contact String - id: 6435 name: API TEST PICKLIST (dont delete me) field_type: list value: '3241' formatted_value: '2' - id: 6433 name: API TEST BOOLEAN (dont delete me) field_type: boolean value: false formatted_value: 'No' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: deleteMatter summary: Delete Matter description: 'Delete an existing Matter by ID. Warning: This is irreversible!' tags: - Matters (Prospects) parameters: - name: prospect_id in: path required: true description: The prospect id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: deleteMatter: summary: DELETE Matter value: data: id: '41835' type: prospect attributes: first_name: Lawmatics last_name: Example email: null created_at: '2018-10-15T15:26:09.927-07:00' updated_at: '2018-10-15T15:26:09.927-07:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/notes/{note_id}: get: operationId: getNote summary: Note description: A specific Note by ID tags: - Notes parameters: - name: note_id in: path required: true description: The note id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getNote: summary: GET Note value: data: id: '27430' type: note attributes: name: Example Note 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. created_at: '2018-10-17T18:17:15.722-07:00' updated_at: '2018-10-17T18:17:15.722-07:00' relationships: notable: data: id: '41874' type: prospect '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer put: operationId: updateNote summary: Update Note tags: - Notes parameters: - name: note_id in: path required: true description: The note id schema: type: string requestBody: required: true content: application/json: schema: type: object example: name: Updated Note body: I just updated this responses: '200': description: OK content: application/json: schema: type: object examples: putUpdateNote: summary: PUT Update Note value: data: id: '108' type: note attributes: name: Updated Note body: I just updated this created_at: '2022-05-26T13:23:11.485-07:00' updated_at: '2022-05-26T13:23:19.697-07:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: deleteNote summary: Delete Note tags: - Notes parameters: - name: note_id in: path required: true description: The note id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: deleteDeleteNote: summary: DELETE Delete Note value: data: id: '108' type: note attributes: name: Updated Note body: I just updated this created_at: '2022-05-26T13:23:11.485-07:00' updated_at: '2022-05-26T13:23:26.462-07:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/notes: get: operationId: getNotes summary: Notes description: A paginated list of all Notes in Lawmatics tags: - Notes responses: '200': description: OK content: application/json: schema: type: object examples: getNotes: summary: GET Notes value: data: - id: '27430' type: note attributes: name: Example Note 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. created_at: '2018-10-17T18:17:15.722-07:00' updated_at: '2018-10-17T18:17:15.722-07:00' relationships: notable: data: id: '41874' type: prospect - id: '25231' type: note attributes: name: sed body: ipsa created_at: '2018-10-10T17:39:54.279-07:00' updated_at: '2018-10-10T17:39:54.279-07:00' relationships: notable: data: id: '14' type: prospect - id: '8825' type: note attributes: name: explicabo body: voluptas created_at: '2018-09-24T15:27:47.155-07:00' updated_at: '2018-09-24T15:27:47.155-07:00' relationships: notable: data: id: '14' type: prospect - id: '8823' type: note attributes: name: voluptatibus body: occaecati created_at: '2018-09-20T17:38:11.886-07:00' updated_at: '2018-09-20T17:38:11.886-07:00' relationships: notable: data: id: '25' type: prospect - id: '8822' type: note attributes: name: asd body: asd created_at: '2018-09-19T18:27:06.917-07:00' updated_at: '2018-09-19T18:27:06.917-07:00' relationships: notable: data: id: '35' type: prospect - id: '8821' type: note attributes: name: sfd body: sdfsdf created_at: '2018-09-19T14:11:22.278-07:00' updated_at: '2018-09-19T14:11:22.278-07:00' relationships: notable: data: id: '17877' type: prospect - id: '8820' type: note attributes: name: quia body: dolores created_at: '2018-09-11T11:49:06.517-07:00' updated_at: '2018-09-11T11:49:06.517-07:00' relationships: notable: data: id: '14' type: prospect - id: '8819' type: note attributes: name: eius body: ea created_at: '2018-09-11T11:46:04.109-07:00' updated_at: '2018-09-11T11:46:04.109-07:00' relationships: notable: data: id: '14' type: prospect - id: '8818' type: note attributes: name: pariatur body: rerum created_at: '2018-09-05T13:58:04.430-07:00' updated_at: '2018-09-05T13:58:04.430-07:00' relationships: notable: data: id: '25' type: prospect - id: '8817' type: note attributes: name: ratione body: nemo created_at: '2018-09-05T13:36:02.560-07:00' updated_at: '2018-09-05T13:36:02.560-07:00' relationships: notable: data: id: '14' type: prospect - id: '8816' type: note attributes: name: est body: in created_at: '2018-08-24T16:47:01.463-07:00' updated_at: '2018-08-24T16:47:01.463-07:00' relationships: notable: data: id: '1' type: prospect - id: '2446' type: note attributes: name: null body: null created_at: '2018-07-21T00:00:00.000-07:00' updated_at: '2018-07-22T21:12:22.210-07:00' relationships: notable: data: id: '1' type: prospect - id: '101' type: note attributes: name: test body: test created_at: '2018-07-16T16:46:45.548-07:00' updated_at: '2018-07-16T16:46:45.548-07:00' relationships: notable: data: id: '1' type: company - id: '100' type: note attributes: name: Joseph Note 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. created_at: '2018-07-16T15:12:55.439-07:00' updated_at: '2018-07-16T15:12:55.439-07:00' relationships: notable: data: id: '100' type: prospect - id: '99' type: note attributes: name: Karen Note 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. created_at: '2018-07-16T15:12:55.323-07:00' updated_at: '2018-07-16T15:12:55.323-07:00' relationships: notable: data: id: '99' type: prospect - id: '98' type: note attributes: name: Barbara Note 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. created_at: '2018-07-16T15:12:55.081-07:00' updated_at: '2018-07-16T15:12:55.081-07:00' relationships: notable: data: id: '98' type: prospect - id: '97' type: note attributes: name: Sarah Note 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. created_at: '2018-07-16T15:12:54.860-07:00' updated_at: '2018-07-16T15:12:54.860-07:00' relationships: notable: data: id: '97' type: prospect - id: '96' type: note attributes: name: Thomas Note 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. created_at: '2018-07-16T15:12:54.740-07:00' updated_at: '2018-07-16T15:12:54.740-07:00' relationships: notable: data: id: '96' type: prospect - id: '95' type: note attributes: name: William Note 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. created_at: '2018-07-16T15:12:54.488-07:00' updated_at: '2018-07-16T15:12:54.488-07:00' relationships: notable: data: id: '95' type: prospect - id: '94' type: note attributes: name: Karen Note 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. created_at: '2018-07-16T15:12:54.360-07:00' updated_at: '2018-07-16T15:12:54.360-07:00' relationships: notable: data: id: '94' type: prospect - id: '93' type: note attributes: name: Maria Note 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. created_at: '2018-07-16T15:12:54.131-07:00' updated_at: '2018-07-16T15:12:54.131-07:00' relationships: notable: data: id: '93' type: prospect - id: '92' type: note attributes: name: Maria Note 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. created_at: '2018-07-16T15:12:54.018-07:00' updated_at: '2018-07-16T15:12:54.018-07:00' relationships: notable: data: id: '92' type: prospect - id: '91' type: note attributes: name: Jennifer Note 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. created_at: '2018-07-16T15:12:53.780-07:00' updated_at: '2018-07-16T15:12:53.780-07:00' relationships: notable: data: id: '91' type: prospect - id: '90' type: note attributes: name: Richard Note 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. created_at: '2018-07-16T15:12:53.527-07:00' updated_at: '2018-07-16T15:12:53.527-07:00' relationships: notable: data: id: '90' type: prospect - id: '89' type: note attributes: name: Jennifer Note 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. created_at: '2018-07-16T15:12:53.403-07:00' updated_at: '2018-07-16T15:12:53.403-07:00' relationships: notable: data: id: '89' type: prospect meta: total_pages: 5 limit_per_page: 25 total_entries: 110 links: self: /v1/note?page=1 next: /v1/note?page=2 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createNote summary: Create Note tags: - Notes responses: '201': description: Created content: application/json: schema: type: object examples: postCreateNote: summary: POST Create Note value: data: id: '109' type: note attributes: name: New Note body: An important thing to remember created_at: '2022-05-26T13:48:20.485-07:00' updated_at: '2022-05-26T13:48:20.485-07:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/invoices/{invoice_id}: get: operationId: getInvoice summary: Invoice description: A specific Invoice in Lawmatics tags: - Payment Invoices parameters: - name: invoice_id in: path required: true description: The invoice id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getInvoice: summary: GET Invoice value: data: id: '1' type: invoice attributes: number: 1 status: sent target_account_type: operating payment_terms: due_date include_balance_forward: false enable_online_payment: false include_statement_of_accounts: false invoiced_at: '2021-11-02' due_at: '2021-11-02' voided_at: null contactable_address: null contactable_name: Roey Tester note: "hey zsolt this is a specific invoice note\n\nhere \nis\na \nbunch\n\nof\ \ (two)\nnewlines" amount_cents: 0 amount_paid_cents: 0 outstanding_amount_cents: 0 pdf_url: http://localhost:3000/attachments/80623eb43ae0fa961d5a32b8d169fd54a0249de1/store/511432f743969f1e7b9cc636c1a9c7b4ca1a4d5dd902ef0a1ba405ff89f7/Invoice+%231.pdf created_at: '2021-11-02T10:28:40.535-07:00' updated_at: '2022-01-10T19:43:47.382-08:00' relationships: invoice_type: data: null prospect: data: id: '101' type: prospect created_by: data: id: '5' type: created_by forwarded_to: data: null time_entries: data: - id: '8' type: time_entry expenses: data: [] invoice_adjustments: data: [] transactions: data: [] forwarded_from: data: [] '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/invoices: get: operationId: getInvoices summary: Invoices description: A paginated list of all Invoices in Lawmatics tags: - Payment Invoices responses: '200': description: OK content: application/json: schema: type: object examples: getInvoices: summary: GET Invoices value: data: - id: '1' type: invoice attributes: number: 1 status: sent target_account_type: operating payment_terms: due_date include_balance_forward: false enable_online_payment: false include_statement_of_accounts: false invoiced_at: '2021-11-02' due_at: '2021-11-02' voided_at: null contactable_address: null contactable_name: Roey Tester note: "hey zsolt this is a specific invoice note\n\nhere \nis\na \nbunch\n\nof\ \ (two)\nnewlines" amount_cents: 0 amount_paid_cents: 0 outstanding_amount_cents: 0 pdf_url: http://localhost:3000/attachments/80623eb43ae0fa961d5a32b8d169fd54a0249de1/store/511432f743969f1e7b9cc636c1a9c7b4ca1a4d5dd902ef0a1ba405ff89f7/Invoice+%231.pdf created_at: '2021-11-02T10:28:40.535-07:00' updated_at: '2022-01-10T19:43:47.382-08:00' relationships: invoice_type: data: null prospect: data: id: '101' type: prospect created_by: data: id: '5' type: created_by forwarded_to: data: null time_entries: data: - id: '8' type: time_entry expenses: data: [] invoice_adjustments: data: [] transactions: data: [] forwarded_from: data: [] meta: total_pages: 1 limit_per_page: 25 total_entries: 1 links: self: /v1/invoices?page=1 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/expenses: get: operationId: getExpenses summary: Expenses description: A paginated list of all Time Entries in Lawmatics tags: - Payment Expenses parameters: - name: fields in: query required: false schema: type: string example: all responses: '200': description: OK content: application/json: schema: type: object examples: getExpenses: summary: GET Expenses value: data: - id: '39' type: expense attributes: description: Phone Call duration: 0.1 duration_rounded: 0.1 started_at: '2022-12-26T16:19:51.917-08:00' completed_at: '2022-12-26T16:25:51.917-08:00' created_at: '2022-12-26T16:20:24.936-08:00' updated_at: '2022-12-26T16:23:49.489-08:00' billable: true rate_flat_fee: true rate: cents: 123000 currency_iso: USD relationships: user: data: id: '5' type: user created_by: data: id: '5' type: user activity_type: data: id: '1' type: activity_type contactable: data: id: '101' type: prospect invoice: data: id: '1' type: invoice - id: '37' type: expense attributes: description: null duration: 0 duration_rounded: 0 started_at: '2022-07-05T13:01:52.086-07:00' completed_at: null created_at: '2022-07-05T13:01:52.089-07:00' updated_at: '2022-07-05T13:01:52.089-07:00' billable: true rate_flat_fee: false rate: cents: 0 currency_iso: USD relationships: user: data: id: '11' type: user created_by: data: id: '11' type: user activity_type: data: null contactable: data: null invoice: data: null - id: '36' type: expense attributes: description: null duration: 0.004429444444444444 duration_rounded: 0.1 started_at: '2022-03-14T12:02:44.172-07:00' completed_at: null created_at: '2022-03-14T12:02:44.355-07:00' updated_at: '2023-01-10T15:15:46.748-08:00' billable: true rate_flat_fee: false rate: cents: 123000 currency_iso: USD relationships: user: data: id: '5' type: user created_by: data: id: '5' type: user activity_type: data: id: '1' type: activity_type contactable: data: null invoice: data: null - id: '16' type: expense attributes: description: null duration: 0 duration_rounded: 0 started_at: '2022-01-27T16:13:29.750-08:00' completed_at: null created_at: '2022-01-27T16:13:29.752-08:00' updated_at: '2022-01-27T16:13:29.752-08:00' billable: true rate_flat_fee: false rate: cents: 0 currency_iso: USD relationships: user: data: id: '5' type: user created_by: data: id: '5' type: user activity_type: data: null contactable: data: null invoice: data: null - id: '11' type: expense attributes: description: null duration: 0.006879166666666667 duration_rounded: 0.1 started_at: '2021-11-04T18:15:11.498-07:00' completed_at: null created_at: '2021-11-04T18:15:11.500-07:00' updated_at: '2022-01-05T16:40:11.136-08:00' billable: true rate_flat_fee: false rate: cents: 0 currency_iso: USD relationships: user: data: id: '5' type: user created_by: data: id: '5' type: user activity_type: data: id: '1' type: activity_type contactable: data: null invoice: data: null - id: '10' type: expense attributes: description: '' duration: 0 duration_rounded: 0.1 started_at: '2021-11-04T18:15:03.000-07:00' completed_at: '2021-11-04T18:15:11.299-07:00' created_at: '2021-11-04T18:15:03.154-07:00' updated_at: '2022-03-22T11:23:51.773-07:00' billable: true rate_flat_fee: false rate: cents: 123123 currency_iso: USD relationships: user: data: id: '3' type: user created_by: data: id: '5' type: user activity_type: data: id: '1' type: activity_type contactable: data: id: '19' type: prospect invoice: data: null - id: '9' type: expense attributes: description: '' duration: 0.003985277777777779 duration_rounded: 0.1 started_at: '2021-11-02T10:27:10.000-07:00' completed_at: '2021-11-04T18:15:03.033-07:00' created_at: '2021-11-02T10:27:10.168-07:00' updated_at: '2021-11-04T18:15:03.080-07:00' billable: true rate_flat_fee: false rate: cents: 0 currency_iso: USD relationships: user: data: id: '5' type: user created_by: data: id: '5' type: user activity_type: data: id: '1' type: activity_type contactable: data: id: '14' type: prospect invoice: data: null - id: '8' type: expense attributes: description: Test duration: 0.003545555555555556 duration_rounded: 0.1 started_at: '2021-10-26T16:32:57.000-07:00' completed_at: '2021-10-26T16:33:09.764-07:00' created_at: '2021-10-26T16:32:57.553-07:00' updated_at: '2022-12-26T16:22:52.245-08:00' billable: true rate_flat_fee: false rate: cents: 0 currency_iso: USD relationships: user: data: id: '5' type: user created_by: data: id: '5' type: user activity_type: data: id: '1' type: activity_type contactable: data: id: '101' type: prospect invoice: data: id: '1' type: invoice meta: total_pages: 1 limit_per_page: 25 total_entries: 8 links: self: /v1/expenses?page=1 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createExpense summary: Create Expense description: A specific Time Entry in Lawmatics tags: - Payment Expenses requestBody: required: true content: multipart/form-data: schema: type: object properties: billable: type: string contactable_type: type: string contactable_id: type: string cost_cents: type: string description: type: string created_by_id: type: string user_id: type: string expensed_at: type: string responses: '200': description: OK content: application/json: schema: type: object examples: createExpense: summary: Create Expense value: data: id: '34' type: expense attributes: description: Postage duration: 61 is_billable: true is_flat_fee: false relationships: staff: data: id: '2' type: user contactable: data: id: '12' type: prospect activity_type: data: id: '1' type: activity_type invoice: data: null '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/expenses/{expense_id}: get: operationId: getExpense summary: Expense description: A specific Time Entry in Lawmatics tags: - Payment Expenses parameters: - name: expense_id in: path required: true description: The expense id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getExpense: summary: GET Expense value: data: id: '9' type: time_entry attributes: description: null duration: 0 is_billable: true is_flat_fee: false relationships: staff: data: id: '1' type: user contactable: data: null activity_type: data: null invoice: data: null '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer put: operationId: updateExpense summary: Update Expense description: A specific Time Entry in Lawmatics tags: - Payment Expenses parameters: - name: expense_id in: path required: true description: The expense id schema: type: string requestBody: required: true content: multipart/form-data: schema: type: object properties: billable: type: string description: type: string contactable_type: type: string contactable_id: type: string responses: '200': description: OK content: application/json: schema: type: object examples: updateExpense: summary: Update Expense value: data: id: '35' type: expense attributes: description: Postage duration: 200 is_billable: false is_flat_fee: true relationships: staff: data: id: '2' type: user contactable: data: null activity_type: data: id: '1' type: activity_type invoice: data: null '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: deleteExpense summary: Expense description: A specific Time Entry in Lawmatics tags: - Payment Expenses parameters: - name: expense_id in: path required: true description: The expense id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: deleteExpense: summary: DELETE Expense value: data: id: '9' type: expense attributes: description: null duration: 0 is_billable: true is_flat_fee: false relationships: staff: data: id: '1' type: user contactable: data: null activity_type: data: null invoice: data: null '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/time_entries: get: operationId: getTimeEntries summary: Time Entries description: A paginated list of all Time Entries in Lawmatics tags: - Payment Time Entries parameters: - name: fields in: query required: false schema: type: string example: all responses: '200': description: OK content: application/json: schema: type: object examples: getTimeEntries: summary: GET Time Entries value: data: - id: '39' type: time_entry attributes: description: Phone Call duration: 0.1 duration_rounded: 0.1 started_at: '2022-12-26T16:19:51.917-08:00' completed_at: '2022-12-26T16:25:51.917-08:00' created_at: '2022-12-26T16:20:24.936-08:00' updated_at: '2022-12-26T16:23:49.489-08:00' billable: true rate_flat_fee: true rate: cents: 123000 currency_iso: USD relationships: user: data: id: '5' type: user created_by: data: id: '5' type: user activity_type: data: id: '1' type: activity_type contactable: data: id: '101' type: prospect invoice: data: id: '1' type: invoice - id: '37' type: time_entry attributes: description: null duration: 0 duration_rounded: 0 started_at: '2022-07-05T13:01:52.086-07:00' completed_at: null created_at: '2022-07-05T13:01:52.089-07:00' updated_at: '2022-07-05T13:01:52.089-07:00' billable: true rate_flat_fee: false rate: cents: 0 currency_iso: USD relationships: user: data: id: '11' type: user created_by: data: id: '11' type: user activity_type: data: null contactable: data: null invoice: data: null - id: '36' type: time_entry attributes: description: null duration: 0.004429444444444444 duration_rounded: 0.1 started_at: '2022-03-14T12:02:44.172-07:00' completed_at: null created_at: '2022-03-14T12:02:44.355-07:00' updated_at: '2023-01-10T15:15:46.748-08:00' billable: true rate_flat_fee: false rate: cents: 123000 currency_iso: USD relationships: user: data: id: '5' type: user created_by: data: id: '5' type: user activity_type: data: id: '1' type: activity_type contactable: data: null invoice: data: null - id: '16' type: time_entry attributes: description: null duration: 0 duration_rounded: 0 started_at: '2022-01-27T16:13:29.750-08:00' completed_at: null created_at: '2022-01-27T16:13:29.752-08:00' updated_at: '2022-01-27T16:13:29.752-08:00' billable: true rate_flat_fee: false rate: cents: 0 currency_iso: USD relationships: user: data: id: '5' type: user created_by: data: id: '5' type: user activity_type: data: null contactable: data: null invoice: data: null - id: '11' type: time_entry attributes: description: null duration: 0.006879166666666667 duration_rounded: 0.1 started_at: '2021-11-04T18:15:11.498-07:00' completed_at: null created_at: '2021-11-04T18:15:11.500-07:00' updated_at: '2022-01-05T16:40:11.136-08:00' billable: true rate_flat_fee: false rate: cents: 0 currency_iso: USD relationships: user: data: id: '5' type: user created_by: data: id: '5' type: user activity_type: data: id: '1' type: activity_type contactable: data: null invoice: data: null - id: '10' type: time_entry attributes: description: '' duration: 0 duration_rounded: 0.1 started_at: '2021-11-04T18:15:03.000-07:00' completed_at: '2021-11-04T18:15:11.299-07:00' created_at: '2021-11-04T18:15:03.154-07:00' updated_at: '2022-03-22T11:23:51.773-07:00' billable: true rate_flat_fee: false rate: cents: 123123 currency_iso: USD relationships: user: data: id: '3' type: user created_by: data: id: '5' type: user activity_type: data: id: '1' type: activity_type contactable: data: id: '19' type: prospect invoice: data: null - id: '9' type: time_entry attributes: description: '' duration: 0.003985277777777779 duration_rounded: 0.1 started_at: '2021-11-02T10:27:10.000-07:00' completed_at: '2021-11-04T18:15:03.033-07:00' created_at: '2021-11-02T10:27:10.168-07:00' updated_at: '2021-11-04T18:15:03.080-07:00' billable: true rate_flat_fee: false rate: cents: 0 currency_iso: USD relationships: user: data: id: '5' type: user created_by: data: id: '5' type: user activity_type: data: id: '1' type: activity_type contactable: data: id: '14' type: prospect invoice: data: null - id: '8' type: time_entry attributes: description: Test duration: 0.003545555555555556 duration_rounded: 0.1 started_at: '2021-10-26T16:32:57.000-07:00' completed_at: '2021-10-26T16:33:09.764-07:00' created_at: '2021-10-26T16:32:57.553-07:00' updated_at: '2022-12-26T16:22:52.245-08:00' billable: true rate_flat_fee: false rate: cents: 0 currency_iso: USD relationships: user: data: id: '5' type: user created_by: data: id: '5' type: user activity_type: data: id: '1' type: activity_type contactable: data: id: '101' type: prospect invoice: data: id: '1' type: invoice meta: total_pages: 1 limit_per_page: 25 total_entries: 8 links: self: /v1/time_entries?page=1 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createTimeEntry summary: Create Time Entry description: A specific Time Entry in Lawmatics tags: - Payment Time Entries requestBody: required: true content: multipart/form-data: schema: type: object properties: billable: type: string completed_at: type: string contactable_type: type: string contactable_id: type: string description: type: string duration: type: string rate_cents: type: string started_at: type: string created_by_id: type: string user_id: type: string responses: '200': description: OK content: application/json: schema: type: object examples: createTimeEntry: summary: Create Time Entry value: data: id: '34' type: time_entry attributes: description: Research Hours Billed duration: 61 is_billable: true is_flat_fee: false relationships: staff: data: id: '2' type: user contactable: data: id: '12' type: prospect activity_type: data: id: '1' type: activity_type invoice: data: null createFlatFeeTimeEntry: summary: Create Flat Fee Time Entry value: data: id: '34' type: time_entry attributes: description: Research Hours Billed duration: 61 is_billable: true is_flat_fee: false relationships: staff: data: id: '2' type: user contactable: data: id: '12' type: prospect activity_type: data: id: '1' type: activity_type invoice: data: null '201': description: OK content: application/json: schema: type: object examples: createTimeEntryForInvoice: summary: Create Time Entry For Invoice value: data: id: '34' type: time_entry attributes: description: Research Hours Billed duration: 61 is_billable: true is_flat_fee: false relationships: staff: data: id: '2' type: user contactable: data: id: '12' type: prospect activity_type: data: id: '1' type: activity_type invoice: data: null '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/time_entries/{time_entry_id}: get: operationId: getTimeEntry summary: Time Entry description: A specific Time Entry in Lawmatics tags: - Payment Time Entries parameters: - name: time_entry_id in: path required: true description: The time entry id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getTimeEntry: summary: GET Time Entry value: data: id: '9' type: time_entry attributes: description: null duration: 0 is_billable: true is_flat_fee: false relationships: staff: data: id: '1' type: user contactable: data: null activity_type: data: null invoice: data: null '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer put: operationId: updateTimeEntry summary: Update Time Entry description: A specific Time Entry in Lawmatics tags: - Payment Time Entries parameters: - name: time_entry_id in: path required: true description: The time entry id schema: type: string requestBody: required: true content: multipart/form-data: schema: type: object properties: billable: type: string description: type: string responses: '200': description: OK content: application/json: schema: type: object examples: updateTimeEntry: summary: Update Time Entry value: data: id: '35' type: time_entry attributes: description: Research Hours Billed duration: 200 is_billable: false is_flat_fee: true relationships: staff: data: id: '2' type: user contactable: data: null activity_type: data: id: '1' type: activity_type invoice: data: null '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: deleteTimeEntry summary: Time Entry description: A specific Time Entry in Lawmatics tags: - Payment Time Entries parameters: - name: time_entry_id in: path required: true description: The time entry id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: deleteTimeEntry: summary: DELETE Time Entry value: data: id: '9' type: time_entry attributes: description: null duration: 0 is_billable: true is_flat_fee: false relationships: staff: data: id: '1' type: user contactable: data: null activity_type: data: null invoice: data: null '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/transactions/{transaction_id}: get: operationId: getTransaction summary: Transaction description: A specific Transaction in Lawmatics tags: - Payment Transactions parameters: - name: transaction_id in: path required: true description: The transaction id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getTransaction: summary: GET Transaction value: data: id: '1' type: transaction attributes: account_type: Contact bank_account_type: trust status: processed payment_method: venmo transaction_type: credit amount_cents: 12323 amount_currency: USD account_id: 101 created_by_id: 5 firm_id: 2 external_id: null invoice_id: null prospect_id: 101 created_at: '2021-12-26T14:52:44.808-08:00' updated_at: '2021-12-26T14:52:44.808-08:00' note: Such a goo payment relationships: account: data: id: '101' type: contact prospect: data: id: '101' type: prospect invoice: data: null '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/transactions: get: operationId: getTransactions summary: Transactions description: A paginated list of all Transactions in Lawmatics tags: - Payment Transactions parameters: - name: fields in: query required: false schema: type: string example: all responses: '200': description: OK content: application/json: schema: type: object examples: getTransactions: summary: GET Transactions value: data: - id: '6' type: transaction attributes: account_type: Contact bank_account_type: trust status: processed payment_method: other transaction_type: credit amount_cents: 12300 amount_currency: USD account_id: 3 created_by_id: 5 firm_id: 2 external_id: null invoice_id: null prospect_id: null created_at: '2022-04-21T00:17:38.437-07:00' updated_at: '2022-04-21T00:17:38.437-07:00' note: asdasd relationships: account: data: id: '3' type: contact prospect: data: null invoice: data: null - id: '5' type: transaction attributes: account_type: Contact bank_account_type: trust status: processed payment_method: credit_card transaction_type: credit amount_cents: 1230 amount_currency: USD account_id: 3 created_by_id: 5 firm_id: 2 external_id: null invoice_id: null prospect_id: 3 created_at: '2022-04-20T22:37:22.982-07:00' updated_at: '2022-04-20T22:37:22.982-07:00' note: asdasdas relationships: account: data: id: '3' type: contact prospect: data: id: '3' type: prospect invoice: data: null - id: '4' type: transaction attributes: account_type: Contact bank_account_type: trust status: processed payment_method: credit_card transaction_type: credit amount_cents: 1230 amount_currency: USD account_id: 9 created_by_id: 5 firm_id: 2 external_id: null invoice_id: null prospect_id: null created_at: '2022-04-20T16:47:22.562-07:00' updated_at: '2022-04-20T16:47:22.562-07:00' note: asdasdasd relationships: account: data: id: '9' type: contact prospect: data: null invoice: data: null - id: '3' type: transaction attributes: account_type: Contact bank_account_type: trust status: processed payment_method: credit_card transaction_type: credit amount_cents: 12300 amount_currency: USD account_id: 3 created_by_id: 5 firm_id: 2 external_id: null invoice_id: null prospect_id: 3 created_at: '2022-04-20T16:47:07.893-07:00' updated_at: '2022-04-20T16:47:07.893-07:00' note: test relationships: account: data: id: '3' type: contact prospect: data: id: '3' type: prospect invoice: data: null - id: '2' type: transaction attributes: account_type: Contact bank_account_type: trust status: processed payment_method: credit_card transaction_type: credit amount_cents: 123123 amount_currency: USD account_id: 101 created_by_id: 5 firm_id: 2 external_id: null invoice_id: null prospect_id: 101 created_at: '2022-01-10T20:05:03.839-08:00' updated_at: '2022-01-10T20:05:03.839-08:00' note: Tester relationships: account: data: id: '101' type: contact prospect: data: id: '101' type: prospect invoice: data: null - id: '1' type: transaction attributes: account_type: Contact bank_account_type: trust status: processed payment_method: venmo transaction_type: credit amount_cents: 12323 amount_currency: USD account_id: 101 created_by_id: 5 firm_id: 2 external_id: null invoice_id: null prospect_id: 101 created_at: '2021-12-26T14:52:44.808-08:00' updated_at: '2021-12-26T14:52:44.808-08:00' note: Such a goo payment relationships: account: data: id: '101' type: contact prospect: data: id: '101' type: prospect invoice: data: null meta: total_pages: 1 limit_per_page: 25 total_entries: 6 links: self: /v1/transactions?page=1 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createTransaction summary: Create Transaction description: "Create a new Transaction\n\nOptional Fields: invoice_number, invoice_id, note \n\n\ invoice_number or invoice_id: only one should be specified\n\ntransactable: Prospect, Contact,\ \ Company with which to associate the transaction\n\ntransaction_type: debit or credit\n\nbank_account_type:\ \ operating or trust\n\npayment_method: credit_card, check, cash, paypal, venmo, trust_payment,\ \ debit_card, ach, or other" tags: - Payment Transactions parameters: - name: fields in: query required: false schema: type: string example: all responses: '200': description: OK content: application/json: schema: type: object examples: postCreateRefundTransaction: summary: POST Create Refund Transaction value: data: id: '38' type: transaction attributes: account_type: Contact bank_account_type: operating payment_method: invoice_refund transaction_type: debit amount_cents: 5000 amount_currency: USD account_id: 112 external_id: null created_at: '2022-12-27T13:15:25.890-08:00' updated_at: '2022-12-27T13:15:25.890-08:00' note: '' relationships: created_by: data: id: '5' type: user account: data: id: '112' type: contact prospect: data: id: '113' type: prospect invoice: data: id: '1' type: invoice trust_fund_request: data: null refunded_transaction: data: id: '30' type: transaction postCreateTransaction: summary: POST Create Transaction value: data: id: '36' type: transaction attributes: account_type: Contact bank_account_type: operating payment_method: credit_card transaction_type: credit amount_cents: 5000 amount_currency: USD account_id: 112 external_id: null created_at: '2022-12-27T13:09:52.790-08:00' updated_at: '2022-12-27T13:09:52.790-08:00' note: '' relationships: created_by: data: id: '5' type: user account: data: id: '112' type: contact prospect: data: id: '113' type: prospect invoice: data: id: '1' type: invoice trust_fund_request: data: null '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/phone_numbers/{phone_number_id}: get: operationId: getPhoneNumber summary: Phone Number description: A specific Phone Number by id tags: - Phone Numbers parameters: - name: phone_number_id in: path required: true description: The phone number id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getPhoneNumber: summary: GET Phone Number value: data: id: '514' type: phone_number attributes: label: Primary info: '9989888888' relationships: informationable: data: id: '520' type: contact '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer put: operationId: updatePhoneNumber summary: Update Phone Number description: Updates a Phone Number by id tags: - Phone Numbers parameters: - name: phone_number_id in: path required: true description: The phone number id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: putUpdatePhoneNumber: summary: PUT Update Phone Number value: data: id: '514' type: phone_number attributes: label: Primary info: '9989888888' relationships: informationable: data: id: '520' type: contact '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: deletePhoneNumber summary: Delete Phone Number description: 'Delete a Phone Number phone_number_id: ID of the Phone Number to delete' tags: - Phone Numbers parameters: - name: phone_number_id in: path required: true description: The phone number id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: delDeletePhoneNumber: summary: DEL Delete Phone Number value: data: id: '514' type: phone_number attributes: label: Primary info: '9989888888' relationships: informationable: data: id: '520' type: contact '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/phone_numbers: get: operationId: getPhoneNumbers summary: Phone Numbers description: A paginated list of all Phone Numbers in Lawmatics tags: - Phone Numbers responses: '200': description: OK content: application/json: schema: type: object examples: getPhoneNumbers: summary: GET Phone Numbers value: data: - id: '514' type: phone_number attributes: label: Primary info: '9989888888' relationships: informationable: data: id: '520' type: contact - id: '512' type: phone_number attributes: label: Primary info: '9989888888' relationships: informationable: data: id: '519' type: contact - id: '503' type: phone_number attributes: label: Home info: 916-234-5677 relationships: informationable: data: id: '58' type: company - id: '502' type: phone_number attributes: label: Other info: 916-235-5678 relationships: informationable: data: id: '58' type: company - id: '499' type: phone_number attributes: label: Primary info: 800-555-1234 relationships: informationable: data: id: '58' type: company - id: '497' type: phone_number attributes: label: Primary info: 123-123-1234 relationships: informationable: data: id: '534' type: contact - id: '495' type: phone_number attributes: label: Primary info: 800-987-6543 relationships: informationable: data: id: '57' type: company - id: '493' type: phone_number attributes: label: Home info: 916-234-5677 relationships: informationable: data: id: '55' type: company - id: '492' type: phone_number attributes: label: Other info: 916-235-5678 relationships: informationable: data: id: '55' type: company - id: '489' type: phone_number attributes: label: Primary info: 800-555-1234 relationships: informationable: data: id: '55' type: company - id: '487' type: phone_number attributes: label: Home info: 916-234-5677 relationships: informationable: data: id: '54' type: company - id: '486' type: phone_number attributes: label: Other info: 916-235-5678 relationships: informationable: data: id: '54' type: company - id: '483' type: phone_number attributes: label: Primary info: 800-555-1234 relationships: informationable: data: id: '54' type: company - id: '481' type: phone_number attributes: label: Home info: 916-234-5677 relationships: informationable: data: id: '53' type: company - id: '480' type: phone_number attributes: label: Other info: 916-235-5678 relationships: informationable: data: id: '53' type: company - id: '477' type: phone_number attributes: label: Primary info: 800-555-1234 relationships: informationable: data: id: '53' type: company - id: '475' type: phone_number attributes: label: Home info: 916-234-5677 relationships: informationable: data: id: '52' type: company - id: '474' type: phone_number attributes: label: Primary info: 916-235-5678 relationships: informationable: data: id: '52' type: company - id: '471' type: phone_number attributes: label: Home info: 916-234-5677 relationships: informationable: data: id: '51' type: company - id: '470' type: phone_number attributes: label: Primary info: 916-235-5678 relationships: informationable: data: id: '51' type: company - id: '467' type: phone_number attributes: label: Home info: 916-234-5677 relationships: informationable: data: id: '50' type: company - id: '466' type: phone_number attributes: label: Primary info: 916-235-5678 relationships: informationable: data: id: '50' type: company - id: '463' type: phone_number attributes: label: Home info: 916-234-5677 relationships: informationable: data: id: '49' type: company - id: '462' type: phone_number attributes: label: Primary info: 916-235-5678 relationships: informationable: data: id: '49' type: company - id: '459' type: phone_number attributes: label: Primary info: 800-555-1234 relationships: informationable: data: id: '49' type: company meta: total_pages: 6 limit_per_page: 25 total_entries: 143 links: self: /v1/phone_numbers?page=1 next: /v1/phone_numbers?page=2 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createPhoneNumber summary: Create Phone Number description: 'Create a new Phone Number Required Fields: informationable, label, info info: The Phone Number string. label: The Phone Number''s label e.g. Primary. informationable_type: Prospect, Contact, Company, or Firm that the Phone Number belongs to. informationable_id: Id of Record. Firm type doesn''t need an ID passed and it will be ignored. Note - Setting the Phone Number through a Prospect (Matter) will set the address on the Prospects'' Contact/Company.' tags: - Phone Numbers requestBody: required: true content: multipart/form-data: schema: type: object properties: label: type: string info: type: string informationable_type: type: string informationable_id: type: string responses: '201': description: Created content: application/json: schema: type: object examples: createPhoneNumber: summary: Create Phone Number value: data: id: '514' type: phone_number attributes: label: Primary info: '9989888888' relationships: informationable: data: id: '520' type: contact '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/tags/{tag_id}: get: operationId: getTag summary: Tag description: A specific Tag in Lawmatics tags: - Tags parameters: - name: tag_id in: path required: true description: The tag id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getTag: summary: GET Tag value: data: id: '1' type: tag attributes: name: test description: null color: null created_at: '2022-03-07T09:49:33.433-08:00' updated_at: '2022-03-07T09:49:33.433-08:00' '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer put: operationId: updateTag summary: Update Tag description: 'Updates a Tag Optional Fields: Description, Color title: The Tag title description: The Tag description color: The Tag color. Can be any CSS valid color (hex, rgb, hsl, colorname string, etc)' tags: - Tags parameters: - name: tag_id in: path required: true description: The tag id schema: type: string requestBody: required: true content: application/json: schema: type: object example: name: Updated Tag 76288a88-8c4c-4e65-9329-69288f3db815 color: '#554433' description: One tag to rule them all responses: '201': description: Created content: application/json: schema: type: object examples: putUpdateTask: summary: PUT Update Task value: data: id: '5' type: tag attributes: name: Updated Tag color: '#554433' '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: deleteTag summary: Delete Tag description: 'Delete a Tag tag_id: ID of the tag to delete' tags: - Tags parameters: - name: tag_id in: path required: true description: The tag id schema: type: string responses: '201': description: Created content: application/json: schema: type: object examples: deleteDeleteTag: summary: DELETE Delete Tag value: data: id: '5' type: tag attributes: name: Updated Tag color: '#554433' '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/tags: get: operationId: getTags summary: Tags description: 'A paginated list of all Tags in Lawmatics Can be filtered by matter_id , prospect_id , contact_id , company_id, task_id and user_id as well as all the regular fields as referenced by our Param Guide (most fields returned by?fields=all).' tags: - Tags responses: '200': description: OK content: application/json: schema: type: object examples: getTags: summary: GET Tags value: data: - id: '4' type: tag attributes: name: aeee description: null color: '#7997c9' created_at: '2022-03-08T04:56:46.862-08:00' updated_at: '2022-03-15T11:19:10.106-07:00' - id: '3' type: tag attributes: title: test 3 description: null color: null created_at: '2022-03-08T04:56:42.595-08:00' updated_at: '2022-03-08T04:56:42.595-08:00' - id: '2' type: tag attributes: title: test2 description: null color: null created_at: '2022-03-07T09:49:38.432-08:00' updated_at: '2022-03-07T09:49:38.432-08:00' - id: '1' type: tag attributes: title: test description: null color: null created_at: '2022-03-07T09:49:33.433-08:00' updated_at: '2022-03-07T09:49:33.433-08:00' meta: total_pages: 1 limit_per_page: 25 total_entries: 4 links: self: /v1/tags?page=1 getTagsByMatter: summary: GET Tags by Matter value: data: - id: '4' type: tag attributes: name: aeee description: null color: '#7997c9' created_at: '2022-03-08T04:56:46.862-08:00' updated_at: '2022-03-15T11:19:10.106-07:00' - id: '3' type: tag attributes: title: test 3 description: null color: null created_at: '2022-03-08T04:56:42.595-08:00' updated_at: '2022-03-08T04:56:42.595-08:00' - id: '2' type: tag attributes: title: test2 description: null color: null created_at: '2022-03-07T09:49:38.432-08:00' updated_at: '2022-03-07T09:49:38.432-08:00' - id: '1' type: tag attributes: title: test description: null color: null created_at: '2022-03-07T09:49:33.433-08:00' updated_at: '2022-03-07T09:49:33.433-08:00' meta: total_pages: 1 limit_per_page: 25 total_entries: 4 links: self: /v1/tags?page=1 getTagsByContact: summary: GET Tags by Contact value: data: - id: '4' type: tag attributes: name: aeee description: null color: '#7997c9' created_at: '2022-03-08T04:56:46.862-08:00' updated_at: '2022-03-15T11:19:10.106-07:00' - id: '3' type: tag attributes: title: test 3 description: null color: null created_at: '2022-03-08T04:56:42.595-08:00' updated_at: '2022-03-08T04:56:42.595-08:00' - id: '2' type: tag attributes: title: test2 description: null color: null created_at: '2022-03-07T09:49:38.432-08:00' updated_at: '2022-03-07T09:49:38.432-08:00' - id: '1' type: tag attributes: title: test description: null color: null created_at: '2022-03-07T09:49:33.433-08:00' updated_at: '2022-03-07T09:49:33.433-08:00' meta: total_pages: 1 limit_per_page: 25 total_entries: 4 links: self: /v1/tags?page=1 getTagsByCompany: summary: GET Tags by Company value: data: - id: '4' type: tag attributes: name: aeee description: null color: '#7997c9' created_at: '2022-03-08T04:56:46.862-08:00' updated_at: '2022-03-15T11:19:10.106-07:00' - id: '3' type: tag attributes: title: test 3 description: null color: null created_at: '2022-03-08T04:56:42.595-08:00' updated_at: '2022-03-08T04:56:42.595-08:00' - id: '2' type: tag attributes: title: test2 description: null color: null created_at: '2022-03-07T09:49:38.432-08:00' updated_at: '2022-03-07T09:49:38.432-08:00' - id: '1' type: tag attributes: title: test description: null color: null created_at: '2022-03-07T09:49:33.433-08:00' updated_at: '2022-03-07T09:49:33.433-08:00' meta: total_pages: 1 limit_per_page: 25 total_entries: 4 links: self: /v1/tags?page=1 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createTag summary: Create Tag description: 'Create a new Tag Optional Fields: Description, Color title: The Tag title description: The Tag description color: The Tag color. Can be any CSS valid color (hex, rgb, hsl, colorname string, etc)' tags: - Tags requestBody: required: true content: application/json: schema: type: object example: name: New Tag 9e7fb986-57ae-476d-82b7-cccb011ecc89 color: '#554433' description: A tag to rule them all responses: '201': description: Created content: application/json: schema: type: object examples: postCreateTag: summary: POST Create Tag value: data: id: '5' type: tag attributes: name: New Tag color: '#554433' '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/tags/attach: post: operationId: attachTag summary: Attach Tag description: 'Attaches tags to a Matter, Contact, Company, or Task (type)_id: The ID of the entity to attach tags to. One of matter_id, contact_id, company_id, or task_id. tags: List of tags to attach. If a tag does not exist, it will be created.' tags: - Tags responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: postAttachTag: summary: POST Attach Tag value: data: id: '290' type: prospect attributes: first_name: John last_name: Hancock case_title: null case_blurb: null status: pnc email: null phone: null phone_number: null email_address: null address: null photo_url: null birthdate: null name_prefix: null middle_name: null name_suffix: null sub_status: Pnc informal_name: null employer: null occupation: null citizenship: null bio: null title: null hobbies: null social_security: null age: null referring_url: null driver_license: null gender: null marital_status: null timezone: null estimated_value_cents: 0 actual_value_cents: 0 lead_cost_cents: 0 date_of_last_contact: '2022-05-09T07:16:04.329-07:00' days_since_last_contact: 22 converted_date: null statute_of_limitations: null utm_source: null utm_campaign: null utm_medium: null utm_term: null street: null street2: null city: null state: null zipcode: null country: null full_address: null full_street: null city_state_zip: null custom_fields: [] custom_field_values: {} created_at: '2022-05-09T07:16:04.203-07:00' updated_at: '2022-05-31T16:40:25.234-07:00' last_contacted_date: '2022-05-09T07:16:04.329-07:00' relationships: source: data: null stage: data: null campaign: data: null practice_area: data: id: '6' type: practice_area salesperson: data: null lead_attorney: data: null originating_attorney: data: null owned_by: data: null created_by: data: id: '2' type: user contact: data: id: '306' type: contact company: data: null assigned_staff: data: [] events: data: [] file_requests: data: [] documents: data: [] notes: data: [] tasks: data: [] emails: data: [] phone_numbers: data: [] addresses: data: [] invoices: data: [] tags: data: - id: '4' type: tag - id: '1' type: tag - id: '6' type: tag - id: '8' type: tag - id: '9' type: tag - id: '10' type: tag relationships: data: [] '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/tags/detach: post: operationId: detachTag summary: Detach Tag description: 'Detaches tags from a Matter, Contact, Company, or Task (type)_id: The ID of the entity to detach Tags from. One of matter_id, contact_id, company_id, or task_id. tags: List of Tags to detach. If a Tag does not exist, it will be ignored.' tags: - Tags responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: postDetachTag: summary: POST Detach Tag value: data: id: '290' type: prospect attributes: first_name: John last_name: Hancock case_title: null case_blurb: null status: pnc email: null phone: null phone_number: null email_address: null address: null photo_url: null birthdate: null name_prefix: null middle_name: null name_suffix: null sub_status: Pnc informal_name: null employer: null occupation: null citizenship: null bio: null title: null hobbies: null social_security: null age: null referring_url: null driver_license: null gender: null marital_status: null timezone: null estimated_value_cents: 0 actual_value_cents: 0 lead_cost_cents: 0 date_of_last_contact: '2022-05-09T07:16:04.329-07:00' days_since_last_contact: 22 converted_date: null statute_of_limitations: null utm_source: null utm_campaign: null utm_medium: null utm_term: null street: null street2: null city: null state: null zipcode: null country: null full_address: null full_street: null city_state_zip: null custom_fields: [] custom_field_values: {} created_at: '2022-05-09T07:16:04.203-07:00' updated_at: '2022-05-31T16:40:25.234-07:00' last_contacted_date: '2022-05-09T07:16:04.329-07:00' relationships: source: data: null stage: data: null campaign: data: null practice_area: data: id: '6' type: practice_area salesperson: data: null lead_attorney: data: null originating_attorney: data: null owned_by: data: null created_by: data: id: '2' type: user contact: data: id: '306' type: contact company: data: null assigned_staff: data: [] events: data: [] file_requests: data: [] documents: data: [] notes: data: [] tasks: data: [] emails: data: [] phone_numbers: data: [] addresses: data: [] invoices: data: [] tags: data: - id: '4' type: tag - id: '1' type: tag - id: '6' type: tag - id: '8' type: tag relationships: data: [] '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/tasks/{task_id}: get: operationId: getTask summary: Task description: A specific Task in Lawmatics tags: - Tasks parameters: - name: task_id in: path required: true description: The task id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getTask: summary: GET Task value: data: id: '117' type: task attributes: name: Brand new updated task description: The updated new description due_date: '2023-08-25T00:00:00.000-07:00' done: false status: No Status priority: high tags: - id: 2 firm_id: 1 name: nevermindd key: nevermindd description: null color: null created_at: '2023-04-24T16:11:25.082-07:00' updated_at: '2023-04-24T21:48:51.112-07:00' assigned_by_id: 2 recurrence_rule: type: weekly end_date: 08/30/2023 wednesday: true created_at: '2023-07-05T10:49:06.424-07:00' updated_at: '2023-07-05T10:51:40.650-07:00' relationships: users: data: - id: '2' type: user taskable: data: id: '471' type: prospect '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer put: operationId: updateTask summary: Update Task description: "Updates a Task\n\nOptional Fields: user_ids, priority, done, taskable, tag_ids, assigned_by_id,\ \ recurrence_rule\n\ndue_date: Task due date (iso8601 datetime)\n\nuser_ids: The Firm User ids\ \ that will be assigned to this Task.\n\npriority: high, medium, low (default)\n\ndone: true or\ \ false (default)\n\ntaskable_type, taskable_id: Record type, ID the Task is associated with (Prospect\ \ (Matter), Contact, Company, Client).\n\ntag_ids: Tags to associate to this **Task. \n\nassigned_by_id:**\ \ The user id the task is assigned by.\n\nrecurrence_rule: Json object. Following are the fields\ \ with which we can create a recurrence_rule.\nRecurrenceType options are the following = 'daily'\ \ or 'weekly' or monthly' or 'yearly';\n\nfields of the json object you can choose from:\ntype:\ \ RecurrenceType;\nendOption?: boolean;\nendDate?: Date;\n\n// If you choose type to be daily\n\ \nfrequency?: number;\n\n// If you choose type to be weekly\n\nsunday?: boolean;\nmonday?: boolean;\n\ tuesday?: boolean;\nwednesday?: boolean;\nthursday?: boolean;\nfriday?: boolean;\nsaturday?: boolean;\n\ \n// If you choose type to be monthly\nmonthlyFrequency?: number;\ndayOfMonth?: number;\n\n//\ \ If you choose type to be yearly\nmonth?: string;\ndayOfMonthYear?: number;" tags: - Tasks parameters: - name: task_id in: path required: true description: The task id schema: type: string - name: fields in: query required: false schema: type: string example: all responses: '201': description: Created content: application/json: schema: type: object examples: putUpdateTask: summary: PUT Update Task value: data: id: '117' type: task attributes: name: Brand new updated task description: The updated new description due_date: '2023-08-25T00:00:00.000-07:00' done: false priority: high status: No Status tags: - id: 2 firm_id: 1 name: nevermindd key: nevermindd description: null color: null created_at: '2023-04-24T16:11:25.082-07:00' updated_at: '2023-04-24T21:48:51.112-07:00' recurrence_rule: type: weekly wednesday: true end_date: 08/30/2023 assigned_by_id: 2 created_at: '2023-07-05T10:49:06.424-07:00' updated_at: '2023-07-05T10:51:40.650-07:00' relationships: users: data: - id: '2' type: user documents: data: [] taskable: data: id: '471' type: prospect subtasks: data: [] comments: data: [] '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: deleteTask summary: Delete Task description: Delete a Task tags: - Tasks parameters: - name: task_id in: path required: true description: The task id schema: type: string responses: '201': description: Created content: application/json: schema: type: object examples: deleteDeleteTask: summary: DELETE Delete Task value: data: id: '13' type: task attributes: name: Updated Task description: The updated tag description due_date: '2022-06-30T00:00:00.000-07:00' done: false priority: high tags: [] created_at: '2022-06-21T12:53:05.939-07:00' updated_at: '2022-06-21T12:57:27.416-07:00' relationships: users: data: - id: '2' type: user taskable: data: id: '37' type: contact '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/tasks: get: operationId: getTasks summary: Tasks description: 'A paginated list of all Tasks in Lawmatics Can be filtered by matter_id, prospect_id, contact_id, company_id, client_id, anduser_id as well as all the regular fields as referenced by our Param Guide (most fields returned by?fields=all).' tags: - Tasks responses: '200': description: OK content: application/json: schema: type: object examples: getTasks: summary: GET Tasks value: data: - id: '3' type: task attributes: name: Pinky description: Think of a plan due_date: '2022-06-28T00:00:00.000-07:00' done: false priority: low tags: - id: 2 firm_id: 2 name: test key: test description: null color: '#8fc1d8' created_at: '2022-06-07T14:28:31.081-07:00' updated_at: '2022-06-07T14:47:13.127-07:00' created_at: '2022-06-17T18:05:05.702-07:00' updated_at: '2022-06-17T18:05:49.602-07:00' relationships: users: data: - id: '2' type: user taskable: data: null - id: '2' type: task attributes: name: The Brain description: Take over the world due_date: '2022-06-30T00:00:00.000-07:00' done: false priority: low tags: [] created_at: '2022-06-17T17:26:45.659-07:00' updated_at: '2022-06-17T18:01:56.394-07:00' relationships: users: data: - id: '2' type: user taskable: data: id: '9' type: contact meta: total_pages: 1 limit_per_page: 25 total_entries: 2 links: self: /v1/tasks?page=1 getTasksByMatter: summary: GET Tasks by Matter value: data: - id: '5' type: task attributes: name: another task description: last one due_date: '2022-07-02T00:00:00.000-07:00' done: false priority: low tags: [] created_at: '2022-06-17T18:14:03.977-07:00' updated_at: '2022-06-17T18:14:04.022-07:00' relationships: users: data: - id: '2' type: user taskable: data: id: '68' type: prospect - id: '4' type: task attributes: name: test description: test task for matter due_date: '2022-06-27T00:00:00.000-07:00' done: false priority: low tags: [] created_at: '2022-06-17T18:12:44.753-07:00' updated_at: '2022-06-17T18:12:44.781-07:00' relationships: users: data: - id: '2' type: user taskable: data: id: '68' type: prospect meta: total_pages: 1 limit_per_page: 25 total_entries: 2 links: self: /v1/tasks?page=1 getTasksByContact: summary: GET Tasks by Contact value: data: - id: '7' type: task attributes: name: Fundraiser description: '' due_date: '2022-07-14T00:00:00.000-07:00' done: false priority: low tags: [] created_at: '2022-06-17T18:18:34.852-07:00' updated_at: '2022-06-17T18:18:34.881-07:00' relationships: users: data: - id: '2' type: user taskable: data: id: '100' type: contact - id: '6' type: task attributes: name: Bake Sale description: Bake cookies due_date: '2022-07-09T00:00:00.000-07:00' done: false priority: low tags: [] created_at: '2022-06-17T18:17:25.939-07:00' updated_at: '2022-06-17T18:17:25.966-07:00' relationships: users: data: - id: '2' type: user taskable: data: id: '100' type: contact meta: total_pages: 1 limit_per_page: 25 total_entries: 2 links: self: /v1/tasks?page=1 getTasksByClient: summary: GET Tasks by Client value: data: - id: '8' type: task attributes: name: Test description: '' due_date: '2022-07-14T00:00:00.000-07:00' done: false priority: low tags: [] created_at: '2022-06-17T18:18:34.852-07:00' updated_at: '2022-06-17T18:18:34.881-07:00' relationships: users: data: - id: '2' type: user taskable: data: id: '12' type: client - id: '9' type: task attributes: name: Test task description: Task description due_date: '2022-07-09T00:00:00.000-07:00' done: false priority: low tags: [] created_at: '2022-06-17T18:17:25.939-07:00' updated_at: '2022-06-17T18:17:25.966-07:00' relationships: users: data: - id: '2' type: user taskable: data: id: '12' type: client meta: total_pages: 1 limit_per_page: 25 total_entries: 2 links: self: /v1/tasks?page=1 getTasksByCompany: summary: GET Tasks by Company value: data: - id: '10' type: task attributes: name: New Task description: An important piece of work to be made until it's due date due_date: '2022-05-30T00:00:00.000-07:00' done: false priority: low tags: [] created_at: '2022-06-17T18:23:22.428-07:00' updated_at: '2022-06-17T18:23:22.428-07:00' relationships: users: data: - id: '2' type: user taskable: data: id: '1' type: company meta: total_pages: 1 limit_per_page: 25 total_entries: 1 links: self: /v1/tasks?page=1 getTasksByUser: summary: GET Tasks by User value: data: - id: '209' type: task attributes: name: Task 1 description: '' due_date: '2022-05-11T20:00:00.000-07:00' done: false priority: low tags: [] taskable_type: User taskable_id: 17 created_at: '2022-05-06T12:00:57.968-07:00' updated_at: '2022-05-06T12:38:17.337-07:00' relationships: users: data: - id: '2' type: user - id: '9' type: task attributes: name: Task 2 description: null due_date: '2022-05-03T08:02:14.045-07:00' done: false priority: low tags: [] taskable_type: User taskable_id: 17 created_at: '2022-05-03T08:02:14.076-07:00' updated_at: '2022-05-03T08:02:14.076-07:00' relationships: users: data: - id: '3' type: user meta: total_pages: 1 limit_per_page: 25 total_entries: 2 links: self: /v1/tasks?page=1 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createTask summary: Create Task description: 'Create a new Task Optional Fields: user_ids, priority, done, taskable, tag_ids, assigned_by_id, recurrence_rule due_date: Task''s due date (iso8601 datetime) user_ids: The Firm User ids assigned to this Task. priority: high, medium, low (default) done: true or false (default) taskable_type, taskable_id: Record type, ID the Task is associated with (Prospect (Matter), Contact, Company, Client) tag_ids: Tags to associate to this Task assigned_by_id: The user id the task is assigned by. recurrence_rule: Json object. Following are the fields with which we can create a recurrence_rule. RecurrenceType options are the following = ''daily'' or ''weekly'' or monthly'' or ''yearly''; fields of the json object you can choose from: type: RecurrenceType; endOption?: boolean; endDate?: Date; // If you choose type to be daily frequency?: number; // If you choose type to be weekly sunday?: boolean; monday?: boolean; tuesday?: boolean; wednesday?: boolean; thursday?: boolean; friday?: boolean; saturday?: boolean; // If you choose type to be monthly monthlyFrequency?: number; dayOfMonth?: number; // If you choose type to be yearly month?: string; dayOfMonthYear?: number;' tags: - Tasks responses: '201': description: Created content: application/json: schema: type: object examples: postCreateTask: summary: POST Create Task value: data: id: '117' type: task attributes: name: A brand new task description: An important piece of work to be made until it's due date due_date: '2023-07-30T00:00:00.000-07:00' done: false status: No Status priority: low tags: - id: 1 firm_id: 1 name: mytag key: mytag description: null color: null created_at: '2023-04-24T15:51:53.352-07:00' updated_at: '2023-04-24T15:51:53.352-07:00' assigned_by_id: 1 recurrence_rule: type: daily frequency: 2 endDate: 08/15/2023 created_at: '2023-07-05T10:49:06.424-07:00' updated_at: '2023-07-05T10:49:06.450-07:00' relationships: users: data: [] taskable: data: id: '471' type: prospect '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/tasks/{task_id}/subtasks/{subtask_id}: get: operationId: getSubtask summary: Subtask description: A specific subtask in tasks in Lawmatics. tags: - Tasks parameters: - name: task_id in: path required: true description: The task id schema: type: string - name: subtask_id in: path required: true description: The subtask id schema: type: string responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: subtask: summary: Subtask value: id: 10 body: kab? order: 0 done: false task_id: 47 created_at: '2023-02-09T14:34:02.173-08:00' updated_at: '2023-02-09T14:34:02.173-08:00' deleted_at: null '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer put: operationId: updateSubtask summary: Update Subtask description: Updates a subtask on a task. tags: - Tasks parameters: - name: task_id in: path required: true description: The task id schema: type: string - name: subtask_id in: path required: true description: The subtask id schema: type: string requestBody: required: true content: application/json: schema: type: object example: body: you are awesome number 1 done: 'false' responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: updateSubtask: summary: Update Subtask value: data: id: '26' type: subtask attributes: body: you are awesome number 1 done: false order: 1 created_at: '2023-06-29T12:11:42.971-07:00' updated_at: '2023-06-29T15:37:15.140-07:00' relationships: task: data: id: '46' type: task '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: deleteSubtask summary: Delete Subtask description: Deletes a subtask from a task. tags: - Tasks parameters: - name: task_id in: path required: true description: The task id schema: type: string - name: subtask_id in: path required: true description: The subtask id schema: type: string responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: deleteSubtask: summary: Delete Subtask value: data: id: '46' type: subtask attributes: body: hamne done: true order: 0 created_at: '2023-02-09T14:31:31.631-08:00' updated_at: '2023-06-29T14:12:37.048-07:00' relationships: task: data: id: '46' type: task '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/tasks/{task_id}/subtasks: get: operationId: getSubtasks summary: Subtasks description: All the subtasks that belong to a task in Lawmatics. tags: - Tasks parameters: - name: task_id in: path required: true description: The task id schema: type: string responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: getSubtasks: summary: GET Subtasks value: - id: 10 body: kab? order: 0 done: false task_id: 47 created_at: '2023-02-09T14:34:02.173-08:00' updated_at: '2023-02-09T14:34:02.173-08:00' deleted_at: null - id: 11 body: schi nu order: 1 done: false task_id: 47 created_at: '2023-06-28T16:04:39.451-07:00' updated_at: '2023-06-28T16:04:39.451-07:00' deleted_at: null '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createSubtask summary: Create Subtask description: Creates a new subtask on a task. tags: - Tasks parameters: - name: task_id in: path required: true description: The task id schema: type: string requestBody: required: true content: application/json: schema: type: object example: body: first one done: false responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: createSubtask: summary: Create Subtask value: data: id: '35' type: subtask attributes: body: first one done: false order: 0 created_at: '2023-06-29T15:11:07.442-07:00' updated_at: '2023-06-29T15:11:07.442-07:00' relationships: task: data: id: '50' type: task '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/tasks/{task_id}/comments/{comment_id}: get: operationId: getComment summary: Comment description: A specific comment on a task in Lawmatics. tags: - Tasks parameters: - name: task_id in: path required: true description: The task id schema: type: string - name: comment_id in: path required: true description: The comment id schema: type: string responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: comment: summary: Comment value: data: id: '1' type: comment attributes: body:

eda fer @Westeros User 

commentable_type: Task commentable_id: 45 mentioned_user_ids: [] created_at: '2023-02-13T18:07:02.962-08:00' updated_at: '2023-06-30T10:36:03.283-07:00' relationships: commentable: data: id: '45' type: task comment_mentions: data: [] '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer put: operationId: updateComment summary: Update Comment description: 'Updates a specific comment on a task in Lawmatics. optional field: mentioned_user_ids mentioned_user_ids: list of user ids.' tags: - Tasks parameters: - name: task_id in: path required: true description: The task id schema: type: string - name: comment_id in: path required: true description: The comment id schema: type: string responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: updateComment: summary: Update Comment value: data: id: '45' type: comment attributes: body: A new comment on task updated commentable_type: Task commentable_id: 45 mentioned_user_ids: - 1 - 5 - 6 created_at: '2023-07-05T11:14:44.974-07:00' updated_at: '2023-07-05T11:15:58.840-07:00' relationships: commentable: data: id: '45' type: task comment_mentions: data: - id: '11' type: comment_mention - id: '12' type: comment_mention - id: '13' type: comment_mention '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: deleteComment summary: Delete Comment description: Deletes a specific comment on a task in Lawmatics. tags: - Tasks parameters: - name: task_id in: path required: true description: The task id schema: type: string - name: comment_id in: path required: true description: The comment id schema: type: string responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: deleteComment: summary: Delete Comment value: data: id: '31' type: comment attributes: body: hello love commentable_type: Task commentable_id: 45 created_at: '2023-06-30T12:53:17.586-07:00' updated_at: '2023-06-30T13:10:40.829-07:00' relationships: commentable: data: id: '45' type: task comment_mentions: data: [] '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/tasks/{task_id}/comments: get: operationId: getComments summary: Comments description: Retrieves all the comments on a task in Lawmatics. tags: - Tasks parameters: - name: task_id in: path required: true description: The task id schema: type: string responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createComment summary: Create Comment description: "Creates a comment on a task in Lawmatics.\noptional field: mentioned_user_ids\n\n\ mentioned_user_ids: list of user ids.\n\nFeel free to add HTML tags to format your comments.\n\ \nFollowing is a simple comment with formatting example using bold italic etc. \n\nThis is a\ \ simple comment with formatting example using bold italics\n\nAnother example of comment with\ \ mentioned users. \n\nHi its a new comment on task 45 @Jasmine Rattan" tags: - Tasks parameters: - name: task_id in: path required: true description: The task id schema: type: string responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: createComment: summary: Create Comment value: data: id: '45' type: comment attributes: body: A new comment on task commentable_type: Task commentable_id: 45 mentioned_user_ids: - 1 created_at: '2023-07-05T11:14:44.974-07:00' updated_at: '2023-07-05T11:14:44.974-07:00' relationships: commentable: data: id: '45' type: task comment_mentions: data: - id: '11' type: comment_mention '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/task_statuses/{task_status_id}: get: operationId: getTaskStatus summary: Task Status description: A specific task status in Lawmatics. tags: - Task Statuses parameters: - name: task_status_id in: path required: true description: The task status id schema: type: string responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: getTaskStatus: summary: GET Task Status value: data: id: '3' type: task_status attributes: name: Waiting for Client color: '#A7783B' created_at: '2022-12-27T10:08:45.708-08:00' updated_at: '2022-12-27T10:08:45.708-08:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer put: operationId: updateTaskStatus summary: Update Task Status description: Updates a task status in Lawmatics. tags: - Task Statuses parameters: - name: task_status_id in: path required: true description: The task status id schema: type: string requestBody: required: true content: application/json: schema: type: object example: name: i am changing task status id 11 color: '#000000' responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: updateTaskStatus: summary: UPDATE Task Status value: data: id: '11' type: task_status attributes: name: i am changing task status id 11 color: '#000000' created_at: '2023-07-03T09:51:58.461-07:00' updated_at: '2023-07-03T10:12:16.345-07:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: deleteTaskStatus summary: Delete Task Status description: Deletes a task status in Lawmatics. tags: - Task Statuses parameters: - name: task_status_id in: path required: true description: The task status id schema: type: string responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: deleteTaskStatus: summary: DELETE Task Status value: data: id: '10' type: task_status attributes: name: lmao color: '#000000' created_at: '2023-07-03T09:49:50.880-07:00' updated_at: '2023-07-03T09:50:01.235-07:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/task_statuses: get: operationId: getTaskStatuses summary: Task Statuses description: Gets all the task statuses in Lawmatics. tags: - Task Statuses responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: getTaskStatuses: summary: GET Task Statuses value: data: - id: '11' type: task_status attributes: name: dolare color: '#FFFFFF' created_at: '2023-07-03T09:51:58.461-07:00' updated_at: '2023-07-03T10:02:21.859-07:00' relationships: {} - id: '9' type: task_status attributes: name: hello color: '#000000' created_at: '2023-04-24T15:42:34.296-07:00' updated_at: '2023-04-24T15:42:34.296-07:00' relationships: {} - id: '4' type: task_status attributes: name: In Progress color: '#DE5E1C' created_at: '2022-12-27T10:08:45.712-08:00' updated_at: '2022-12-27T10:08:45.712-08:00' relationships: {} - id: '3' type: task_status attributes: name: Waiting for Client color: '#A7783B' created_at: '2022-12-27T10:08:45.708-08:00' updated_at: '2022-12-27T10:08:45.708-08:00' relationships: {} - id: '2' type: task_status attributes: name: Waiting for Attorney color: '#EDBE30' created_at: '2022-12-27T10:08:45.704-08:00' updated_at: '2022-12-27T10:08:45.704-08:00' relationships: {} - id: '1' type: task_status attributes: name: Not Started color: '#6519FA' created_at: '2022-12-27T10:08:45.699-08:00' updated_at: '2023-04-24T15:42:47.077-07:00' relationships: {} meta: total_pages: 1 limit_per_page: 25 total_entries: 6 links: self: /v1/task_statuses?page=1 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createTaskStatus summary: Create Task Status description: Creates a task status in Lawmatics. tags: - Task Statuses requestBody: required: true content: application/json: schema: type: object example: name: new task status by jasmine color: '#000000' responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: createTaskStatus: summary: CREATE Task Status value: data: id: '12' type: task_status attributes: name: new task status by jasmine color: '#000000' created_at: '2023-07-03T10:10:26.384-07:00' updated_at: '2023-07-03T10:10:26.384-07:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/activities/{activity_id}: get: operationId: getActivity summary: Activity description: A specific Activity in Lawmatics tags: - Timeline Activities parameters: - name: activity_id in: path required: true description: The activity id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getActivity: summary: GET Activity value: data: id: '101' type: timeline_activity attributes: key: prospect.update type: TimelineActivity::Prospect detail_keys: - emails: - id: 187 info: - richard93@example.com - ricardo+1@lawmatics.com parent_id: null relationships: owner: data: id: '2' type: user tracked: data: id: '94' type: prospect recipient: data: id: '94' type: prospect '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/activities: get: operationId: getActivities summary: Activities description: 'A paginated list of Activities in Lawmatics Can be filtered by matter_id, contact_id, type, andevent as well as all the regular fields as referenced by our Param Guide (most fields returned by?fields=all).' tags: - Timeline Activities parameters: - name: filter_by in: query required: false description: matter_id, contact_id, type or event schema: type: string example: matter_id - name: filter_on in: query required: false schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: matterActivities: summary: Matter Activities value: data: - id: '1' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Mary Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '1' type: note recipient: data: id: '1' type: prospect meta: total_pages: 1 limit_per_page: 25 total_entries: 1 links: self: /v1/timeline_activities?page=1 contactActivities: summary: Contact Activities value: data: - id: '3' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Michael Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '3' type: note recipient: data: id: '3' type: prospect meta: total_pages: 1 limit_per_page: 25 total_entries: 1 links: self: /v1/timeline_activities?page=1 activitiesByType: summary: Activities By Type value: data: - id: '100' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Lisa Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '100' type: note recipient: data: id: '100' type: prospect - id: '99' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: David Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '99' type: note recipient: data: id: '99' type: prospect - id: '98' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Patricia Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '98' type: note recipient: data: id: '98' type: prospect - id: '97' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Michael Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '97' type: note recipient: data: id: '97' type: prospect - id: '96' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Karen Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '96' type: note recipient: data: id: '96' type: prospect - id: '95' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: James Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '95' type: note recipient: data: id: '95' type: prospect - id: '94' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Richard Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '94' type: note recipient: data: id: '94' type: prospect - id: '93' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Jennifer Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '93' type: note recipient: data: id: '93' type: prospect - id: '92' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: James Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '92' type: note recipient: data: id: '92' type: prospect - id: '91' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Jennifer Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '91' type: note recipient: data: id: '91' type: prospect - id: '90' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Barbara Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '90' type: note recipient: data: id: '90' type: prospect - id: '89' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Jennifer Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '89' type: note recipient: data: id: '89' type: prospect - id: '88' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Maria Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '88' type: note recipient: data: id: '88' type: prospect - id: '87' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Karen Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '87' type: note recipient: data: id: '87' type: prospect - id: '86' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: William Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '86' type: note recipient: data: id: '86' type: prospect - id: '85' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Jennifer Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '85' type: note recipient: data: id: '85' type: prospect - id: '84' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Susan Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '84' type: note recipient: data: id: '84' type: prospect - id: '83' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: William Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '83' type: note recipient: data: id: '83' type: prospect - id: '82' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Michael Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '82' type: note recipient: data: id: '82' type: prospect - id: '81' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Charles Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '81' type: note recipient: data: id: '81' type: prospect - id: '80' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Michael Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '80' type: note recipient: data: id: '80' type: prospect - id: '79' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Joseph Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '79' type: note recipient: data: id: '79' type: prospect - id: '78' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Barbara Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '78' type: note recipient: data: id: '78' type: prospect - id: '77' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: William Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '77' type: note recipient: data: id: '77' type: prospect - id: '76' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Susan Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '76' type: note recipient: data: id: '76' type: prospect meta: total_pages: 4 limit_per_page: 25 total_entries: 100 links: self: /v1/timeline_activities?page=1 next: /v1/timeline_activities?page=2 activitiesByEvent: summary: Activities By Event value: data: - id: '100' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Lisa Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '100' type: note recipient: data: id: '100' type: prospect - id: '99' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: David Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '99' type: note recipient: data: id: '99' type: prospect - id: '98' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Patricia Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '98' type: note recipient: data: id: '98' type: prospect - id: '97' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Michael Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '97' type: note recipient: data: id: '97' type: prospect - id: '96' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Karen Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '96' type: note recipient: data: id: '96' type: prospect - id: '95' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: James Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '95' type: note recipient: data: id: '95' type: prospect - id: '94' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Richard Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '94' type: note recipient: data: id: '94' type: prospect - id: '93' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Jennifer Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '93' type: note recipient: data: id: '93' type: prospect - id: '92' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: James Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '92' type: note recipient: data: id: '92' type: prospect - id: '91' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Jennifer Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '91' type: note recipient: data: id: '91' type: prospect - id: '90' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Barbara Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '90' type: note recipient: data: id: '90' type: prospect - id: '89' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Jennifer Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '89' type: note recipient: data: id: '89' type: prospect - id: '88' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Maria Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '88' type: note recipient: data: id: '88' type: prospect - id: '87' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Karen Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '87' type: note recipient: data: id: '87' type: prospect - id: '86' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: William Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '86' type: note recipient: data: id: '86' type: prospect - id: '85' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Jennifer Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '85' type: note recipient: data: id: '85' type: prospect - id: '84' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Susan Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '84' type: note recipient: data: id: '84' type: prospect - id: '83' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: William Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '83' type: note recipient: data: id: '83' type: prospect - id: '82' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Michael Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '82' type: note recipient: data: id: '82' type: prospect - id: '81' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Charles Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '81' type: note recipient: data: id: '81' type: prospect - id: '80' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Michael Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '80' type: note recipient: data: id: '80' type: prospect - id: '79' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Joseph Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '79' type: note recipient: data: id: '79' type: prospect - id: '78' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Barbara Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '78' type: note recipient: data: id: '78' type: prospect - id: '77' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: William Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '77' type: note recipient: data: id: '77' type: prospect - id: '76' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. name: Susan Note parent_id: null relationships: owner: data: id: '2' type: firm tracked: data: id: '76' type: note recipient: data: id: '76' type: prospect meta: total_pages: 4 limit_per_page: 25 total_entries: 100 links: self: /v1/timeline_activities?page=1 next: /v1/timeline_activities?page=2 activitiesAfterADate: summary: Activities After a Date value: data: - id: '683' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. name: Example Note created_at: '2022-07-25T12:34:17.177-07:00' updated_at: '2022-07-25T12:34:17.177-07:00' relationships: owner: data: id: '1' type: application tracked: data: id: '180' type: note recipient: data: id: '220' type: contact - id: '682' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. name: Example Note created_at: '2022-07-25T12:34:10.224-07:00' updated_at: '2022-07-25T12:34:10.224-07:00' relationships: owner: data: id: '1' type: application tracked: data: id: '179' type: note recipient: data: id: '219' type: contact - id: '681' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. name: Example Note created_at: '2022-07-25T12:33:53.903-07:00' updated_at: '2022-07-25T12:33:53.903-07:00' relationships: owner: data: id: '1' type: application tracked: data: id: '178' type: note recipient: data: id: '218' type: contact - id: '680' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. name: Example Note created_at: '2022-07-25T12:31:37.738-07:00' updated_at: '2022-07-25T12:31:37.738-07:00' relationships: owner: data: id: '1' type: application tracked: data: id: '177' type: note recipient: data: id: '217' type: contact - id: '679' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. name: Example Note created_at: '2022-07-25T12:31:32.040-07:00' updated_at: '2022-07-25T12:31:32.040-07:00' relationships: owner: data: id: '1' type: application tracked: data: id: '176' type: note recipient: data: id: '216' type: contact - id: '678' type: timeline_activity attributes: key: task.complete type: task detail_keys: done: true name: Updated Task due_date: '2022-06-25T00:00:00.000-07:00' priority: high description: The updated tag description created_at: '2022-07-25T10:51:13.545-07:00' updated_at: '2022-07-25T10:51:13.545-07:00' relationships: owner: data: id: '5' type: user tracked: data: id: '28' type: task recipient: data: id: '1' type: prospect - id: '677' type: timeline_activity attributes: key: task.create type: task detail_keys: name: New Task due_date: '2022-06-30T00:00:00.000-07:00' description: An important piece of work to be made until it's due date created_at: '2022-07-25T10:51:13.454-07:00' updated_at: '2022-07-25T10:51:13.560-07:00' relationships: owner: data: id: '5' type: user tracked: data: id: '28' type: task recipient: data: id: '1' type: prospect - id: '676' type: timeline_activity attributes: key: note.create type: note detail_keys: body: An important thing to remember name: New Note created_at: '2022-07-25T10:51:09.092-07:00' updated_at: '2022-07-25T10:51:09.092-07:00' relationships: owner: data: id: '5' type: user tracked: data: id: '175' type: note recipient: data: id: '113' type: prospect - id: '671' type: timeline_activity attributes: key: task.create type: task detail_keys: name: New Task due_date: '2022-06-30T00:00:00.000-07:00' description: An important piece of work to be made until it's due date created_at: '2022-07-25T10:45:02.163-07:00' updated_at: '2022-07-25T10:45:02.163-07:00' relationships: owner: data: id: '5' type: user tracked: data: id: '27' type: task recipient: data: id: '1' type: prospect - id: '670' type: timeline_activity attributes: key: note.create type: note detail_keys: body: An important thing to remember name: New Note created_at: '2022-07-25T10:42:16.795-07:00' updated_at: '2022-07-25T10:42:16.795-07:00' relationships: owner: data: id: '5' type: user tracked: data: id: '174' type: note recipient: data: id: '113' type: prospect - id: '669' type: timeline_activity attributes: key: note.create type: note detail_keys: body: An important thing to remember name: New Note created_at: '2022-07-25T10:41:32.986-07:00' updated_at: '2022-07-25T10:41:32.986-07:00' relationships: owner: data: id: '5' type: user tracked: data: id: '173' type: note recipient: data: id: '113' type: prospect - id: '668' type: timeline_activity attributes: key: note.create type: note detail_keys: body: An important thing to remember name: New Note created_at: '2022-07-25T10:41:17.434-07:00' updated_at: '2022-07-25T10:41:17.434-07:00' relationships: owner: data: id: '5' type: user tracked: data: id: '172' type: note recipient: data: id: '113' type: prospect - id: '667' type: timeline_activity attributes: key: task.complete type: task detail_keys: done: true name: Updated Task due_date: '2022-06-25T00:00:00.000-07:00' priority: high description: The updated tag description created_at: '2022-07-25T10:30:10.867-07:00' updated_at: '2022-07-25T10:30:10.867-07:00' relationships: owner: data: id: '5' type: user tracked: data: id: '26' type: task recipient: data: id: '1' type: prospect - id: '666' type: timeline_activity attributes: key: task.create type: task detail_keys: name: New Task due_date: '2022-06-30T00:00:00.000-07:00' description: An important piece of work to be made until it's due date created_at: '2022-07-25T10:30:10.124-07:00' updated_at: '2022-07-25T10:30:10.913-07:00' relationships: owner: data: id: '5' type: user tracked: data: id: '26' type: task recipient: data: id: '1' type: prospect - id: '665' type: timeline_activity attributes: key: note.create type: note detail_keys: body: An important thing to remember name: New Note created_at: '2022-07-25T10:30:05.869-07:00' updated_at: '2022-07-25T10:30:05.869-07:00' relationships: owner: data: id: '5' type: user tracked: data: id: '171' type: note recipient: data: id: '113' type: prospect - id: '664' type: timeline_activity attributes: key: event.delete type: event detail_keys: {} created_at: '2022-07-25T10:29:56.258-07:00' updated_at: '2022-07-25T10:29:56.258-07:00' relationships: owner: data: id: '5' type: user tracked: data: null recipient: data: id: '3' type: contact - id: '663' type: timeline_activity attributes: key: task.complete type: task detail_keys: done: true name: Updated Task due_date: '2022-06-25T00:00:00.000-07:00' priority: high description: The updated tag description created_at: '2022-07-25T10:28:11.657-07:00' updated_at: '2022-07-25T10:28:11.657-07:00' relationships: owner: data: id: '5' type: user tracked: data: id: '25' type: task recipient: data: id: '1' type: prospect - id: '662' type: timeline_activity attributes: key: task.create type: task detail_keys: name: New Task due_date: '2022-06-30T00:00:00.000-07:00' description: An important piece of work to be made until it's due date created_at: '2022-07-25T10:28:10.960-07:00' updated_at: '2022-07-25T10:28:11.719-07:00' relationships: owner: data: id: '5' type: user tracked: data: id: '25' type: task recipient: data: id: '1' type: prospect - id: '661' type: timeline_activity attributes: key: note.delete type: note detail_keys: {} created_at: '2022-07-25T10:28:07.111-07:00' updated_at: '2022-07-25T10:28:07.111-07:00' relationships: owner: data: id: '5' type: user tracked: data: null recipient: data: id: '136' type: prospect - id: '660' type: timeline_activity attributes: key: note.update type: note detail_keys: {} created_at: '2022-07-25T10:28:06.674-07:00' updated_at: '2022-07-25T10:28:06.674-07:00' relationships: owner: data: id: '5' type: user tracked: data: null recipient: data: id: '136' type: prospect - id: '659' type: timeline_activity attributes: key: note.create type: note detail_keys: body: An important thing to remember name: New Note created_at: '2022-07-25T10:28:05.625-07:00' updated_at: '2022-07-25T10:28:05.625-07:00' relationships: owner: data: id: '5' type: user tracked: data: id: '170' type: note recipient: data: id: '113' type: prospect - id: '657' type: timeline_activity attributes: key: event.delete type: event detail_keys: {} created_at: '2022-07-25T10:27:36.564-07:00' updated_at: '2022-07-25T10:27:36.564-07:00' relationships: owner: data: id: '5' type: user tracked: data: null recipient: data: id: '2' type: contact - id: '653' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. name: Example Note created_at: '2022-07-24T17:28:47.160-07:00' updated_at: '2022-07-24T17:28:47.160-07:00' relationships: owner: data: id: '1' type: application tracked: data: id: '169' type: note recipient: data: id: '172' type: prospect - id: '652' type: timeline_activity attributes: key: note.create type: note detail_keys: 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. name: Example Note created_at: '2022-07-24T17:28:19.069-07:00' updated_at: '2022-07-24T17:28:19.069-07:00' relationships: owner: data: id: '1' type: application tracked: data: id: '168' type: note recipient: data: id: '171' type: prospect meta: total_pages: 1 limit_per_page: 25 total_entries: 24 links: self: /v1/timeline_activities?page=1 '422': description: Unprocessable Entity content: application/json: schema: type: object examples: invalidParameter: summary: Invalid Parameter value: errors: - status: 422 title: Filter By Parameter Not Available detail: When applying filters, a valid 'filter_by' parameter is required. '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/users/{user_id}: get: operationId: getUser summary: User description: Return a specific User by ID tags: - Users parameters: - name: user_id in: path required: true description: The user id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: getUser: summary: GET User value: data: id: '17' type: user attributes: name: Roey Chasman email: roey@lawmatics.com role: admin sign_in_count: 80 profile_pic_url: https://lm.lawmatics.com/attachments/bb05ebb95548440709cfee67eaa47ad9477901f7/store/7a1dfa6208de277097e5fd94cef73878adce3ec6010ef99611a30a209607/photo.gif created_at: '2018-01-05T17:19:17.216-08:00' updated_at: '2018-10-16T10:11:52.023-07:00' relationships: firms: data: - id: '15' type: firm - id: '24' type: firm current_firm: data: id: '15' type: firm invited_by: data: id: '15' type: user '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer put: operationId: updateUser summary: Update User description: Updates a user tags: - Users parameters: - name: user_id in: path required: true description: The user id schema: type: string requestBody: required: true content: application/json: schema: type: object example: first_name: Bruce last_name: Banner email: thebat.ef46a23a-0525-4977-ba30-fa146d7c1816@gothan.com responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: putUpdateUser: summary: PUT Update User value: data: id: '28' type: user attributes: first_name: Bruce last_name: Banner email: thebat@gothan.com created_at: '2022-10-31T16:11:06.048-07:00' updated_at: '2022-10-31T16:15:17.930-07:00' confirmed_at: null current_sign_in_at: null invitation_sent_at: null invitation_accepted_at: null role: Admin relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer delete: operationId: deleteUser summary: Delete User description: Dissociates a user from a firm, in practice this is the same as deleting the user as it won't have access to the system anymore. tags: - Users parameters: - name: user_id in: path required: true description: The user id schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: deleteDeleteUser: summary: DELETE Delete User value: data: id: '17' type: user attributes: name: Roey Chasman email: roey@lawmatics.com role: admin sign_in_count: 80 profile_pic_url: https://lm.lawmatics.com/attachments/bb05ebb95548440709cfee67eaa47ad9477901f7/store/7a1dfa6208de277097e5fd94cef73878adce3ec6010ef99611a30a209607/photo.gif created_at: '2018-01-05T17:19:17.216-08:00' updated_at: '2018-10-16T10:11:52.023-07:00' relationships: firms: data: - id: '15' type: firm - id: '24' type: firm current_firm: data: id: '15' type: firm invited_by: data: id: '15' type: user '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/users: get: operationId: getUsers summary: Users description: Return a paginated list of all users in the firm tags: - Users responses: '200': description: OK content: application/json: schema: type: object examples: getUsers: summary: GET Users value: data: - id: '219' type: user attributes: name: Bobby Orozco email: bobby@lawmatics.com created_at: '2018-09-10T14:54:02.100-07:00' updated_at: '2018-10-15T16:03:57.819-07:00' relationships: {} - id: '192' type: user attributes: name: Anna Gasperlin email: anna@lawmatics.com created_at: '2018-08-27T12:41:56.353-07:00' updated_at: '2018-10-16T16:19:21.578-07:00' relationships: {} - id: '66' type: user attributes: name: Jasper Forest email: jasper@lawmatics.com created_at: '2018-06-18T10:26:37.122-07:00' updated_at: '2018-10-02T19:56:32.119-07:00' relationships: {} - id: '24' type: user attributes: name: Fred Assuncao email: fred@lawmatics.com created_at: '2018-03-08T07:33:41.086-08:00' updated_at: '2018-10-16T12:58:29.738-07:00' relationships: {} - id: '23' type: user attributes: name: Sarah Bottorff email: sarah.bottorff@gmail.com created_at: '2018-03-06T06:21:09.994-08:00' updated_at: '2018-04-26T15:16:25.524-07:00' relationships: {} - id: '21' type: user attributes: name: Zsolt Már email: zsolt@lawmatics.com created_at: '2018-02-02T15:17:22.830-08:00' updated_at: '2018-10-12T17:36:54.846-07:00' relationships: {} - id: '17' type: user attributes: name: Roey Chasman email: roey@lawmatics.com created_at: '2018-01-05T17:19:17.216-08:00' updated_at: '2018-10-16T10:11:52.023-07:00' relationships: {} - id: '15' type: user attributes: name: Matt Spiegel email: matt@lawmatics.com created_at: '2018-01-05T09:20:40.371-08:00' updated_at: '2018-10-16T16:29:25.480-07:00' relationships: {} meta: total_pages: 1 limit_per_page: 25 total_entries: 8 links: self: /v1/user?page=1 '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer post: operationId: createUser summary: Create User description: Creates a user or assigns it to the firm if it already exists. tags: - Users requestBody: required: true content: application/json: schema: type: object example: email: peter@oscorp.com role: Admin password: spiderman first_name: Peter last_name: Parker responses: default: description: Example response captured in the source Postman collection; the HTTP status code was not recorded by the publisher. content: application/json: schema: type: object examples: postCreateUser: summary: POST Create User value: data: id: '28' type: user attributes: first_name: Peter last_name: Parker email: peter@oscorp.com created_at: '2022-10-31T16:11:06.048-07:00' updated_at: '2022-10-31T16:11:06.048-07:00' confirmed_at: null current_sign_in_at: null invitation_sent_at: null invitation_accepted_at: null role: Admin relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer /v1/users/me: get: operationId: getMe summary: Me description: Return the authenticated user tags: - Users responses: '200': description: OK content: application/json: schema: type: object examples: getMe: summary: GET Me value: data: id: '17' type: user attributes: name: Roey Chasman email: roey@lawmatics.com created_at: '2018-01-05T17:19:17.216-08:00' updated_at: '2018-10-16T10:11:52.023-07:00' relationships: {} '401': description: Unauthorized - missing or invalid OAuth 2.0 bearer token '429': description: Too Many Requests - the per-firm rate limit was exceeded; a Retry-After header is returned headers: Retry-After: description: Seconds to wait before retrying schema: type: integer components: securitySchemes: oauth2: type: oauth2 description: OAuth 2.0 authorization code grant. Register a developer app at https://app.lawmatics.com/settings/developers (developer settings must be enabled by Lawmatics support). Access tokens are non-expiring; no refresh tokens are issued and scopes are not supported. flows: authorizationCode: authorizationUrl: https://app.lawmatics.com/oauth/authorize tokenUrl: https://api.lawmatics.com/oauth/token scopes: {} bearerAuth: type: http scheme: bearer description: 'The OAuth 2.0 access token is sent as `Authorization: Bearer `.' x-provenance: generated: '2026-08-13' method: derived publisher: API Evangelist source: https://docs.lawmatics.com/api/collections/26379991/2sA3JM7gbw?segregateAuth=true&versionTag=latest source_type: Postman collection published by Lawmatics as its official API documentation source_file: postman/lawmatics-oauth-api.postman_collection.json note: 'NOT published by Lawmatics. Lawmatics publishes no OpenAPI. Every path, method, parameter, request example and response example in this document was converted mechanically from the provider-published Postman collection "Lawmatics OAuth API v1.22.0"; nothing was invented. Schemas are typed as generic objects because the collection carries examples, not JSON Schema. The server URL is the base documented in the collection Param Guide (https://api.lawmatics.com), not the collection''s disabled {{host}} placeholder. The 401 and 429 responses added to every authenticated operation are the provider-documented, globally applicable responses: the collection''s auth guide states a per-firm rate limit applies to all endpoints and returns 429 with a Retry-After header, and https://api.lawmatics.com/v1/contacts was observed returning 401 unauthenticated on 2026-08-13.'