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

# List Program Templates

> Returns a list of your program templates.



## OpenAPI

````yaml GET /program_templates
openapi: 3.1.0
info:
  title: Moonbase REST API
  version: v0
servers:
  - url: https://api.moonbase.ai/v0
security:
  - bearer: []
tags:
  - name: Inboxes
    description: Manage your inboxes, conversations, and messages
  - name: Collections
    description: Manage your collections and items
  - name: Marketing
    description: Manage your marketing campaigns and forms
  - name: Activities
    description: View activities and capture calls
  - name: Library
    description: Manage your meetings, files, and notes
paths:
  /program_templates:
    get:
      tags:
        - Marketing
      summary: List program templates
      description: Returns a list of your program templates.
      parameters:
        - name: before
          in: query
          required: false
          schema:
            type: string
          description: >-
            When specified, returns results starting immediately before the item
            identified by this cursor. Use the cursor value from the response's
            metadata to fetch the previous page of results.
          explode: true
        - name: after
          in: query
          required: false
          schema:
            type: string
          description: >-
            When specified, returns results starting immediately after the item
            identified by this cursor. Use the cursor value from the previous
            response's metadata to fetch the next page of results.
          explode: true
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
          description: >-
            Maximum number of items to return per page. Must be between 1 and
            100. Defaults to 20 if not specified.
          explode: true
        - name: include[]
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - program
          description: >-
            Specifies which related objects to include in the response. Valid
            option is `program`.
          explode: true
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                description: A set of results using cursor-based pagination.
                properties:
                  type:
                    type: string
                    const: list
                  data:
                    type: array
                    description: An array of ProgramTemplate items.
                    items:
                      $ref: '#/components/schemas/ProgramTemplate'
                  meta:
                    type: object
                    description: >-
                      Metadata about the pagination, including the cursors
                      pointing to the previous and next pages.
                    properties:
                      cursors:
                        type: object
                        properties:
                          prev:
                            type: string
                            description: >-
                              Cursor for the previous page. This value should be
                              used with the `before` query parameter to fetch
                              the previous page of results.
                          next:
                            type: string
                            description: >-
                              Cursor for the next page. This value should be
                              used with the `after` query parameter to fetch the
                              next page of results.
                    required:
                      - cursors
                required:
                  - type
                  - data
                  - meta
              examples:
                Default:
                  summary: Default
                  value:
                    type: list
                    data:
                      - id: 1CLJt2v7opRhSWqVEtHwYT
                        type: program_template
                        subject: Test Subject to {{ person.name }}
                        body:
                          markdown: Message content
                        created_at: '2025-02-17T16:00:00.000Z'
                        updated_at: '2025-02-17T16:00:00.000Z'
                      - id: 1CLJt2v6pHdDoet4Thyb5M
                        type: program_template
                        subject: Join your team
                        body:
                          markdown: Message content
                        created_at: '2025-02-17T16:00:00.000Z'
                        updated_at: '2025-02-17T16:00:00.000Z'
                      - id: 1CLJt2v6ZuRbtwPhmQtzxa
                        type: program_template
                        subject: Test Subject to {{ person.name }}
                        body:
                          markdown: Message content
                        created_at: '2025-02-17T16:00:00.000Z'
                        updated_at: '2025-02-17T16:00:00.000Z'
                      - id: 1CLJt2v5aNd8G5SGzEaeVU
                        type: program_template
                        subject: Verify your email
                        body:
                          markdown: Message content
                        created_at: '2025-02-17T16:00:00.000Z'
                        updated_at: '2025-02-17T16:00:00.000Z'
                    meta:
                      cursors: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                Default:
                  summary: Default
                  value:
                    type: errors
                    errors:
                      - type: error
                        status: '400'
                        title: Bad Request
                        detail: >-
                          The request could not be understood due to malformed
                          syntax or invalid parameters.
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                Default:
                  summary: Default
                  value:
                    type: errors
                    errors:
                      - type: error
                        status: '401'
                        title: Unauthorized
                        detail: >-
                          Invalid or missing API key or JWT. You should provide
                          your Moonbase API Key or JWT in the authorization
                          header, in the format: "Authorization: Bearer
                          MOONBASE_API_KEY"
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                Default:
                  summary: Default
                  value:
                    type: errors
                    errors:
                      - type: error
                        status: '403'
                        title: Forbidden
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                Default:
                  summary: Default
                  value:
                    type: errors
                    errors:
                      - type: error
                        status: '429'
                        title: Too Many Requests
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                Default:
                  summary: Default
                  value:
                    type: errors
                    errors:
                      - type: error
                        status: '500'
                        title: Internal Server Error
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                Default:
                  summary: Default
                  value:
                    type: errors
                    errors:
                      - type: error
                        status: '503'
                        title: Service Unavailable
                        detail: >-
                          The service is temporarily unavailable, please try
                          again later.
      x-codeSamples:
        - lang: JavaScript
          source: >-
            import Moonbase from '@moonbaseai/sdk';


            const client = new Moonbase({
              apiKey: process.env['MOONBASE_API_KEY'], // This is the default and can be omitted
            });


            // Automatically fetches more pages as needed.

            for await (const programTemplate of client.programTemplates.list())
            {
              console.log(programTemplate.id);
            }
        - lang: Python
          source: |-
            import os
            from moonbase import Moonbase

            client = Moonbase(
                api_key=os.environ.get("MOONBASE_API_KEY"),  # This is the default and can be omitted
            )
            page = client.program_templates.list()
            page = page.data[0]
            print(page.id)
        - lang: Go
          source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/moonbaseai/moonbase-sdk-go\"\n\t\"github.com/moonbaseai/moonbase-sdk-go/option\"\n)\n\nfunc main() {\n\tclient := moonbase.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.ProgramTemplates.List(context.TODO(), moonbase.ProgramTemplateListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n"
        - lang: Ruby
          source: |-
            require "moonbase"

            moonbase = Moonbase::Client.new(api_key: "My API Key")

            page = moonbase.program_templates.list

            puts(page)
components:
  schemas:
    ProgramTemplate:
      title: ProgramTemplate
      description: >-
        The ProgramTemplate object defines the content of a message sent by a
        `Program`, including support for Liquid templating.
      type: object
      properties:
        type:
          description: >-
            String representing the object’s type. Always `program_template` for
            this object.
          type: string
          const: program_template
        id:
          description: Unique identifier for the object.
          type: string
        subject:
          description: The subject line of the email, which can include Liquid variables.
          type: string
        body:
          $ref: '#/components/schemas/FormattedText'
          description: The body content of the email, which can include Liquid variables.
        program:
          $ref: '#/components/schemas/Program'
          description: >
            The `Program` that uses this template.


            **Note:** Only present when requested using the `include` query
            parameter.
        created_at:
          description: >-
            Time at which the object was created, as an ISO 8601 timestamp in
            UTC.
          type: string
          format: date-time
        updated_at:
          description: >-
            Time at which the object was last updated, as an ISO 8601 timestamp
            in UTC.
          type: string
          format: date-time
      required:
        - subject
        - type
        - id
        - body
        - created_at
        - updated_at
    Errors:
      title: Errors
      description: >-
        The Errors object is a container that holds multiple Error objects when
        an API request encounters several validation or processing issues. This
        allows the API to return comprehensive feedback about all problems
        encountered in a single response.
      type: object
      properties:
        type:
          type: string
          const: errors
        errors:
          description: A list of `Error` objects.
          type: array
          items:
            $ref: '#/components/schemas/Error'
      required:
        - type
    FormattedText:
      title: FormattedText
      description: >-
        Structured content that can be rendered in multiple formats, currently
        supporting Markdown.
      type: object
      properties:
        markdown:
          description: The content formatted as Markdown text.
          type: string
      required: []
    Program:
      title: Program
      description: >-
        The Program object represents an email campaign. It defines the sending
        behavior and tracks engagement metrics.
      type: object
      properties:
        type:
          description: >-
            String representing the object’s type. Always `program` for this
            object.
          type: string
          const: program
        id:
          description: Unique identifier for the object.
          type: string
        display_name:
          description: The user-facing name of the program.
          type: string
        status:
          description: >-
            The current status of the program. Can be `draft`, `published`,
            `paused`, or `archived`.
          type: string
          enum:
            - draft
            - published
            - paused
            - archived
        trigger:
          description: >-
            The sending trigger for the program. Can be `api` for transactional
            sends or `broadcast` for scheduled sends.
          type: string
          enum:
            - api
            - broadcast
        scheduled_at:
          description: >-
            For `broadcast` programs, the time the program is scheduled to send,
            as an ISO 8601 timestamp in UTC.
          type: string
          format: date-time
        track_opens:
          description: '`true` if email opens are tracked for this program.'
          type: boolean
        track_clicks:
          description: '`true` if link clicks are tracked for this program.'
          type: boolean
        activity_metrics:
          $ref: '#/components/schemas/ProgramActivityMetrics'
          description: >
            A `ProgramActivityMetrics` object summarizing engagement for this
            program.


            **Note:** Only present when requested using the `include` query
            parameter.
        program_template:
          $ref: '#/components/schemas/ProgramTemplate'
          description: >
            The `ProgramTemplate` used for messages in this program.


            **Note:** Only present when requested using the `include` query
            parameter.
        created_at:
          description: >-
            Time at which the object was created, as an ISO 8601 timestamp in
            UTC.
          type: string
          format: date-time
        updated_at:
          description: >-
            Time at which the object was last updated, as an ISO 8601 timestamp
            in UTC.
          type: string
          format: date-time
      required:
        - trigger
        - type
        - id
        - status
        - track_opens
        - track_clicks
        - created_at
        - updated_at
    Error:
      title: Error
      description: >-
        The Error object represents a single error that occurred during API
        request processing. It provides detailed information about what went
        wrong, including a unique identifier, status code, and human-readable
        descriptions to help developers understand and resolve the issue.
      type: object
      properties:
        type:
          type: string
          const: error
        id:
          description: A unique identifier for this specific error instance.
          type: string
        status:
          description: The HTTP status code for this problem, as a string.
          type: string
        code:
          description: An application-specific error code string.
          type: string
        title:
          description: A short, human-readable summary of the problem.
          type: string
        detail:
          description: A human-readable explanation of this specific error.
          type: string
        source:
          $ref: '#/components/schemas/ErrorSource'
          description: >-
            An object containing more specific information about the part of the
            request that caused the error.
        meta:
          type: object
          additionalProperties: true
      required:
        - type
    ProgramActivityMetrics:
      title: ProgramActivityMetrics
      description: >-
        The ProgramActivityMetrics object provides a summary of engagement and
        delivery statistics for a marketing program.
      type: object
      properties:
        bounced:
          description: The number of emails that could not be delivered.
          type: integer
        clicked:
          description: The number of recipients who clicked at least one link.
          type: integer
        complained:
          description: The number of recipients who marked the email as spam.
          type: integer
        failed:
          description: The number of emails that failed to send due to a technical issue.
          type: integer
        opened:
          description: The number of recipients who opened the email.
          type: integer
        sent:
          description: The total number of emails successfully sent.
          type: integer
        shielded:
          description: The number of emails blocked by delivery protection rules.
          type: integer
        unsubscribed:
          description: The number of recipients who unsubscribed.
          type: integer
      required:
        - bounced
        - clicked
        - complained
        - failed
        - opened
        - sent
        - shielded
        - unsubscribed
    ErrorSource:
      title: ErrorSource
      description: >-
        The ErrorSource object provides additional context about the specific
        part of an API request that caused an error. It can point to either a
        field in the request document or a query parameter that contains invalid
        data.
      type: object
      properties:
        pointer:
          description: >-
            A JSON Pointer [RFC6901] to the associated entity in the request
            document.
          type: string
        parameter:
          description: A string indicating which URI query parameter caused the error.
          type: string
      required: []
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: Your Moonbase API key.

````