LeanLaw Developer Platform
LeanLaw API

Matter

Endpoint:https://api.leanlaw.io

Get a list of matters

GET
https://api.leanlaw.io
/v2/matters

Get a list of matters › query Parameters

  • querystring

    Search for matters matching the query string. Returns matters that match partially on either name or reference.

  • referencestring

    Return matter matching the matter reference (exact match only)

  • clientReferencestring

    Return matters matching the client reference (exact match only)

  • userIdstring · uuid

    Only return matters where this user is assigned

  • responsibleIdstring · uuid

    Only return matters where this user is responsible

  • originatorIdstring · uuid

    Only return matters where this user is the originator

  • clientIdstring · uuid

    Filter by client, only return matters for this client

  • practiceAreaIdstring · uuid

    Filter by practice area, only return matters for this practice area

  • archivedboolean

    Filter by archived- return only archived matters (true) or only active matters (false) or all matters (null)

  • selectstring

    Used to include additional detail in the response with a comma separated list of object identifiers.. Fields can be prefixed with a minus sign to exclude them. Supported fields: matter, ledesConfiguration, responsible, originator, practiceArea, meta

  • sortstring

    Sorting parameters for matters. Supported sort fields: name, reference, client.name, client.reference Example: "name,-client.name" sorts by name ascending, then client name descending

  • limitinteger · int32

    Maximum number of items to return (default: 1000)

  • offsetinteger · int32

    Number of items to offset (default: 0)

  • modifiedSincestring · date-time

    Only return results that have the ModifiedDate property after this date and time (optional)

Get a list of matters › Responses

OK

  • dataarray | null

    The list of items returned by the API

  • paginationobject

    Pagination information

Create a new matter

POST
https://api.leanlaw.io
/v2/matters

Create a new matter › Request Body

  • namestring · minLength: 1 · required

    The name of the matter

  • clientIdstring · uuid · required

    The client id of the matter (required)

  • responsibleIdstring · uuid · required

    User id for responsible attorney for matter

  • referencestring | null

    A reference number for the matter (optional)

  • matterTypestring · enum

    Matter type determines defaults for time entries and certain billing behaviors. The default value is "hourly".

    Enum values:
    hourly
    fixedFee
    contingency
    probono
    internal
  • openedstring | null · date

    The date the matter was opened

  • archivedboolean

    Whether the matter is archived (true) or active (false)

  • conflictInformationobject

    Conflict information for a matter

  • billingInstructionsstring | null

    Billing instructions for the matter

  • notesstring | null

    Notes about the matter

  • referralSourcesstring | null

    Referral sources for the matter

Create a new matter › Responses

OK

  • dataobject

    Represents a matter in the firm

Get a matter by id

GET
https://api.leanlaw.io
/v2/matters/{id}

Get a matter by id › path Parameters

  • idstring · uuid · required

    The id of the matter

Get a matter by id › Responses

OK

  • dataobject

    Represents a matter in the firm

Update a matter

PUT
https://api.leanlaw.io
/v2/matters/{id}

The update is "sparse", where only the fields that are provided in the request will be updated.

Update a matter › path Parameters

  • idstring · uuid · required

    The id of the matter to update

Update a matter › Request Body

  • namestring | null

    The name of the matter, if not provided, the current name will not be changed

  • referencestring | null

    A reference number for the matter; if not provided, the current reference will not be changed

  • clientIdstring | null · uuid

    The client id of the matter - if not provided, the client will not be changed

  • responsibleIdstring | null · uuid

    User id for responsible attorney for matter, if not provided, the current responsible will not be changed

  • openedstring | null · date

    The date the matter was opened, if not provided, the current opened date will not be changed

  • archivedboolean | null

    Whether the matter is archived (true) or active (false), if not provided, the current archived state will not be changed

  • conflictInformationobject

    Conflict information for a matter

  • billingInstructionsstring | null

    Billing instructions for the matter, if not provided, the current billing instructions will not be changed

  • notesstring | null

    Notes about the matter, if not provided, the current notes will not be changed

  • referralSourcesstring | null

    Referral sources for the matter, if not provided, the current referral sources will not be changed

Update a matter › Responses

OK

  • dataobject

    Represents a matter in the firm

Delete a matter

DELETE
https://api.leanlaw.io
/v2/matters/{id}

Deleting a matter will remove it from the system permanently. Matters that have any associated activity in the system such as time entries, expenses, or invoices cannot be deleted. To archive a matter, use UpdateMatter and set the Archived property to true.

Delete a matter › path Parameters

  • idstring · uuid · required

    The id of the matter to delete

Delete a matter › Responses

OK

No data returned
InvoicePracticeArea