# List Companies In A Portfolio

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

Endpoint: GET /monitoring/portfolios/{portfolioId}/companies
Version: 1.10.9
Security: bearerToken

## Query parameters:

  - `searchQuery` (string)
    Return companies that match the given value

  - `pageSize` (integer)
    Number of items to return per Page.

  - `page` (integer)
    Starting page number inGlobal Monitoring is . If all items are displayed on one page this can also be left blank.

  - `countryCode` (string)
    Return companies from the portfolio that match the given countryCode

## Path parameters:

  - `portfolioId` (number, required)
    The unique identifier of the portfolio, obtained from .

## Response 200 fields (application/json):

  - `correlationId` (string)
    A unique ID assigned to this request.
    Example: "23921650-c073-11ea-860f-06bc8182190e"

  - `totalCount` (number)
    The total number of events returned for the given company.
    Example: 1

  - `paging` (object)
    Paging parameters.

  - `paging.size` (number,null)
    The maximum number of results returned per page.
    Example: 10

  - `paging.prev` (number,null)
    The page number of the previous page, null if there is no previous page available.

  - `paging.next` (number,null)
    The page number of the next page, null if there is no next page available.
    Example: 2

  - `paging.last` (number,null)
    The page number of the last page.
    Example: 3

  - `data` (array)

  - `data.id` (string)
    The connectId of the company. A connectId is the primary Company identifier that is used to uniquely identify all companies across Creditsafe's Universe and Partner Network.
    Example: "US-X-US22384484"

  - `data.safeNumber` (string)
    The Safe Number (Creditsafe's identifier on all Companies owned in the Creditsafe Universe) of the company.
    Example: "US22384484"

  - `data.name` (string)
    The name of the company .
    Example: "GOOGLE LLC"

  - `data.address` (string)
    The address of the company.
    Example: "VIA PABLO NERUDA, 4, TREZZANO SUL NAVIGLIO, 20090"

  - `data.countryCode` (string)
    ISO/Alpha 2 format country code of the company.
    Example: "US"

  - `data.portfolioId` (number)
    The portfolio Id of the portfolio that contains the company.
    Example: 589960

  - `data.creditLimit` (number,null)
    The credit limit of the company.
    Example: 10000

  - `data.dateLastEvent` (string,null)
    The date of the most recent event the company has had.
    Example: "2018-06-14T00:59:06"

  - `data.freeText` (string,null)
    Field that can be used to add a free text note to when adding a company to a portfolio.

  - `data.personalLimit` (string,null)
    Field that can be used to add a personal limit number against the company in a portfolio.
    Example: 10000

  - `data.personalReference` (string,null)
    Field that can be used to add a personal reference against the company in a portfolio.
    Example: "Follow up Jan 2021"

  - `data.ratingCommon` (string,null)
    The rating score band that the company is in.
    Example: "A"

  - `data.ratingLocal` (string,null)
    Country specific rating score.
    Example: "Not rated - insufficient information to rate"

  - `data.companyStatus` (string,null)
    The current status of the company
    Example: 1

  - `data.dateAdded` (string)

  - `data.dateModified` (string)

## Response 400 fields (application/json):

  - `correlationId` (string)
    A unique ID assigned to this request.

  - `message` (string)

  - `details` (string)
    Provides further information on why the request was rejected

## Response 401 fields (application/json):

  - `error` (string)

## Response 403 fields (application/json):

  - `message` (string)
    Example: "Access forbidden"

## Response 404 fields (application/json):

  - `correlationId` (string)
    A unique ID assigned to this request.

  - `message` (string)

  - `details` (string)
    Provides further information on why the request was rejected