> ## Documentation Index > Fetch the complete documentation index at: https://docs.polymorfa.com/llms.txt > Use this file to discover all available pages before exploring further. # Export campaign recipients > Returns recipients as CSV in queue order. Unfiltered exports page up to 1,000 recipients per request, using the `Polymorfa-Next-Cursor` response header. Each page starts with a header row and reflects outcomes when requested. Filtered exports are one atomic page of up to 1,000 recipients; larger filtered results return 409, so changing statuses cannot silently omit matches between pages. The export contains outcomes and `failureReason` codes only, never message content or template variables. Requires `campaigns:read`. Project tokens only access resources in their own project. ## OpenAPI ````yaml api-reference/features/campaigns.json GET /platform/campaigns/{campaignId}/recipients/export openapi: 3.0.3 info: title: Campaigns API methods version: 1.0.0 description: Task-focused campaigns methods across supported Polymorfa connection types. servers: [] security: [] paths: /platform/campaigns/{campaignId}/recipients/export: get: tags: - Campaigns summary: Export campaign recipients description: >- Returns recipients as CSV in queue order. Unfiltered exports page up to 1,000 recipients per request, using the `Polymorfa-Next-Cursor` response header. Each page starts with a header row and reflects outcomes when requested. Filtered exports are one atomic page of up to 1,000 recipients; larger filtered results return 409, so changing statuses cannot silently omit matches between pages. The export contains outcomes and `failureReason` codes only, never message content or template variables. Requires `campaigns:read`. Project tokens only access resources in their own project. operationId: managementExportCampaignRecipients parameters: - name: campaignId in: path required: true schema: type: string description: Identifier for the campaign. - name: projectId in: query required: false description: >- Project the campaign belongs to. Required with a team API key; a project token is bound to its own project and omits it. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uuid` | schema: type: string format: uuid description: >- Project that owns the campaign. Required for team API keys; a project token is bound to its own project. - schema: type: string enum: - queued - sending - sent - delivered - read - failed - skipped required: false name: status in: query description: |- Current status of this resource or operation. **Allowed values** | Value | Meaning | | --- | --- | | `queued` | Queued. | | `sending` | Sending. | | `sent` | Sent. | | `delivered` | Delivered. | | `read` | Read. | | `failed` | Failed. | | `skipped` | Skipped. | - name: reason in: query required: false description: |- Only recipients whose `failureReason` is this code. **Allowed values** | Value | Meaning | | --- | --- | | `opted_out` | Opted out. | | `cold_held` | Cold held. | | `campaign_cancelled` | Campaign cancelled. | | `invalid_recipient` | Invalid recipient. | | `session_not_connected` | Session not connected. | | `ack_timeout` | Ack timeout. | | `blocked_by_safety` | Blocked by safety. | | `send_failed` | Send failed. | | `missing_variable` | Missing variable. | | `other` | Other. | schema: $ref: '#/components/schemas/management__CampaignRecipientFailureReason' - schema: type: string minLength: 1 maxLength: 256 description: >- The `Polymorfa-Next-Cursor` value from the previous unfiltered page. Filtered exports cannot be paged. required: false name: cursor in: query description: |- Specifies cursor for this query parameter. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | `1` through `256` characters | - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 1000 default: 1000 description: >- Recipients per unfiltered page, up to 1,000. Filtered exports require 1,000. description: |- Specifies limit for this query parameter. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `1` through `1000` (inclusive) | responses: '200': description: One CSV page. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. X-Trace-Id: schema: type: string pattern: ^[0-9a-f]{32}$ description: >- W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one. Polymorfa-Version: schema: type: string description: API version applied to this response. Polymorfa-Next-Cursor: schema: type: string description: Cursor for the next page. Absent on the last page. content: text/csv: schema: type: string description: >- Header row, then one row per recipient. Columns: recipientId, phone, status, failureReason, attempts, variantKey, queuedAt, sentAt, deliveredAt, readAt, failedAt, respondedAt. Times are ISO 8601 in UTC. Empty fields are null. Text that begins with =, +, -, @, tab or carriage return is prefixed with an apostrophe, including phone numbers in international format. Machine readers should remove that leading apostrophe from phone cells. '400': $ref: '#/components/responses/management__BadRequest' '401': $ref: '#/components/responses/management__Unauthorized' '403': $ref: '#/components/responses/management__Forbidden' '404': $ref: '#/components/responses/management__NotFound' '409': $ref: '#/components/responses/management__Conflict' security: - management__ApiKeyAuth: [] servers: - url: https://api.polymorfa.com components: schemas: management__CampaignRecipientFailureReason: type: string enum: - opted_out - cold_held - campaign_cancelled - invalid_recipient - session_not_connected - ack_timeout - blocked_by_safety - send_failed - missing_variable - other description: >- Why the recipient was not sent, or why its last attempt did not succeed. Null when nothing went wrong. `opted_out`: the number is on the team's opt-out list. `cold_held`: the number never wrote to the sending number and the campaign holds cold sends. `campaign_cancelled`: the campaign was stopped before this recipient was sent. `invalid_recipient`: the number is not a valid WhatsApp address. `session_not_connected`: the sending number was not connected. `ack_timeout`: WhatsApp did not acknowledge the send in time. `blocked_by_safety`: a safety check refused the send before it was attempted; the recipient waits for the campaign to resume. `send_failed`: WhatsApp refused the send, or its outcome could not be confirmed. `missing_variable`: the campaign was launched with `skipMissingVariables` and the recipient had no value and no fallback for a variable. `other`: any other reason. New codes may be added. management__ErrorEnvelope: type: object required: - error - data - docs properties: error: type: object required: - type - code - message - param - request_id properties: type: type: string enum: - invalid_request_error - authentication_error - permission_error - conflict_error - rate_limit_error - api_error - upstream_error description: |- Type discriminator for this object. **Allowed values** | Value | Meaning | | --- | --- | | `invalid_request_error` | Invalid request error. | | `authentication_error` | Authentication error. | | `permission_error` | Permission error. | | `conflict_error` | Conflict error. | | `rate_limit_error` | Rate limit error. | | `api_error` | Api error. | | `upstream_error` | Upstream error. | code: type: string description: Stable failure code. Use this value for programmatic handling. message: type: string description: Safe explanation of the failure. param: type: string nullable: true description: |- Invalid request field, or null when no field applies. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | request_id: type: string description: >- Matches the X-Request-Id response header. Include it when you contact support. request_log_url: type: string format: uri description: >- Console page that shows this request. Returned only to organization and project credentials whose request was logged. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uri` | description: Error details returned when the operation fails. data: type: string nullable: true enum: - null description: |- Always null for a failed request. **Allowed values** | Value | Meaning | | --- | --- | | `null` | Null. | **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | docs: type: string format: uri description: |- Documentation link to this failure code. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uri` | responses: management__BadRequest: description: A path, query, or request-body value did not pass validation. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. X-Trace-Id: schema: type: string pattern: ^[0-9a-f]{32}$ description: >- W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' management__Unauthorized: description: Missing/invalid credential for this audience. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. X-Trace-Id: schema: type: string pattern: ^[0-9a-f]{32}$ description: >- W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' management__Forbidden: description: Authenticated but lacks the required scope/role/audience. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. X-Trace-Id: schema: type: string pattern: ^[0-9a-f]{32}$ description: >- W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' management__NotFound: description: >- The requested resource was not found inside the authenticated team or project scope. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. X-Trace-Id: schema: type: string pattern: ^[0-9a-f]{32}$ description: >- W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' management__Conflict: description: The request conflicts with the resource's current state. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. X-Trace-Id: schema: type: string pattern: ^[0-9a-f]{32}$ description: >- W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' securitySchemes: management__ApiKeyAuth: type: http scheme: bearer description: >- Send your team API key or project token as `Authorization: Bearer `. The credential must have the required permissions. Project tokens can access only their own project. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.