Skip to content

Latest commit

 

History

History
15 lines (11 loc) · 1.16 KB

GetClientsRequest.md

File metadata and controls

15 lines (11 loc) · 1.16 KB

GetClientsRequest

Properties

Name Type Description Notes
client_i_ds string[] The requested client IDs. Default: all IDs that the authenticated user’s access level allows. [optional]
search_text string Text to use in the search. Can include FirstName, LastName, and Email. Note that user credentials must be provided. [optional]
is_prospect bool When `true`, filters the results to include only those clients marked as prospects for the business.<br /> When `false`, indicates that only those clients who are not marked prospects should be returned. [optional]
last_modified_date \DateTime Filters the results to include only the clients that have been modified on or after this date. [optional]
limit int Number of results to include, defaults to 100 [optional]
offset int Page offset, defaults to 0. [optional]

[Back to Model list] [Back to API list] [Back to README]