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

# The on/off settings for the transactional emails that Outseta sends to your customers.

> Each setting names the email templates it covers. A setting that is off stops the
automatic email only; an email sent by hand, such as the send invoice button, is
still sent.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/templates/transactional-email-settings
openapi: 3.0.0
info:
  title: Outseta API
  description: >-
    Outseta REST API. See the [API
    overview](https://docs.outseta.com/api-reference/overview) for
    authentication, field selection, pagination, filtering, errors, rate limits
    and webhooks.
  version: v1
servers:
  - url: https://{subdomain}.outseta.com
    description: Your Outseta account
    variables:
      subdomain:
        default: your-subdomain
        description: >-
          Your Outseta account subdomain — the part before ".outseta.com" in
          your admin URL.
security: []
paths:
  /api/v1/templates/transactional-email-settings:
    get:
      tags:
        - Template
      summary: >-
        The on/off settings for the transactional emails that Outseta sends to
        your customers.
      description: >-
        Each setting names the email templates it covers. A setting that is off
        stops the

        automatic email only; an email sent by hand, such as the send invoice
        button, is

        still sent.
      operationId: Template_GetTransactionalEmailSettings
      parameters:
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  metadata:
                    limit: 0
                    offset: 0
                    total: 0
                  items:
                    - Key: string
                      Name: string
                      SentWhen: string
                      TemplateSystemNames: []
                      IsEnabled: false
                properties:
                  metadata:
                    $ref: '#/components/schemas/CollectionMetadata'
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/TransactionalEmailSetting'
        '401':
          description: Unauthorized
      security:
        - Bearer: []
        - ApiKey: []
components:
  parameters:
    limit:
      name: limit
      in: query
      description: >-
        Requested page size. The server caps it at 100, or 25 when requested
        fields expand child objects or require additional queries;
        metadata.limit reports the applied value. Use offset=1 for the second
        page.
      schema:
        type: integer
        default: 25
    offset:
      name: offset
      in: query
      description: >-
        Zero-based page number, not a record offset. With limit=50, the second
        page is offset=1; offset=50 is page index 50 (records 2501-2550).
      schema:
        type: integer
        default: 0
  schemas:
    CollectionMetadata:
      type: object
      properties:
        limit:
          type: integer
        offset:
          type: integer
        total:
          type: integer
    TransactionalEmailSetting:
      type: object
      additionalProperties: false
      properties:
        Key:
          type: string
          nullable: true
        Name:
          type: string
          nullable: true
        SentWhen:
          type: string
          nullable: true
        TemplateSystemNames:
          type: array
          nullable: true
          items:
            type: string
        IsEnabled:
          type: boolean
  securitySchemes:
    Bearer:
      type: http
      description: Enter your access token (OAuth / JWT).
      scheme: bearer
      bearerFormat: JWT
    ApiKey:
      type: apiKey
      description: 'Enter: Outseta {api_key}:{api_secret}'
      name: Authorization
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.