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

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

# List Teams

`GET` `/portals/{portalId}/teams`

Operation ID: `list-portal-teams`

Lists the developer teams in a portal. Each team can contain any developer and developers can be part of multiple teams.

## Path parameters

- `portalId` (string, uuid, required) - ID of the portal.

## 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.
- `filter` (object, optional) - Filter teams returned in the response.

## Responses

- `200` - A paginated list of teams in a portal.
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## 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/{portalId}/teams:
    parameters:
      - $ref: "#/components/parameters/PortalId"
    get:
      operationId: list-portal-teams
      summary: List Teams
      description: Lists the developer teams in a portal. Each team can contain any
        developer and developers can be part of multiple teams.
      parameters:
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageNumber"
        - name: filter
          in: query
          description: Filter teams returned in the response.
          required: false
          schema:
            type: object
            properties:
              name:
                $ref: "#/components/schemas/StringFieldFilter"
              can_own_applications:
                $ref: "#/components/schemas/BooleanFieldFilter"
          style: deepObject
      responses:
        "200":
          $ref: "#/components/responses/ListPortalTeams"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Portal Teams
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    PortalId:
      schema:
        type: string
        format: uuid
      name: portalId
      in: path
      required: true
      description: ID of the portal.
    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
  schemas:
    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
    ListPortalTeamsResponse:
      description: A paginated list of teams in a portal.
      type: object
      properties:
        meta:
          $ref: "#/components/schemas/PaginatedMeta"
        data:
          type: array
          items:
            $ref: "#/components/schemas/PortalTeamResponse"
      example:
        meta:
          page:
            number: 1
            size: 10
            total: 3
        data:
          - id: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
            name: Partner
            description: Team with access to Partner APIs
            created_at: 2022-02-07T17:46:57.52Z
            updated_at: 2022-09-25T13:00:00.00Z
            can_own_applications: false
          - id: af9fd312-a987-4628-b4c5-bb4f4fddd5f7
            name: Internal
            description: Team with access to Internal APIs
            created_at: 2022-02-07T17:46:57.52Z
            updated_at: 2022-09-25T13:00:00.00Z
            can_own_applications: true
          - id: 4f9fd312-a987-4628-b4c5-bb4f4fddd5f7
            name: Root
            description: Team with access to Internal Systems
            created_at: 2022-02-07T17:46:57.52Z
            updated_at: 2022-09-25T13:00:00.00Z
            can_own_applications: true
      required:
        - data
        - meta
      title: ListPortalTeamsResponse
    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
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    PaginatedMeta:
      description: returns the pagination information
      type: object
      properties:
        page:
          $ref: "#/components/schemas/PageMeta"
      required:
        - page
      title: PaginatedMeta
    PortalTeamResponse:
      description: Details about a developer team.
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
          readOnly: true
        name:
          type: string
          example: IDM - Developers
          maxLength: 250
          pattern: ^[\w \W]+$
        description:
          type: string
          example: The developers for the IDM API.
          maxLength: 250
        created_at:
          type: string
          format: date-time
          example: 1992-02-07T17:46:57.52Z
          readOnly: true
        updated_at:
          type: string
          format: date-time
          example: 2022-02-07T17:00:00.52Z
          readOnly: true
        can_own_applications:
          description: Whether the team is allowed to own applications.
          type: boolean
          example: false
      example:
        id: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
        name: IDM - Developers
        description: The developers for the IDM API.
        created_at: 1992-02-07T17:46:57.52Z
        updated_at: 2022-08-31T17:00:00.52Z
        can_own_applications: false
      title: PortalTeamResponse
    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
    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
  responses:
    ListPortalTeams:
      description: A paginated list of teams in a portal.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ListPortalTeamsResponse"
          examples:
            Example 1:
              $ref: "#/components/examples/ListPortalTeamsExample1"
    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"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  examples:
    ListPortalTeamsExample1:
      value:
        meta:
          page:
            number: 1
            size: 10
            total: 3
        data:
          - id: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
            name: Partner
            description: Team with access to Partner APIs
            created_at: 2022-02-07T17:46:57.52Z
            updated_at: 2022-09-25T13:00:00.00Z
            can_own_applications: false
          - id: af9fd312-a987-4628-b4c5-bb4f4fddd5f7
            name: Internal
            description: Team with access to Internal APIs
            created_at: 2022-02-07T17:46:57.52Z
            updated_at: 2022-09-25T13:00:00.00Z
            can_own_applications: true
          - id: 4f9fd312-a987-4628-b4c5-bb4f4fddd5f7
            name: Root
            description: Team with access to Internal Systems
            created_at: 2022-02-07T17:46:57.52Z
            updated_at: 2022-09-25T13:00:00.00Z
            can_own_applications: true
    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
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  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...'`
```
