List Companies In A Portfolio

Request

This endpoints gets all companies from a specific portfolio based on the portfolio id, optionally filter with query parameters.

Security

bearerToken

Path

portfolioIdnumberrequired

The unique identifier of the portfolio, obtained from /portfolios.

Query

searchQuerystring

Return companies that match the given value

pageSizeinteger

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

pageinteger

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

Default:0

countryCodestring

Return companies from the portfolio that match the given countryCode

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/companies?searchQuery=string&pageSize=0&page=0&countryCode=string' \
  -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 companies returned for the given portfolio.

Example:1

pagingobject(ConnectMonitoringPaging)

Paging parameters.

dataArray of objects

Response

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