GET
/
v1
/
Portfolio
Returns the Bussinesses in the current user's Portfolio.
curl --request GET \
  --url https://api.creditriskmonitor.com/v1/Portfolio \
  --header 'Authorization: Bearer <token>'
{
  "Success": true,
  "Data": [
    {
      "BusinessId": 123,
      "BusinessName": "<string>",
      "FRISKScore": 123,
      "FRISKLastChangeDate": "2023-11-07T05:31:56Z",
      "ZScore": 123,
      "ZScoreLastChangeDate": "2023-11-07T05:31:56Z",
      "DBTIndex": 123,
      "PAYCEScore": 123,
      "PAYCELastChangeDate": "2023-11-07T05:31:56Z",
      "LatestStatementDate": "2023-11-07T05:31:56Z",
      "CurrentFiscalYear": 123,
      "CurrentFiscalQuarter": 123,
      "FinancialsLastChangeDate": "2023-11-07T05:31:56Z"
    }
  ],
  "ErrorCode": "<string>"
}
Use the Login endpoint to retrieve the SessionKey, then include it in the Authorization field for authentication.

Authorizations

​
Authorization
string
header
required

Enter the Session Key with the Bearer prefix, e.g. "Bearer abcde12345".

Query Parameters

​
FirstRow
integer

First row to return

​
LastRow
integer

Last row to return

​
FromDate
string<date-time>

Results will only include Businesses that have had changes since this date. Leave NULL to return all Businesses.

Response

200
application/json

OK