GET Companies

Retrieves a list of companies.

Request Information

URI Parameters

Name Description Type Additional information
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

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.

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.

CompanyName Filter records with a company name matching the supplied parameter. string

None.

Body Parameters

None.

Response Information

Resource Description

CompanyListResponse
Name Description Type Additional information
Companies A list of company records. Collection of CompanyDetail

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:
{
  "Companies": [
    {
      "Id": 1,
      "Name": "MakeMoney Inc.",
      "Abn": "53004085616",
      "Website": "https://makemoney.org",
      "LastUpdatedId": "AAAAAAKbc=",
      "LongDescription": "A test company",
      "LogoUrl": null,
      "TradingName": "MakeMoney Inc",
      "CompanyEmail": "bigboss@somecompany.com",
      "LastModifiedDateUtc": "2017-06-27T22:18:03.7501413Z",
      "CreatedDateUtc": "2017-06-18T22:18:03.7501413Z",
      "LastModifiedByUserId": 321,
      "_links": [
        {
          "rel": "detail",
          "href": "https://api.saasu.com/Company/1?FileId=123",
          "method": "GET",
          "title": null
        }
      ]
    },
    {
      "Id": 2,
      "Name": "MakeMoney Inc.",
      "Abn": " 53004085616",
      "Website": "https://makemoney.org",
      "LastUpdatedId": "AAAAAAKbc=",
      "LongDescription": "A test company",
      "LogoUrl": null,
      "TradingName": "MakeMoney Inc",
      "CompanyEmail": "bigboss@somecompany.com",
      "LastModifiedDateUtc": "2017-06-27T22:18:03.7501413Z",
      "CreatedDateUtc": "2017-06-18T22:18:03.7501413Z",
      "LastModifiedByUserId": 321,
      "_links": [
        {
          "rel": "detail",
          "href": "https://api.saasu.com/Company/2?FileId=123",
          "method": "GET",
          "title": null
        }
      ]
    }
  ],
  "_links": [
    {
      "rel": "self",
      "href": "https://api.saasu.com/Companies?FileId=123",
      "method": "GET",
      "title": null
    },
    {
      "rel": "next",
      "href": "https://api.saasu.com/Companies?FileId=123&Page=2&PageSize=25",
      "method": "GET",
      "title": null
    }
  ]
}

application/xml, text/xml

Sample:
<CompanyListResponse 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/Companies?FileId=123</href>
      <method>GET</method>
    </Link>
    <Link>
      <rel>next</rel>
      <href>https://api.saasu.com/Companies?FileId=123&amp;Page=2&amp;PageSize=25</href>
      <method>GET</method>
    </Link>
  </_links>
  <Companies>
    <CompanyDetail>
      <_links>
        <Link>
          <rel>detail</rel>
          <href>https://api.saasu.com/Company/1?FileId=123</href>
          <method>GET</method>
        </Link>
      </_links>
      <Id>1</Id>
      <Name>MakeMoney Inc.</Name>
      <Abn>53004085616</Abn>
      <Website>https://makemoney.org</Website>
      <LastUpdatedId>AAAAAAKbc=</LastUpdatedId>
      <LongDescription>A test company</LongDescription>
      <TradingName>MakeMoney Inc</TradingName>
      <CompanyEmail>bigboss@somecompany.com</CompanyEmail>
      <LastModifiedDateUtc>2017-06-27T22:18:03.7501413Z</LastModifiedDateUtc>
      <CreatedDateUtc>2017-06-18T22:18:03.7501413Z</CreatedDateUtc>
      <LastModifiedByUserId>321</LastModifiedByUserId>
    </CompanyDetail>
    <CompanyDetail>
      <_links>
        <Link>
          <rel>detail</rel>
          <href>https://api.saasu.com/Company/2?FileId=123</href>
          <method>GET</method>
        </Link>
      </_links>
      <Id>2</Id>
      <Name>MakeMoney Inc.</Name>
      <Abn> 53004085616</Abn>
      <Website>https://makemoney.org</Website>
      <LastUpdatedId>AAAAAAKbc=</LastUpdatedId>
      <LongDescription>A test company</LongDescription>
      <TradingName>MakeMoney Inc</TradingName>
      <CompanyEmail>bigboss@somecompany.com</CompanyEmail>
      <LastModifiedDateUtc>2017-06-27T22:18:03.7501413Z</LastModifiedDateUtc>
      <CreatedDateUtc>2017-06-18T22:18:03.7501413Z</CreatedDateUtc>
      <LastModifiedByUserId>321</LastModifiedByUserId>
    </CompanyDetail>
  </Companies>
</CompanyListResponse>