/customers/export - Export customers to CSV or PDF

GET /customers/export
Bearer auth

Export customers to CSV or PDF format with applied filters (max 10,000 customers)

Query parameters

  • format string Required

    Export format (csv or pdf)

    Values are csv or pdf.

  • sort_by string

    Field to sort customers by

    Values are name, description, created_at, or updated_at.

  • sort_direction string

    Sort direction

    Values are asc or desc. Default value is asc.

Responses

  • 200

    Customers exported successfully
  • 400 application/json

    Bad request - validation error

    Hide response attributes Show response attributes object
    • code integer

      HTTP error code

    • message string

      Error message

    • data object
      Hide data attributes Show data attributes object
      • type string

        Type of error

        Values are validation_error or external_api_error.

      • errors array[object]
        Hide errors attributes Show errors attributes object
        • key string

          Field name that failed validation

        • message string

          Error code or message

        • value string

          Value that failed validation

      • details

        Additional error details
  • 401 application/json

    Unauthorized - invalid or missing token

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object | null
  • 403 application/json

    Forbidden - insufficient permissions

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object | null
GET /customers/export 
curl \
 --request GET 'https://api.your-domain.com/api/customers/export?format=csv' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (400) 
{
  "code": 400,
  "message": "validation failed",
  "data": {
    "type": "validation_error",
    "errors": [
      {
        "key": "username",
        "message": "required",
        "value": "string"
      }
    ]
  }
}
Response examples (401) 
{
  "code": 401,
  "message": "invalid token",
  "data": {}
}
Response examples (403) 
{
  "code": 403,
  "message": "insufficient permissions",
  "data": {}
}