Skip to content

Get all companies in the system

Request

Fetches the list of all companies available in the system. A valid authorization token is required to access this resource.

Security
Bearer
curl -i -X GET \
  https://developer.sustainabilitymaster.ai/_mock/openapi/api/EnterpriseTables/Company \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully retrieved the list of companies

Bodyapplication/json
Array [
idinteger, (int32)

Unique identifier for the company.

Example:123
namestring or null

Name of the company.

Example:"Acme Corporation"
shortNamestring or null

Short name or abbreviation of the company.

Example:"Acme Corp"
parentCompanyIdinteger or null, (int32)

ID of the parent company, if applicable.

Example:10
parentCompanyNamestring or null

Name of the parent company, if applicable.

Example:"Global Holdings"
taxNostring or null

Tax number associated with the company.

Example:"987654321"
hqaddressstring or null

Address of the company's headquarters.

Example:"1234 Elm St, Springfield"
countryIdinteger or null, (int32)

Country ID where the company is located.

Example:1
countryNamestring or null

Name of the country where the company is located.

Example:"United States"
zipCodestring or null

Zip code of the company's headquarters location.

Example:"90001"
industryIdinteger or null, (int32)

Industry ID that represents the company's industry.

Example:5
industryNamestring or null

Name of the industry the company operates in.

Example:"Technology"
companyTypeIdinteger or null, (int32)

Company type ID, representing the company's classification.

Example:2
companyTypeNamestring or null

Name of the company type.

Example:"Public"
companySubTypeIdinteger or null, (int32)

Company subtype ID, if applicable.

Example:3
companySubTypeNamestring or null

Name of the company subtype, if applicable.

Example:"Software"
locationTypeIdinteger or null, (int32)

Location type ID, such as whether the company has a branch, office, or other types of locations.

Example:1
locationTypeNamestring or null

Name of the location type (e.g., Headquarter, Branch, etc.).

Example:"Headquarter"
esrssupplierDomainstring or null

The domain name for the company's supplier if applicable.

Example:"acmesupplier.com"
esrssupplierSubDomainstring or null

The subdomain name for the company's supplier if applicable.

Example:"supplier.acmesupplier.com"
ownershipPercentagenumber or null, (double)

Ownership percentage in the company if applicable.

Example:100
holdingCompanyIdinteger or null, (int32)

Holding company ID if the company belongs to a holding company.

Example:8
holdingCompanyNamestring or null

Name of the holding company if applicable.

Example:"Global Investments"
consolidatedboolean or null

Whether the company is consolidated in its financial statements.

Example:true
reportingEntityboolean or null

Whether the company is a reporting entity.

Example:false
consolidatingEntitystring or null

The name of the entity that is responsible for consolidation in case the company is part of a larger consolidation.

Example:"Global Investments Consolidated Entity"
establishmentDatestring or null, (date-time)

The date when the company was established.

Example:"1990-05-10"
closingDatestring or null, (date-time)

The date when the company's financial year or operations close.

Example:"2023-12-31"
]
Response
[
  {
    "id": 123,
    "name": "Acme Corporation",
    "shortName": "Acme Corp",
    "parentCompanyId": 10,
    "parentCompanyName": "Global Holdings",
    "taxNo": "987654321",
    "hqaddress": "1234 Elm St, Springfield",
    "countryId": 1,
    "countryName": "United States",
    "zipCode": "90001",
    "industryId": 5,
    "industryName": "Technology",
    "companyTypeId": 2,
    "companyTypeName": "Public",
    "companySubTypeId": 3,
    "companySubTypeName": "Software",
    "locationTypeId": 1,
    "locationTypeName": "Headquarter",
    "esrssupplierDomain": "acmesupplier.com",
    "esrssupplierSubDomain": "supplier.acmesupplier.com",
    "ownershipPercentage": 100,
    "holdingCompanyId": 8,
    "holdingCompanyName": "Global Investments",
    "consolidated": true,
    "reportingEntity": false,
    "consolidatingEntity": "Global Investments Consolidated Entity",
    "establishmentDate": "1990-05-10",
    "closingDate": "2023-12-31"
  }
]