GET Contacts

Gets a list of contacts for a given file.

Request Information

URI Parameters

Name	Description	Type	Additional information
Page	Specifies the page number of the result set to return.	integer	None.
PageSize	Specifies the number of records on each page of results. Maximum page size is 100. Defaults to 25 if not specified.	integer	None.
WsAccessKey	The Web Service access key for this user and file which allows access to the API for the associated file (found in File - Settings). Using OAuth authentication mechanism is the preferred method to allow API access.	string	Optional. Legacy authentication method and only required if not using OAuth. OAuth is preferred.
FileId	Specifies the file id of the file to perform the operation upon.	integer	Required
LastModifiedFromDate	Filter records with LastModifiedDate greater than or equal to a date in UTC (must also specifiy LastModifiedToDate).	date	None.
LastModifiedToDate	Filter records with LastModifiedDate less than or equal to a date in UTC (must also specifiy LastModifiedFromDate).	date	None.
GivenName	Filter records with a given name matching the supplied parameter.	string	None.
FamilyName	Filter records with a family name matching the supplied parameter.	string	None.
CompanyName	Filter records with a company name matching the supplied parameter.	string	None.
CompanyId	Filter records with a company id matching the supplied parameter.	string	None.
IsActive	Filter records that are either Active (IsActive=true) or Inactive (IsActive=false).	boolean	None.
IsCustomer	Filter records with that are a customer (IsCustomer=true) or not a customer (IsCustomer=false).	boolean	None.
IsSupplier	Filter records with that are a supplier (IsSupplier=true) or not a supplier (IsSupplier=false).	boolean	None.
IsContractor	Filter records with that are a contractor (IsContractor=true) or not a contractor (IsContractor=false).	boolean	None.
IsPartner	Filter records with that are a partner (IsPartner=true) or not a partner (IsPartner=false).	boolean	None.
Tags	One or more tags that are used to filter the result set by. More tags can be separated with a comma, for example 'tags=tag1,tag2'.	string	None.
TagSelection	Specifies how to filter when using the supplied tags.Valid values are: requireAny - filter records with ANY ONE of the supplied tags, requireAll - filter records with ALL of the supplied tags, excludeAny - filter records excluding any records with ANY ONE of the specified tags, excludeAll - filter records excluding any records with ALL of the specified tags.	string	None.
Email	Filter records with an email address equal to the specified value.	string	None.
ContactId	Filter records with a Contact Id equal to the specified value.	string	None.

Body Parameters

None.

Response Information

Resource Description

ContactResponse

Name	Description	Type	Additional information
Contacts	A list of contact records.	Collection of Contact	None.
_links	Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server.	Collection of Link	None.

Response Formats

application/json, text/json

Sample:

{
  "Contacts": [
    {
      "Id": 54353,
      "CreatedDateUtc": "2024-11-10T19:21:11.864721Z",
      "LastModifiedDateUtc": "2024-11-20T19:21:11.864721Z",
      "LastUpdatedId": "AAAAAFwWAN8=",
      "Salutation": "Mr.",
      "GivenName": "Joe",
      "MiddleInitials": null,
      "FamilyName": "Blogs",
      "IsActive": true,
      "CompanyId": 3,
      "PositionTitle": "BigBoss",
      "WebsiteUrl": null,
      "PrimaryPhone": "02 4444 5555",
      "HomePhone": null,
      "OtherPhone": null,
      "MobilePhone": null,
      "Fax": null,
      "EmailAddress": "main_user@example.com",
      "AdditionalEmails": "second_user@example.com, third_user@example.com, fourth_user@example.com",
      "ContactId": "1234",
      "ContactManagerId": null,
      "DirectDepositDetails": {
        "AcceptDirectDeposit": true,
        "AccountName": "Account name",
        "AccountBSB": "602456",
        "AccountNumber": "34234234"
      },
      "ChequeDetails": {
        "AcceptCheque": false,
        "ChequePayableTo": null
      },
      "CustomField1": "",
      "CustomField2": "",
      "TwitterId": "",
      "SkypeId": "",
      "LinkedInProfile": "",
      "AutoSendStatement": true,
      "IsPartner": false,
      "IsCustomer": false,
      "IsSupplier": false,
      "IsContractor": false,
      "Tags": [
        "Advisor",
        "Business"
      ],
      "DefaultSaleDiscount": null,
      "DefaultPurchaseDiscount": null,
      "LastModifiedByUserId": 567,
      "BpayDetails": {
        "BillerCode": "111222",
        "CRN": "8732993"
      },
      "PostalAddress": {
        "Street": "123 Acme Street",
        "City": "Sydney",
        "State": "NSW",
        "Postcode": "2000",
        "Country": "Australia"
      },
      "OtherAddress": {
        "Street": "123 other Street",
        "City": "Melbourne",
        "State": "VIC",
        "Postcode": "3000",
        "Country": "Australia"
      },
      "SaleTradingTerms": {
        "TradingTermsType": 1,
        "TradingTermsInterval": 2,
        "TradingTermsIntervalType": 1
      },
      "PurchaseTradingTerms": {
        "TradingTermsType": 1,
        "TradingTermsInterval": 3,
        "TradingTermsIntervalType": 2
      },
      "_links": [
        {
          "rel": "detail",
          "href": "https://api.saasu.com/Contact/54353?FileId=123",
          "method": "GET",
          "title": null
        },
        {
          "rel": "related",
          "href": "https://api.saasu.com/Company/3?FileId=123",
          "method": "GET",
          "title": "Company"
        },
        {
          "rel": "related",
          "href": "https://api.saasu.com/ContactAggregate/54353?FileId=123",
          "method": "GET",
          "title": "Aggregate"
        }
      ]
    },
    {
      "Id": 896421,
      "CreatedDateUtc": "2024-11-19T19:21:11.8777797Z",
      "LastModifiedDateUtc": "2024-11-20T19:21:11.8777797Z",
      "LastUpdatedId": "AAAAAFwWAN8=",
      "Salutation": "Mrs.",
      "GivenName": "Mary",
      "MiddleInitials": null,
      "FamilyName": "Biggs",
      "IsActive": true,
      "CompanyId": 3,
      "PositionTitle": "Cleaner",
      "WebsiteUrl": null,
      "PrimaryPhone": "02 5555 4444",
      "HomePhone": null,
      "OtherPhone": null,
      "MobilePhone": "04 1111 1111",
      "Fax": "02 5555 4445",
      "EmailAddress": "main_user@example.com",
      "AdditionalEmails": "second_user@example.com, third_user@example.com, fourth_user@example.com",
      "ContactId": "4567",
      "ContactManagerId": null,
      "DirectDepositDetails": {
        "AcceptDirectDeposit": true,
        "AccountName": "HJKY Co",
        "AccountBSB": "602784",
        "AccountNumber": "78454234"
      },
      "ChequeDetails": {
        "AcceptCheque": false,
        "ChequePayableTo": null
      },
      "CustomField1": "",
      "CustomField2": "",
      "TwitterId": "",
      "SkypeId": "",
      "LinkedInProfile": "",
      "AutoSendStatement": false,
      "IsPartner": false,
      "IsCustomer": true,
      "IsSupplier": false,
      "IsContractor": false,
      "Tags": [
        "Toys",
        "Business"
      ],
      "DefaultSaleDiscount": null,
      "DefaultPurchaseDiscount": null,
      "LastModifiedByUserId": 123,
      "BpayDetails": {
        "BillerCode": "122345",
        "CRN": "747821192"
      },
      "PostalAddress": {
        "Street": "456 Arndale Street",
        "City": "Sydney",
        "State": "NSW",
        "Postcode": "2000",
        "Country": "Australia"
      },
      "OtherAddress": {
        "Street": "123 whatever Street",
        "City": "Melbourne",
        "State": "VIC",
        "Postcode": "3000",
        "Country": "Australia"
      },
      "SaleTradingTerms": {
        "TradingTermsType": 1,
        "TradingTermsInterval": 2,
        "TradingTermsIntervalType": 1
      },
      "PurchaseTradingTerms": {
        "TradingTermsType": 1,
        "TradingTermsInterval": 3,
        "TradingTermsIntervalType": 2
      },
      "_links": [
        {
          "rel": "detail",
          "href": "https://api.saasu.com/Contact/896421?FileId=123",
          "method": "GET",
          "title": null
        },
        {
          "rel": "related",
          "href": "https://api.saasu.com/Company/3?FileId=123",
          "method": "GET",
          "title": "Company"
        },
        {
          "rel": "related",
          "href": "https://api.saasu.com/ContactAggregate/896421?FileId=123",
          "method": "GET",
          "title": "Aggregate"
        }
      ]
    }
  ],
  "_links": [
    {
      "rel": "self",
      "href": "https://api.saasu.com/Contacts?FileId=123",
      "method": "GET",
      "title": null
    },
    {
      "rel": "next",
      "href": "https://api.saasu.com/Contacts?FileId=123&Page=2&PageSize=25",
      "method": "GET",
      "title": null
    }
  ]
}

application/xml, text/xml

Sample:

<ContactResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <_links>
    <Link>
      <rel>self</rel>
      <href>https://api.saasu.com/Contacts?FileId=123</href>
      <method>GET</method>
    </Link>
    <Link>
      <rel>next</rel>
      <href>https://api.saasu.com/Contacts?FileId=123&amp;Page=2&amp;PageSize=25</href>
      <method>GET</method>
    </Link>
  </_links>
  <Contacts>
    <Contact>
      <_links>
        <Link>
          <rel>detail</rel>
          <href>https://api.saasu.com/Contact/54353?FileId=123</href>
          <method>GET</method>
        </Link>
        <Link>
          <rel>related</rel>
          <href>https://api.saasu.com/Company/3?FileId=123</href>
          <method>GET</method>
          <title>Company</title>
        </Link>
        <Link>
          <rel>related</rel>
          <href>https://api.saasu.com/ContactAggregate/54353?FileId=123</href>
          <method>GET</method>
          <title>Aggregate</title>
        </Link>
      </_links>
      <Id>54353</Id>
      <CreatedDateUtc>2024-11-10T19:21:11.864721Z</CreatedDateUtc>
      <LastModifiedDateUtc>2024-11-20T19:21:11.864721Z</LastModifiedDateUtc>
      <LastUpdatedId>AAAAAFwWAN8=</LastUpdatedId>
      <Salutation>Mr.</Salutation>
      <GivenName>Joe</GivenName>
      <MiddleInitials xsi:nil="true" />
      <FamilyName>Blogs</FamilyName>
      <IsActive>true</IsActive>
      <CompanyId>3</CompanyId>
      <PositionTitle>BigBoss</PositionTitle>
      <WebsiteUrl xsi:nil="true" />
      <PrimaryPhone>02 4444 5555</PrimaryPhone>
      <HomePhone xsi:nil="true" />
      <OtherPhone xsi:nil="true" />
      <MobilePhone xsi:nil="true" />
      <Fax xsi:nil="true" />
      <EmailAddress>main_user@example.com</EmailAddress>
      <AdditionalEmails>second_user@example.com, third_user@example.com, fourth_user@example.com</AdditionalEmails>
      <ContactId>1234</ContactId>
      <ContactManagerId xsi:nil="true" />
      <DirectDepositDetails>
        <AcceptDirectDeposit>true</AcceptDirectDeposit>
        <AccountName>Account name</AccountName>
        <AccountBSB>602456</AccountBSB>
        <AccountNumber>34234234</AccountNumber>
      </DirectDepositDetails>
      <ChequeDetails>
        <AcceptCheque>false</AcceptCheque>
        <ChequePayableTo xsi:nil="true" />
      </ChequeDetails>
      <CustomField1 />
      <CustomField2 />
      <TwitterId />
      <SkypeId />
      <LinkedInProfile />
      <AutoSendStatement>true</AutoSendStatement>
      <IsPartner>false</IsPartner>
      <IsCustomer>false</IsCustomer>
      <IsSupplier>false</IsSupplier>
      <IsContractor>false</IsContractor>
      <Tags>
        <string>Advisor</string>
        <string>Business</string>
      </Tags>
      <DefaultSaleDiscount xsi:nil="true" />
      <DefaultPurchaseDiscount xsi:nil="true" />
      <LastModifiedByUserId>567</LastModifiedByUserId>
      <BpayDetails>
        <BillerCode>111222</BillerCode>
        <CRN>8732993</CRN>
      </BpayDetails>
      <PostalAddress>
        <Street>123 Acme Street</Street>
        <City>Sydney</City>
        <State>NSW</State>
        <Postcode>2000</Postcode>
        <Country>Australia</Country>
      </PostalAddress>
      <OtherAddress>
        <Street>123 other Street</Street>
        <City>Melbourne</City>
        <State>VIC</State>
        <Postcode>3000</Postcode>
        <Country>Australia</Country>
      </OtherAddress>
      <SaleTradingTerms>
        <TradingTermsType>1</TradingTermsType>
        <TradingTermsInterval>2</TradingTermsInterval>
        <TradingTermsIntervalType>1</TradingTermsIntervalType>
      </SaleTradingTerms>
      <PurchaseTradingTerms>
        <TradingTermsType>1</TradingTermsType>
        <TradingTermsInterval>3</TradingTermsInterval>
        <TradingTermsIntervalType>2</TradingTermsIntervalType>
      </PurchaseTradingTerms>
    </Contact>
    <Contact>
      <_links>
        <Link>
          <rel>detail</rel>
          <href>https://api.saasu.com/Contact/896421?FileId=123</href>
          <method>GET</method>
        </Link>
        <Link>
          <rel>related</rel>
          <href>https://api.saasu.com/Company/3?FileId=123</href>
          <method>GET</method>
          <title>Company</title>
        </Link>
        <Link>
          <rel>related</rel>
          <href>https://api.saasu.com/ContactAggregate/896421?FileId=123</href>
          <method>GET</method>
          <title>Aggregate</title>
        </Link>
      </_links>
      <Id>896421</Id>
      <CreatedDateUtc>2024-11-19T19:21:11.8777797Z</CreatedDateUtc>
      <LastModifiedDateUtc>2024-11-20T19:21:11.8777797Z</LastModifiedDateUtc>
      <LastUpdatedId>AAAAAFwWAN8=</LastUpdatedId>
      <Salutation>Mrs.</Salutation>
      <GivenName>Mary</GivenName>
      <MiddleInitials xsi:nil="true" />
      <FamilyName>Biggs</FamilyName>
      <IsActive>true</IsActive>
      <CompanyId>3</CompanyId>
      <PositionTitle>Cleaner</PositionTitle>
      <WebsiteUrl xsi:nil="true" />
      <PrimaryPhone>02 5555 4444</PrimaryPhone>
      <HomePhone xsi:nil="true" />
      <OtherPhone xsi:nil="true" />
      <MobilePhone>04 1111 1111</MobilePhone>
      <Fax>02 5555 4445</Fax>
      <EmailAddress>main_user@example.com</EmailAddress>
      <AdditionalEmails>second_user@example.com, third_user@example.com, fourth_user@example.com</AdditionalEmails>
      <ContactId>4567</ContactId>
      <ContactManagerId xsi:nil="true" />
      <DirectDepositDetails>
        <AcceptDirectDeposit>true</AcceptDirectDeposit>
        <AccountName>HJKY Co</AccountName>
        <AccountBSB>602784</AccountBSB>
        <AccountNumber>78454234</AccountNumber>
      </DirectDepositDetails>
      <ChequeDetails>
        <AcceptCheque>false</AcceptCheque>
        <ChequePayableTo xsi:nil="true" />
      </ChequeDetails>
      <CustomField1 />
      <CustomField2 />
      <TwitterId />
      <SkypeId />
      <LinkedInProfile />
      <AutoSendStatement>false</AutoSendStatement>
      <IsPartner>false</IsPartner>
      <IsCustomer>true</IsCustomer>
      <IsSupplier>false</IsSupplier>
      <IsContractor>false</IsContractor>
      <Tags>
        <string>Toys</string>
        <string>Business</string>
      </Tags>
      <DefaultSaleDiscount xsi:nil="true" />
      <DefaultPurchaseDiscount xsi:nil="true" />
      <LastModifiedByUserId>123</LastModifiedByUserId>
      <BpayDetails>
        <BillerCode>122345</BillerCode>
        <CRN>747821192</CRN>
      </BpayDetails>
      <PostalAddress>
        <Street>456 Arndale Street</Street>
        <City>Sydney</City>
        <State>NSW</State>
        <Postcode>2000</Postcode>
        <Country>Australia</Country>
      </PostalAddress>
      <OtherAddress>
        <Street>123 whatever Street</Street>
        <City>Melbourne</City>
        <State>VIC</State>
        <Postcode>3000</Postcode>
        <Country>Australia</Country>
      </OtherAddress>
      <SaleTradingTerms>
        <TradingTermsType>1</TradingTermsType>
        <TradingTermsInterval>2</TradingTermsInterval>
        <TradingTermsIntervalType>1</TradingTermsIntervalType>
      </SaleTradingTerms>
      <PurchaseTradingTerms>
        <TradingTermsType>1</TradingTermsType>
        <TradingTermsInterval>3</TradingTermsInterval>
        <TradingTermsIntervalType>2</TradingTermsIntervalType>
      </PurchaseTradingTerms>
    </Contact>
  </Contacts>
</ContactResponse>