> ## Documentation Index
> Fetch the complete documentation index at: https://docs.inyett.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get all portfolios

> Returns the monitoring portfolios owned by the calling company profile, optionally filtered by portfolio type. Use the returned portfolio id to add companies to watch or read back detected changes.



## OpenAPI

````yaml https://api-test.inyett.com/swagger/v3/swagger.json get /3/{profileCountry}/monitor/portfolios
openapi: 3.0.4
info:
  title: Inyett Automation
  description: |-
    <p>Inyett Automation is a payment control and company screening API for
                        Swedish and Norwegian businesses. It lets integrators automatically check a company's
                        status and risk before doing business with it, monitor companies over time for changes,
                        and screen outgoing payment batches for anomalies, sanctions and compliance issues before
                        the money leaves the paying customer. It is used by ERP, payment and procurement systems
                        that need this control built into their own workflows rather than as a manual step.</p><h3>How to connect</h3>
                        <p>Read more about our API and how to connect on <a href='https://docs.inyett.com/home' target='_blank'>docs.inyett.com</a></p> 
  contact:
    email: support@inyett.com
  version: '3.0'
servers: []
security:
  - X-Api-Key: []
  - Bearer: []
tags:
  - name: Inyett Company Control
    description: >-
      Risk assessment endpoints such as main rating, fraud, debt and payment
      remark checks, used to screen a company before paying it.
  - name: Inyett Company Data
    description: >-
      Company master data: addresses, accounts, owners, directors, financial
      statements and other registry information for a company.
  - name: Inyett Company Debts & Credits
    description: >-
      Aggregated debt and credit information for a company, including historical
      claims and payment remarks.
  - name: Inyett Company Find
    description: Free-text and organisation-number search for companies.
  - name: Inyett Company Insights
    description: >-
      The company relation graph: companies related to a given company, grouped
      by relation category (tag).
  - name: Inyett Company Monitor
    description: >-
      Continuous monitoring of company portfolios: create portfolios, add or
      remove companies to watch, and read back detected changes over time.
  - name: Inyett Payment Control
    description: >-
      Batch screening of outgoing payments: submit a payment batch for analysis
      and read back any warnings before the money leaves the customer.
paths:
  /3/{profileCountry}/monitor/portfolios:
    get:
      tags:
        - Inyett Company Monitor
      summary: Get all portfolios
      description: >-
        Returns the monitoring portfolios owned by the calling company profile,
        optionally filtered by portfolio type. Use the returned portfolio id to
        add companies to watch or read back detected changes.
      operationId: monitorPortfolioGet
      parameters:
        - name: profileCountry
          in: path
          description: >-
            The country whose scope/entitlement profile (SE or NO) is used to
            authorize the request. Determines which market-specific rules apply,
            independent of the country the requested company is registered in.
          required: true
          schema:
            $ref: '#/components/schemas/Country'
        - name: Fetch
          in: query
          description: Required if Offset is set
          schema:
            type: integer
            format: int32
        - name: Offset
          in: query
          description: Required if Fetch is set
          schema:
            type: integer
            format: int32
        - name: portfolioType
          in: query
          description: >-
            Filters portfolios by how their companies are managed: Manual (added
            individually) or Auto (kept in sync automatically).
          schema:
            $ref: '#/components/schemas/PortfolioType'
        - name: AppId
          in: header
          description: App id
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Generic_FetchOffsetResult_1_Portfolio'
              example:
                data:
                  - id: 1
                    type: Auto
                    name: Foo
                    createdDate: '2024-01-01T00:00:00'
                    updatedDate: '2024-01-01T00:00:00'
                    enabled: true
                  - id: 2
                    type: Manual
                    name: Bar
                    createdDate: '2024-01-01T00:00:00'
                    updatedDate: '2024-01-01T00:00:00'
                    enabled: false
                total: 2
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailResponse'
components:
  schemas:
    Country:
      enum:
        - SE
        - 'NO'
      type: string
      description: >-
        ISO country code supported for company lookups: SE (Sweden) or NO
        (Norway).
    PortfolioType:
      enum:
        - Manual
        - Auto
      type: string
      description: >-
        How companies are added to a portfolio: Manual (added individually) or
        Auto (kept in sync automatically).
    Generic_FetchOffsetResult_1_Portfolio:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Portfolio'
          nullable: true
        total:
          type: integer
          format: int32
      additionalProperties: false
      description: >-
        A page of monitoring portfolios, together with the total number of
        matching portfolios.
    ValidationProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          nullable: true
      additionalProperties: {}
      description: >-
        A machine-readable validation error response (RFC 7807 Problem Details)
        including per-field error messages.
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
      additionalProperties: {}
      description: >-
        A machine-readable error response following the RFC 7807 Problem Details
        format.
    FailResponse:
      type: object
      properties:
        message:
          type: string
          nullable: true
      additionalProperties: false
      description: >-
        Error response returned when a request fails, containing a
        human-readable message.
    Portfolio:
      type: object
      properties:
        id:
          type: integer
          format: int32
        type:
          $ref: '#/components/schemas/PortfolioType'
        name:
          type: string
          nullable: true
        createdDate:
          type: string
          format: date-time
        updatedDate:
          type: string
          format: date-time
        enabled:
          type: boolean
      additionalProperties: false
      description: >-
        A monitoring portfolio used to group companies that should be watched
        for changes.
  securitySchemes:
    X-Api-Key:
      type: apiKey
      description: 'Api key needed to access the endpoints. X-Api-Key: My api key'
      name: X-Api-Key
      in: header
    Bearer:
      type: http
      description: Please enter a valid token
      scheme: Bearer
      bearerFormat: JWT

````