POST https://api.d-tools.com/SI/Subscribe/Clients/ClientList

Get clients for given client ids published by a SI user. You can pass a maximum of 100 client ids.

Request Information

URI Parameters

None.

Body Parameters

Send single or multiple clientIds

Collection of string

Request Formats

application/json, text/json

Sample:

[
  "sample string 1",
  "sample string 2"
]

application/x-www-form-urlencoded

Sample:

[0]=123&[1]=Foo

Response Information

Resource Description

Collection of Client

Name	Description	Type	Additional information
Id	Unique Id for the client (must be Guid). Client will be created in SI with this Guid and will be used to update client.	string	None.
Name	Client name (Required)	string	None.
Number	Number	string	None.
IntegrationId	Optional Id provided by the Integration for client. The IntegrationId can be used to update clients	string	None.
Phone	Phone	string	None.
Fax	Fax	string	None.
Email	Email	string	None.
WebSite	Web site	string	None.
ClientType	Client Type - must be Lead or Prospect or Client	string	None.
LeadSource	Lead source	string	None.
Tax	Tax	string	None.
LaborTax	Labor tax	string	None.
CreatedOn	Date the client was created (UTC Time)	date	None.
UpdatedOn	Date the client was updated (UTC Time)	date	None.
UpdatedBy	Client Updated By	string	None.
PublishedBy	Client Published By	string	None.
ClientAddresses	Client addresses for client	Collection of ClientAddress	None.
ClientContacts	Client contacts for client	Collection of ClientContact	None.
CustomField1	CustomField1 (Text) (BETA).	string	None.
CustomField2	CustomField2 (Text) (BETA).	string	None.
CustomField3	CustomField3 (Text) (BETA).	string	None.
CustomField4	CustomField4 (Text) (BETA).	string	None.
CustomField5	CustomField5 (Text) (BETA).	string	None.
CustomField6	CustomField6 (Boolean) (BETA).	boolean	None.
CustomField7	CustomField7 (Boolean) (BETA).	boolean	None.
CustomField8	CustomField8 (Boolean) (BETA).	boolean	None.
CustomField9	CustomField9 (Boolean) (BETA).	boolean	None.
CustomField10	CustomField10 (Boolean) (BETA).	boolean	None.
CustomField11	CustomField11 (Date) (BETA).	date	None.
CustomField12	CustomField12 (Date) (BETA).	date	None.
CustomField13	CustomField13 (Date) (BETA).	date	None.
CustomField14	CustomField14 (Date) (BETA).	date	None.
CustomField15	CustomField15 (Date) (BETA).	date	None.
CustomField16	CustomField16 (List) (BETA).	string	None.
CustomField17	CustomField17 (List) (BETA).	string	None.
CustomField18	CustomField18 (List) (BETA).	string	None.
CustomField19	CustomField19 (List) (BETA).	string	None.
CustomField20	CustomField20 (List) (BETA).	string	None.
CustomField21	CustomField21 (Hyperlink) (BETA).	string	None.
CustomField22	CustomField22 (Hyperlink) (BETA).	string	None.
CustomField23	CustomField23 (Hyperlink) (BETA).	string	None.
CustomField24	CustomField24 (Hyperlink) (BETA).	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "sample string 1",
    "Name": "sample string 2",
    "Number": "sample string 3",
    "IntegrationId": "sample string 4",
    "Phone": "sample string 5",
    "Fax": "sample string 6",
    "Email": "sample string 7",
    "WebSite": "sample string 8",
    "ClientType": "sample string 9",
    "LeadSource": "sample string 10",
    "Tax": "sample string 11",
    "LaborTax": "sample string 12",
    "CreatedOn": "2026-08-06T17:42:58.393573+00:00",
    "UpdatedOn": "2026-08-06T17:42:58.3945721+00:00",
    "UpdatedBy": "sample string 15",
    "PublishedBy": "sample string 16",
    "ClientAddresses": [
      {
        "TypeId": 64,
        "Name": "sample string 2",
        "Street1": "sample string 3",
        "Street2": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "PostalCode": "sample string 7",
        "Country": "sample string 8",
        "Phone": "sample string 9",
        "Fax": "sample string 10"
      },
      {
        "TypeId": 64,
        "Name": "sample string 2",
        "Street1": "sample string 3",
        "Street2": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "PostalCode": "sample string 7",
        "Country": "sample string 8",
        "Phone": "sample string 9",
        "Fax": "sample string 10"
      }
    ],
    "ClientContacts": [
      {
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "Company": "sample string 3",
        "Title": "sample string 4",
        "Email": "sample string 5",
        "Phone": "sample string 6",
        "Fax": "sample string 7",
        "Mobile": "sample string 8",
        "Street1": "sample string 9",
        "Street2": "sample string 10",
        "City": "sample string 11",
        "State": "sample string 12",
        "PostalCode": "sample string 13",
        "Country": "sample string 14",
        "Notes": "sample string 15"
      },
      {
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "Company": "sample string 3",
        "Title": "sample string 4",
        "Email": "sample string 5",
        "Phone": "sample string 6",
        "Fax": "sample string 7",
        "Mobile": "sample string 8",
        "Street1": "sample string 9",
        "Street2": "sample string 10",
        "City": "sample string 11",
        "State": "sample string 12",
        "PostalCode": "sample string 13",
        "Country": "sample string 14",
        "Notes": "sample string 15"
      }
    ],
    "CustomField1": "sample string 17",
    "CustomField2": "sample string 18",
    "CustomField3": "sample string 19",
    "CustomField4": "sample string 20",
    "CustomField5": "sample string 21",
    "CustomField6": true,
    "CustomField7": true,
    "CustomField8": true,
    "CustomField9": true,
    "CustomField10": true,
    "CustomField11": "2026-08-06T17:42:58.395653+00:00",
    "CustomField12": "2026-08-06T17:42:58.395653+00:00",
    "CustomField13": "2026-08-06T17:42:58.395653+00:00",
    "CustomField14": "2026-08-06T17:42:58.395653+00:00",
    "CustomField15": "2026-08-06T17:42:58.395653+00:00",
    "CustomField16": "sample string 22",
    "CustomField17": "sample string 23",
    "CustomField18": "sample string 24",
    "CustomField19": "sample string 25",
    "CustomField20": "sample string 26",
    "CustomField21": "sample string 27",
    "CustomField22": "sample string 28",
    "CustomField23": "sample string 29",
    "CustomField24": "sample string 30"
  },
  {
    "Id": "sample string 1",
    "Name": "sample string 2",
    "Number": "sample string 3",
    "IntegrationId": "sample string 4",
    "Phone": "sample string 5",
    "Fax": "sample string 6",
    "Email": "sample string 7",
    "WebSite": "sample string 8",
    "ClientType": "sample string 9",
    "LeadSource": "sample string 10",
    "Tax": "sample string 11",
    "LaborTax": "sample string 12",
    "CreatedOn": "2026-08-06T17:42:58.393573+00:00",
    "UpdatedOn": "2026-08-06T17:42:58.3945721+00:00",
    "UpdatedBy": "sample string 15",
    "PublishedBy": "sample string 16",
    "ClientAddresses": [
      {
        "TypeId": 64,
        "Name": "sample string 2",
        "Street1": "sample string 3",
        "Street2": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "PostalCode": "sample string 7",
        "Country": "sample string 8",
        "Phone": "sample string 9",
        "Fax": "sample string 10"
      },
      {
        "TypeId": 64,
        "Name": "sample string 2",
        "Street1": "sample string 3",
        "Street2": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "PostalCode": "sample string 7",
        "Country": "sample string 8",
        "Phone": "sample string 9",
        "Fax": "sample string 10"
      }
    ],
    "ClientContacts": [
      {
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "Company": "sample string 3",
        "Title": "sample string 4",
        "Email": "sample string 5",
        "Phone": "sample string 6",
        "Fax": "sample string 7",
        "Mobile": "sample string 8",
        "Street1": "sample string 9",
        "Street2": "sample string 10",
        "City": "sample string 11",
        "State": "sample string 12",
        "PostalCode": "sample string 13",
        "Country": "sample string 14",
        "Notes": "sample string 15"
      },
      {
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "Company": "sample string 3",
        "Title": "sample string 4",
        "Email": "sample string 5",
        "Phone": "sample string 6",
        "Fax": "sample string 7",
        "Mobile": "sample string 8",
        "Street1": "sample string 9",
        "Street2": "sample string 10",
        "City": "sample string 11",
        "State": "sample string 12",
        "PostalCode": "sample string 13",
        "Country": "sample string 14",
        "Notes": "sample string 15"
      }
    ],
    "CustomField1": "sample string 17",
    "CustomField2": "sample string 18",
    "CustomField3": "sample string 19",
    "CustomField4": "sample string 20",
    "CustomField5": "sample string 21",
    "CustomField6": true,
    "CustomField7": true,
    "CustomField8": true,
    "CustomField9": true,
    "CustomField10": true,
    "CustomField11": "2026-08-06T17:42:58.395653+00:00",
    "CustomField12": "2026-08-06T17:42:58.395653+00:00",
    "CustomField13": "2026-08-06T17:42:58.395653+00:00",
    "CustomField14": "2026-08-06T17:42:58.395653+00:00",
    "CustomField15": "2026-08-06T17:42:58.395653+00:00",
    "CustomField16": "sample string 22",
    "CustomField17": "sample string 23",
    "CustomField18": "sample string 24",
    "CustomField19": "sample string 25",
    "CustomField20": "sample string 26",
    "CustomField21": "sample string 27",
    "CustomField22": "sample string 28",
    "CustomField23": "sample string 29",
    "CustomField24": "sample string 30"
  }
]

application/xml, text/xml

Sample:

<ArrayOfClient xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Client>
    <Id>sample string 1</Id>
    <Name>sample string 2</Name>
    <Number>sample string 3</Number>
    <IntegrationId>sample string 4</IntegrationId>
    <Phone>sample string 5</Phone>
    <Fax>sample string 6</Fax>
    <Email>sample string 7</Email>
    <WebSite>sample string 8</WebSite>
    <ClientType>sample string 9</ClientType>
    <LeadSource>sample string 10</LeadSource>
    <Tax>sample string 11</Tax>
    <LaborTax>sample string 12</LaborTax>
    <CreatedOn>2026-08-06T17:42:58.393573+00:00</CreatedOn>
    <UpdatedOn>2026-08-06T17:42:58.3945721+00:00</UpdatedOn>
    <UpdatedBy>sample string 15</UpdatedBy>
    <PublishedBy>sample string 16</PublishedBy>
    <ClientAddresses>
      <ClientAddress>
        <Street1>sample string 3</Street1>
        <Street2>sample string 4</Street2>
        <City>sample string 5</City>
        <State>sample string 6</State>
        <PostalCode>sample string 7</PostalCode>
        <Country>sample string 8</Country>
        <Phone>sample string 9</Phone>
        <Fax>sample string 10</Fax>
        <TypeId>64</TypeId>
        <Name>sample string 2</Name>
      </ClientAddress>
      <ClientAddress>
        <Street1>sample string 3</Street1>
        <Street2>sample string 4</Street2>
        <City>sample string 5</City>
        <State>sample string 6</State>
        <PostalCode>sample string 7</PostalCode>
        <Country>sample string 8</Country>
        <Phone>sample string 9</Phone>
        <Fax>sample string 10</Fax>
        <TypeId>64</TypeId>
        <Name>sample string 2</Name>
      </ClientAddress>
    </ClientAddresses>
    <ClientContacts>
      <ClientContact>
        <FirstName>sample string 1</FirstName>
        <LastName>sample string 2</LastName>
        <Company>sample string 3</Company>
        <Title>sample string 4</Title>
        <Email>sample string 5</Email>
        <Phone>sample string 6</Phone>
        <Fax>sample string 7</Fax>
        <Mobile>sample string 8</Mobile>
        <Street1>sample string 9</Street1>
        <Street2>sample string 10</Street2>
        <City>sample string 11</City>
        <State>sample string 12</State>
        <PostalCode>sample string 13</PostalCode>
        <Country>sample string 14</Country>
        <Notes>sample string 15</Notes>
      </ClientContact>
      <ClientContact>
        <FirstName>sample string 1</FirstName>
        <LastName>sample string 2</LastName>
        <Company>sample string 3</Company>
        <Title>sample string 4</Title>
        <Email>sample string 5</Email>
        <Phone>sample string 6</Phone>
        <Fax>sample string 7</Fax>
        <Mobile>sample string 8</Mobile>
        <Street1>sample string 9</Street1>
        <Street2>sample string 10</Street2>
        <City>sample string 11</City>
        <State>sample string 12</State>
        <PostalCode>sample string 13</PostalCode>
        <Country>sample string 14</Country>
        <Notes>sample string 15</Notes>
      </ClientContact>
    </ClientContacts>
    <CustomField1>sample string 17</CustomField1>
    <CustomField2>sample string 18</CustomField2>
    <CustomField3>sample string 19</CustomField3>
    <CustomField4>sample string 20</CustomField4>
    <CustomField5>sample string 21</CustomField5>
    <CustomField6>true</CustomField6>
    <CustomField7>true</CustomField7>
    <CustomField8>true</CustomField8>
    <CustomField9>true</CustomField9>
    <CustomField10>true</CustomField10>
    <CustomField11>2026-08-06T17:42:58.395653+00:00</CustomField11>
    <CustomField12>2026-08-06T17:42:58.395653+00:00</CustomField12>
    <CustomField13>2026-08-06T17:42:58.395653+00:00</CustomField13>
    <CustomField14>2026-08-06T17:42:58.395653+00:00</CustomField14>
    <CustomField15>2026-08-06T17:42:58.395653+00:00</CustomField15>
    <CustomField16>sample string 22</CustomField16>
    <CustomField17>sample string 23</CustomField17>
    <CustomField18>sample string 24</CustomField18>
    <CustomField19>sample string 25</CustomField19>
    <CustomField20>sample string 26</CustomField20>
    <CustomField21>sample string 27</CustomField21>
    <CustomField22>sample string 28</CustomField22>
    <CustomField23>sample string 29</CustomField23>
    <CustomField24>sample string 30</CustomField24>
  </Client>
  <Client>
    <Id>sample string 1</Id>
    <Name>sample string 2</Name>
    <Number>sample string 3</Number>
    <IntegrationId>sample string 4</IntegrationId>
    <Phone>sample string 5</Phone>
    <Fax>sample string 6</Fax>
    <Email>sample string 7</Email>
    <WebSite>sample string 8</WebSite>
    <ClientType>sample string 9</ClientType>
    <LeadSource>sample string 10</LeadSource>
    <Tax>sample string 11</Tax>
    <LaborTax>sample string 12</LaborTax>
    <CreatedOn>2026-08-06T17:42:58.393573+00:00</CreatedOn>
    <UpdatedOn>2026-08-06T17:42:58.3945721+00:00</UpdatedOn>
    <UpdatedBy>sample string 15</UpdatedBy>
    <PublishedBy>sample string 16</PublishedBy>
    <ClientAddresses>
      <ClientAddress>
        <Street1>sample string 3</Street1>
        <Street2>sample string 4</Street2>
        <City>sample string 5</City>
        <State>sample string 6</State>
        <PostalCode>sample string 7</PostalCode>
        <Country>sample string 8</Country>
        <Phone>sample string 9</Phone>
        <Fax>sample string 10</Fax>
        <TypeId>64</TypeId>
        <Name>sample string 2</Name>
      </ClientAddress>
      <ClientAddress>
        <Street1>sample string 3</Street1>
        <Street2>sample string 4</Street2>
        <City>sample string 5</City>
        <State>sample string 6</State>
        <PostalCode>sample string 7</PostalCode>
        <Country>sample string 8</Country>
        <Phone>sample string 9</Phone>
        <Fax>sample string 10</Fax>
        <TypeId>64</TypeId>
        <Name>sample string 2</Name>
      </ClientAddress>
    </ClientAddresses>
    <ClientContacts>
      <ClientContact>
        <FirstName>sample string 1</FirstName>
        <LastName>sample string 2</LastName>
        <Company>sample string 3</Company>
        <Title>sample string 4</Title>
        <Email>sample string 5</Email>
        <Phone>sample string 6</Phone>
        <Fax>sample string 7</Fax>
        <Mobile>sample string 8</Mobile>
        <Street1>sample string 9</Street1>
        <Street2>sample string 10</Street2>
        <City>sample string 11</City>
        <State>sample string 12</State>
        <PostalCode>sample string 13</PostalCode>
        <Country>sample string 14</Country>
        <Notes>sample string 15</Notes>
      </ClientContact>
      <ClientContact>
        <FirstName>sample string 1</FirstName>
        <LastName>sample string 2</LastName>
        <Company>sample string 3</Company>
        <Title>sample string 4</Title>
        <Email>sample string 5</Email>
        <Phone>sample string 6</Phone>
        <Fax>sample string 7</Fax>
        <Mobile>sample string 8</Mobile>
        <Street1>sample string 9</Street1>
        <Street2>sample string 10</Street2>
        <City>sample string 11</City>
        <State>sample string 12</State>
        <PostalCode>sample string 13</PostalCode>
        <Country>sample string 14</Country>
        <Notes>sample string 15</Notes>
      </ClientContact>
    </ClientContacts>
    <CustomField1>sample string 17</CustomField1>
    <CustomField2>sample string 18</CustomField2>
    <CustomField3>sample string 19</CustomField3>
    <CustomField4>sample string 20</CustomField4>
    <CustomField5>sample string 21</CustomField5>
    <CustomField6>true</CustomField6>
    <CustomField7>true</CustomField7>
    <CustomField8>true</CustomField8>
    <CustomField9>true</CustomField9>
    <CustomField10>true</CustomField10>
    <CustomField11>2026-08-06T17:42:58.395653+00:00</CustomField11>
    <CustomField12>2026-08-06T17:42:58.395653+00:00</CustomField12>
    <CustomField13>2026-08-06T17:42:58.395653+00:00</CustomField13>
    <CustomField14>2026-08-06T17:42:58.395653+00:00</CustomField14>
    <CustomField15>2026-08-06T17:42:58.395653+00:00</CustomField15>
    <CustomField16>sample string 22</CustomField16>
    <CustomField17>sample string 23</CustomField17>
    <CustomField18>sample string 24</CustomField18>
    <CustomField19>sample string 25</CustomField19>
    <CustomField20>sample string 26</CustomField20>
    <CustomField21>sample string 27</CustomField21>
    <CustomField22>sample string 28</CustomField22>
    <CustomField23>sample string 29</CustomField23>
    <CustomField24>sample string 30</CustomField24>
  </Client>
</ArrayOfClient>