---
title: "Get custom email template used in a portal"
url: "https://nov18-dev.movespot.fyi/apis/portal-management-v3-3/versions/209d0e93-97b5-4dd3-a5a4-172ba6d8a51e/operations/get-portal-custom-email-template"
---

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

# Get custom email template used in a portal

`GET` `/portals/{portalId}/email-templates/{templateName}`

Operation ID: `get-portal-custom-email-template`

Get custom email template

## Path parameters

- `portalId` (string, uuid, required) - ID of the portal.
- `templateName` (string, required) - Name of the email template.

## Responses

- `200` - Successful Retrieval for a portal email template.
- `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}/email-templates/{templateName}:
    parameters:
      - $ref: "#/components/parameters/PortalId"
      - $ref: "#/components/parameters/EmailTemplateName"
    get:
      operationId: get-portal-custom-email-template
      summary: Get custom email template used in a portal
      description: Get custom email template
      responses:
        "200":
          $ref: "#/components/responses/EmailTemplate"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Portal Emails
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    PortalId:
      schema:
        type: string
        format: uuid
      name: portalId
      in: path
      required: true
      description: ID of the portal.
    EmailTemplateName:
      name: templateName
      description: Name of the email template.
      in: path
      required: true
      schema:
        $ref: "#/components/schemas/EmailTemplateName"
  responses:
    EmailTemplate:
      description: Successful Retrieval for a portal email template.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/EmailTemplate"
          examples:
            Example 1:
              $ref: "#/components/examples/EmailTemplateExample1"
    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"
  schemas:
    EmailTemplateName:
      description: |
        Short name email template name.
      type: string
      enum:
        - confirm-email-address
        - app-registration-approved
        - app-registration-rejected
        - app-registration-revoked
        - reset-password
        - account-access-approved
        - account-access-rejected
        - account-access-revoked
        - api-key-expiring-soon
        - api-key-expired
        - developer-invitation
    EmailTemplate:
      type: object
      properties:
        label:
          description: The label of the email template
          type: string
          example: App registration approved
        name:
          $ref: "#/components/schemas/EmailTemplateName"
        default_content:
          $ref: "#/components/schemas/DefaultEmailTemplateContent"
        content:
          $ref: "#/components/schemas/EmailTemplateContent"
        variables:
          type: array
          items:
            $ref: "#/components/schemas/EmailTemplateVariableName"
        enabled:
          description: Whether the email template is enabled or disabled for a portal
          type: boolean
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      required:
        - name
        - label
        - default_content
        - variables
        - enabled
        - created_at
        - updated_at
    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
    DefaultEmailTemplateContent:
      type: object
      properties:
        subject:
          type: string
          nullable: false
        title:
          type: string
          nullable: false
        body:
          type: string
          nullable: false
        button_label:
          type: string
          nullable: false
      required:
        - subject
        - title
        - body
    EmailTemplateContent:
      type: object
      properties:
        subject:
          type: string
          maxLength: 1024
          nullable: true
        title:
          type: string
          maxLength: 1024
          nullable: true
        body:
          type: string
          maxLength: 4096
          nullable: true
        button_label:
          type: string
          maxLength: 128
          nullable: true
      nullable: true
    EmailTemplateVariableName:
      description: |
        Enum for available portal email template variables.
      type: string
      enum:
        - portal_display_name
        - portal_domain
        - developer_email
        - developer_fullname
        - dev_portal_reply_to
        - developer_status
        - api_documentation_url
        - api_name
        - api_version
        - application_name
        - credential_name
        - credential_expires_at
    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
    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
  examples:
    EmailTemplateExample1:
      value:
        name: confirm-email-address
        default_content:
          subject: Confirm Your Email Address
          title: Confirm Your Email Address
          body: "Hello {{ developer_fullname }},\\n\\nPlease confirm your email address by
            clicking the link below:"
          button_label: Confirm Email Address
        label: Confirm Email Address
        content:
          subject: Confirm Your Email Address
          title: Confirm Your Email Address
          body: Hello {{ developer_fullname }},\n\nPlease confirm your email address by
            clicking the link below:\n\n{{ confirmation_link }}\n\nBest
            regards,\nThe {{ portal.name }} Team
          button_label: null
        variables:
          - developer_email
          - developer_fullname
        enabled: true
        created_at: 2022-12-22T20:13:07.305Z
        updated_at: 2022-12-22T20:13:36.710Z
    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...'`
```
