GET api/crm/companylist/get

Gets the complete list of your organizations, including the office address and the general contact.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CustomerCode": "28722",
    "Name": "Firm Name",
    "Email": "info@venue.com",
    "Vat": "BE123.456.789",
    "VatTransfer": true,
    "Phone": "555-333-004",
    "Contact": {
      "Gender": "male",
      "FirstName": "Alice",
      "LastName": "McLagan",
      "Title": "Ceo",
      "Email": "Elizabeth@venues.com",
      "Phone": "555.123.457",
      "Mobile": "",
      "LanguageCode": "EN"
    },
    "Address": {
      "AddressLineOne": "Road to venue 12",
      "AddressLineTwo": "",
      "PostalCode": "1234",
      "City": "Sarma",
      "CountryCode": "GB",
      "State": ""
    },
    "CustomFields": {
      "companycode": "12321"
    }
  },
  {
    "CustomerCode": "58586",
    "Name": "Firm c°",
    "Email": "info@venue.com",
    "Vat": "BE123.456.789",
    "VatTransfer": true,
    "Phone": "555-333-002",
    "Contact": {
      "Gender": "male",
      "FirstName": "Myrtle",
      "LastName": "Eusden",
      "Title": "Ceo",
      "Email": "Carrie@venues.com",
      "Phone": "555.123.457",
      "Mobile": "",
      "LanguageCode": "EN"
    },
    "Address": {
      "AddressLineOne": "Road to venue 12",
      "AddressLineTwo": "",
      "PostalCode": "1234",
      "City": "Sarma",
      "CountryCode": "GB",
      "State": ""
    },
    "CustomFields": {
      "companycode": "12321"
    }
  },
  {
    "CustomerCode": "25192",
    "Name": "Firm Lt",
    "Email": "info@venue.com",
    "Vat": "BE123.456.789",
    "VatTransfer": true,
    "Phone": "555-333-004",
    "Contact": {
      "Gender": "male",
      "FirstName": "Catherine",
      "LastName": "Croster",
      "Title": "Ceo",
      "Email": "Gertrude@venues.com",
      "Phone": "555.123.457",
      "Mobile": "",
      "LanguageCode": "EN"
    },
    "Address": {
      "AddressLineOne": "Road to venue 12",
      "AddressLineTwo": "",
      "PostalCode": "1234",
      "City": "Sarma",
      "CountryCode": "GB",
      "State": ""
    },
    "CustomFields": {
      "companycode": "12321"
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfCompanyList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Expodoc.Api.Classes.Contracts.Crm">
  <CompanyList>
    <Address>
      <AddressLineOne>Road to venue 12</AddressLineOne>
      <AddressLineTwo></AddressLineTwo>
      <City>Sarma</City>
      <CountryCode>GB</CountryCode>
      <PostalCode>1234</PostalCode>
      <State></State>
    </Address>
    <Contact>
      <Email>Elizabeth@venues.com</Email>
      <FirstName>Alice</FirstName>
      <Gender>male</Gender>
      <LanguageCode>EN</LanguageCode>
      <LastName>McLagan</LastName>
      <Mobile></Mobile>
      <Phone>555.123.457</Phone>
      <Title>Ceo</Title>
    </Contact>
    <CustomFields xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>companycode</d3p1:Key>
        <d3p1:Value xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string">12321</d3p1:Value>
      </d3p1:KeyValueOfstringanyType>
    </CustomFields>
    <CustomerCode>28722</CustomerCode>
    <Email>info@venue.com</Email>
    <Name>Firm Name</Name>
    <Phone>555-333-004</Phone>
    <Vat>BE123.456.789</Vat>
    <VatTransfer>true</VatTransfer>
  </CompanyList>
  <CompanyList>
    <Address>
      <AddressLineOne>Road to venue 12</AddressLineOne>
      <AddressLineTwo></AddressLineTwo>
      <City>Sarma</City>
      <CountryCode>GB</CountryCode>
      <PostalCode>1234</PostalCode>
      <State></State>
    </Address>
    <Contact>
      <Email>Carrie@venues.com</Email>
      <FirstName>Myrtle</FirstName>
      <Gender>male</Gender>
      <LanguageCode>EN</LanguageCode>
      <LastName>Eusden</LastName>
      <Mobile></Mobile>
      <Phone>555.123.457</Phone>
      <Title>Ceo</Title>
    </Contact>
    <CustomFields xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>companycode</d3p1:Key>
        <d3p1:Value xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string">12321</d3p1:Value>
      </d3p1:KeyValueOfstringanyType>
    </CustomFields>
    <CustomerCode>58586</CustomerCode>
    <Email>info@venue.com</Email>
    <Name>Firm c°</Name>
    <Phone>555-333-002</Phone>
    <Vat>BE123.456.789</Vat>
    <VatTransfer>true</VatTransfer>
  </CompanyList>
  <CompanyList>
    <Address>
      <AddressLineOne>Road to venue 12</AddressLineOne>
      <AddressLineTwo></AddressLineTwo>
      <City>Sarma</City>
      <CountryCode>GB</CountryCode>
      <PostalCode>1234</PostalCode>
      <State></State>
    </Address>
    <Contact>
      <Email>Gertrude@venues.com</Email>
      <FirstName>Catherine</FirstName>
      <Gender>male</Gender>
      <LanguageCode>EN</LanguageCode>
      <LastName>Croster</LastName>
      <Mobile></Mobile>
      <Phone>555.123.457</Phone>
      <Title>Ceo</Title>
    </Contact>
    <CustomFields xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>companycode</d3p1:Key>
        <d3p1:Value xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string">12321</d3p1:Value>
      </d3p1:KeyValueOfstringanyType>
    </CustomFields>
    <CustomerCode>25192</CustomerCode>
    <Email>info@venue.com</Email>
    <Name>Firm Lt</Name>
    <Phone>555-333-004</Phone>
    <Vat>BE123.456.789</Vat>
    <VatTransfer>true</VatTransfer>
  </CompanyList>
</ArrayOfCompanyList>