List Portfolio Documents

Required scope: portfolio_file:read

Use this endpoint to read the documents currently attached to a portfolio.

Generated Reference

POST /public-api/publicapi.v1.Portfolio/ListPortfolioDocuments

Lists portfolio documents.

Request ListPortfolioDocumentsRequest

Response ListPortfolioDocumentsResponse

ListPortfolioDocumentsRequest

Field	Type
`portfolio_id`	`string`
`visibility`	`PortfolioFileVisibility`

ListPortfolioDocumentsResponse

Field	Type
`documents`	`repeated PortfolioDocument`

Related Types

PortfolioDocument

Field	Type
`id`	`string`
`portfolio_id`	`string`
`visibility`	`PortfolioFileVisibility`
`filename`	`string`
`original_filename`	`string`
`content_type`	`string`
`size_bytes`	`int64`
`description`	`string`
`created_at`	`int64`
`updated_at`	`int64`

Request

{
  "portfolioId": "be85f4d1-b680-4964-bf62-9828fdf4ce04",
  "visibility": "PUBLIC_PORTFOLIO_FILE_VISIBILITY_CUSTOMER"
}

Response

{
  "documents": [
    {
      "id": "cba8fef4-4fd2-4be6-af77-326e716ef130",
      "portfolioId": "be85f4d1-b680-4964-bf62-9828fdf4ce04",
      "visibility": "PUBLIC_PORTFOLIO_FILE_VISIBILITY_CUSTOMER",
      "originalFilename": "quote.pdf",
      "contentType": "application/pdf",
      "sizeBytes": 124991
    }
  ]
}