---
title: "List Portals"
url: "https://nov18-dev.movespot.fyi/apis/portal-management-v3-3/versions/209d0e93-97b5-4dd3-a5a4-172ba6d8a51e/operations/list-portals"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-management-v3-3/versions/209d0e93-97b5-4dd3-a5a4-172ba6d8a51e.md

# List Portals

`GET` `/portals`

Operation ID: `list-portals`

Lists developer portals defined in this region for this organization. Each developer portal is available at a unique address and has isolated configuration, customization, developers, and applications.

## Query parameters

- `page[size]` (integer, optional) - The maximum number of items to include per page. The last page of a collection may include fewer items.
- `page[number]` (integer, optional) - Determines which page of the entities to retrieve.
- `sort` (string, optional) - Sorts a collection of portals. Supported sort attributes are: - name - description - authentication_enabled - rbac_enabled - auto_approve_applications - auto_approve_developers - default_domain - canonical_domain - created_at - updated_at
- `filter` (object, optional) - Filter portals returned in the response.

## Responses

- `200` - A paginated list of portals in the current region of an organization.
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Portal Management V3
  version: 3.4.1
servers:
  - url: https://us.api.konghq.com/v3
    description: United-States Production region
  - url: https://eu.api.konghq.com/v3
    description: Europe Production region
  - url: https://au.api.konghq.com/v3
    description: Australia Production region
  - url: https://me.api.konghq.com/v3
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v3
    description: India Production region
  - url: https://sg.api.konghq.com/v3
    description: Singapore Production region
paths:
  /portals:
    get:
      operationId: list-portals
      summary: List Portals
      description: Lists developer portals defined in this region for this
        organization. Each developer portal is available at a unique address and
        has isolated configuration, customization, developers, and applications.
      parameters:
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/SortPortals"
        - name: filter
          in: query
          description: Filter portals returned in the response.
          required: false
          schema:
            $ref: "#/components/schemas/PortalFilterParameters"
          style: deepObject
      responses:
        "200":
          $ref: "#/components/responses/ListPortalsResponse"
        "400":
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: "#/components/schemas/BadRequestError"
              examples:
                ListPortalsBadRequestExample1:
                  $ref: "#/components/examples/ListPortalsBadRequestExample1"
                ListPortalsBadRequestExample2:
                  $ref: "#/components/examples/ListPortalsBadRequestExample2"
                ListPortalsBadRequestExample3:
                  $ref: "#/components/examples/ListPortalsBadRequestExample3"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
      tags:
        - Portals
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    PageSize:
      name: page[size]
      description: The maximum number of items to include per page. The last page of a
        collection may include fewer items.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 10
    PageNumber:
      name: page[number]
      description: Determines which page of the entities to retrieve.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 1
    SortPortals:
      name: sort
      description: |
        Sorts a collection of portals. Supported sort attributes are:
          - name
          - description
          - authentication_enabled
          - rbac_enabled
          - auto_approve_applications
          - auto_approve_developers
          - default_domain
          - canonical_domain
          - created_at
          - updated_at
      in: query
      required: false
      schema:
        type: string
  schemas:
    PortalFilterParameters:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UuidFieldFilter"
        name:
          $ref: "#/components/schemas/StringFieldFilter"
        description:
          $ref: "#/components/schemas/StringFieldFilter"
        authentication_enabled:
          $ref: "#/components/schemas/BooleanFieldFilter"
        rbac_enabled:
          $ref: "#/components/schemas/BooleanFieldFilter"
        default_api_visibility:
          $ref: "#/components/schemas/StringFieldFilter"
        default_page_visibility:
          $ref: "#/components/schemas/StringFieldFilter"
        default_application_auth_strategy_id:
          $ref: "#/components/schemas/UuidFieldFilter"
        auto_approve_developers:
          $ref: "#/components/schemas/BooleanFieldFilter"
        auto_approve_applications:
          $ref: "#/components/schemas/BooleanFieldFilter"
        default_domain:
          $ref: "#/components/schemas/StringFieldFilter"
        canonical_domain:
          $ref: "#/components/schemas/StringFieldFilter"
      title: PortalFilterParameters
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    UuidFieldFilter:
      description: "Filter using **one** of the following operators: `eq`, `oeq`, `neq`"
      type: object
      properties:
        eq:
          description: The field exactly matches the provided value.
          type: string
          example: ?filter[field_name_here][eq]=foo
        oeq:
          description: The field matches any of the provided values.
          type: string
          example: ?filter[field_name_here][oeq]=foo,bar
        neq:
          description: The field does not match the provided value.
          type: string
          example: ?filter[field_name_here][neq]=bar
      additionalProperties: false
      x-examples:
        example-1:
          oeq: some-value,some-other-value
          neq: not-this-value
        example-2:
          eq: some-value
    StringFieldFilter:
      oneOf:
        - title: Filter by operator
          description: "Filter using **one** of the following operators: `eq`, `oeq`,
            `neq`, `contains`, `ocontains`"
          x-examples:
            example-1:
              contains: some-value
              ocontains: this-value,or-that-value
              oeq: some-value,some-other-value
              neq: not-this-value
            example-2:
              eq: some-value
          properties:
            eq:
              description: The field exactly matches the provided value.
              type: string
              example: ?filter[field_name_here][eq]=foo
            contains:
              description: The field contains the provided value.
              type: string
              example: ?filter[field_name_here][contains]=foo
            ocontains:
              description: The field contains any of the provided values.
              type: string
              example: ?filter[field_name_here][ocontains]=foo,bar
            oeq:
              description: The field matches any of the provided values.
              type: string
              example: ?filter[field_name_here][oeq]=foo,bar
            neq:
              description: The field does not match the provided value.
              type: string
              example: ?filter[field_name_here][neq]=bar
          type: object
          additionalProperties: false
        - title: Filter by exact string match
          type: string
          description: The field exactly matches the provided value.
          example: ?filter[title]=foo
    BooleanFieldFilter:
      description: Filter by a boolean value (true/false).
      type: boolean
      title: BooleanFieldFilter
      x-examples:
        example-1: true
    UUID:
      description: Contains a unique identifier used for this resource.
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      readOnly: true
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    Labels:
      description: >
        Labels store metadata of an entity that can be used for filtering an
        entity list or for searching across entity types. 


        Keys must be of length 1-63 characters, and cannot start with "kong",
        "konnect", "mesh", "kic", or "_".
      type: object
      example:
        env: test
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
      maxProperties: 50
      title: Labels
    PaginatedMeta:
      description: returns the pagination information
      type: object
      properties:
        page:
          $ref: "#/components/schemas/PageMeta"
      required:
        - page
      title: PaginatedMeta
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    PageMeta:
      description: Contains pagination query parameters and the total number of
        objects returned.
      type: object
      properties:
        number:
          type: number
          example: 1
        size:
          type: number
          example: 10
        total:
          type: number
          example: 100
      required:
        - number
        - size
        - total
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
  responses:
    ListPortalsResponse:
      description: A paginated list of portals in the current region of an organization.
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: array
                items:
                  title: Portal
                  type: object
                  additionalProperties: false
                  properties:
                    id:
                      $ref: "#/components/schemas/UUID"
                    created_at:
                      $ref: "#/components/schemas/CreatedAt"
                    updated_at:
                      $ref: "#/components/schemas/UpdatedAt"
                    name:
                      description: The name of the portal, used to distinguish it from other portals.
                        Name must be unique.
                      type: string
                      maxLength: 255
                      minLength: 1
                    display_name:
                      description: The display name of the portal. This value will be the portal's
                        `name` in Portal API.
                      type: string
                      maxLength: 255
                      minLength: 1
                      nullable: false
                    description:
                      description: A description of the portal.
                      type: string
                      maxLength: 512
                      nullable: true
                    authentication_enabled:
                      description: Whether the portal supports developer authentication. If disabled,
                        developers cannot register for accounts or create
                        applications.
                      type: boolean
                      default: true
                    rbac_enabled:
                      description: Whether the portal resources are protected by Role Based Access
                        Control (RBAC). If enabled, developers view or register
                        for APIs until unless assigned to teams with access to
                        view and consume specific APIs. Authentication must be
                        enabled to use RBAC.
                      type: boolean
                      default: false
                    sipr_enabled:
                      description: Whether ip allow list is enabled for the portal.
                      type: boolean
                      example: true
                      default: false
                    default_api_visibility:
                      description: The default visibility of APIs in the portal. If set to `public`,
                        newly published APIs are visible to unauthenticated
                        developers. If set to `private`, newly published APIs
                        are hidden from unauthenticated developers.
                      type: string
                      enum:
                        - public
                        - private
                    default_page_visibility:
                      description: The default visibility of pages in the portal. If set to `public`,
                        newly created pages are visible to unauthenticated
                        developers. If set to `private`, newly created pages are
                        hidden from unauthenticated developers.
                      type: string
                      enum:
                        - public
                        - private
                    default_application_auth_strategy_id:
                      description: The default authentication strategy for APIs published to the
                        portal. Newly published APIs will use this
                        authentication strategy unless overridden during
                        publication. If set to `null`, API publications will not
                        use an authentication strategy unless set during
                        publication.
                      type: string
                      format: uuid
                      nullable: true
                    auto_approve_developers:
                      description: Whether developer account registrations will be automatically
                        approved, or if they will be set to pending until
                        approved by an admin.
                      type: boolean
                      default: false
                    auto_approve_applications:
                      description: Whether requests from applications to register for APIs will be
                        automatically approved, or if they will be set to
                        pending until approved by an admin.
                      type: boolean
                      default: false
                    default_domain:
                      description: The domain assigned to the portal by Konnect. This is the default
                        place to access the portal and its API if not using a
                        `custom_domain``.
                      type: string
                      format: hostname
                      readOnly: true
                    canonical_domain:
                      description: The canonical domain of the developer portal
                      type: string
                      format: hostname
                      nullable: false
                      readOnly: true
                    labels:
                      $ref: "#/components/schemas/Labels"
                  required:
                    - id
                    - name
                    - display_name
                    - description
                    - authentication_enabled
                    - rbac_enabled
                    - sipr_enabled
                    - default_api_visibility
                    - default_page_visibility
                    - default_application_auth_strategy_id
                    - auto_approve_applications
                    - auto_approve_developers
                    - default_domain
                    - canonical_domain
                    - created_at
                    - updated_at
              meta:
                $ref: "#/components/schemas/PaginatedMeta"
            additionalProperties: false
            required:
              - data
              - meta
          examples:
            Example 1:
              $ref: "#/components/examples/ListPortalsExample1"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
  examples:
    ListPortalsBadRequestExample1:
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:1433447772874964729
        detail: Invalid Parameters
        invalid_parameters:
          - field: page[size]
            rule: is_number
            reason: '"page[size]" must be a number'
            source: query
    ListPortalsBadRequestExample2:
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:1433447772874964729
        detail: Invalid Parameters
        invalid_parameters:
          - field: page[number]
            rule: is_number
            reason: '"page[number]" must be a number'
            source: query
    ListPortalsBadRequestExample3:
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:1433447772874964729
        detail: Invalid Parameters
        invalid_parameters:
          - field: sort
            rule: enum
            choices:
              - created_at
              - updated_at
            reason: must be one of [created_at, updated_at]
            source: query
    ListPortalsExample1:
      value:
        meta:
          page:
            number: 1
            size: 10
            total: 1
        data:
          - id: 8f9fd312-a987-4628-b4c5-bb4f4fddd5f7
            created_at: 2022-02-07T17:46:57.52Z
            updated_at: 2022-10-08T17:00:00.52Z
            name: Portal A
            display_name: Developer Portal A
            description: The Portal A
            authentication_enabled: false
            rbac_enabled: true
            sipr_enabled: false
            default_api_visibility: private
            default_page_visibility: private
            default_application_auth_strategy_id: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
            auto_approve_applications: false
            auto_approve_developers: true
            default_domain: 123455678abcd.edge.us.portal.konghq.com
            canonical_domain: 123455678abcd.edge.us.portal.konghq.com
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
  securitySchemes:
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```
