Get Companies in Phin API Route

This route is used to get a list of all companies under your partner in Phin. Company level API calls will need the CompanyId. One of the ways to obtain those CompanyIds is through this call.

Response Reference

Field Type Example
partnerInventory array[company] [{ “companyId”: “sampleId”, “name”: “You Company Name”, “partnerName”: “Your Partner Name”}]

Response Sample

{ "partnerInventory":
"companyId": “sampleId”,
"name": “Your Company Name”,
"partnerName": “Your Partner Name”

Error Reference

Code Message Explanation
500 Failed to get partner inventory data. Something went wrong fetching the inventory of companies. Try again later or contact Phin.