> ## Documentation Index > Fetch the complete documentation index at: https://docs.brudcast.com/llms.txt > Use this file to discover all available pages before exploring further. # Start a contact export > Queues an export of the contacts matching the filter. The 201 confirms only that the job was queued: the file is written by a background worker, so poll the export by id until `status` is completed, then call the download endpoint. Requires the `contacts:write` scope. ## OpenAPI ````yaml /api-reference/openapi.json post /api/v1/user/contact-exports openapi: 3.0.0 info: title: Brudcast API version: 1.0.0 servers: - url: https://core-service.prod.brudcast.com description: Production security: [] tags: - name: Analytics x-displayName: Analytics - name: Campaigns x-displayName: Campaigns - name: Contacts x-displayName: Contacts - name: Mailboxes x-displayName: Mailboxes - name: Messages x-displayName: Messages - name: Sender Identities x-displayName: Sender Identities - name: Sending Domains x-displayName: Sending Domains - name: Templates x-displayName: Templates - name: Webhooks x-displayName: Webhooks paths: /api/v1/user/contact-exports: post: tags: - Contacts summary: Start a contact export description: >- Queues an export of the contacts matching the filter. The 201 confirms only that the job was queued: the file is written by a background worker, so poll the export by id until `status` is completed, then call the download endpoint. Requires the `contacts:write` scope. parameters: - in: header name: X-Organization-Id required: false description: >- Required when authenticating with an access token. Optional with an API key, whose own organization binding is authoritative; a value contradicting it is refused with 403. schema: type: string format: uuid requestBody: content: application/json: schema: type: object properties: format: enum: - csv - json filter: type: object properties: type: enum: - all - active - list - segment listId: type: string format: uuid segmentId: type: string format: uuid required: - type additionalProperties: false fields: type: array items: type: string minLength: 1 minItems: 1 required: - format - filter - fields additionalProperties: false responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/ContactExportDataResponse' '401': description: The credential is missing, malformed, revoked or expired content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: >- The key lacks the scope the endpoint requires, or the organization does not match the credential content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: The payload or query string failed validation content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' '429': description: >- Rate limit exceeded; retry after the number of seconds in `retryAfter` content: application/json: schema: $ref: '#/components/schemas/RateLimitErrorResponse' security: - apiKey: [] - apiKeyBearer: [] components: schemas: ContactExportDataResponse: type: object properties: success: type: boolean example: true message: type: string data: $ref: '#/components/schemas/ContactExportData' required: - success - message - data ErrorResponse: type: object properties: success: type: boolean example: false message: type: string example: Resource not found code: type: string enum: - E_VALIDATION_ERROR - E_UNAUTHORIZED_ACCESS - E_UNAUTHORIZED - E_FORBIDDEN - E_INSUFFICIENT_SCOPE - E_ROW_NOT_FOUND - E_TOO_MANY_REQUESTS - E_BUSINESS_RULE_VIOLATION - E_CAMPAIGN_NOT_SENDABLE - INSUFFICIENT_CREDITS - SUBSCRIPTION_REQUIRED example: E_ROW_NOT_FOUND required: - success - message - code ValidationErrorResponse: type: object properties: success: type: boolean example: false message: type: string example: The payload is invalid code: type: string enum: - E_VALIDATION_ERROR - E_UNAUTHORIZED_ACCESS - E_UNAUTHORIZED - E_FORBIDDEN - E_INSUFFICIENT_SCOPE - E_ROW_NOT_FOUND - E_TOO_MANY_REQUESTS - E_BUSINESS_RULE_VIOLATION - E_CAMPAIGN_NOT_SENDABLE - INSUFFICIENT_CREDITS - SUBSCRIPTION_REQUIRED example: E_VALIDATION_ERROR errors: type: array items: $ref: '#/components/schemas/ValidationErrorItem' required: - success - message - code - errors RateLimitErrorResponse: type: object properties: success: type: boolean example: false message: type: string example: Too many requests code: type: string enum: - E_VALIDATION_ERROR - E_UNAUTHORIZED_ACCESS - E_UNAUTHORIZED - E_FORBIDDEN - E_INSUFFICIENT_SCOPE - E_ROW_NOT_FOUND - E_TOO_MANY_REQUESTS - E_BUSINESS_RULE_VIOLATION - E_CAMPAIGN_NOT_SENDABLE - INSUFFICIENT_CREDITS - SUBSCRIPTION_REQUIRED example: E_TOO_MANY_REQUESTS retryAfter: type: number example: 60 required: - success - message - code - retryAfter ContactExportData: type: object properties: export: $ref: '#/components/schemas/ContactExport' required: - export ValidationErrorItem: type: object properties: field: type: string example: emailAddress rule: type: string example: email message: type: string example: The emailAddress field must be a valid email address required: - field - rule - message ContactExport: type: object properties: id: type: string format: uuid organizationId: type: string format: uuid format: type: string enum: - csv - json filter: type: object additionalProperties: true description: >- The contact filter the export was requested with, echoed back as submitted fields: type: array items: type: string description: Contact fields written to the file description: type: string nullable: true example: 'List: Newsletter' description: >- Readable label for the filter, resolved when the export was requested so it survives a later rename or deletion of the list or segment it names totalContacts: type: number description: Contacts written to the file, 0 until processing completes status: type: string enum: - processing - completed - failed downloadUrl: type: string nullable: true description: >- Storage path of the generated file, not a URL. It stays null until the export completes, and the download endpoint turns it into a signed link createdAt: type: string format: date-time completedAt: type: string format: date-time nullable: true required: - id - organizationId - format - filter - fields - description - totalContacts - status - downloadUrl - createdAt - completedAt securitySchemes: apiKey: type: apiKey in: header name: X-API-Key description: >- An organization API key, prefixed `bk_live_`. Takes precedence over `Authorization` when both are sent. The key is bound to one organization, and the scopes it was issued with are enforced per endpoint. apiKeyBearer: type: http scheme: bearer bearerFormat: bk_live_... description: >- The same organization API key sent as `Authorization: Bearer bk_live_...`. Accepted only when the value begins with `bk_` and no `X-API-Key` header is present. ````