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

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

# List email domains

`GET` `/portals/email-domains`

Operation ID: `list-email-domains`

List email domains

## 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 email domains. Supported sort attributes are: - domain - created_at - updated_at
- `filter` (object, optional) - Filter email domains returned in the response.

## Responses

- `200` - List of a email domains
- `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/email-domains:
    get:
      operationId: list-email-domains
      summary: List email domains
      description: List email domains
      parameters:
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/SortEmailDomains"
        - name: filter
          in: query
          description: Filter email domains returned in the response.
          required: false
          schema:
            $ref: "#/components/schemas/EmailDomainFilterParameters"
          style: deepObject
      responses:
        "200":
          description: List of a email domains
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListDomains"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
      tags:
        - Portal Emails
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
    SortEmailDomains:
      name: sort
      description: |
        Sorts a collection of email domains. Supported sort attributes are:
          - domain
          - created_at
          - updated_at
      in: query
      required: false
      schema:
        type: string
  schemas:
    EmailDomainFilterParameters:
      type: object
      properties:
        domain:
          $ref: "#/components/schemas/StringFieldFilter"
        verification_status:
          $ref: "#/components/schemas/StringFieldFilter"
      title: EmailDomainFilterParameters
    ListDomains:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/EmailDomain"
        meta:
          $ref: "#/components/schemas/PaginatedMeta"
      required:
        - data
        - meta
    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
    EmailDomain:
      type: object
      properties:
        domain:
          type: string
        verification:
          $ref: "#/components/schemas/EmailDomainVerification"
        dns_validation_records:
          type: array
          items:
            $ref: "#/components/schemas/DNSRecord"
          readOnly: true
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      additionalProperties: false
      required:
        - domain
        - verification
        - dns_validation_records
        - created_at
        - updated_at
    PaginatedMeta:
      description: returns the pagination information
      type: object
      properties:
        page:
          $ref: "#/components/schemas/PageMeta"
      required:
        - page
      title: PaginatedMeta
    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
    EmailDomainVerification:
      type: object
      properties:
        status:
          $ref: "#/components/schemas/EmailVerificationStatus"
        last_time_checked:
          description: An ISO-8601 timestamp representation of the last time the
            verification got checked.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        last_time_success:
          description: An ISO-8601 timestamp representation of the last time the
            verification succeeded.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
      additionalProperties: false
      readOnly: true
      required:
        - status
        - last_time_checked
        - last_time_success
    DNSRecord:
      type: object
      properties:
        type:
          type: string
          readOnly: true
        name:
          type: string
          readOnly: true
        value:
          type: string
          readOnly: true
      additionalProperties: false
      required:
        - type
        - name
        - value
    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
    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
    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
    EmailVerificationStatus:
      description: Specifies the status of the mail domain verification
      type: string
      enum:
        - pending
        - success
        - failed
        - temporary_failure
        - not_started
      readOnly: true
  responses:
    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:
    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...'`
```
