GET api/v1/Client?company={company}&id={id}&country={country}&vatnumber={vatnumber}&segmentation={segmentation}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
company

string

Default value is

id

string

Default value is

country

string

Default value is

vatnumber

string

Default value is

segmentation

string

Default value is

Body Parameters

None.

Response Information

Resource Description

Collection of Client
NameDescriptionTypeAdditional information
Company

string

None.

Code

string

None.

Name

string

None.

Address

string

None.

Phone

string

None.

BusinessContact

string

None.

Email

string

None.

ClientType

string

None.

Country

string

None.

CountryDesc

string

None.

VATNumber

string

None.

SalesforceID

string

None.

IsParentAccount

boolean

None.

ParentAccountID

string

None.

ParentAccountDesc

string

None.

SegmentationID

string

None.

SegmentationDesc

string

None.

ActivitySectorID

string

None.

ActivitySectorDesc

string

None.

KAMGroupID

string

None.

LastUpdateDate

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Company": "sample string 1",
    "Code": "sample string 2",
    "Name": "sample string 3",
    "Address": "sample string 4",
    "Phone": "sample string 5",
    "BusinessContact": "sample string 6",
    "Email": "sample string 7",
    "ClientType": "sample string 8",
    "Country": "sample string 9",
    "CountryDesc": "sample string 10",
    "VATNumber": "sample string 11",
    "SalesforceID": "sample string 12",
    "IsParentAccount": true,
    "ParentAccountID": "sample string 14",
    "ParentAccountDesc": "sample string 15",
    "SegmentationID": "sample string 16",
    "SegmentationDesc": "sample string 17",
    "ActivitySectorID": "sample string 18",
    "ActivitySectorDesc": "sample string 19",
    "KAMGroupID": "sample string 20",
    "LastUpdateDate": "2025-05-27T19:35:48.880111+01:00"
  },
  {
    "Company": "sample string 1",
    "Code": "sample string 2",
    "Name": "sample string 3",
    "Address": "sample string 4",
    "Phone": "sample string 5",
    "BusinessContact": "sample string 6",
    "Email": "sample string 7",
    "ClientType": "sample string 8",
    "Country": "sample string 9",
    "CountryDesc": "sample string 10",
    "VATNumber": "sample string 11",
    "SalesforceID": "sample string 12",
    "IsParentAccount": true,
    "ParentAccountID": "sample string 14",
    "ParentAccountDesc": "sample string 15",
    "SegmentationID": "sample string 16",
    "SegmentationDesc": "sample string 17",
    "ActivitySectorID": "sample string 18",
    "ActivitySectorDesc": "sample string 19",
    "KAMGroupID": "sample string 20",
    "LastUpdateDate": "2025-05-27T19:35:48.880111+01:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfClient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CTRLWebApi.Models">
  <Client>
    <ActivitySectorDesc>sample string 19</ActivitySectorDesc>
    <ActivitySectorID>sample string 18</ActivitySectorID>
    <Address>sample string 4</Address>
    <BusinessContact>sample string 6</BusinessContact>
    <ClientType>sample string 8</ClientType>
    <Code>sample string 2</Code>
    <Company>sample string 1</Company>
    <Country>sample string 9</Country>
    <CountryDesc>sample string 10</CountryDesc>
    <Email>sample string 7</Email>
    <IsParentAccount>true</IsParentAccount>
    <KAMGroupID>sample string 20</KAMGroupID>
    <LastUpdateDate>2025-05-27T19:35:48.880111+01:00</LastUpdateDate>
    <Name>sample string 3</Name>
    <ParentAccountDesc>sample string 15</ParentAccountDesc>
    <ParentAccountID>sample string 14</ParentAccountID>
    <Phone>sample string 5</Phone>
    <SalesforceID>sample string 12</SalesforceID>
    <SegmentationDesc>sample string 17</SegmentationDesc>
    <SegmentationID>sample string 16</SegmentationID>
    <VATNumber>sample string 11</VATNumber>
  </Client>
  <Client>
    <ActivitySectorDesc>sample string 19</ActivitySectorDesc>
    <ActivitySectorID>sample string 18</ActivitySectorID>
    <Address>sample string 4</Address>
    <BusinessContact>sample string 6</BusinessContact>
    <ClientType>sample string 8</ClientType>
    <Code>sample string 2</Code>
    <Company>sample string 1</Company>
    <Country>sample string 9</Country>
    <CountryDesc>sample string 10</CountryDesc>
    <Email>sample string 7</Email>
    <IsParentAccount>true</IsParentAccount>
    <KAMGroupID>sample string 20</KAMGroupID>
    <LastUpdateDate>2025-05-27T19:35:48.880111+01:00</LastUpdateDate>
    <Name>sample string 3</Name>
    <ParentAccountDesc>sample string 15</ParentAccountDesc>
    <ParentAccountID>sample string 14</ParentAccountID>
    <Phone>sample string 5</Phone>
    <SalesforceID>sample string 12</SalesforceID>
    <SegmentationDesc>sample string 17</SegmentationDesc>
    <SegmentationID>sample string 16</SegmentationID>
    <VATNumber>sample string 11</VATNumber>
  </Client>
</ArrayOfClient>