Help Page Home - Company
GET Company/Id
Retrieves the details for a single company.
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 |
| Id | Id/Key of the company. | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
CompanyDetail| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | The unique key/Id of the company. | integer |
None. |
| Name | Name of the company. | string |
None. |
| Abn | Company ABN. | string |
None. |
| Website | Url of the company website. | string |
None. |
| LastUpdatedId | Identifier used for concurrency checking. Required for update. | string |
None. |
| LongDescription | Description of the company. | string |
None. |
| LogoUrl | Url of the company logo. Note: This field is not supported and will be removed in a future version. | string |
None. |
| TradingName | Company trading name. | string |
None. |
| CompanyEmail | Company email address. | string |
None. |
| LastModifiedDateUtc | Date and time that the company data was last modified in UTC. | date |
None. |
| CreatedDateUtc | Date and time that the company was created in UTC. | date |
None. |
| LastModifiedByUserId | The user id that last modified the company data. | integer |
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:
{
"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": "2025-10-23T18:00:12.4652287Z",
"CreatedDateUtc": "2025-10-14T18:00:12.4652287Z",
"LastModifiedByUserId": 321,
"_links": [
{
"rel": "self",
"href": "https://api.saasu.com/Company/1?FileId=123",
"method": "GET",
"title": null
},
{
"rel": "list",
"href": "https://api.saasu.com/Companies?FileId=123",
"method": "GET",
"title": null
}
]
}
application/xml, text/xml
Sample:
<CompanyDetail 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/Company/1?FileId=123</href>
<method>GET</method>
</Link>
<Link>
<rel>list</rel>
<href>https://api.saasu.com/Companies?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>2025-10-23T18:00:12.4652287Z</LastModifiedDateUtc>
<CreatedDateUtc>2025-10-14T18:00:12.4652287Z</CreatedDateUtc>
<LastModifiedByUserId>321</LastModifiedByUserId>
</CompanyDetail>