Phin API Documentation
      Back to home
      1. Help Center
      2. API / Technical Questions
      3. Phin API Documentation

      Phin API Reference

      Routes

      Name

      Method

      Domain

      Route

      Get Access Token

      		 POST https://phin.us.auth0.com /oauth/token
      Test GET https://api.phinsec.io /partners/:partnerId/test

      Get Companies in Phin

      		 GET https://api.phinsec.io /partners/:partnerId/inventory
      Get Historical Data from a Company GET https://api.phinsec.io /partners/:partnerId/companies/:companyId/historical-data
      Get a list of Reporting Artifacts for a Company GET https://api.phinsec.io /partners/:partnerId/companies/:companyId/reports
      Get a specific report for a Company GET https://api.phinsec.io /partners/:partnerId/companies/:companyId/report/:reportPath
      Get usage for a Partner GET https://api.phinsec.io /partners/:partnerId/billing/usage
      Get usage for a Company GET https://api.phinsec.io /partners/:partnerId/companies/:companyId/usage
      Create a Company for a Partner POST https://api.phinsec.io /partners/:partnerId/companies

      Generic Errors

      Name Explanation

      400

      		 You may be using the incorrect partnerId in the route or have disabled your Phin API Partner Integration.
      429 You are sending too many API requests. There are currently few limitations to using the API. However, we will introduce API rate limiting per partner in the future.