Create and View All Portfolios

Endpoints to create new portfolios and retrieve a list of all existing portfolios for monitoring.

Operations

List All Portfolios

Request

This endpoint allows you to manage portfolios. You can use the GET method to retrieve all portfolios associated with the user.

Security

bearerToken

Query

searchQuerystring

Return portfolios that match the given value

pageinteger

Starting page number inGlobal Monitoring is 0. If all items are displayed on one page this can also be left blank.

Default:0

pageSizeinteger

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios?searchQuery=string&page=0&pageSize=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

correlationIdstring

A unique ID assigned to this request.

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

totalCountnumber

The total number of portfolios returned for the logged in user.

Example:1

pagingobject(ConnectMonitoringPaging)

Paging parameters.

dataobject

Response

{
  "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  "totalCount": 1,
  "paging": {
    "size": 10,
    "prev": 0,
    "next": 2,
    "last": 3
  },
  "data": {
    "portfolios": [ … ],
    "sharedPortfolios": [ … ]
  }
}