Get a list of clients
query Parameters
querystringSearch for clients matching the query string. Returns clients that match partially on either name or reference.
referencestringReturn client matching the reference (exact match only)
selectstringUsed 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: contact, meta
sortstringSorting parameters for clients. Supported sort fields: name, reference Example: "name,-reference" sorts by name ascending, then reference descending
limitinteger · int32 · min: 1 · max: 1000Maximum number of items to return (default: 1000, max: 1000)
offsetinteger · int32 · min: 0 · max: 2147483647Number of items to offset (default: 0)
modifiedSincestring · date-timeOnly return results that have the ModifiedDate property after this date and time (optional)
Responses
OK
dataarray | nullThe list of items returned by the API
paginationobjectPagination information
Create a new client
Request Body
namestring · minLength: 1 · requiredThe name of the client
referencestring | nullA reference number for the client
contactobjectnotesstring | nullNotes about the client
Responses
OK
dataobjectA client of the firm with contact information and other detail
Example: {"id":"a081025c-fdc2-45b7-9fd4-16f208f71879","name":"Doe, John","contact":{"firstName":"John","lastName":"Doe","email":"[email protected]"}}
Get a client by id
path Parameters
idstring · uuid · requiredThe id of the client
Responses
OK
dataobjectA client of the firm with contact information and other detail
Example: {"id":"a081025c-fdc2-45b7-9fd4-16f208f71879","name":"Doe, John","contact":{"firstName":"John","lastName":"Doe","email":"[email protected]"}}
Update a client
path Parameters
idstring · uuid · requiredThe id of the client to update
Request Body
namestring | nullThe name of the client, if not provided, the current name will not be changed
referencestring | nullA reference number for the client, if not provided, the current reference will not be changed
contactobjectnotesstring | nullNotes about the client, if not provided, the current notes will not be changed
Responses
OK
dataobjectA client of the firm with contact information and other detail
Example: {"id":"a081025c-fdc2-45b7-9fd4-16f208f71879","name":"Doe, John","contact":{"firstName":"John","lastName":"Doe","email":"[email protected]"}}