--- title: "Api List Data Sources" method: GET path: "/v1/data_sources/{application_id}" tags: ["data_sources"] --- # Api List Data Sources `GET /v1/data_sources/{application_id}` ## Request - Base URL: `https://api.branchly.io` (the document declares no server; this is the origin it was published from) - URL: `https://api.branchly.io/v1/data_sources/{application_id}` - Auth: HTTP bearer ## Path parameters - `application_id` string, uuid, required ## Query parameters - `data_source_types` DataSourceType[], nullable ## Response `200` Successful Response - DataSource[] - `id` string, uuid, required - `application_id` string, uuid, required - `name` string, required - `type` 'website_crawler' | 'file_upload' | 'node_editor' | 'default_node' | 'openAPI' | 'helpspace' | 'custom_website_crawler' | 'webhook' | 'wordpress', required - `schedule` string, nullable - `settings` union, required: Settings for data source, shown to user. - WebsiteCrawlerSettingsCreateOutput - `type` 'website_crawler' - `crawler_type` 'playwright:firefox' | 'playwright:adaptive' | 'cheerio' - `actor` 'apify/website-content-crawler' - `urls` ApifyStartURLs, required - `start_urls` string[], required - `max_pages_per_crawl` integer, nullable - `max_crawl_depth` integer, nullable - `include_url_globs` string[] - `exclude_url_globs` string[] - `ignore_errors` boolean: Ignore any page-specific errors (Lang-Tab not available, status code etc.) and continue crawling. - `ignore_canonical_url` boolean: Ignore canonical URLs when crawling if they are incorrectly defined or the crawler should consider Query Parameters as well. - `remove_html_elements` string: List of CSS selectors to remove from the HTML content. List should be separated by commas. - `filters` PageMetadataFiltersOutput - `criteria` FilterCriterion[] - `field` 'published_time' | 'modified_time', required - `condition` FieldCondition, required - `type` 'max_age_days' | 'contains', required - `value` union, required - … - `title_suffix_to_remove` string, nullable: Remove suffix or prefix from page titles. - `custom_tags` string[]: Tags defined by the user that are displayed as badges in frontend. Applies to all pages crawled with this data source. - `unavailable_source_policy` 'ignore' | 'delete_unavailable': Policy for handling unavailable URLs during data source sync. - PDFUploadSettings - `type` 'file_upload' - `files` FileUploadResult[], required - `file_name` string, required - `url` string, uri, required - `is_external` boolean - OpenAPISettingsCreateOutput - `type` 'openAPI' - `openapi_spec` string, required - `operation_id` string, required - `data_template_mapping` DataTemplateMapperOutput, required - `text` string, required - `title` string, required - `source` string, required - `page_metadata` PageMetadataMapper - `title` string, nullable - `description` string, nullable - `images` ImageMetadataMapper - `url` string, nullable - `article` ArticleMetadataMapper - `published_time` string, nullable - `modified_time` string, nullable - `tags` string, nullable - `custom_metadata` CustomMetadataMapper - `tags` string, nullable - `score_boost` string, nullable - `extra_options` object, nullable - `response_content_path` string, nullable - `unavailable_source_policy` 'ignore' | 'delete_unavailable': Policy for handling unavailable URLs during data source sync. - HelpspaceSettings - `type` 'helpspace' - `client_id` string, required - `api_token` string, required - `site_id` integer, required - `unavailable_source_policy` 'ignore' | 'delete_unavailable': Policy for handling unavailable URLs during data source sync. - CustomWebcrawlerSettingsOutput - `type` 'custom_website_crawler' - `crawler_type` 'playwright:firefox' | 'playwright:adaptive' | 'cheerio' - `actor` 'apify/website-content-crawler' - `urls` ApifyStartURLs, required - `start_urls` string[], required - `ignore_errors` boolean - `main_content_marker` CommentsContentMarker, required - `type` 'comments' - `selector_filter` string, required - `start_marker` string, required - `end_marker` string, required - `title_suffix_to_remove` string, nullable: Remove suffix or prefix from page titles. - `graph_builder` GraphBuilderSettings, required - `connect_start_urls_to_entry` boolean: Connect start URLs to entry node - `nodes_wo_out_edges_to_contact` boolean: Nodes without outgoing edges to contact nodes. Uses contact_node_ids if available, otherwise all contact nodes - `nodes_wo_out_edges_to_tool` boolean: Nodes without outgoing edges to tool nodes. Uses tool_node_ids if available, otherwise all tool nodes - `nodes_wo_edges_to_root` boolean: Nodes without incoming/outgoing edges to the root node/start url. Prevents orphan nodes - `contact_node_ids` string[], nullable - `tool_node_ids` string[], nullable - `navigation_builder` BreadcrumbNavigationBuilderOptions, required - `type` 'breadcrumbs' - `breadcrumb_selector` string, required - `include_url_globs` string[] - `exclude_url_globs` string[] - `custom_tags` string[]: Tags defined by the user that are displayed as badges in frontend. Applies to all pages crawled with this data source. - `unavailable_source_policy` 'ignore' | 'delete_unavailable': Policy for handling unavailable URLs during data source sync. - `fetch_image_captions` boolean: Fetch and generate captions for images found during crawling. - WebhookSettingsOutput: Settings for webhook data source. - `type` 'webhook' - `data_template_mapping` DataTemplateMapperOutput - `text` string, required - `title` string, required - `source` string, required - `page_metadata` PageMetadataMapper - `title` string, nullable - `description` string, nullable - `images` ImageMetadataMapper - `url` string, nullable - `article` ArticleMetadataMapper - `published_time` string, nullable - `modified_time` string, nullable - `tags` string, nullable - `custom_metadata` CustomMetadataMapper - `tags` string, nullable - `score_boost` string, nullable - WordPressSettingsOutput - `type` 'wordpress' - `api_path` string - `verify_ssl` boolean - `timeout` integer - `post_types` string[] - `post_status` string[] - `excluded_categories` integer[] - `locale_detection` 'static' | 'path_prefix' | 'subdomain' | 'query_param' | 'wpml' - `default_site_locale` string: Locale assigned to all posts in 'static' mode, or used as fallback in detection modes. - `locale_mapping` object: Map detected URL language codes to app locales. e.g. {'en': 'en', 'de': 'de', 'fr_FR': 'fr'}. Applied after locale_detection; unmatched codes are used as-is. Falls back to default_locale when no locale is detected.Locale mapping is used to filter posts in 'wpml' language detection mode. - `unavailable_source_policy` 'ignore' | 'delete_unavailable': Policy for handling unavailable URLs during data source sync. - `filters` PageMetadataFiltersOutput - `criteria` FilterCriterion[] - `field` 'published_time' | 'modified_time', required - `condition` FieldCondition, required - `type` 'max_age_days' | 'contains', required - `value` union, required - … - `integration_id` string, uuid, nullable ## Other responses - `422`: Validation Error --- [API](https://skmtc.dev/branchly/apis/branchly-io-api.md) · [All operations](https://skmtc.dev/branchly/apis/branchly-io-api/llms.txt) · [OpenAPI document](https://skmtc.dev/branchly/apis/branchly-io-api/revisions/9ffb024f8ec8?raw)