Sources

Preview Source

Preview the records that would be ingested for the given source payload, without persisting anything. Use this to validate filters / list selections before committing to Create.

Per-source body shapes and field semantics live in /docs/source-detail/{source_id}.txt. The route schema only enforces that the body is a JSON object; per-source validation runs inside the handler and surfaces as 400 with a specific message and, when multiple fields fail, an errors[] array of {field, message} entries.

Results are typically capped at 100 rows (source-specific — e.g. Slack returns up to 10). metadata.total_results is the count returned in this preview; it is omitted when the source cannot count the matches. When metadata.capped is true, more rows exist upstream but were omitted due to preview limits.

Trimming the response. Pass a top-level limit (positive integer) to cap how many rows come back — useful when you only need to eyeball the shape of a row rather than the whole sample. limit is a response-shaping knob applied by this endpoint: it does not reduce what the source fetches upstream, and it never changes metadata.total_results. When it drops rows, metadata.capped is true.

post/api/v1/sources/{source_id}/preview

Request

  • Base URL
    http://localhost:3009
  • Auth
    HTTP bearer

Path parameters

source_idstring required

Source identifier. Currently supported: find_companies, find_companies_by_tech_stack, find_companies_from_sales_navigator, find_companies_hiring, find_ecommerce_stores, find_job_postings, find_linkedin_post_reactors, find_linkedin_posts, find_people, find_people_from_sales_navigator, import_from_ai_ark, import_from_attio, import_from_fireflies, import_from_gmail, import_from_google_sheets, import_from_hubspot, import_from_pipedrive, import_from_salesforce, import_from_slack, import_from_snowflake, import_from_stripe, import_from_typeform, import_from_zoho, search_local_businesses, search_x_tweets, track_companies_hiring, track_job_postings, track_linkedin_posts, track_personal_website_visitors, track_website_visitors, track_x_posts.

Request body

limitinteger

Optional cap on rows returned. Response-shaping only — the source still fetches its normal preview sample, metadata.total_results is unchanged, and metadata.capped becomes true when rows are dropped.

Example request

{
  "limit": 3
}

Response

Default Response

statusinteger

Changes

No recorded changes to this operation across all 1 revision of this API.