Mailchimp Exports API

swagger: '2.0'
info:
  version: 3.0.55
  title: Mailchimp Marketing Abuse Exports API
  contact:
    name: Mailchimp API Support
    email: apihelp@mailchimp.com
  x-permalink: https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/main/spec/marketing.json
  description: '

    The Mailchimp Marketing API provides programmatic access to Mailchimp data

    and functionality, allowing developers to build custom features to do

    things like sync email activity and campaign analytics with their

    database, manage audiences and campaigns, and more.'
host: server.api.mailchimp.com
basePath: /3.0
schemes:
- https
consumes:
- application/json
produces:
- application/json
- application/problem+json
security:
- basicAuth: []
tags:
- name: Exports
paths:
  /account-exports:
    get:
      summary: Mailchimp List Account Exports
      description: Get a list of account exports for a given account.
      operationId: getAccountExports
      parameters:
      - name: fields
        x-title: Fields
        in: query
        description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
        required: false
        type: array
        collectionFormat: csv
        items:
          type: string
        example: example_value
      - name: exclude_fields
        x-title: Exclude Fields
        in: query
        description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
        required: false
        type: array
        collectionFormat: csv
        items:
          type: string
        example: example_value
      - name: count
        x-title: Count
        in: query
        description: The number of records to return. Default value is 10. Maximum value is 1000
        required: false
        default: 10
        maximum: 1000
        type: integer
        example: example_value
      - name: offset
        x-title: Offset
        in: query
        description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
        required: false
        default: 0
        type: integer
        example: example_value
      responses:
        '200':
          description: ''
          schema:
            type: object
            description: An array of objects, each representing an account export.
            properties:
              exports:
                title: Account Exports
                description: An array of objects, each representing an account export.
                type: array
                items:
                  type: object
                  description: An account export.
                  properties:
                    export_id:
                      type: integer
                      title: Export ID
                      description: The ID for the export.
                    started:
                      type: string
                      format: date-time
                      title: Start Time
                      description: Start time for the export.
                    finished:
                      type: string
                      format: date-time
                      title: Finish Time
                      description: If finished, the finish time for the export.
                    size_in_bytes:
                      type: integer
                      title: Export Size
                      description: The size of the uncompressed export in bytes.
                    download_url:
                      type: string
                      title: Download URL
                      description: If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes.
                    _links:
                      title: Links
                      description: A list of link types and descriptions for the API schema documents.
                      type: array
                      items:
                        type: object
                        title: Resource Link
                        description: This object represents a link from the resource where it is found to another resource or action that may be performed.
                        properties:
                          rel:
                            type: string
                            title: Rel
                            description: As with an HTML 'rel' attribute, this describes the type of link.
                            readOnly: true
                          href:
                            type: string
                            title: Href
                            description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
                            readOnly: true
                          method:
                            type: string
                            title: Method
                            description: The HTTP method that should be used when accessing the URL defined in 'href'.
                            enum:
                            - GET
                            - POST
                            - PUT
                            - PATCH
                            - DELETE
                            - OPTIONS
                            - HEAD
                            readOnly: true
                          targetSchema:
                            type: string
                            title: Target Schema
                            description: For GETs, this is a URL representing the schema that the response should conform to.
                            readOnly: true
                          schema:
                            type: string
                            title: Schema
                            description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
                            readOnly: true
                      readOnly: true
              total_items:
                type: integer
                title: Item Count
                description: The total number of items matching the query regardless of pagination.
                readOnly: true
              _links:
                title: Links
                description: A list of link types and descriptions for the API schema documents.
                type: array
                items:
                  type: object
                  title: Resource Link
                  description: This object represents a link from the resource where it is found to another resource or action that may be performed.
                  properties:
                    rel:
                      type: string
                      title: Rel
                      description: As with an HTML 'rel' attribute, this describes the type of link.
                      readOnly: true
                    href:
                      type: string
                      title: Href
                      description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
                      readOnly: true
                    method:
                      type: string
                      title: Method
                      description: The HTTP method that should be used when accessing the URL defined in 'href'.
                      enum:
                      - GET
                      - POST
                      - PUT
                      - PATCH
                      - DELETE
                      - OPTIONS
                      - HEAD
                      readOnly: true
                    targetSchema:
                      type: string
                      title: Target Schema
                      description: For GETs, this is a URL representing the schema that the response should conform to.
                      readOnly: true
                    schema:
                      type: string
                      title: Schema
                      description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
                      readOnly: true
                readOnly: true
        default:
          description: An error generated by the Mailchimp API.
          schema:
            type: object
            title: Problem Detail Document
            description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.
            required:
            - type
            - title
            - status
            - detail
            - instance
            properties:
              type:
                type: string
                title: Problem Type
                description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
                example: https://mailchimp.com/developer/marketing/docs/errors/
              title:
                type: string
                title: Error Title
                description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.
                example: Resource Not Found
              status:
                type: integer
                title: HTTP Status Code
                description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
                example: 404
              detail:
                type: string
                title: Error Message
                description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).
                example: The requested resource could not be found.
              instance:
                type: string
                title: Instance ID
                description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
                example: 995c5cb0-3280-4a6e-808b-3b096d0bb219
      deprecated: false
      tags:
      - Exports
      x-custom-config:
        methodNameSnake: list_account_exports
        methodNameCamel: listAccountExports
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      summary: Mailchimp Add Export
      description: Create a new account export in your Mailchimp account.
      operationId: postAccountExport
      parameters:
      - name: body
        in: body
        required: true
        schema:
          type: object
          title: Create an account export
          description: Creates an account export with the given parameters.
          required:
          - include_stages
          properties:
            include_stages:
              type: array
              title: Include Stages
              description: The stages of an account export to include.
              example: '["audiences", "gallery_files"]'
              items:
                type: string
                enum:
                - audiences
                - campaigns
                - events
                - gallery_files
                - reports
                - templates
            since_timestamp:
              type: string
              title: Since Timestamp
              format: date-time
              description: An ISO 8601 date that will limit the export to only records created after a given time. For instance, the reports stage will contain any campaign sent after the given timestamp. Audiences, however, are excluded from this limit.
              example: '2021-08-23T14:15:09Z'
        example: example_value
      responses:
        '200':
          description: ''
          schema:
            type: object
            description: An account export.
            properties:
              export_id:
                type: integer
                title: Export ID
                description: The ID for the export.
              started:
                type: string
                format: date-time
                title: Start Time
                description: Start time for the export.
              finished:
                type: string
                format: date-time
                title: Finish Time
                description: If finished, the finish time for the export.
              size_in_bytes:
                type: integer
                title: Export Size
                description: The size of the uncompressed export in bytes.
              download_url:
                type: string
                title: Download URL
                description: If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes.
              _links:
                title: Links
                description: A list of link types and descriptions for the API schema documents.
                type: array
                items:
                  type: object
                  title: Resource Link
                  description: This object represents a link from the resource where it is found to another resource or action that may be performed.
                  properties:
                    rel:
                      type: string
                      title: Rel
                      description: As with an HTML 'rel' attribute, this describes the type of link.
                      readOnly: true
                    href:
                      type: string
                      title: Href
                      description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
                      readOnly: true
                    method:
                      type: string
                      title: Method
                      description: The HTTP method that should be used when accessing the URL defined in 'href'.
                      enum:
                      - GET
                      - POST
                      - PUT
                      - PATCH
                      - DELETE
                      - OPTIONS
                      - HEAD
                      readOnly: true
                    targetSchema:
                      type: string
                      title: Target Schema
                      description: For GETs, this is a URL representing the schema that the response should conform to.
                      readOnly: true
                    schema:
                      type: string
                      title: Schema
                      description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
                      readOnly: true
                readOnly: true
        default:
          description: An error generated by the Mailchimp API.
          schema:
            type: object
            title: Problem Detail Document
            description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.
            required:
            - type
            - title
            - status
            - detail
            - instance
            properties:
              type:
                type: string
                title: Problem Type
                description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
                example: https://mailchimp.com/developer/marketing/docs/errors/
              title:
                type: string
                title: Error Title
                description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.
                example: Resource Not Found
              status:
                type: integer
                title: HTTP Status Code
                description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
                example: 404
              detail:
                type: string
                title: Error Message
                description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).
                example: The requested resource could not be found.
              instance:
                type: string
                title: Instance ID
                description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
                example: 995c5cb0-3280-4a6e-808b-3b096d0bb219
      deprecated: false
      tags:
      - Exports
      x-custom-config:
        methodNameSnake: create_account_export
        methodNameCamel: createAccountExport
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /account-exports/{export_id}:
    get:
      summary: Mailchimp Get Account Export Info
      description: Get information about a specific account export.
      operationId: getAccountExportId
      parameters:
      - name: fields
        x-title: Fields
        in: query
        description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
        required: false
        type: array
        collectionFormat: csv
        items:
          type: string
        example: example_value
      - name: exclude_fields
        x-title: Exclude Fields
        in: query
        description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
        required: false
        type: array
        collectionFormat: csv
        items:
          type: string
        example: example_value
      - in: path
        name: export_id
        x-title: Export ID
        type: string
        required: true
        description: The unique id for the account export.
        example: '500123'
      responses:
        '200':
          description: ''
          schema:
            type: object
            description: An account export.
            properties:
              export_id:
                type: integer
                title: Export ID
                description: The ID for the export.
              started:
                type: string
                format: date-time
                title: Start Time
                description: Start time for the export.
              finished:
                type: string
                format: date-time
                title: Finish Time
                description: If finished, the finish time for the export.
              size_in_bytes:
                type: integer
                title: Export Size
                description: The size of the uncompressed export in bytes.
              download_url:
                type: string
                title: Download URL
                description: If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes.
              _links:
                title: Links
                description: A list of link types and descriptions for the API schema documents.
                type: array
                items:
                  type: object
                  title: Resource Link
                  description: This object represents a link from the resource where it is found to another resource or action that may be performed.
                  properties:
                    rel:
                      type: string
                      title: Rel
                      description: As with an HTML 'rel' attribute, this describes the type of link.
                      readOnly: true
                    href:
                      type: string
                      title: Href
                      description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
                      readOnly: true
                    method:
                      type: string
                      title: Method
                      description: The HTTP method that should be used when accessing the URL defined in 'href'.
                      enum:
                      - GET
                      - POST
                      - PUT
                      - PATCH
                      - DELETE
                      - OPTIONS
                      - HEAD
                      readOnly: true
                    targetSchema:
                      type: string
                      title: Target Schema
                      description: For GETs, this is a URL representing the schema that the response should conform to.
                      readOnly: true
                    schema:
                      type: string
                      title: Schema
                      description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
                      readOnly: true
                readOnly: true
        default:
          description: An error generated by the Mailchimp API.
          schema:
            type: object
            title: Problem Detail Document
            description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.
            required:
            - type
            - title
            - status
            - detail
            - instance
            properties:
              type:
                type: string
                title: Problem Type
                description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
                example: https://mailchimp.com/developer/marketing/docs/errors/
              title:
                type: string
                title: Error Title
                description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.
                example: Resource Not Found
              status:
                type: integer
                title: HTTP Status Code
                description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
                example: 404
              detail:
                type: string
                title: Error Message
                description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).
                example: The requested resource could not be found.
              instance:
                type: string
                title: Instance ID
                description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
                example: 995c5cb0-3280-4a6e-808b-3b096d0bb219
      deprecated: false
      tags:
      - Exports
      x-custom-config:
        methodNameSnake: get_account_exports
        methodNameCamel: getAccountExports
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /exports/info:
    post:
      operationId: postExportsInfo
      summary: Mailchimp Get Export Info
      description: Get information about an individual data export job.
      tags:
      - Exports
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - key
              - id
              properties:
                key:
                  type: string
                  description: A valid Mandrill API key.
                id:
                  type: string
                  description: The unique identifier for the export job.
            examples:
              PostexportsinfoRequestExample:
                summary: Default postExportsInfo request
                x-microcks-default: true
                value:
                  key: example_value
                  id: abc123
      responses:
        '200':
          description: The export job details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportJob'
              examples:
                Postexportsinfo200Example:
                  summary: Default postExportsInfo 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    created_at: '2026-01-15T10:30:00Z'
                    type: activity
                    finished_at: '2026-01-15T10:30:00Z'
                    state: waiting
                    result_url: https://www.example.com
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/InvalidKeyError'
        '500':
          $ref: '#/components/responses/GeneralError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /exports/list:
    post:
      operationId: postExportsList
      summary: Mailchimp List Exports
      description: Get a list of all data export jobs for the account.
      tags:
      - Exports
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - key
              properties:
                key:
                  type: string
                  description: A valid Mandrill API key.
            examples:
              PostexportslistRequestExample:
                summary: Default postExportsList request
                x-microcks-default: true
                value:
                  key: example_value
      responses:
        '200':
          description: An array of export job objects.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExportJob'
              examples:
                Postexportslist200Example:
                  summary: Default postExportsList 200 response
                  x-microcks-default: true
                  value:
                  - id: abc123
                    created_at: '2026-01-15T10:30:00Z'
                    type: activity
                    finished_at: '2026-01-15T10:30:00Z'
                    state: waiting
                    result_url: https://www.example.com
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/InvalidKeyError'
        '500':
          $ref: '#/components/responses/GeneralError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /exports/rejects:
    post:
      operationId: postExportsRejects
      summary: Mailchimp Export Rejections
      description: Start a new export job for the account's rejection blacklist. When complete, a download URL is provided.
      tags:
      - Exports
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - key
              properties:
                key:
                  type: string
                  description: A valid Mandrill API key.
                notify_email:
                  type: string
                  format: email
                  description: Email address to notify when the export is ready.
            examples:
              PostexportsrejectsRequestExample:
                summary: Default postExportsRejects request
                x-microcks-default: true
                value:
                  key: example_value
                  notify_email: user@example.com
      responses:
        '200':
          description: The export job details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportJob'
              examples:
                Postexportsrejects200Example:
                  summary: Default postExportsRejects 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    created_at: '2026-01-15T10:30:00Z'
                    type: activity
                    finished_at: '2026-01-15T10:30:00Z'
                    state: waiting
                    result_url: https://www.example.com
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/InvalidKeyError'
        '500':
          $ref: '#/components/responses/GeneralError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /exports/allowlist:
    post:
      operationId: postExportsAllowlist
      summary: Mailchimp Export Allowlist
      description: Start a new export job for the account's allowlist. When complete, a download URL is provided.
      tags:
      - Exports
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - key
              properties:
                key:
                  type: string
                  description: A valid Mandrill API key.
                notify_email:
                  type: string
                  format: email
                  description: Email address to notify when the export is ready.
            examples:
              PostexportsallowlistRequestExample:
                summary: Default postExportsAllowlist request
                x-microcks-default: true
                value:
                  key: example_value
                  notify_email: user@example.com
      responses:
        '200':
          description: The export job details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportJob'
              examples:
                Postexportsallowlist200Example:
                  summary: Default postExportsAllowlist 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    created_at: '2026-01-15T10:30:00Z'
                    type: activity
                    finished_at: '2026-01-15T10:30:00Z'
                    state: waiting
                    result_url: https://www.example.com
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/InvalidKeyError'
        '500':
          $ref: '#/components/responses/GeneralError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /exports/activity:
    post:
      operationId: postExportsActivity
      summary: Mailchimp Export Message Activity
      description: Start a new export job for message activity history. The export includes detailed message logs for the specified date range.
      tags:
      - Exports
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - key
              properties:
                key:
                  type: string
                  description: A valid Mandrill API key.
                notify_email:
                  type: string
                  format: email
                  description: Email address to notify when the export is ready.
                date_from:
                  type: string
                  format: date-time
                  description: Start date for the activity export (UTC).
                date_to:
                  type: string
                  format: date-time
                  description: End date for the activity export (UTC).
                tags:
                  type: array
                  items:
                    type: string
                  description: Tags to filter the activity export.
                senders

# --- truncated at 32 KB (62 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mailchimp/refs/heads/main/openapi/mailchimp-exports-api-openapi.yml