> ## Documentation Index
> Fetch the complete documentation index at: https://www.vobiz.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Export results as CSV

> Downloads every recipient with its send result as a CSV file (`text/csv`), named `broadcast-<id>.csv`.



## OpenAPI

````yaml openapi-sms.yaml GET /broadcasts/{id}/export
openapi: 3.0.3
info:
  title: Vobiz Messaging API
  description: >
    Send and receive SMS, MMS and RCS messages, buy messaging numbers, register
    for

    US 10DLC and toll-free, run broadcasts, manage conversations, opt-outs and
    webhooks.


    **Base URL:** `https://api.vobiz.ai/api/v1/sms`


    **Authentication:** every request needs the `X-Auth-ID` and `X-Auth-Token`
    headers.

    The account is taken from your credentials; you never put an account ID in a
    path or body.

    Field names in this API are camelCase.
  version: '1.0'
  contact:
    email: support@vobiz.ai
    url: https://vobiz.ai
servers:
  - url: https://api.vobiz.ai/api/v1/sms
    description: Production
security:
  - AuthID: []
    AuthToken: []
tags:
  - name: Messages
    description: Send messages and inspect their delivery state.
  - name: Numbers
    description: >-
      Messaging-capable numbers on your account, inventory search, purchase and
      release.
  - name: Coverage
    description: Where you can send, per country.
  - name: Conversations
    description: Two-way threads between one of your numbers and a contact.
  - name: Opt-outs
    description: Numbers that must not receive messages on a channel.
  - name: Webhooks
    description: Subscriptions that deliver message and broadcast events to your server.
  - name: Broadcasts
    description: Bulk sends from an uploaded recipient list.
  - name: RCS Senders
    description: RCS sender (agent) identities and their message templates.
  - name: 10DLC Brands
    description: US 10DLC brand registration.
  - name: 10DLC Campaigns
    description: US 10DLC campaigns, toll-free verification and supporting documents.
paths:
  /broadcasts/{id}/export:
    get:
      tags:
        - Broadcasts
      summary: Export results as CSV
      description: >-
        Downloads every recipient with its send result as a CSV file
        (`text/csv`), named `broadcast-<id>.csv`. The columns are `row`, `to`,
        `status`, `message_id`, `error_code`, `error_message` and `sent_at`,
        followed by one column per column of your upload. Text cells that start
        with `=`, `+`, `-`, `@`, a tab or a carriage return are prefixed with
        `'` so they open safely in spreadsheet applications. You can export a
        broadcast in any status, including a draft, to check the parsed list.
      operationId: export-broadcast
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            The broadcast's `id` (UUID), as returned by `POST /broadcasts` or
            `GET /broadcasts`. An id that is not a UUID, or that belongs to
            another account, returns `404` with `broadcast not found`.
          schema:
            type: string
            format: uuid
          example: 3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35
      responses:
        '200':
          description: The CSV file.
          headers:
            Content-Disposition:
              description: Suggested filename, `broadcast-<id>.csv`.
              schema:
                type: string
              example: >-
                attachment;
                filename="broadcast-3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35.csv"
          content:
            text/csv:
              schema:
                type: string
              example: >
                row,to,status,message_id,error_code,error_message,sent_at,name,amount

                2,+14155550123,sent,9b2e1c40-8a3d-4f5e-9c1a-7d6b2e8f4a01,,,2026-10-12T11:05:10Z,Priya,$42.00

                3,+14155550124,failed,,routing_failed,no route for
                destination,,Sam,$18.50
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: The broadcast does not exist on your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: broadcast not found
      x-codeSamples:
        - lang: typescript
          label: Node SDK
          source: >
            import { VobizClient } from "@vobiz/sdk";


            const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken:
            "YOUR_AUTH_TOKEN" });


            await client.sms.broadcasts.exportBroadcast({
                id: "id"
            })
        - lang: python
          label: Python SDK
          source: |
            from vobiz import Vobiz

            client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

            client.sms.broadcasts.export_broadcast(
                id="id",
            )
        - lang: go
          label: Go SDK
          source: |
            import (
                "context"

                vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
                "github.com/vobiz-ai/Vobiz-Go-SDK/client"
                "github.com/vobiz-ai/Vobiz-Go-SDK/option"
                "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
            )

            c := client.NewClient(
                option.WithAPIKey("MA_XXXXXXXX"),
                option.WithAuthToken("YOUR_AUTH_TOKEN"),
            )

            request := &sms.ExportBroadcastRequest{
                    ID: "id",
                }
            c.Sms.Broadcasts.ExportBroadcast(
                    context.TODO(),
                    request,
                )
        - lang: java
          label: Java SDK
          source: |
            import com.vobiz.api.VobizApiClient;

            VobizApiClient client = VobizApiClient
                .builder()
                .apiKey("MA_XXXXXXXX")
                .authToken("YOUR_AUTH_TOKEN")
                .build();

            client.sms().broadcasts().exportBroadcast(
                "id",
                ExportBroadcastRequest
                    .builder()
                    .build()
            );
        - lang: ruby
          label: Ruby SDK
          source: >
            require 'vobiz'


            client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token:
            'YOUR_AUTH_TOKEN')


            client.sms.broadcasts.export_broadcast(id: "id")
        - lang: csharp
          label: C# SDK
          source: >
            using Vobiz;

            using Vobiz.Sms;


            var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");


            await client.Sms.Broadcasts.ExportBroadcastAsync(new
            ExportBroadcastRequest { Id = "id" });
        - lang: php
          label: PHP SDK
          source: >
            <?php


            require 'vendor/autoload.php';


            use Vobiz\VobizClient;


            $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken:
            'YOUR_AUTH_TOKEN');


            $client->sms->broadcasts->exportBroadcast(
                'id',
            );
components:
  responses:
    Unauthorized:
      description: Missing or invalid `X-Auth-ID` / `X-Auth-Token`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: missing or invalid credentials
  schemas:
    Error:
      type: object
      description: >-
        The body of every error response: a flat object with one `error` string
        that explains what went wrong. Use the HTTP status code to decide how to
        handle the error, and log `error` for diagnosis.
      required:
        - error
      properties:
        error:
          type: string
          example: 'recipient has opted out: +14155550123'
          description: >-
            Human-readable explanation of the error, for example `phoneNumber is
            required` or `recipient has opted out: +14155550123`. Branch on the
            HTTP status code rather than on this text.
  securitySchemes:
    AuthID:
      type: apiKey
      in: header
      name: X-Auth-ID
      description: Your Vobiz account Auth ID (`MA_XXXXXXXX`).
    AuthToken:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: Your Vobiz account Auth Token.

````

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