Skip to content
Connect API Catalog/Creditsafe Connect/
/
User Management of Portfo...

Retrieve Portfolio By Id

Request

This endpoint allows you to retrieve the portfolio details from the portfolioId.

Security
bearerToken
Path
portfolioIdnumberrequired

The unique identifier for the portfolio that you wish to retrieve, obtained from /portfolios.

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
correlationIdstring

A unique ID assigned to this request.

Example:"23921650-c073-11ea-860f-06bc8182190e"
portfolioIdnumber

A unique ID assigned to each portfolio.

Example:36
namestring

The name of the portfolio

Example:"Customers 2"
isDefaultboolean

States if the portfolio is set as Default or not

Example:false
emailSubjectstring

The subject of the email notification.

Example:"Creditsafe Monitoring Notification on portfolio {{portfolioName}}"
emailsArray of objects

The email addresses of the user to receive the email notification.

Response
{
  "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  "portfolioId": 36,
  "name": "Customers 2",
  "isDefault": false,
  "emailSubject": "Creditsafe Monitoring Notification on portfolio {{portfolioName}}",
  "emails": [
    { … }
  ]
}