GET api/abtraccustomapi/GetClientsByName?user={user}&password={password}&secretKey={secretKey}&filter={filter}

Request Information

URI Parameters

Name	Type	Additional information
user	string	Required
password	string	Required
secretKey	string	Required
filter	string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of APIDataClient

Name	Type	Additional information
ClientID	integer	None.
ClientOwner1Name	string	None.
ClientOwner2Name	string	None.
ClientTypeName	string	None.
ClientRatingName	string	None.
ClientOfficeName	string	None.
ClientCode	string	None.
ClientName	string	None.
ClientAbbreviation	string	None.
CurrentClient	boolean	None.
BillableClient	boolean	None.
HasJobs	boolean	None.
IsContact	boolean	None.
IsSubConsultant	boolean	None.
InvDefaultPurchaseOrderRequired	boolean	None.
CreateDate	date	None.
Comment	string	None.
InvDefaultClientName	string	None.
InvDefaultAddress1	string	None.
InvDefaultAddress2	string	None.
InvDefaultAddress3	string	None.
InvDefaultAddress4	string	None.
InvDefaultAddress5	string	None.
InvDefaultBillRecipient	string	None.
InvDefaultRecipientRole	string	None.
InvDefaultRecipientEmail	string	None.
InvDefaultOrderNo	string	None.
InvDefaultAddressPostCode	string	None.
rowversion	integer	None.
IsMasterClient	boolean	None.
MasterClientID	integer	None.
MasterClientName	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ClientID": 1,
    "ClientOwner1Name": "sample string 2",
    "ClientOwner2Name": "sample string 3",
    "ClientTypeName": "sample string 4",
    "ClientRatingName": "sample string 5",
    "ClientOfficeName": "sample string 6",
    "ClientCode": "sample string 7",
    "ClientName": "sample string 8",
    "ClientAbbreviation": "sample string 9",
    "CurrentClient": true,
    "BillableClient": true,
    "HasJobs": true,
    "IsContact": true,
    "IsSubConsultant": true,
    "InvDefaultPurchaseOrderRequired": true,
    "CreateDate": "2025-12-11T07:51:24.4952154+00:00",
    "Comment": "sample string 16",
    "InvDefaultClientName": "sample string 17",
    "InvDefaultAddress1": "sample string 18",
    "InvDefaultAddress2": "sample string 19",
    "InvDefaultAddress3": "sample string 20",
    "InvDefaultAddress4": "sample string 21",
    "InvDefaultAddress5": "sample string 22",
    "InvDefaultBillRecipient": "sample string 23",
    "InvDefaultRecipientRole": "sample string 24",
    "InvDefaultRecipientEmail": "sample string 25",
    "InvDefaultOrderNo": "sample string 26",
    "InvDefaultAddressPostCode": "sample string 27",
    "rowversion": 28,
    "IsMasterClient": true,
    "MasterClientID": 1,
    "MasterClientName": "sample string 30"
  },
  {
    "ClientID": 1,
    "ClientOwner1Name": "sample string 2",
    "ClientOwner2Name": "sample string 3",
    "ClientTypeName": "sample string 4",
    "ClientRatingName": "sample string 5",
    "ClientOfficeName": "sample string 6",
    "ClientCode": "sample string 7",
    "ClientName": "sample string 8",
    "ClientAbbreviation": "sample string 9",
    "CurrentClient": true,
    "BillableClient": true,
    "HasJobs": true,
    "IsContact": true,
    "IsSubConsultant": true,
    "InvDefaultPurchaseOrderRequired": true,
    "CreateDate": "2025-12-11T07:51:24.4952154+00:00",
    "Comment": "sample string 16",
    "InvDefaultClientName": "sample string 17",
    "InvDefaultAddress1": "sample string 18",
    "InvDefaultAddress2": "sample string 19",
    "InvDefaultAddress3": "sample string 20",
    "InvDefaultAddress4": "sample string 21",
    "InvDefaultAddress5": "sample string 22",
    "InvDefaultBillRecipient": "sample string 23",
    "InvDefaultRecipientRole": "sample string 24",
    "InvDefaultRecipientEmail": "sample string 25",
    "InvDefaultOrderNo": "sample string 26",
    "InvDefaultAddressPostCode": "sample string 27",
    "rowversion": 28,
    "IsMasterClient": true,
    "MasterClientID": 1,
    "MasterClientName": "sample string 30"
  }
]

application/xml, text/xml

Sample:

<ArrayOfAPIDataClient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Abtrac6.Business.Models.APIDataModels">
  <APIDataClient>
    <BillableClient>true</BillableClient>
    <ClientAbbreviation>sample string 9</ClientAbbreviation>
    <ClientCode>sample string 7</ClientCode>
    <ClientID>1</ClientID>
    <ClientName>sample string 8</ClientName>
    <ClientOfficeName>sample string 6</ClientOfficeName>
    <ClientOwner1Name>sample string 2</ClientOwner1Name>
    <ClientOwner2Name>sample string 3</ClientOwner2Name>
    <ClientRatingName>sample string 5</ClientRatingName>
    <ClientTypeName>sample string 4</ClientTypeName>
    <Comment>sample string 16</Comment>
    <CreateDate>2025-12-11T07:51:24.4952154+00:00</CreateDate>
    <CurrentClient>true</CurrentClient>
    <HasJobs>true</HasJobs>
    <InvDefaultAddress1>sample string 18</InvDefaultAddress1>
    <InvDefaultAddress2>sample string 19</InvDefaultAddress2>
    <InvDefaultAddress3>sample string 20</InvDefaultAddress3>
    <InvDefaultAddress4>sample string 21</InvDefaultAddress4>
    <InvDefaultAddress5>sample string 22</InvDefaultAddress5>
    <InvDefaultAddressPostCode>sample string 27</InvDefaultAddressPostCode>
    <InvDefaultBillRecipient>sample string 23</InvDefaultBillRecipient>
    <InvDefaultClientName>sample string 17</InvDefaultClientName>
    <InvDefaultOrderNo>sample string 26</InvDefaultOrderNo>
    <InvDefaultPurchaseOrderRequired>true</InvDefaultPurchaseOrderRequired>
    <InvDefaultRecipientEmail>sample string 25</InvDefaultRecipientEmail>
    <InvDefaultRecipientRole>sample string 24</InvDefaultRecipientRole>
    <IsContact>true</IsContact>
    <IsMasterClient>true</IsMasterClient>
    <IsSubConsultant>true</IsSubConsultant>
    <MasterClientID>1</MasterClientID>
    <MasterClientName>sample string 30</MasterClientName>
    <rowversion>28</rowversion>
  </APIDataClient>
  <APIDataClient>
    <BillableClient>true</BillableClient>
    <ClientAbbreviation>sample string 9</ClientAbbreviation>
    <ClientCode>sample string 7</ClientCode>
    <ClientID>1</ClientID>
    <ClientName>sample string 8</ClientName>
    <ClientOfficeName>sample string 6</ClientOfficeName>
    <ClientOwner1Name>sample string 2</ClientOwner1Name>
    <ClientOwner2Name>sample string 3</ClientOwner2Name>
    <ClientRatingName>sample string 5</ClientRatingName>
    <ClientTypeName>sample string 4</ClientTypeName>
    <Comment>sample string 16</Comment>
    <CreateDate>2025-12-11T07:51:24.4952154+00:00</CreateDate>
    <CurrentClient>true</CurrentClient>
    <HasJobs>true</HasJobs>
    <InvDefaultAddress1>sample string 18</InvDefaultAddress1>
    <InvDefaultAddress2>sample string 19</InvDefaultAddress2>
    <InvDefaultAddress3>sample string 20</InvDefaultAddress3>
    <InvDefaultAddress4>sample string 21</InvDefaultAddress4>
    <InvDefaultAddress5>sample string 22</InvDefaultAddress5>
    <InvDefaultAddressPostCode>sample string 27</InvDefaultAddressPostCode>
    <InvDefaultBillRecipient>sample string 23</InvDefaultBillRecipient>
    <InvDefaultClientName>sample string 17</InvDefaultClientName>
    <InvDefaultOrderNo>sample string 26</InvDefaultOrderNo>
    <InvDefaultPurchaseOrderRequired>true</InvDefaultPurchaseOrderRequired>
    <InvDefaultRecipientEmail>sample string 25</InvDefaultRecipientEmail>
    <InvDefaultRecipientRole>sample string 24</InvDefaultRecipientRole>
    <IsContact>true</IsContact>
    <IsMasterClient>true</IsMasterClient>
    <IsSubConsultant>true</IsSubConsultant>
    <MasterClientID>1</MasterClientID>
    <MasterClientName>sample string 30</MasterClientName>
    <rowversion>28</rowversion>
  </APIDataClient>
</ArrayOfAPIDataClient>