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

# Create Contact Export

> Create a tracked CSV export of contacts and queue it for background processing.
Requires an administrator or a user with the `contact_manage` permission.

Send export options only in the JSON request body. Query-string parameters are
ignored: they neither supply options nor override body values. An empty body
uses the default columns and exports all resolved contacts in the account.
Unknown body options and invalid option values return 422 without creating
an export or queuing a job.




## OpenAPI

````yaml https://raw.githubusercontent.com/chatwoot/chatwoot/develop/swagger/tag_groups/application_swagger.json post /api/v1/accounts/{account_id}/data_exports
openapi: 3.1.0
info:
  title: Chatwoot
  description: This is the API documentation for Chatwoot server.
  version: 1.1.0
  termsOfService: https://www.chatwoot.com/terms-of-service/
  contact:
    email: hello@chatwoot.com
  license:
    name: MIT License
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://app.chatwoot.com/
security: []
tags:
  - name: Account AgentBots
    description: Account-specific Agent Bots
  - name: Agents
    description: Agent management APIs
  - name: Campaigns
    description: >-
      Create, schedule, and manage campaigns. Requires an account administrator
      and API access enabled for the account.
  - name: Canned Responses
    description: Pre-defined responses for common queries
  - name: Contacts
    description: Contact management APIs
  - name: Contact Labels
    description: Manage contact labels
  - name: Conversation Assignments
    description: Manage conversation assignments
  - name: Conversation Labels
    description: Manage conversation labels
  - name: Conversations
    description: Conversation management APIs
  - name: Custom Attributes
    description: Custom fields for contacts and conversations
  - name: Custom Filters
    description: Saved filters for conversations
  - name: Inboxes
    description: Communication channels setup
  - name: Integrations
    description: Third-party integrations
  - name: Labels
    description: Account label management APIs
  - name: Messages
    description: Message management APIs
  - name: Profile
    description: User profile APIs
  - name: Reports
    description: Analytics and reporting APIs
  - name: Teams
    description: Team management APIs
  - name: Webhooks
    description: Event notification webhooks
  - name: Automation Rule
    description: Workflow automation rules
  - name: Help Center
    description: Knowledge base management
paths:
  /api/v1/accounts/{account_id}/data_exports:
    parameters:
      - $ref: '#/components/parameters/account_id'
    post:
      tags:
        - Contacts
      summary: Create Contact Export
      description: >
        Create a tracked CSV export of contacts and queue it for background
        processing.

        Requires an administrator or a user with the `contact_manage`
        permission.


        Send export options only in the JSON request body. Query-string
        parameters are

        ignored: they neither supply options nor override body values. An empty
        body

        uses the default columns and exports all resolved contacts in the
        account.

        Unknown body options and invalid option values return 422 without
        creating

        an export or queuing a job.
      operationId: contactExportCreate
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                column_names:
                  type: array
                  description: >-
                    Contact column names to export. Omitted or empty uses the
                    default columns.
                  items:
                    type: string
                  default:
                    - id
                    - name
                    - email
                    - phone_number
                    - labels
                payload:
                  type: array
                  description: >-
                    Contact filters, using the same format as POST
                    /contacts/filter. A non-empty payload takes precedence over
                    label.
                  items:
                    type: object
                    additionalProperties: false
                    required:
                      - attribute_key
                      - filter_operator
                      - values
                    properties:
                      attribute_key:
                        type: string
                      attribute_model:
                        type:
                          - string
                          - 'null'
                      filter_operator:
                        type: string
                      query_operator:
                        type:
                          - string
                          - 'null'
                      custom_attribute_type:
                        type:
                          - string
                          - 'null'
                      values:
                        type: array
                        description: >-
                          Values must match the selected attribute and operator;
                          text attributes require strings.
                        items:
                          type:
                            - string
                            - number
                            - boolean
                      timezone:
                        type: string
                        description: IANA timezone for date filters. Omit to use UTC.
                label:
                  type: string
                  description: >-
                    An existing account label to select contacts when payload is
                    absent or empty. Empty selects all resolved contacts.
                scope_name:
                  type: string
                  description: Display name for the selection. Does not filter contacts.
            example:
              column_names:
                - name
                - email
                - phone_number
              payload:
                - attribute_key: email
                  filter_operator: contains
                  values:
                    - example.com
                  query_operator: null
              scope_name: Example customers
      responses:
        '200':
          description: >-
            Export created and queued. The CSV becomes downloadable after
            processing completes.
          content:
            application/json:
              schema:
                type: object
                required:
                  - id
                  - name
                  - data_type
                  - status
                  - export_options
                  - processed_records
                  - downloadable
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                    example: Contacts - 2026-11-09
                  data_type:
                    type: string
                    enum:
                      - contacts
                  status:
                    type: string
                    enum:
                      - pending
                      - processing
                      - completed
                      - failed
                  export_options:
                    type: object
                    description: >-
                      Validated body options with default columns filled in and
                      duplicate columns removed.
                  processed_records:
                    type: integer
                  total_records:
                    type:
                      - integer
                      - 'null'
                  error_message:
                    type:
                      - string
                      - 'null'
                  initiated_by:
                    type:
                      - object
                      - 'null'
                    properties:
                      id:
                        type: integer
                      name:
                        type: string
                      email:
                        type: string
                  created_at:
                    type: string
                    format: date-time
                  updated_at:
                    type: string
                    format: date-time
                  started_at:
                    type:
                      - string
                      - 'null'
                    format: date-time
                  completed_at:
                    type:
                      - string
                      - 'null'
                    format: date-time
                  artifacts_expired_at:
                    type:
                      - string
                      - 'null'
                    format: date-time
                  stalled:
                    type: boolean
                  downloadable:
                    type: boolean
                  can_rerun:
                    type: boolean
        '401':
          description: >-
            Authentication required or insufficient permission to export
            contacts.
        '422':
          description: Invalid export options. No export is created or queued.
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                properties:
                  message:
                    type: string
                    example: 'Unsupported export options: unexpected.'
      security:
        - userBearerAuth: []
        - userApiKey: []
components:
  parameters:
    account_id:
      in: path
      name: account_id
      schema:
        type: integer
      required: true
      description: The numeric ID of the account
  securitySchemes:
    userBearerAuth:
      type: http
      scheme: bearer
      description: >-
        Authenticate with `Authorization: Bearer <token>` using a user API token
        from **Profile Settings**. Available in Chatwoot `v4.19.0` and later.
    userApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: >-
        Find your API token in **Profile Settings**. The `api_access_token`
        header remains supported, but will be deprecated in a future release.
        For new integrations, use Bearer authentication.

````

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