Audiences

Export audience prospects to CSV

Changed on

Triggers CSV export of prospects (people) in an audience. The export runs asynchronously - CSV links will be sent to the provided email address (if userEmail is provided) or returned in the API response. Export quota limits apply per usage period. Optionally filter to only export prospects with verified emails or phones.

<span>⚡ <strong>Rate limit:</strong> 120 requests per 1 minute</span>

<span>💰 <strong>Cost:</strong> FREE! No credits are charged for this API. <span title="Pricing shown is default pricing. Actual pricing may vary.">ⓘ</span></span>

post/v1/audiences/{audienceId}/export/prospects

Request

  • Base URL
    https://api.fiber.ai
  • URL
    https://api.fiber.ai/v1/audiences/{audienceId}/export/prospects
  • Auth
    none declared

Path parameters

audienceIdstring required

The unique ID of the audience.

Request body

apiKeystring required

Your Fiber API key

format'PROSPECT_GENERIC_CSV' | 'PROSPECT_LI_ADS_CSV' | 'PROSPECT_GOOGLE_ADS_CSV' | 'PROSPECT_META_ADS_CSV' | 'COMPANY_GENERIC_CSV' | 'COMPANY_LI_ADS_CSV' | 'LI_PROFILE_URL_FIXUP' | 'LI_COMPANY_URL_FIXUP' | 'GOOGLE_MAPS_CSV' | 'DOMAIN_AGENT_CSV' | 'MOSAIC_CSV' required

The format of the exported file.

maxRowsToExportinteger nullable

Maximum number of rows to export. Defaults to your remaining export quota for the usage period; an export never exceeds 1,000,000 rows. Large exports are split across several files.

excludeFieldsstring[]

The fields to exclude from the export.

onlyWithContactsboolean

If true, only export prospects with verified emails or phones

userEmailstring email nullable

Optional email address to receive CSV export links. If not provided, no email will be sent.

Response

Default Response

advicestring[] nullable

Tips, recommendations, and suggestions for using this API effectively.

Changes

  • 4002aa81d4fbRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became optional for the status

    • info

      the response's property default value was removed for the status

  • fda5277ff34fRevision changes
    • info

      added the new MOSAIC_CSV enum value to the request property