> ## Documentation Index > Fetch the complete documentation index at: https://docs.activeviam.com/llms.txt > Use this file to discover all available pages before exploring further. # List portfolio and book relationships. > Returns the hierarchy visible to the current user, including accessible portfolios and Derivitec books, direct parents and children, portfolio type, access level, and active state. Inactive items can appear with their state. Use this read-only operation to reconstruct the accessible hierarchy without changing it. ## OpenAPI ````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json get /api/Portfolios/PortfolioBookRelationships openapi: 3.0.4 info: title: Derivitec Api 1.0 version: '1.0' servers: - url: https://api.riskportal.activeviam.com security: - oauth2: [] - apikey: [] tags: - name: AdminUser - name: AtotiReport - name: AtotiSession - name: BloombergOAuth - name: Bond - name: BondYieldCurvePage - name: BookAccess - name: Books - name: Commodity - name: Counterparties - name: Currencies - name: Equity - name: EquityDividend - name: EquityPage - name: FeatureFlag - name: Fx - name: FxPage - name: GroupAccess - name: Home - name: LegacyPosition - name: MarketData - name: MarketDataProvider - name: MarketDataProviderAccess - name: Meta - name: Notification - name: Organisation - name: PnLReport - name: PortfolioAccess - name: Portfolios - name: Position - name: PositionFilter - name: PricingEnvironment - name: PricingEnvironmentAccess - name: RateAsset - name: RateAssetPage - name: Report - name: ReportDefinition - name: ReportHistoryLauncherQuery - name: ReportLauncher - name: ReportQuery - name: ReportQueryViewUser - name: ReportRestriction - name: ReportView - name: RiskReport - name: Tradable - name: TradeBooking - name: User - name: VarReport - name: VarReportQuery - name: YieldCurvePage paths: /api/Portfolios/PortfolioBookRelationships: get: tags: - Portfolios summary: List portfolio and book relationships. description: >- Returns the hierarchy visible to the current user, including accessible portfolios and Derivitec books, direct parents and children, portfolio type, access level, and active state. Inactive items can appear with their state. Use this read-only operation to reconstruct the accessible hierarchy without changing it. operationId: GetPortfolioBookRelationships responses: '200': description: >- Returns accessible portfolio and book relationship records; an empty collection is valid. content: application/json: schema: $ref: '#/components/schemas/ApiGetPortfolioBookRelationshipsResponse' '400': description: BadRequest '401': description: Unauthorized '403': description: Forbidden security: - oauth2: [] - apikey: [] components: schemas: ApiGetPortfolioBookRelationshipsResponse: required: - $type type: object properties: is_success: type: boolean description: >- Whether the operation completed successfully. The default is `true`; error outcomes set it to `false`. example: true error_messages: type: array items: type: string description: >- Messages explaining operation-level failures. The collection is empty by default. nullable: true portfolio_book_relationships: type: array items: $ref: '#/components/schemas/PortfolioBookRelationship' description: >- Accessible portfolio and book entries with their direct parent and child links; an empty collection is valid. nullable: true $type: type: string enum: - >- Derivitec.Web.Core.Portfolios.ApiGetPortfolioBookRelationshipsResponse, Derivitec.Web.Core additionalProperties: false description: >- Accessible portfolio and book hierarchy with direct parent and child relationships. PortfolioBookRelationship: required: - $type type: object properties: name: type: string description: Client-visible name of the portfolio or book. nullable: true description: type: string description: Client-visible description of the portfolio or book. nullable: true group_type: enum: - portfolio - book type: string description: Whether this hierarchy entry represents a Portfolio or a Book. portfolio_type: enum: - derivitec - enfusion - orchestrade - liquidity_book - maia - fund_studio - not_set type: string description: Portfolio source that disambiguates this hierarchy entry's identity. access_type: enum: - view - edit - full - owner type: string description: >- Effective access level reported for the current user on this hierarchy entry; it is descriptive, not independent proof of authorisation. link_id: type: integer description: >- Numeric identifier carried for this portfolio or book entry and interpreted with its group and portfolio source. format: int32 example: 1001 is_active: type: boolean description: Whether the portfolio or book is currently active. group_key: type: string description: >- Opaque client key that distinguishes this hierarchy entry; callers must not parse a construction format from it. nullable: true readOnly: true parents: type: array items: $ref: '#/components/schemas/PortfolioBookInfo' description: Direct parent portfolios of this hierarchy entry. nullable: true children: type: array items: $ref: '#/components/schemas/PortfolioBookInfo' description: >- Direct child portfolios and books of this hierarchy entry; descendants beyond one link are represented on their own entries. nullable: true $type: type: string enum: - >- Derivitec.Web.Core.Portfolios.PortfolioBookRelationship, Derivitec.Web.Core additionalProperties: false description: >- A portfolio-or-book hierarchy entry together with its direct parents and children. PortfolioBookInfo: description: >- Display, source, lifecycle, access, and link identity for one portfolio-or-book hierarchy entry. discriminator: propertyName: $type mapping: Derivitec.Web.Core.Portfolios.PortfolioBookInfo, Derivitec.Web.Core: '#/components/schemas/PortfolioBookInfoMintlifyShape' Derivitec.Web.Core.Portfolios.PortfolioBookRelationship, Derivitec.Web.Core: '#/components/schemas/PortfolioBookRelationship' oneOf: - $ref: '#/components/schemas/PortfolioBookInfoMintlifyShape' - $ref: '#/components/schemas/PortfolioBookRelationship' PortfolioBookInfoMintlifyShape: required: - $type type: object properties: name: type: string description: Client-visible name of the portfolio or book. nullable: true description: type: string description: Client-visible description of the portfolio or book. nullable: true group_type: enum: - portfolio - book type: string description: Whether this hierarchy entry represents a Portfolio or a Book. portfolio_type: enum: - derivitec - enfusion - orchestrade - liquidity_book - maia - fund_studio - not_set type: string description: Portfolio source that disambiguates this hierarchy entry's identity. access_type: enum: - view - edit - full - owner type: string description: >- Effective access level reported for the current user on this hierarchy entry; it is descriptive, not independent proof of authorisation. link_id: type: integer description: >- Numeric identifier carried for this portfolio or book entry and interpreted with its group and portfolio source. format: int32 example: 1001 is_active: type: boolean description: Whether the portfolio or book is currently active. group_key: type: string description: >- Opaque client key that distinguishes this hierarchy entry; callers must not parse a construction format from it. nullable: true readOnly: true $type: type: string enum: - >- Derivitec.Web.Core.Portfolios.PortfolioBookInfo, Derivitec.Web.Core additionalProperties: false description: >- Display, source, lifecycle, access, and link identity for one portfolio-or-book hierarchy entry. securitySchemes: oauth2: type: oauth2 description: >- OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header flows: implicit: authorizationUrl: https://auth.riskportal.derivitec.com/oauth2/authorize scopes: {} apikey: type: apiKey description: API-Key requested via the site and provided as a header name: x-api-key in: header ````