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-import-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 Import API
  version: '1.0'
  description: 'Operations tagged Import 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: Import
  description: Import API
  externalDocs:
    url: https://listmonk.app/docs/apis/lists/
paths:
  /import/subscribers:
    get:
      description: returns import status.
      operationId: getImportSubscribers
      tags:
      - Import
      responses:
        '200':
          description: import status
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ImportStatus'
    post:
      description: handles the uploading and bulk importing of a ZIP file of one or more CSV files.
      operationId: importSubscribers
      tags:
      - Import
      requestBody:
        description: uploads and bulk imports of compressed CSV files
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                params:
                  type: string
                  description: JSON string containing import parameters for more detail https://listmonk.app/docs/apis/import/#params-json-string
                  example: '{"mode":"subscribe", "subscription_status":"confirmed", "delim":",", "lists":[1, 2], "overwrite": true}'
                file:
                  type: string
                  format: binary
                  description: File for upload.
      responses:
        '200':
          description: updated import status
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ImportStatus'
    delete:
      description: sends a stop signal to the importer.
      operationId: stopImportSubscribers
      tags:
      - Import
      responses:
        '200':
          description: response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ImportStatus'
    servers:
    - description: Listmonk Developement Server
      url: http://localhost:9000/api
  /import/subscribers/logs:
    get:
      description: returns import logs from an ongoing import
      operationId: getImportSubscriberLogs
      tags:
      - Import
      responses:
        '200':
          description: import statistics
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: string
    servers:
    - description: Listmonk Developement Server
      url: http://localhost:9000/api
components:
  schemas:
    ImportStatus:
      type: object
      properties:
        data:
          type: object
          properties:
            name:
              type: string
            total:
              type: integer
            imported:
              type: integer
            status:
              type: string
  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