Skip to content
  • There are no suggestions because the search field is empty.

Get Company with Phin API

This route is used to get a single company in Phin.

Company Attribute Reference

Field Name Description Value Type Optional (Y/N)
id Unique Id of the company String N
name The name of this company String N
partnerId The ID of the partner this company belongs to String N
partnerName The name of the partner this company belongs to String N
isNFRCompany Whether this is an NFR (internal) company String N
activeUsers Total of all active users in the company String N
isFreeTrial Whether this company is in a free trial String N
deleted Whether this company has been deleted String Y
deletionInfo Additional metadata about the deletion action Object Y

Response Reference For Active Company

{
  "id": "XJg8r123tsz7Zz6gCkBR",
  "name": "Phin MSP",
  "partnerId": "qok62bsyZEQYShxN38kG",
  "partnerName": "Testing Partner",
  "isNFRCompany": false,
  "activeUsers": 35,
  "isFreeTrial": false,
}

Response Sample For Deleted Company

{
  "id": "KUWtsz7Zz6gCkBRxdyR2",
  "name": "Example Company",
  "partnerId": "qok62bsyZEQYShxN38kG",
  "partnerName": "Testing Partner",
  "isNFRCompany": false,
  "activeUsers": 0,
  "isFreeTrial": false,
  "deleted": true,
  "deletionInfo": {
      "deletionTimestamp": "2026-05-14T14:58:58.000",
      "deletedByAdminEmail": "admin@examplemsp.com"
    }
}

Error Reference

Code Message Explanation
500
Failed to get company. Please try again or contact Phin Support for assistance.
 Something went wrong when getting the company data.  
404
Could not find company with that ID.
 The company with the passed ID does not exist or couldn't be found.