Skip to main content

List companies

Summary

  • Translate the company ids from authentication response into company display names
  • Required API calls: companyService/list

Request

Request to https://apis.alfaview.com/json/v1/companyService/list

{
  "accessInfo": {
    "requestId": "### REQUEST ID ###",
    "accessToken": "### ACCESS TOKEN ###"
  },
  "companyIdList": [
  "### COMPANY ID ###"
  ]
}

Response

{
  ...
  "companies": {
    "A1B2C3D4E5F6G7H8I9J0": {
    "displayName": "My Company",
    ...
    }
  },
  ...
}

Notes

  • API response for authentication request contains all company ids that are accessible
  • Add all company ids from authentication response to the companyIdList array

Last updated on July 3rd, 2025, 11:53 am