find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/listmonk-transactional-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Listmonk Transactional API
  version: '1.0'
  description: 'Operations tagged Transactional across 2 of this provider''s published API definitions: listmonk-collections-openapi.yml, listmonk-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- description: Listmonk Developement Server
  url: http://localhost:9000/api
- url: '{host}/api'
  description: Self-hosted instance
  variables:
    host:
      default: http://localhost:9000
      description: Base URL of your listmonk instance
tags:
- name: Transactional
  description: Transactional API
  externalDocs:
    url: https://listmonk.app/docs/apis/transactional/
paths:
  /tx:
    post:
      tags:
      - Transactional
      description: send message to a subscriber
      operationId: transactWithSubscriber
      requestBody:
        description: email message to a subscriber
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransactionalMessage'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: boolean
    servers:
    - description: Listmonk Developement Server
      url: http://localhost:9000/api
components:
  schemas:
    TransactionalMessage:
      type: object
      properties:
        subscriber_email:
          type: string
        subscriber_id:
          type: integer
        template_id:
          type: integer
        from_email:
          type: string
        data:
          type: object
        headers:
          type: array
          items:
            type: object
        messenger:
          type: string
        content_type:
          type: string
    TransactionalRequest:
      type: object
      properties:
        subscriber_email:
          type: string
          format: email
        subscriber_id:
          type: integer
        subscriber_emails:
          type: array
          items:
            type: string
        subscriber_ids:
          type: array
          items:
            type: integer
        template_id:
          type: integer
        subscriber_mode:
          type: string
          enum:
          - default
          - fallback
          - external
        from_email:
          type: string
        subject:
          type: string
        data:
          type: object
          additionalProperties: true
          description: Custom variables available in templates via {{ .Tx.Data.* }}.
        headers:
          type: array
          items:
            type: object
            additionalProperties:
              type: string
        messenger:
          type: string
          default: email
        content_type:
          type: string
          enum:
          - html
          - markdown
          - plain
        altbody:
          type: string
      required:
      - template_id
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: HTTP Basic auth using an API user name and token (api_user:token).
    TokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: 'Authorization header in the form: token api_user:token.'
x-refined-from:
- listmonk-collections-openapi.yml
- listmonk-openapi.yml