--- canonical_url: "https://docs.composio.dev/toolkits/fiber" markdown_url: "https://docs.composio.dev/toolkits/fiber.md" product: "platform" version: null last_updated: null --- # Fiber Fiber provides AI-powered people and company search, enrichment, contact discovery, and data validation APIs. - **Category:** hr talent & recruitment - **Auth:** API_KEY - **Composio-managed OAuth available?** N/A - **Tools:** 247 - **Triggers:** 0 - **Slug:** `FIBER` - **Version:** 00000000_00 ## Tools ### Add Companies to a Company Exclusion List **Slug:** `FIBER_ADD_COMPANIES_TO_EXCLUSION_LIST` Free persistent-state operation: Add companies to a company exclusion list. Confirm the intended target before changing Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | string | Yes | The ID of the company exclusion list to add companies to. | | `companies` | array | Yes | The companies to add to the exclusion list. A maximum of 5000 companies can be added at a time. Each entry needs a domain or a LinkedIn company URL; invalid entries are skipped and reported in the response without failing the request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Profiles to the Job Change List **Slug:** `FIBER_ADD_PROFILES_TO_LIST` Billable operation: Add profiles to the job change list whose job changes you want to track. Note: we automatically remove 404 profiles from the list. Once the upload starts, you can use /job-changes/get-list to track the upload progress. Confirm the documented credit cost immediately before calling. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `profiles` | array | Yes | Person profile inputs to process; provide each profile using the identifiers or fields accepted by this operation. | | `job_change_list_id` | string | Yes | The job change list id. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Prospects to a Prospect Exclusion List **Slug:** `FIBER_ADD_PROSPECTS_TO_EXCLUSION_LIST` Free persistent-state operation: Add prospects to a prospect exclusion list. Confirm the intended target before changing Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | string | Yes | The ID of the prospect exclusion list to add prospects to. | | `prospects` | array | Yes | The prospects to add to the exclusion list. A maximum of 5000 prospects can be added at a time. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Companies to Tracker List **Slug:** `FIBER_ADD_TRACKER_COMPANIES` Free persistent-state operation: Add companies to a company tracker list. Identify companies by LinkedIn URL, organization ID, slug, or website domain. At least one identifier is required per company. Confirm the intended target before changing Fiber state. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | string | Yes | The unique ID of the tracker list. | | `companies` | array | Yes | Companies to add. At least one identifier required per company. | | `initial_signals` | object | No | When provided, generates signals immediately for recent events (funding rounds, news, job postings, social posts) without waiting for the first tracking cycle. Only certain rule types support initial signals. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add People to Tracker List **Slug:** `FIBER_ADD_TRACKER_PEOPLE` Free persistent-state operation: Add people to a person tracker list. Identify people by LinkedIn URL, user ID, or slug. At least one identifier is required per person. Confirm the intended target before changing Fiber state. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `people` | array | Yes | People to add. At least one identifier required per person. | | `list_id` | string | Yes | The unique ID of the tracker list. | | `initial_signals` | object | No | When provided, generates signals immediately for recent events (funding rounds, news, job postings, social posts) without waiting for the first tracking cycle. Only certain rule types support initial signals. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Blue Collar Job Listings **Slug:** `FIBER_BLUE_COLLAR_JOBS_SEARCH` Billable operation: Search blue collar and trade job postings. Ideal for finding service, manufacturing, trades, and other non-desk positions. Currently US-only. Supports search by company, job title/keyword, and location. Supports pagination via nextPageToken. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | No | Job title or keyword to search for (e.g. 'warehouse worker', 'forklift operator'). | | `location` | string | No | US city, state, or region to search within (e.g. 'Philadelphia, PA', 'Texas'). Only US locations are supported. | | `company_slug` | string | No | Company identifier on the job board. Use the resolve-company endpoint to find this from a domain or name. | | `next_page_token` | string | No | Pagination token returned from a previous search. Pass to get the next page of results. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Resolve Company to Blue Collar Job Board Identifier **Slug:** `FIBER_BLUE_COLLAR_RESOLVE_COMPANY` Billable operation: Resolve a company to the identifier used for searching their blue collar job listings on boards such as Indeed. Provide a company name, a website domain or URL, or both for best results. Use the returned slug in the companySlug field of the blue collar jobs search endpoint. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `domain` | string | No | Company website domain or URL (e.g. 'caterpillar.com', 'https://walmart.com'). At least one of companyName or domain must be provided. | | `company_name` | string | No | Company name to look up (e.g. 'Caterpillar', 'Amazon'). At least one of companyName or domain must be provided. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Booking.com Property Details **Slug:** `FIBER_BOOKING_PROPERTY` Billable operation: Retrieves full details for a single Booking.com property, including amenities, photos, scores, and house rules. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `property_url` | string | Yes | Full Booking.com property URL (e.g. 'https://www.booking.com/hotel/hr/sumratin-dubrovnik.html'). Obtain it from a result returned by POST /v1/booking/search — pass the `propertyUrl`, not the `propertyId`. | | `language_code` | string | No | Language for property names, descriptions, and labels. Pass a BCP-47 language tag such as 'en', 'en-US', 'fr', 'de', or 'es'. Omit for English. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Booking.com Properties **Slug:** `FIBER_BOOKING_SEARCH` Billable operation: Searches Booking.com stays for a destination and returns matching properties with rates, ratings, and availability. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Destination to search (city, region, or landmark). For example, 'Dubrovnik' or 'Rome, Italy'. | | `rooms` | integer | No | Number of rooms to search for. Defaults to 1. | | `adults` | integer | No | Number of adult guests (at least 1). Total guests (`adults` + `children`) must not exceed 30. | | `sort_by` | string ("relevance" | "lowestPrice" | "highestRating" | "mostReviewed") | No | Sort criterion for results. 'relevance' ranks by overall match. 'lowestPrice' sorts cheapest first. 'highestRating' sorts by guest review score. 'mostReviewed' uses Booking.com's top-reviewed ranking, which weighs review score by review volume. Omit to sort by relevance. | | `children` | integer | No | Number of child guests. Total guests (`adults` + `children`) must not exceed 30. | | `check_in_date` | string | Yes | Check-in date for the stay. | | `children_ages` | array | No | Ages of each child guest. Must contain exactly `children` entries when `children` is greater than zero. | | `currency_code` | string | No | ISO 4217 currency code for prices in the response (e.g. 'EUR', 'GBP', 'CAD'). Case-insensitive. Defaults to USD. | | `language_code` | string | No | Language for property names, descriptions, and labels. Pass a BCP-47 language tag such as 'en', 'en-US', 'fr', 'de', or 'es'. Omit for English. | | `check_out_date` | string | Yes | Check-out date for the stay. Must be at least one calendar day after `checkInDate`. | | `next_page_token` | string | No | Opaque pagination token from a prior search response's `nextPageToken`. Send it with the same search parameters that produced it. Omit (or pass null) to fetch the first page. | | `hotel_star_classes` | array | No | Filter to specific hotel star classes. This is a list of exact classes, not a range: [3, 5] returns only 3- and 5-star properties and excludes 4-star, so list every class you want (e.g. [3, 4, 5]). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Build Audience from Search Parameters **Slug:** `FIBER_BUILD_AUDIENCE` Billable asynchronous trigger: Triggers the audience building process. This runs a company and prospect search based on the configured search parameters and saves results to the database. The build runs asynchronously - use the get-audience-status endpoint to poll for completion. Status transitions: DRAFT BUILDING NORMAL (success) or FAILED (error). Check progress or retrieve results with FIBER_GET_AUDIENCE_STATUS. Confirm the expected credit charge immediately before starting work; do not retry merely because results are not yet ready. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `audience_id` | string | Yes | The unique ID of the audience. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Bulk Company Logos **Slug:** `FIBER_BULK_COMPANY_LOGOS` Billable operation: Get logo URLs for a list of companies. Max 10,000 companies can be looked up at a time. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `companies_identifier` | string | Yes | The list of companies to get the logo for. Include any of domain, linkedinUrl, or liOrgId. Max 10000 companies can be added at a time. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Bulk Enrich Companies **Slug:** `FIBER_BULK_ENRICH_COMPANIES` Billable and privacy-sensitive: enrich 1-50 known companies in one request. Fiber charges 2 credits per company lookup and reports the actual charge in chargeInfo. Use FIBER_ENRICH_COMPANY for one company and company search for discovery. Responses may include workforce and personnel-derived aggregates. Call FIBER_GET_ORG_CREDITS and obtain explicit user confirmation immediately before every call. Use only for an authorized purpose, request only necessary data, and apply appropriate retention controls. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `companies` | array | Yes | Company lookups to enrich in one request (1-50). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Bulk Enrich People **Slug:** `FIBER_BULK_ENRICH_PEOPLE` Billable and privacy-sensitive: enrich 1-50 known people in one request. Fiber charges 2 credits per lookup, plus 2 additional credits per lookup when live_fetch is true. Use FIBER_ENRICH_PERSON for one person and contact reveal actions only when email or phone discovery is the goal. Call FIBER_GET_ORG_CREDITS and obtain explicit user confirmation immediately before every call. Use only for an authorized purpose and subject, minimize the personal data requested, and apply appropriate retention controls. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `profiles` | array | Yes | Person lookups to enrich in one request (1-50). | | `live_fetch` | boolean | No | Trigger real-time LinkedIn fetches. This costs 2 additional credits per lookup. | | `fuzzy_search` | boolean | No | Enable fuzzy name matching. | | `thoroughness` | string ("low" | "high") | No | Search thoroughness. High searches longer to recover more matches. | | `force_company_match` | boolean | No | Require matched profiles to work at the company specified in each lookup. | | `get_detailed_education` | boolean | No | Return detailed education entries with school details. | | `get_detailed_work_experience` | boolean | No | Return detailed work entries with company details. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Bulk Profile Pics **Slug:** `FIBER_BULK_PROFILE_PIC` Billable operation: Get profile pics for a list of profiles. Max 10,000 profiles can be looked up at a time. Confirm the documented credit cost immediately before calling. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `linkedin_urls` | array | Yes | Fully qualified URLs for linkedin urls. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Cancel Batch Contact Reveal **Slug:** `FIBER_CANCEL_BATCH_CONTACT_REVEAL` Irreversibly stop pending work in an existing batch contact-reveal task. Obtain explicit user confirmation immediately before calling. Fiber refunds eligible profiles the task has not reached; already processed or delivered profiles remain charged and their results are not removed. The response's cancelledCount, creditsRefunded, and chargeInfo are authoritative. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `task_id` | string | Yes | Task ID returned by FIBER_START_BATCH_CONTACT_REVEAL. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Check Google Maps Search Progress **Slug:** `FIBER_CHECK_GOOGLE_MAPS_RESULTS` Read-only asynchronous status check: Check readiness and progress for a Google Maps search started by FIBER_START_GOOGLE_MAPS_SEARCH. This action returns status only; use FIBER_POLL_GOOGLE_MAPS_RESULTS to retrieve paginated result rows. No polling charge is documented; it does not start another job or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `search_id` | string | Yes | The ID of the Google Maps search. You should get this from the start endpoint. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Live Fetch LinkedIn Company **Slug:** `FIBER_COMPANY_LIVE_ENRICH` Billable operation: Returns an enriched company with details for a given LinkedIn company identifier. Confirm the documented credit cost immediately before calling. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("slug" | "orgId" | "liUrl") | Yes | Type used by this operation. | | `value` | string | Yes | The company's LinkedIn slug (e.g. 'microsoft'), LinkedIn URL (e.g. 'https://www.linkedin.com/company/microsoft'), LinkedIn organization ID (e.g. '1441'), or Fiber company ID (e.g. 'comp_1441'). | | `get_historical_headcount` | boolean | No | Whether to compute the company's overall employee count over time and recent growth trends. This returns total headcount through time, not a per-department breakdown — for per-department headcount, use the Depth Chart endpoints. No additional cost, but may take longer. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Company Logo **Slug:** `FIBER_COMPANY_LOGO` Billable operation: Get the logo for a single company. Accepts a LinkedIn company URL, slug, numeric organization ID, or domain the format is auto-detected. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `identifier` | string | Yes | A company identifier: a LinkedIn company URL (e.g. 'https://www.linkedin.com/company/openai'), a LinkedIn company slug (e.g. 'openai'), a numeric LinkedIn organization ID (e.g. '11130470'), or a company domain (e.g. 'openai.com'). The format is auto-detected. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch LinkedIn Company Posts **Slug:** `FIBER_COMPANY_POSTS_LIVE_FETCH` Billable operation: Fetches recent posts from a LinkedIn company page. Returns a paginated feed of company posts. Each page contains up to 50 posts. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Pagination cursor for fetching additional pages of posts | | `identifier` | string | Yes | Company identifier can be either a LinkedIn company slug/url (e.g., 'microsoft' or 'https://www.linkedin.com/company/microsoft') or a numeric linkedin organization ID (e.g., '1035') | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Company/School/Investor Typeahead **Slug:** `FIBER_COMPANY_TYPEAHEAD` Billable operation: Search for companies, schools/universities, and investors by name. Supports partial inputs, which can enable typeaheads in your UI. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `org_type` | string ("investor" | "school") | No | The organization type filter. Use 'investor', 'school', or omit for all types. | | `starts_with` | string | Yes | Search text used to match starts with. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Count Company Search Results **Slug:** `FIBER_COUNT_COMPANY_SEARCH_RESULTS` Billable and privacy-sensitive: count companies matching Fiber's structured filters without returning company records. Use FIBER_SEARCH_COMPANIES when records are needed. Fiber charges 1 credit per request and reports the actual charge in chargeInfo. Use only for an authorized purpose, minimize and retain filters appropriately, call FIBER_GET_ORG_CREDITS first, and obtain explicit user confirmation immediately before every call. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `search_params` | object | Yes | Search parameters for company search API. | | `company_exclusion_list_ids` | array | No | The IDs of company exclusion lists to filter out matching companies. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Count Job Postings **Slug:** `FIBER_COUNT_JOB_POSTINGS` Billable and privacy-sensitive: count Fiber job postings matching structured filters without returning postings. Use FIBER_SEARCH_JOB_POSTINGS when posting records are needed. Fiber charges 1 credit per request and reports the actual charge in chargeInfo. Hiring filters may disclose strategic interests; use only for an authorized purpose, minimize and retain filters appropriately, call FIBER_GET_ORG_CREDITS first, and obtain explicit user confirmation immediately before every call. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `search_params` | object | Yes | Job search filter parameters | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Count People and Companies **Slug:** `FIBER_COUNT_PEOPLE_AND_COMPANIES` Billable and privacy-sensitive: count companies and people together, with people scoped to companies matching the company filters. Use FIBER_SEARCH_PEOPLE_AND_COMPANIES when records are needed. Fiber charges 1 company-count credit and 1 profile-count credit and reports the actual charge in chargeInfo. Use only for an authorized purpose, minimize and retain filters appropriately, call FIBER_GET_ORG_CREDITS first, and obtain explicit user confirmation immediately before every call. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `company_params` | object | Yes | The company search parameters. Prospects are found from companies matching these filters. | | `profile_params` | object | No | The profile search parameters. Returns profiles matching these filters who work/used to work at companies satisfying companyParams. | | `get_fast_estimate` | boolean | No | When true, the people count is estimated rather than counted exactly — much faster, but not perfectly accurate. Set to false if you need the exact count (slower). | | `company_exclusion_list_ids` | string | No | The IDs of company exclusion lists to filter out matching companies. | | `prospect_exclusion_list_ids` | string | No | The IDs of prospect exclusion lists to filter out matching people. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Count People Search Results **Slug:** `FIBER_COUNT_PEOPLE_SEARCH_RESULTS` Billable and privacy-sensitive: count people matching Fiber's structured filters without returning profiles. Use FIBER_SEARCH_PEOPLE when profile records are needed. Search criteria may encode sensitive employment or demographic targeting. Fiber charges 1 credit per request and reports the actual charge in chargeInfo. Use only for an authorized purpose, minimize and retain filters appropriately, call FIBER_GET_ORG_CREDITS first, and obtain explicit user confirmation immediately before every call. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `include_count` | string | No | When true, returns an estimated total count of matching prospects in the response and charges one additional count credit. The count does not account for exclusion lists. | | `search_params` | object | No | Search parameters for people search. | | `current_companies` | string | No | Filter people by the companies they are currently working for. If you want to search over many companies, we suggest using the Combined Search API, which is optimized for this use case. | | `company_exclusion_list_ids` | string | No | Filter out people who work at companies which belong to the given company exclusion lists | | `prospect_exclusion_list_ids` | string | No | Filter out people which belong to the given prospect exclusion lists | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a New Audience **Slug:** `FIBER_CREATE_AUDIENCE` Free persistent-state operation: Creates a new audience in DRAFT status. After creation, use the update-search-params endpoint to set filters, then use the build endpoint to populate the audience with companies and prospects. Confirm the intended target before changing Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the audience (e.g. 'Fintech VPs in NYC'). | | `creation_method` | string ("NORMAL" | "START_FROM_PROSPECTS") | No | How the audience will be created. NORMAL: search companies then prospects. START_FROM_PROSPECTS: search prospects only. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Company Exclusion List **Slug:** `FIBER_CREATE_COMPANY_EXCLUSION_LIST` Free persistent-state operation: Create a company exclusion list. Confirm the intended target before changing Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the company exclusion list. | | `is_organization_wide` | boolean | No | Whether the company exclusion list is organization-wide. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Company Exclusion List from Audience **Slug:** `FIBER_CREATE_COMPANY_EXCLUSION_LIST_FROM_AUDIENCE` Free persistent-state operation: This endpoint creates a new company exclusion list by extracting all companies from a specified audience. Confirm the intended target before changing Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | The name of the company exclusion list. Defaults to 'Exclusion list from {audienceName}' if not provided. | | `audience_id` | string | Yes | The ID of the audience to create the exclusion list from. | | `is_organization_wide` | boolean | No | Whether the company exclusion list is organization-wide. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Job Change List **Slug:** `FIBER_CREATE_JOB_CHANGE_LIST` Free persistent-state operation: Create a new job changes list to monitor when tracked prospects change jobs. Confirm the intended target before changing Fiber state. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the job change list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Prospect Exclusion List **Slug:** `FIBER_CREATE_PROSPECT_EXCLUSION_LIST` Free persistent-state operation: Create a prospect exclusion list. Confirm the intended target before changing Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the prospect exclusion list. | | `is_organization_wide` | boolean | No | Whether the prospect exclusion list is organization-wide. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Prospect Exclusion List from Audience **Slug:** `FIBER_CREATE_PROSPECT_EXCLUSION_LIST_FROM_AUDIENCE` Free persistent-state operation: Create a prospect exclusion list from an audience's prospects. Confirm the intended target before changing Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | The name of the prospect exclusion list. Defaults to 'Exclusion list from {audienceName}' if not provided. | | `audience_id` | string | Yes | The ID of the audience to create the exclusion list from. | | `is_organization_wide` | boolean | No | Whether the prospect exclusion list is organization-wide. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Sandbox API Key **Slug:** `FIBER_CREATE_SANDBOX_API_KEY` Free persistent-state operation: Create a sandbox API key (`sk_test_...`) for local development, CI, and integration tests. Sandbox keys never charge credits. The plaintext secret is returned once and cannot be retrieved later. Live keys cannot be created from the API create those at https://app.fiber.ai. First-time users without any key yet: sign up at https://fiber.ai or via POST /v1/account/send-otp + verify-otp. Confirm the intended target before changing Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Human-readable label to identify this key later (e.g. 'CI runner', 'local dev'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Saved Search **Slug:** `FIBER_CREATE_SAVED_SEARCH` Billable operation: Create a new saved search. Given search params, it automatically re-runs it periodically and tells you which new people and/or companies fit your parameters over time (and also who drops out or returns). You are charged for each new prospect or company we find, depending on your desired type. You can also manually run the saved search if you don't want to wait for the next auto-run. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the saved search. | | `search_params` | string | Yes | Search filters and criteria that define which matching people or companies to include. | | `spawn_frequency_days` | integer | Yes | The frequency of the saved search in days. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Company Tracker List **Slug:** `FIBER_CREATE_TRACKER_COMPANY_LIST` Free persistent-state operation: Create a new company tracker list. By default you add companies manually and we periodically check them for changes matching your tracking rules. Provide `companySearchParams` to instead create a DYNAMIC list that auto-populates with companies matching a query and refreshes over time. Credits are charged per entity per refresh cycle; lists containing premium rules (marked `isPremium` in GET /tracker/rules) bill at a minimum per-entity rate (see your plan's pricing for exact rates). Creating the list itself is free. Confirm the intended target before changing Fiber state. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Human-readable name for the tracker list. | | `tracking_rules` | array | No | Tracking rules to evaluate against this list's entities. Multiple rules can be active simultaneously. Rules marked `isPremium` in GET /tracker/rules make the list bill at a minimum per-entity rate — see your plan's pricing for rates. | | `max_dynamic_members` | integer | No | For dynamic lists only: the maximum number of companies to keep in the list. Defaults to 10000. Ignored for static lists. | | `company_search_params` | object | No | If provided, this list becomes DYNAMIC: rather than adding companies manually, the list auto-populates with companies matching these filters and refreshes over time (new matches are added; companies that no longer match are dropped). Uses the same filters as the company search endpoint. Omit to create a static, manually-managed list. | | `refresh_interval_days` | integer | Yes | How often to check tracked companies for changes, in days. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Person Tracker List **Slug:** `FIBER_CREATE_TRACKER_PERSON_LIST` Free persistent-state operation: Create a new person tracker list. By default you add people manually and we periodically check them for changes matching your tracking rules. Provide `prospectSearchParams` to instead create a DYNAMIC list that auto-populates with people matching a query and refreshes over time. Credits are charged per entity per refresh cycle; lists containing premium rules (marked `isPremium` in GET /tracker/rules) bill at a minimum per-entity rate (see your plan's pricing for exact rates). Creating the list itself is free. Confirm the intended target before changing Fiber state. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Human-readable name for the tracker list. | | `tracking_rules` | array | No | Tracking rules to evaluate against this list's entities. Multiple rules can be active simultaneously. Rules marked `isPremium` in GET /tracker/rules make the list bill at a minimum per-entity rate — see your plan's pricing for rates. | | `max_dynamic_members` | integer | No | For dynamic lists only: the maximum number of people to keep in the list. Defaults to 10000. Ignored for static lists. | | `company_search_params` | object | No | Optional company filter for a dynamic people list: only people at companies matching these filters are included. Requires prospectSearchParams. Ignored for static lists. | | `refresh_interval_days` | integer | Yes | How often to check tracked people for changes, in days. | | `prospect_search_params` | object | No | If provided, this list becomes DYNAMIC: rather than adding people manually, the list auto-populates with people matching these filters and refreshes over time (new matches are added; people who no longer match are dropped). Uses the same filters as the people search endpoint. Omit to create a static, manually-managed list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Webhook Endpoint **Slug:** `FIBER_CREATE_WEBHOOK_ENDPOINT` Free persistent-state operation: Create a webhook endpoint that receives event payloads at the URL you provide. Returns the endpoint along with its signing secret store the secret securely, as it is only shown here and when rotated. Setting up webhooks is free. Confirm the intended target before changing Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | Yes | The HTTPS URL that will receive event payloads, e.g. 'https://api.example.com/webhooks/fiber'. | | `description` | string | No | An optional human-readable label for this endpoint. | | `event_types` | array | Yes | The event types to subscribe this endpoint to. Retrieve the full list of available event types from the webhook event types endpoint. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Archive an Audience **Slug:** `FIBER_DELETE_AUDIENCE` Destructive or state-removing change: Archives an audience by hiding it from the user. The audience and its data are preserved for audit trail and enrichment history. Audiences that are currently BUILDING cannot be archived. Obtain explicit confirmation and verify all target identifiers immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `audience_id` | string | Yes | The unique ID of the audience. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Company Exclusion List **Slug:** `FIBER_DELETE_COMPANY_EXCLUSION_LIST` Destructive or state-removing change: Delete a company exclusion list. Obtain explicit confirmation and verify all target identifiers immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_i_ds` | array | Yes | The IDs of the company exclusion lists to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a Job Changes List **Slug:** `FIBER_DELETE_JOB_CHANGE_LIST` Destructive or state-removing change: Deletes a job changes list. This will remove the list and stop tracking job changes for prospects in this list. Obtain explicit confirmation and verify all target identifiers immediately before calling. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_change_list_id` | string | Yes | The ID of the job change list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Profiles from a Job Change List **Slug:** `FIBER_DELETE_PROFILES_FROM_JOB_CHANGE_LIST` Destructive or state-removing change: Remove profiles from a job changes tracking list. Obtain explicit confirmation and verify all target identifiers immediately before calling. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `profile_ids` | array | Yes | The IDs of the profiles to remove. | | `job_change_list_id` | string | Yes | The ID of the job change list to remove profiles from. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Prospect Exclusion List **Slug:** `FIBER_DELETE_PROSPECT_EXCLUSION_LIST` Destructive or state-removing change: Delete a prospect exclusion list. Obtain explicit confirmation and verify all target identifiers immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_ids` | array | Yes | The IDs of the prospect exclusion lists to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Archive Company Tracker List **Slug:** `FIBER_DELETE_TRACKER_COMPANY_LIST` Destructive or state-removing change: Archive a company tracker list. Stops all monitoring and deactivates all tracked companies and rules on the list. Signal history is preserved for audit purposes. Obtain explicit confirmation and verify all target identifiers immediately before calling. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | string | Yes | The unique ID of the tracker list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Archive Person Tracker List **Slug:** `FIBER_DELETE_TRACKER_PERSON_LIST` Destructive or state-removing change: Archive a person tracker list. Stops all monitoring and deactivates all tracked people and rules on the list. Signal history is preserved for audit purposes. Obtain explicit confirmation and verify all target identifiers immediately before calling. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | string | Yes | The unique ID of the tracker list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Webhook Endpoint **Slug:** `FIBER_DELETE_WEBHOOK_ENDPOINT` Destructive or state-removing change: Delete a webhook endpoint. All future event deliveries to its URL stop immediately. Deleting webhooks is free. Obtain explicit confirmation and verify all target identifiers immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `endpoint_id` | string | Yes | The unique ID of the webhook endpoint. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Poll Domain Lookup **Slug:** `FIBER_DOMAIN_LOOKUP_POLLING` Read-only asynchronous poll: Poll for the results of a domain lookup task. Use it only for work started by FIBER_DOMAIN_LOOKUP_TRIGGER. No polling charge is documented; it does not start another job or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | The cursor from where to start fetching the next page of results. Provide the `nextCursor` from the previous response to continue from there. | | `page_size` | number | No | The number of results to fetch per page. | | `domain_agent_run_id` | string | Yes | The ID of the domain agent run returned by the trigger endpoint. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Start Domain Lookup **Slug:** `FIBER_DOMAIN_LOOKUP_TRIGGER` Billable asynchronous trigger: Use our AI agent to find a company's domain and email domains using a variety of parameters such as company name, country, state, city, address, other context, and description. NOTE: Maximum 400 companies can be provided at a time. Estimated time to complete 150 companies is an hour. Check progress or retrieve results with FIBER_DOMAIN_LOOKUP_POLLING. Confirm the expected credit charge immediately before starting work; do not retry merely because results are not yet ready. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `company_info` | array | Yes | List of companies to look up. Max 400 companies can be provided at a time. | | `over_all_context` | string | Yes | A descriptor of what the companies have in common (e.g. "British freight brokers" or "YC startups"). Helps disambiguate companies with similar names. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Download Your Past API Requests **Slug:** `FIBER_DOWNLOAD_API_REQUESTS` Free read: Download the API requests your organization has made, newest first, with the parameters you sent and how each call turned out. Up to 5000 matching requests are returned in one call; if more exist, `truncated` is true narrow `from`/`to` and retry. History is retained for 14 days. Response bodies are not returned. This operation does not spend credits or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `to` | string | No | Only return requests received strictly before this ISO 8601 timestamp. | | `from_` | string | No | Only return requests received at or after this ISO 8601 timestamp. Logs are retained for 14 days, so earlier timestamps simply return nothing. | | `method` | string | No | Only return requests using this HTTP method, e.g. "POST". | | `error_code` | string | No | Only return the request carrying this error correlation code. | | `route_path` | string | No | Only return requests to this exact route template, e.g. "/v1/person/search". | | `status_code` | integer | No | Only return requests that returned this exact status code. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Enrich Company **Slug:** `FIBER_ENRICH_COMPANY` Billable and privacy-sensitive: match a company from flexible LinkedIn, name, domain, and location hints and return configurable enrichment details. Use FIBER_RESOLVE_COMPANIES for cheaper batch identifier-only lookups when its standard business record is sufficient. Costs 2 credits per lookup and reports actual cost in chargeInfo. Provide at least one company identifier, name, or domain. Use only for an authorized purpose, request and retain only necessary data, call FIBER_GET_ORG_CREDITS, and obtain explicit user confirmation immediately before every call. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `company_name` | object | No | Company name lookup hint. | | `num_companies` | integer | No | Maximum company results to return, sorted by best match (1-10). | | `company_domain` | object | No | Company domain lookup hint. | | `company_location` | object | No | Headquarters location used to disambiguate companies with similar names or domains. | | `company_identifier` | string | No | A LinkedIn slug, URL, or organization ID for the company. This improves lookup accuracy and means company_name and company_domain may be omitted. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Enrich Person **Slug:** `FIBER_ENRICH_PERSON` Billable and privacy-sensitive: match a person from flexible LinkedIn, email, name, company, role, location, or school hints and return configurable detailed education and work history. Use FIBER_RESOLVE_PEOPLE for cheaper batch identifier-only lookups when its standard profile is sufficient. Costs 2 credits per lookup; live_fetch defaults to false because enabling it costs 2 additional credits. Provide at least one person identifier or matching hint. Call FIBER_GET_ORG_CREDITS and obtain explicit user confirmation immediately before each call. Use only for an authorized purpose and subject, and request and retain only necessary personal data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_title` | object | No | Person's job title. | | `live_fetch` | boolean | No | Trigger a real-time LinkedIn fetch. Defaults to false; true costs 2 additional credits. | | `person_name` | object | No | Person name for matching, preferably with a company hint. | | `school_name` | object | No | Name of a school the person attends or attended. | | `company_name` | object | No | Name of the person's current company. | | `fuzzy_search` | boolean | No | Enable fuzzy name matching. | | `num_profiles` | integer | No | Maximum number of matching profiles to return (1-10). | | `thoroughness` | string ("low" | "high") | No | Search thoroughness. High searches longer for more potential matches. | | `email_address` | string | No | Email address to look up; this generally provides the second-best accuracy. | | `school_domain` | object | No | Domain of a school the person attends or attended. | | `company_domain` | object | No | Domain of the person's current company, such as fiber.ai. | | `profile_location` | object | No | Country, state, or locality hints for the person. | | `linkedin_headline` | object | No | LinkedIn headline match criteria. | | `school_identifier` | string | No | LinkedIn identifier for a school. | | `company_identifier` | string | No | LinkedIn identifier for the person's current company. | | `profile_identifier` | string | No | LinkedIn profile identifier. This generally provides the best match accuracy. | | `force_company_match` | boolean | No | Require the matched profile to work at the specified company. | | `get_detailed_education` | boolean | No | Return detailed education entries with school details. | | `get_detailed_work_experience` | boolean | No | Return detailed work entries with company domain, size, and revenue details. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Estimate Enrichment Cost **Slug:** `FIBER_ESTIMATE_ENRICHMENT_COST` Free read: Estimates the credit cost for an audience enrichment run before triggering it. Returns detailed breakdown by operation type (Sales Navigator, live enrichment, contact enrichment, validation) and estimated completion time. This endpoint is free and does not charge any credits. This operation does not spend credits or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `audience_id` | string | Yes | The unique ID of the audience. | | `enrichment_type` | object | Yes | Enrichment types to estimate costs for | | `run_profile_sales_nav` | boolean | No | Whether to include Sales Navigator enrichment in estimate | | `run_contact_enrichment` | boolean | No | Whether to include contact enrichment in estimate | | `max_prospects_to_enrich` | integer | Yes | Maximum number of prospects to include when estimating enrichment cost (must be a positive integer; very large values may be rejected by internal safety limits). | | `run_company_live_enrichment` | boolean | No | Whether to include company live enrichment in estimate | | `run_profile_live_enrichment` | boolean | No | Whether to include profile live enrichment in estimate | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Export Audience Companies to CSV **Slug:** `FIBER_EXPORT_COMPANIES` External-effect operation: Triggers CSV export of companies 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. Confirm the target and intended side effect immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `format` | string ("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") | Yes | The format of the exported file. | | `user_email` | string | No | Optional email address to receive CSV export links. If not provided, no email will be sent. | | `audience_id` | string | Yes | The unique ID of the audience. | | `exclude_fields` | array | No | The fields to exclude from the export. | | `max_rows_to_export` | integer | No | Maximum number of rows to export. Defaults to remaining export quota. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Export Audience Prospects to CSV **Slug:** `FIBER_EXPORT_PROSPECTS` External-effect operation: 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. Confirm the target and intended side effect immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `format` | string ("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") | Yes | The format of the exported file. | | `user_email` | string | No | Optional email address to receive CSV export links. If not provided, no email will be sent. | | `audience_id` | string | Yes | The unique ID of the audience. | | `exclude_fields` | array | No | The fields to exclude from the export. | | `max_rows_to_export` | integer | No | Maximum number of rows to export. Defaults to remaining export quota. | | `only_with_contacts` | boolean | No | If true, only export prospects with verified emails or phones | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch Real Estate Listings **Slug:** `FIBER_FETCH_REAL_ESTATE_LISTINGS` Billable operation: Fetches real estate listings by location and optional filters such as listing status, price ranges, home types, and property features. Data is available for all 50 US states, D.C., Puerto Rico, and all 13 Canadian provinces and territories. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `rent` | object | No | Monthly rent range filter for rental listings. Values must use the local market currency for the location (for example, CAD for Canada and USD for the United States). | | `price` | object | No | Price range filter for sale and sold listings. Values must use the local market currency for the location (for example, CAD for Canada and USD for the United States). | | `sort_by` | string ("relevance" | "newest" | "priceAscending" | "priceDescending" | "paymentAscending" | "paymentDescending" | "bedroomCountDescending" | "bathroomCountDescending" | "floorAreaSqFtDescending" | "lotAreaSqFtDescending" | "estimatedPriceDescending" | "estimatedPriceAscending") | No | Sort order for search results. | | `bedrooms` | object | No | Bedroom count filter. Use `min` to set the lower bound. | | `features` | object | No | Optional property feature filters. | | `keywords` | string | No | Additional keyword terms to match in listing text. For broader matching, separate terms with commas (for example: 'pool,garage'). | | `location` | string | Yes | Location input for listing search. Use `raw` for user-provided text and `structured` for exact city/state precision. | | `bathrooms` | object | No | Bathroom count filter. Use `min` to set the lower bound. | | `home_types` | array | No | Property types to include. | | `year_built` | object | No | Year-built range. | | `parking_spots` | object | No | Parking spots filter. | | `listing_status` | string ("forSale" | "forRent" | "sold") | No | Listing category to search. | | `lot_area_sq_ft` | object | No | Lot-size range in square feet. | | `next_page_token` | string | No | Pagination token from a previous response. Omit for the first page. | | `floor_area_sq_ft` | object | No | Interior living-area range in square feet. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Look Up a Financial Instrument **Slug:** `FIBER_FINANCIAL_INSTRUMENT_LOOKUP` Billable operation: Returns live market data for a stock, index, currency pair, or fund, including the headline quote, price movement, company facts, financial statements, related news, and a price history series. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `window` | string ("1D" | "5D" | "1M" | "6M" | "YTD" | "1Y" | "5Y" | "MAX") | No | Time range for the price history graph. Omit for `1D` (default, recommended). Setting a non-default window may result in less information being available, so we suggest leaving this null unless you have a strong reason not to. | | `instrument` | string | Yes | How to identify the instrument. Use `index` for a named market index, `mutualFund` for a mutual fund, `stockOrEtf` for a stock or ETF, `currencyPair` for a forex or crypto pair, or `customSymbol` for any other format. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Find Work Email **Slug:** `FIBER_FIND_WORK_EMAIL` Billable and highly privacy-sensitive: find at most one work email from a person's name and company without requiring LinkedIn. Costs 1 credit when an email is found and reports actual cost in chargeInfo. Call FIBER_GET_ORG_CREDITS and obtain explicit user confirmation immediately before every call. Use only for an authorized purpose and subject, and request and retain only necessary personal data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Person name. Provide a full name, or first and last name separately. | | `company` | string | Yes | Company to search. Provide a domain, or a company identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Flight Booking Options **Slug:** `FIBER_FLIGHT_BOOKING_OPTIONS` Billable operation: Retrieves booking options (providers, fares, booking links, and available cabin classes) for a single itinerary selected from a flight search. Pass the `bookingToken` returned on an itinerary from `POST /v1/flights/search` along with the same trip configuration. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `trip` | string | Yes | Trip configuration. The shape is determined by flightType — see each variant for its required fields. | | `booking_token` | string | Yes | Booking token from the `bookingToken` field of an itinerary returned by the flight search endpoint (`POST /v1/flights/search`). | | `currency_code` | string | No | ISO 4217 currency code for prices in the response (e.g. 'EUR', 'GBP', 'CAD'). Case-insensitive. Defaults to USD. Match the value used in the original search so prices stay comparable. | | `language_code` | string | No | Language for booking option labels (e.g. fare names). Pass a BCP-47 language tag such as 'en', 'en-US', 'pt-BR', 'zh-CN', 'ja', 'ko', 'fr', 'de', 'es'. | | `search_market_country_code` | string | No | ISO 3166-1 alpha-3 country code that sets the search market. Match the value used in the original search for consistent pricing and availability. Case-insensitive. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Flight Deals **Slug:** `FIBER_FLIGHT_DEALS` Billable operation: Returns cheap round-trip flight deals from a given departure location, ranked by how much cheaper they are than usual. Dates and destinations are chosen per deal; use flight search when you already know the route and dates. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `discovery` | string | No | How to narrow the deals. Omit to return the cheapest round-trip deals from the departure location. Use the `freeText` mode to describe the kind of destinations you want in plain language (e.g. 'beaches and islands'); use the `filters` mode for precise constraints on price, stops, cabin class, or airline. Provide exactly one mode — they cannot be combined. | | `currency_code` | string | No | ISO 4217 currency code for prices in the response (e.g. 'EUR', 'GBP', 'CAD'). Case-insensitive. Defaults to USD. | | `language_code` | string | No | Language for destination names and descriptions. Pass a BCP-47 language tag such as 'en', 'en-US', 'pt-BR', 'zh-CN', 'ja', 'ko', 'fr', 'de', 'es'. Does not change which deals are returned. Defaults to en. | | `departure_airports` | string | Yes | Where to find deals from. Accepts a single 3-letter IATA airport code (e.g. 'JFK'), an X- metro alias that covers every airport in a metro area (e.g. 'X-NYC' — call GET /v1/enums/flight-regions for the full list), or a Freebase ID — a stable location identifier beginning with '/m/' or '/g/' (e.g. '/m/02_286' for New York City), listed as `freebaseId` in GET /v1/enums/flight-regions. Comma-separated airport lists are not supported; use an X- alias instead. Case-insensitive except Freebase IDs. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Flights **Slug:** `FIBER_FLIGHT_SEARCH` Billable operation: Searches flight itineraries between cities of interest and returns trips, fares, timing, etc. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `trip` | string | Yes | Trip configuration. The shape is determined by flightType — see each variant for its required fields. | | `adults` | integer | No | Number of adult passengers (ages 12+). | | `sort_by` | string ("top" | "price" | "departureTime" | "arrivalTime" | "duration" | "emissions") | No | Sort criterion for results. 'top' ranks by overall value. 'price' sorts cheapest first. 'departureTime' and 'arrivalTime' sort earliest first. 'duration' sorts shortest first. 'emissions' sorts lowest carbon first. Direction is always ascending and cannot be changed. Omit to sort by 'top'. | | `airlines` | object | No | Filter by airline. By default all airlines are considered. If you pass 'include', only flights from those airlines are returned. If you pass 'exclude', flights from those airlines are removed. | | `children` | integer | No | Number of child passengers (ages 2-11). | | `max_price` | integer | No | Maximum total itinerary price in whole currency units. You may want to set `currencyCode` as well so the price cap is in the currency you expect (default currency is USD). Omit for no price cap. | | `max_stops` | integer | No | Maximum number of stops allowed. 0 = nonstop only, 1 = one stop or fewer, 2 = two stops or fewer. Omit to allow any number of stops. | | `show_hidden` | boolean | No | When true, include itineraries that would normally be hidden (e.g. very late or undesirable schedules). | | `travel_class` | string ("economy" | "premiumEconomy" | "business" | "first") | No | Preferred cabin class. Omit to consider flights across all cabin classes. | | `currency_code` | string | No | ISO 4217 currency code for prices in the response (e.g. 'EUR', 'GBP', 'CAD'). Case-insensitive. Defaults to USD. | | `language_code` | string | No | Language for search results (airport names, airline names, labels). Pass a BCP-47 language tag such as 'en', 'en-US', 'pt-BR', 'zh-CN', 'ja', 'ko', 'fr', 'de', 'es'. | | `infants_on_lap` | integer | No | Number of infants (under 2) on an adult's lap. | | `infants_in_seat` | integer | No | Number of infants (under 2) with their own seat. | | `next_page_token` | string | No | Token to retrieve the next page. Pass as nextPageToken in the next request. Null if no more pages. | | `layover_duration` | object | No | Constrain layover duration. Omit to allow any layover length. | | `min_checked_bags` | integer | No | Minimum checked bags the itinerary must include. Omit for no requirement. Honored on a best-effort basis: not every itinerary exposes checked-bag inclusion. | | `min_carry_on_bags` | integer | No | Minimum carry-on bags the itinerary must include. Omit for no requirement. | | `return_time_window` | object | No | Time-of-day window for return flights (round-trip only). Both startHour and endHour must be provided together per sub-window. | | `connecting_airports` | object | No | Filter by connecting airports. By default all connecting airports are allowed. We recommend not passing this unless you have a good reason — it significantly reduces the number of results returned. | | `outbound_time_window` | object | No | Time-of-day window for outbound flights. For multi-city trips this constrains the first segment. Both startHour and endHour must be provided together per sub-window. | | `hide_separate_tickets` | boolean | No | When true, drop itineraries that combine separately-issued tickets (which carry higher disruption risk). | | `search_market_country_code` | string | No | ISO 3166-1 alpha-3 country code that sets the search market (e.g. 'GBR', 'BRA'). This affects regional pricing and flight availability — the same route may show different prices and options depending on the market. Case-insensitive. | | `max_flight_duration_minutes` | integer | No | Maximum total flight duration in minutes. Omit for no limit. | | `only_show_low_emission_flights` | boolean | No | When true, only return flights with lower-than-typical carbon emissions. When false (default), return all flights. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Accelerators **Slug:** `FIBER_GET_ACCELERATORS` Free read: Get a list of all accelerators with their metadata, total company counts, and statistics broken down by batch and year. Useful for filtering accelerator data in search APIs. This operation does not spend credits or modify Fiber state. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List API Keys **Slug:** `FIBER_GET_ALL_API_KEYS` Free read: List all API keys for your organization, including each key's name, prefix, expiration, and per-key credit usage. The secret value of a key is only shown once at creation and is never returned here. First-time users: create your initial API key at https://app.fiber.ai or via POST /v1/account/send-otp + verify-otp. This endpoint manages keys once you have one. This operation does not spend credits or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `include_revoked` | boolean | No | Include revoked keys in the results. Defaults to false, returning only active keys. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Companies in an Audience **Slug:** `FIBER_GET_AUDIENCE_COMPANIES` Free read: Gets the companies in an audience with pagination. Use the nextCursor from the response to fetch the next page. This operation does not spend credits or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | The pagination cursor from the previous page. | | `page_size` | integer | No | The number of companies to return per page (max 500). | | `audience_id` | string | Yes | The unique ID of the audience. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Prospects in an Audience **Slug:** `FIBER_GET_AUDIENCE_PROSPECTS` Free read: Gets the prospects (people) in an audience with pagination. Use the nextCursor from the response to fetch the next page. This operation does not spend credits or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | The pagination cursor from the previous page. | | `page_size` | integer | No | The number of prospects to return per page (max 500). | | `audience_id` | string | Yes | The unique ID of the audience. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Audience Status **Slug:** `FIBER_GET_AUDIENCE_STATUS` Read-only asynchronous poll: Gets the status and basic statistics of an audience. Use this to poll for build completion after triggering a build. Status values: DRAFT (waiting for configuration), BUILDING (search in progress), NORMAL (ready to use), FAILED (build failed). Use it only for work started by FIBER_BUILD_AUDIENCE. Fiber documents this poll as free; it does not start another job or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `audience_id` | string | Yes | The unique ID of the audience. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Auto Top-up Settings **Slug:** `FIBER_GET_AUTO_TOPUP_SETTINGS` Free read: Get the organization's auto top-up configuration. When configured is false, no auto top-up settings exist yet. This operation does not spend credits or modify Fiber state. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Company Exclusion List **Slug:** `FIBER_GET_COMPANY_EXCLUSION_LISTS` Free read: Get company exclusion list. This operation does not spend credits or modify Fiber state. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Company Revenue Estimate **Slug:** `FIBER_GET_COMPANY_REVENUE` Billable operation: Fetches the most recent annual revenue estimate for a company. Pass a LinkedIn company URL, domain, and/or company name. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `company_metadata` | object | Yes | Structured company metadata settings for this operation; populate the documented nested fields. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get API Key **Slug:** `FIBER_GET_CURRENT_API_KEY` Free read: Return details about an API key, including its name, prefix, expiration, and per-key credit usage. Acts on the key that authenticates this request unless target is OTHER. First-time users: create your initial API key at https://app.fiber.ai or via POST /v1/account/send-otp + verify-otp. This endpoint manages keys once you have one. This operation does not spend credits or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `target` | string ("SELF" | "OTHER") | No | Which key to act on. SELF acts on the key that authenticates this request. OTHER acts on a different key in your organization, supplied in targetApiKey. | | `target_api_key` | string | No | The key to act on when target is OTHER. Must belong to your organization. You can pass prefix, id, or the raw key. Omit when target is SELF. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Current Companies in Saved Search **Slug:** `FIBER_GET_CURRENT_COMPANIES_IN_SAVED_SEARCH` Free read: Get current companies found for a specific saved search. This operation does not spend credits or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | The cursor to start from | | `statuses` | array | No | The statuses of the companies. This is optional and if not provided, all current companies will be returned. | | `page_size` | integer | No | The number of companies to return | | `saved_search_id` | string | Yes | The ID of the saved search | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Current Profiles in Saved Search **Slug:** `FIBER_GET_CURRENT_PROFILES_IN_SAVED_SEARCH` Free read: Get current profiles found for a specific saved search. This operation does not spend credits or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | The cursor to start from | | `statuses` | array | No | The statuses of the profiles. This is optional and if not provided, all current profiles will be returned. | | `page_size` | integer | No | The number of profiles to return | | `saved_search_id` | string | Yes | The ID of the saved search | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Count Employees Per Department **Slug:** `FIBER_GET_DEPARTMENT_SIZE` Billable operation: Counts how many current employees at a company fall into each department you define. Unlike the depth-chart endpoint, this Synchronous endpoint provides immediate results without waiting for background job generation. You supply the job titles that define each department (no seniority is considered), and every current employee is counted not just a sample. This endpoint performs a headcount snapshot for direct, actionable data. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `company` | string | Yes | Company identifier. Set identifier to 'linkedinUrl', 'linkedinSlug', 'linkedinOrgId', or 'domain' and provide the corresponding value. | | `departments` | array | Yes | Departments to size. Each is counted independently against ALL current employees, so overlapping definitions may count the same person in more than one department. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Enrichment Status **Slug:** `FIBER_GET_ENRICHMENT_STATUS` Read-only asynchronous poll: Gets the current status of an audience enrichment run. Returns progress information including current stage, progress percentage, completed steps, and remaining steps. Use this endpoint to poll for enrichment completion. Use it only for work started by FIBER_TRIGGER_ENRICHMENT. Fiber documents this poll as free; it does not start another job or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `audience_id` | string | Yes | The unique ID of the audience. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Excluded Companies for Exclusion List **Slug:** `FIBER_GET_EXCLUDED_COMPANIES_FOR_EXCLUSION_LIST` Free read: Get excluded companies for a specific exclusion list with pagination. This operation does not spend credits or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Pagination cursor | | `page_size` | integer | No | Number of companies to return per page | | `exclusion_list_id` | string | Yes | ID of the company exclusion list | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Excluded Prospects for Exclusion List **Slug:** `FIBER_GET_EXCLUDED_PROSPECTS_FOR_EXCLUSION_LIST` Free read: Get excluded prospects for a specific exclusion list with pagination. This operation does not spend credits or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Pagination cursor | | `page_size` | integer | No | Number of prospects to return per page | | `exclusion_list_id` | string | Yes | ID of the prospect exclusion list | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Flight Region Aliases **Slug:** `FIBER_GET_FLIGHT_REGIONS` Free read: List every supported `X-` flight region alias along with its metro name and the IATA airport codes it covers. Pass `apiCode` as `departureAirports` / `arrivalAirports` in `POST /v1/flights/search` to search across an entire metro area in one call. This operation does not spend credits or modify Fiber state. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Hotel Amenity Filters **Slug:** `FIBER_GET_HOTEL_AMENITIES` Free read: List supported hotel amenity filter identifiers for use in `amenities` on POST /v1/hotels/search. This operation does not spend credits or modify Fiber state. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Hotel Brand Filters **Slug:** `FIBER_GET_HOTEL_BRANDS` Free read: List supported hotel brand filter identifiers for use in `brands` on POST /v1/hotels/search. This operation does not spend credits or modify Fiber state. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Hotel Property Type Filters **Slug:** `FIBER_GET_HOTEL_PROPERTY_TYPES` Free read: List supported hotel property type filter identifiers for use in `propertyTypes` on POST /v1/hotels/search. This operation does not spend credits or modify Fiber state. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Industries **Slug:** `FIBER_GET_INDUSTRIES` Free read: Get lists of various industry categorizations. Useful for our company search API. This operation does not spend credits or modify Fiber state. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a Job Changes List **Slug:** `FIBER_GET_JOB_CHANGE_LIST` Free read: Get a job changes list. This operation does not spend credits or modify Fiber state. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_change_list_id` | string | Yes | The ID of the job change list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Languages **Slug:** `FIBER_GET_LANGUAGES` Free read: Get a list of all languages that you can pass to our API. This operation does not spend credits or modify Fiber state. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Latest Saved Search Run **Slug:** `FIBER_GET_LATEST_SAVED_SEARCH_RUN` Free read: Get the latest saved search run for a specific saved search. This operation does not spend credits or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `saved_search_id` | string | Yes | The ID of the saved search | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Preset Metro Areas **Slug:** `FIBER_GET_METRO_AREAS` Free read: List all preset metro area regions available for geographic filtering. Each region includes a slug (usable with the `preset-region` strategy in location-based search endpoints), geometry (center + radius for circles, vertices for polygons), major cities, and synonyms for fuzzy matching. This operation does not spend credits or modify Fiber state. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List NAICS Codes **Slug:** `FIBER_GET_NAICS_CODES` Free read: Get all NAICS (North American Industry Classification System) codes from the 2022 version. Returns each code and its corresponding title. This operation does not spend credits or modify Fiber state. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Organization Credits **Slug:** `FIBER_GET_ORG_CREDITS` Check Fiber API-key access, available organization credits, usage-period reset, and organization-specific operation prices. This read-only check is free and should be called before every billable Fiber action. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Prospect Exclusion Lists **Slug:** `FIBER_GET_PROSPECT_EXCLUSION_LISTS` Free read: Get prospect exclusion lists. This operation does not spend credits or modify Fiber state. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Organization Rate Limits **Slug:** `FIBER_GET_RATE_LIMITS` Free read: Returns the effective rate limits for all API endpoints for your organization. If your organization has custom rate limits on any endpoint, those are reflected here. This operation does not spend credits or modify Fiber state. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Countries and Regions **Slug:** `FIBER_GET_REGIONS` Free read: Get a list of all countries and regions supported by the API, along with their names, codes, and additional metadata. This operation does not spend credits or modify Fiber state. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Saved Search **Slug:** `FIBER_GET_SAVED_SEARCH` Free read: Get all details for a specific saved search. This operation does not spend credits or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `saved_search_id` | string | Yes | The ID of the saved search | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Saved Search Run **Slug:** `FIBER_GET_SAVED_SEARCH_RUN` Free read: Get all details for a specific saved search run. This operation does not spend credits or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `saved_search_run_id` | string | Yes | The ID of the saved search run | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Saved Search Run Companies **Slug:** `FIBER_GET_SAVED_SEARCH_RUN_COMPANIES` Free read: Get the companies found for a specific saved search run. This operation does not spend credits or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | The cursor to start from | | `statuses` | array | No | The statuses of the companies. This is optional and if not provided, all companies will be returned. | | `page_size` | integer | No | The number of companies to return | | `saved_search_run_id` | string | Yes | The ID of the saved search run | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Saved Search Run Profiles **Slug:** `FIBER_GET_SAVED_SEARCH_RUN_PROFILES` Free read: Get the profiles found for a specific saved search run. This operation does not spend credits or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | The cursor to start from | | `statuses` | array | No | The statuses of the profiles. This is optional and if not provided, all profiles will be returned. | | `page_size` | integer | No | The number of profiles to return | | `saved_search_run_id` | string | Yes | The ID of the saved search run | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Saved Search Run Status **Slug:** `FIBER_GET_SAVED_SEARCH_RUN_STATUS` Read-only asynchronous poll: Returns the execution status and metadata for a saved search run, including start time, completion time (if finished), and current status (NOT_STARTED, PROCESSING, COMPLETED, or FAILED). Use it only for work started by FIBER_MANUALLY_SPAWN_SAVED_SEARCH_RUN. Fiber documents this poll as free; it does not start another job or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `saved_search_run_id` | string | Yes | The ID of the saved search run | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Company Scouting Report **Slug:** `FIBER_GET_SCOUTING_REPORT` Billable operation: Generates a comprehensive scouting report for a company including news, founders, funding, media links, and historical headcount. This endpoint may take 1-2 minutes to respond as it gathers data from multiple sources please set a generous client timeout (at least 120 seconds). Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `company` | string | Yes | Company identifier. Set identifier to 'linkedinUrl', 'linkedinSlug', 'linkedinOrgId', or 'domain' and provide the corresponding value. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Skills **Slug:** `FIBER_GET_SKILLS` Free read: Get the most common professional skills across profiles. Returns up to 1,000 skill names sorted by popularity. Useful for building skill-based search filters. This operation does not spend credits or modify Fiber state. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Subdivisions by Country **Slug:** `FIBER_GET_SUBDIVISIONS` Free read: Get a list of subdivisions (states, provinces, Lander, etc.) for a given country, identified by ISO 3166-1 alpha-2 or alpha-3 code. This operation does not spend credits or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `country_code` | string | Yes | ISO 3166-1 alpha-2 (e.g. 'US') or alpha-3 (e.g. 'USA') country code. Use GET /enums/regions to look up codes by country name. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Profile and Company Tags **Slug:** `FIBER_GET_TAGS` Free read: Get a list of all profile and company tags that you can use to filter searches in our API, along with their descriptions. This operation does not spend credits or modify Fiber state. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Talent Flow Analysis for a Company **Slug:** `FIBER_GET_TALENT_FLOW` Billable operation: Visualizes talent movement at a company. Use 'joiners' to see where a company is hiring from which competitors, universities, and regions it pulls talent from during the time window. Use 'leavers' to see where a company's alumni are going which companies or startups are attracting its former employees. Processes up to 10,000 profiles per request. Large companies may take up to two minutes to analyze. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `company` | string | Yes | Company to analyze. Set identifier to 'linkedinUrl', 'linkedinSlug', 'linkedinOrgId', or 'domain' and provide the corresponding value. | | `direction` | string ("joiners" | "leavers") | Yes | Direction of talent flow. 'joiners' finds people who started at the company within the window and reports where they came from. 'leavers' finds people who left the company within the window and reports where they went. | | `date_range` | object | Yes | Inclusive bounds that constrain the date range; provide the documented start and end values. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Top Talent Sources/destinations for a Company **Slug:** `FIBER_GET_TALENT_FLOW_RIVALS` Billable operation: Given a company, find the companies where most of its talent is heading to or coming from, in both directions. For instance, company A might have gained N people from company X but lost M people to them in a given window. Reports the two-way head-to-head flow for the most important sources and destinations of the chosen firm. Processes up to 10,000 profiles per direction. Large companies may take up to four minutes to analyze. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `company` | string | Yes | Company to analyze. Set identifier to 'linkedinUrl', 'linkedinSlug', 'linkedinOrgId', or 'domain' and provide the corresponding value. | | `date_range` | object | Yes | Inclusive bounds that constrain the date range; provide the documented start and end values. | | `num_companies_per_side` | integer | No | Number of top donor and acceptor companies to include. Donors are companies the analyzed company gained the most people from; acceptors are companies it lost the most people to. Overlapping companies are combined, so the rival list may hold fewer than twice this number. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Technologies **Slug:** `FIBER_GET_TECHNOLOGIES` Free read: Get all searchable technologies and platforms with their synonyms. Useful for the technology search API. This operation does not spend credits or modify Fiber state. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Time Zones **Slug:** `FIBER_GET_TIME_ZONES` Free read: Get a comprehensive list of all available time zones with geographic information, current time data, and UTC offset ranges. Useful for populating time zone filters in search requests. This operation does not spend credits or modify Fiber state. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Company Tracker List **Slug:** `FIBER_GET_TRACKER_COMPANY_LIST` Free read: Get a single company tracker list by ID. This operation does not spend credits or modify Fiber state. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | string | Yes | The unique ID of the tracker list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Summarize All Tracker Lists **Slug:** `FIBER_GET_TRACKER_OVERVIEW` Free read: Returns every tracker list you own in a single call, with entity counts and a forecast of upcoming refresh costs. Use the individual GET endpoints for full rule details. This operation does not spend credits or modify Fiber state. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Person Tracker List **Slug:** `FIBER_GET_TRACKER_PERSON_LIST` Free read: Get a single person tracker list by ID. This operation does not spend credits or modify Fiber state. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | string | Yes | The unique ID of the tracker list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Webhook Endpoint **Slug:** `FIBER_GET_WEBHOOK_ENDPOINT` Free read: Return a single webhook endpoint's configuration: its delivery URL, the event types it is subscribed to, and whether delivery is currently paused. Reading webhook endpoints is free. This operation does not spend credits or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `endpoint_id` | string | Yes | The unique ID of the webhook endpoint. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Poll GitHub Lookup **Slug:** `FIBER_GITHUB_LOOKUP_POLL` Read-only asynchronous poll: Poll for the results of a GitHub lookup task. Returns progress breakdown and all completed results in a single response (no pagination). Use it only for work started by FIBER_GITHUB_LOOKUP_TRIGGER. No polling charge is documented; it does not start another job or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `github_agent_run_id` | string | Yes | The ID of the GitHub lookup agent run which you got back from the trigger endpoint. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Start GitHub Lookup **Slug:** `FIBER_GITHUB_LOOKUP_TRIGGER` Billable asynchronous trigger: Use our AI agent to find GitHub profiles for a list of people using name and optional context like LinkedIn URL, work email, company, and job title. Check progress or retrieve results with FIBER_GITHUB_LOOKUP_POLL. Confirm the expected credit charge immediately before starting work; do not retry merely because results are not yet ready. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `people` | array | Yes | List of people to look up. Maximum 1000 people can be provided at a time. | | `overall_context` | string | Yes | A descriptor of what the people have in common (e.g. "Engineers at Fiber AI" or "YC founders 2021 batch"). Helps disambiguate people with similar names. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Poll GitHub-to-LinkedIn Lookup **Slug:** `FIBER_GITHUB_TO_LINKED_IN_POLLING` Read-only asynchronous poll: Poll for the results of a GitHub to LinkedIn lookup task. Use it only for work started by FIBER_GITHUB_TO_LINKED_IN_TRIGGER. No polling charge is documented; it does not start another job or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | The cursor from where to start fetching the next page of results. Provide `nextCursor` from the previous response to continue from there. | | `page_size` | number | No | The number of results to fetch per page. | | `github_agent_run_id` | string | Yes | The ID of the GitHub to LinkedIn lookup run which you got back from the trigger endpoint. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Find Person by GitHub Username **Slug:** `FIBER_GITHUB_TO_LINKEDIN_SINGLE` Billable operation: Given a GitHub username, find the person's LinkedIn profile and extract work emails. Use `outputType` to control what data is returned and charged for. For outputType=linkedin we only return LinkedIn fields, for outputType=email we only return emails, for outputType=both we return both. To avoid 429 errors, spread requests evenly instead of sending a burst. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `context` | string | No | Optional descriptor of who this person is (e.g. "Engineer at Fiber AI" or "YC founder 2021 batch"). Improves disambiguation on common names. Max 1000 characters. | | `output_type` | string ("linkedin" | "email" | "both") | No | What to extract from GitHub profile. 'linkedin' finds LinkedIn profile, 'email' extracts work emails from commits, 'both' returns both. | | `github_username` | string | Yes | The GitHub username to look up. | | `customer_provided_id` | string | No | Optional customer-provided ID to tie results back to original input. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Start GitHub-to-LinkedIn Lookup **Slug:** `FIBER_GITHUB_TO_LINKED_IN_TRIGGER` Billable asynchronous trigger: Convert GitHub usernames to LinkedIn profiles or get emailIds. Use outputType flag to specify what to retrieve. Check progress or retrieve results with FIBER_GITHUB_TO_LINKED_IN_POLLING. Confirm the expected credit charge immediately before starting work; do not retry merely because results are not yet ready. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `people` | array | Yes | List of GitHub usernames to look up. Maximum 1000 people can be provided at a time. | | `output_type` | string ("linkedin" | "email" | "both") | No | What to extract from GitHub profile. 'linkedin' finds LinkedIn profile, 'email' extracts work emails from commits, 'both' returns both. | | `overall_context` | string | No | A descriptor of what the people have in common (e.g. "Engineers at Fiber AI" or "YC founders 2021 batch"). Helps disambiguate people with similar names. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a Google Maps Place **Slug:** `FIBER_GOOGLE_MAPS_PLACE` Billable operation: Get detailed information about a Google Maps place, including hours, contact details, ratings, and attributes. Search for places via `POST /v1/google-maps/search`. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `place_id` | string | Yes | Google Maps place ID (e.g. 'ChIJN1t_tDeuEmsRUsoyG83frY4'). Obtain it from the `placeId` of a result returned by the Google Maps search endpoint (`POST /v1/google-maps/search`). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Google Maps Place Reviews **Slug:** `FIBER_GOOGLE_MAPS_REVIEWS` Billable operation: Get reviews of a Google Maps place, paginated, with reviewer details, ratings, and full review text. Obtain the place ID via `POST /v1/google-maps/search`. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort_by` | string ("relevance" | "newest") | No | Sort criterion for reviews. Applies to the first page only: later pages keep the sort the first page used, so changing it mid-pagination has no effect. | | `place_id` | string | Yes | Google Maps place ID (e.g. 'ChIJN1t_tDeuEmsRUsoyG83frY4'). Obtain it from the `placeId` of a result returned by the Google Maps search endpoint (`POST /v1/google-maps/search`). | | `next_page_token` | string | No | Pagination token from a prior response's `nextPageToken`. Omit (or pass null) to fetch the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Google Maps Places **Slug:** `FIBER_GOOGLE_MAPS_SEARCH` Billable operation: Searches Google Maps for places matching a query, and returns them with ratings, review counts, and contact details. Responds synchronously with one page of up to 20 results. For bulk collection across a region, use POST /v1/google-maps-search/start instead, which runs in the background and is polled for results. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | What to search for (e.g. 'coffee shop' or 'The Modern'). A business name also works. | | `location` | string | No | Where to search. Accepts a city and state ('Brooklyn, NY'), a full address, or a ZIP code. Omit to search without a location bias. | | `next_page_token` | string | No | Pagination token from a prior response's `nextPageToken`. Omit (or pass null) to fetch the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Find Person by Hashed Email (HEM) **Slug:** `FIBER_HEM_LOOKUP` Billable operation: Given up to 100 hashed email addresses (HEMs), return the address each one belongs to, plus the LinkedIn identifiers we have for that person. Confirm the documented credit cost immediately before calling. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `hashed_emails` | array | Yes | Up to 100 SHA-256, MD5, or SHA-1 digests of lowercased, trimmed email addresses. Each hash must be a hexadecimal digest, upper or lower case, of the lowercased and trimmed address — SHA-256 is 64 characters, MD5 is 32, and SHA-1 is 40. A hash that is not a valid digest is returned as a `rejected` result rather than failing the request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Hotel Property Details **Slug:** `FIBER_HOTEL_PROPERTY` Billable operation: Retrieves full details for a single hotel or vacation rental, including amenities, images, and booking offers. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `adults` | integer | No | Number of adult guests (at least 1). Total guests (`adults` + `children`) must not exceed 6 for hotels or 10 for vacation rentals. | | `children` | integer | No | Number of child guests. Total guests (`adults` + `children`) must not exceed 6 for hotels or 10 for vacation rentals. | | `check_in_date` | string | Yes | Check-in date for the stay. | | `children_ages` | array | No | Ages of each child guest. Must contain exactly `children` entries when `children` is greater than zero. | | `currency_code` | string | No | ISO 4217 currency code for prices in the response (e.g. 'EUR', 'GBP', 'CAD'). Case-insensitive. Defaults to USD. | | `language_code` | string | No | Language for results such as property names and amenity labels. Pass a BCP-47 language tag such as 'en', 'en-US', 'pt-BR', 'zh-CN', 'ja', 'ko', 'fr', 'de', or 'es'. Defaults to en. | | `check_out_date` | string | Yes | Check-out date for the stay. | | `property_token` | string | Yes | Opaque identifier for a specific hotel or vacation rental. Obtain it from the `propertyToken` of a result returned by the hotel search endpoint (`POST /v1/hotels/search`). | | `search_market_country_code` | string | No | ISO 3166-1 alpha-3 country code that sets the search market (e.g. 'GBR', 'BRA'). This affects regional pricing and availability. Case-insensitive. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Hotels **Slug:** `FIBER_HOTEL_SEARCH` Billable operation: Searches hotels and vacation rentals for a destination and returns matching properties with rates, ratings, and amenities. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Destination or hotel search query (e.g. 'Hotels in Manhattan New York'). | | `adults` | integer | No | Number of adult guests (at least 1). Total guests (`adults` + `children`) must not exceed 6 for hotels or 10 for vacation rentals. | | `sort_by` | string ("relevance" | "lowestPrice" | "highestRating" | "mostReviewed") | No | Sort criterion for results. 'relevance' ranks by overall match. 'lowestPrice' sorts cheapest first. 'highestRating' sorts by guest rating. 'mostReviewed' sorts by review count. Omit to sort by relevance. | | `category` | string | No | Property category and its category-specific filters. 'hotel' accepts hotel filters (star class, property types, amenities, brands, and the free-cancellation/special-offers/eco-certified toggles); 'vacationRental' accepts bedroom/bathroom minimums. Defaults to a plain hotel search when omitted. | | `children` | integer | No | Number of child guests. Total guests (`adults` + `children`) must not exceed 6 for hotels or 10 for vacation rentals. | | `min_rating` | string ("3.5" | "4.0" | "4.5") | No | Minimum guest rating filter. Omit to include all ratings. | | `price_range` | object | No | Filter by nightly price range in whole currency units. | | `check_in_date` | string | Yes | Check-in date for the stay. | | `children_ages` | array | No | Ages of each child guest. Must contain exactly `children` entries when `children` is greater than zero. | | `currency_code` | string | No | ISO 4217 currency code for prices in the response (e.g. 'EUR', 'GBP', 'CAD'). Case-insensitive. Defaults to USD. | | `language_code` | string | No | Language for results such as property names and amenity labels. Pass a BCP-47 language tag such as 'en', 'en-US', 'pt-BR', 'zh-CN', 'ja', 'ko', 'fr', 'de', or 'es'. Defaults to en. | | `check_out_date` | string | Yes | Check-out date for the stay. | | `next_page_token` | string | No | Opaque pagination token from a prior search response's `nextPageToken`. Omit (or pass null) to fetch the first page. | | `search_market_country_code` | string | No | ISO 3166-1 alpha-3 country code that sets the search market (e.g. 'GBR', 'BRA'). This affects regional pricing and availability. Case-insensitive. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch Instagram Post Comments **Slug:** `FIBER_INSTAGRAM_POST_COMMENTS` Billable operation: Fetches comments for an Instagram post. Returns a paginated list. Use the `nextPageToken` field from the response to retrieve subsequent pages. Accepts a full post URL (e.g. 'https://www.instagram.com/p/DVoDVg5DkXM/') or a bare shortcode (e.g. 'DVoDVg5DkXM'). Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `post_url` | string | Yes | Full Instagram post URL (e.g. 'https://www.instagram.com/p/DVoDVg5DkXM/') or shortcode (e.g. 'DVoDVg5DkXM'). | | `next_page_token` | string | No | Pagination token from a previous response to retrieve the next page. Omit for the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch Instagram Post Details **Slug:** `FIBER_INSTAGRAM_POST_DETAILS` Billable operation: Fetches details for a single Instagram post including caption, like count, and media URL. Accepts a full post URL (e.g. 'https://www.instagram.com/p/DVoDVg5DkXM/') or a bare shortcode (e.g. 'DVoDVg5DkXM'). Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `post_url` | string | Yes | Full Instagram post URL (e.g. 'https://www.instagram.com/p/DVoDVg5DkXM/') or shortcode (e.g. 'DVoDVg5DkXM'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch Instagram User Profile **Slug:** `FIBER_INSTAGRAM_PROFILE` Billable operation: Fetches profile information for an Instagram user including follower counts, bio, and account type. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `handle` | string | Yes | Instagram handle to look up. Accepts with or without a leading '@' (e.g. 'natgeo' or '@natgeo'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch Instagram User Posts **Slug:** `FIBER_INSTAGRAM_USER_POSTS` Billable operation: Fetches the latest posts for an Instagram user. Returns a paginated list of posts with engagement metrics. Use the `nextPageToken` field from the response to retrieve subsequent pages. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `handle` | string | Yes | Instagram handle (with or without leading '@'). | | `next_page_token` | string | No | Pagination token from a previous response to retrieve the next page. Omit for the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch Instagram User Reels **Slug:** `FIBER_INSTAGRAM_USER_REELS` Billable operation: Fetches the latest reels for an Instagram user. Returns a paginated list of reels with engagement metrics. Use the `nextPageToken` field from the response to retrieve subsequent pages. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `handle` | string | Yes | Instagram handle (with or without leading '@'). | | `next_page_token` | string | No | Pagination token from a previous response to retrieve the next page. Omit for the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Job Title Synonym Expansion **Slug:** `FIBER_JOB_TITLE_REWRITE` Billable operation: Expand a job title into synonyms and related variations. Useful for broadening job title searches to improve yield. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of suggestions to return. | | `query` | string | Yes | The job title to expand into synonyms and variations. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List All Job Changes Lists **Slug:** `FIBER_LIST_ALL_JOB_CHANGE_LISTS` Free read: Lists all job changes lists for your organization. Returns basic info for each list. This operation does not spend credits or modify Fiber state. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | The pagination cursor to continue from a previous response. | | `page_size` | integer | No | The number of job changes lists to return per page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Lists All Profiles from a Job Change List **Slug:** `FIBER_LIST_ALL_PROFILES_FROM_JOB_CHANGE_LIST` Free read: Get current state of all profiles from the list. Returns basic info for each profile. This operation does not spend credits or modify Fiber state. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | The pagination cursor to continue from a previous response. | | `movements` | array | No | Movements used by this operation. | | `page_size` | integer | No | The number of profiles to return per page. | | `job_change_list_id` | string | Yes | The job change list id. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Your Past API Requests **Slug:** `FIBER_LIST_API_REQUESTS` Free read: List the API requests your organization has made, newest first, with the parameters you sent and how each call turned out. Use it to answer 'what did my agent actually run?' debugging a failed run, auditing usage, or quoting an `errorCode` in a support request. Filter by time range, route, method, status code, or error code, and page through results with `cursor`. History is retained for 14 days; anything older has been purged. Response bodies are not returned only the request side of each call. This operation does not spend credits or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `to` | string | No | Only return requests received strictly before this ISO 8601 timestamp. | | `from_` | string | No | Only return requests received at or after this ISO 8601 timestamp. Logs are retained for 14 days, so earlier timestamps simply return nothing. | | `cursor` | string | No | The cursor from where to start fetching the next page of results. Provide the `nextCursor` from the previous response to continue from there. Keep the same filters as the call that produced the cursor — reusing a cursor while changing filters silently skips rows. | | `method` | string | No | Only return requests using this HTTP method, e.g. "POST". | | `page_size` | integer | No | The number of results to fetch per page. | | `error_code` | string | No | Only return the request carrying this error correlation code. | | `route_path` | string | No | Only return requests to this exact route template, e.g. "/v1/person/search". | | `status_code` | integer | No | Only return requests that returned this exact status code. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List All Audiences **Slug:** `FIBER_LIST_AUDIENCES` Free read: Lists all audiences for your organization. Returns basic info and counts for each audience. Only visible audiences are returned (hidden system audiences are excluded). This operation does not spend credits or modify Fiber state. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Available Tracker Rules **Slug:** `FIBER_LIST_AVAILABLE_TRACKER_RULES` Free read: Returns the tracker rule types available to your organization, with descriptions, configuration schemas, example configs, and example signal payloads. Use this to discover what rules exist before creating tracker lists. Rules flagged `isPremium` monitor additional sources (news coverage and LinkedIn activity) a list containing at least one bills at a minimum per-entity rate per refresh. This operation does not spend credits or modify Fiber state. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Download a Ranked Company List **Slug:** `FIBER_LIST_COMPANY_RANKINGS` Billable operation: Download a ranked company list edition (for example the most recent Fortune 500), including rank, domain, financials, and headcount for every company. Optionally restrict the download to an inclusive rank range. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `rankings` | object | Yes | Structured rankings settings for this operation; populate the documented nested fields. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Saved Searches **Slug:** `FIBER_LIST_SAVED_SEARCH` Free read: List saved searches. This operation does not spend credits or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | The pagination cursor to continue from a previous response. | | `page_size` | integer | No | The number of saved searches to return per page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Saved Search Runs **Slug:** `FIBER_LIST_SAVED_SEARCH_RUNS` Free read: List saved search runs. This operation does not spend credits or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | The cursor to start from. You can pass null to get the first page of results. | | `page_size` | integer | No | The number of runs to return | | `saved_search_id` | string | Yes | The ID of the saved search. Use /saved-search/list to get the ID of a saved search. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Company Tracker Lists **Slug:** `FIBER_LIST_TRACKER_COMPANY_LISTS` Free read: List all company tracker lists for your organization. This operation does not spend credits or modify Fiber state. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Person Tracker Lists **Slug:** `FIBER_LIST_TRACKER_PERSON_LISTS` Free read: List all person tracker lists for your organization. This operation does not spend credits or modify Fiber state. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Signals **Slug:** `FIBER_LIST_TRACKER_SIGNALS` Free read: Retrieve signals for a tracker list. Each signal represents a detected change that matched one of your tracking rules (e.g., a person changed jobs, a company raised funding). Use the `filter` query parameter to control which signals are returned: 'real' (default) for production signals only, 'dummy' for test signals generated via the fire-dummy endpoint, or 'all' for both. Pass `filter=dummy` to validate your integration by consuming test signals through the same polling flow you use in production. This operation does not spend credits or modify Fiber state. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `since` | string | No | Only return signals observed after this date. Example: '2024-06-01T00:00:00Z'. | | `cursor` | string | No | Pass the nextCursor value from the previous response to fetch the next page. Omit or pass null to start from the beginning. | | `filter` | string ("all" | "real" | "dummy") | No | Filter signals by type. 'real' (default) returns only production signals. 'dummy' returns only test signals generated via the fire-dummy endpoint — use this to validate your integration without needing webhooks. 'all' returns both. | | `list_id` | string | Yes | The unique ID of the tracker list. | | `page_size` | integer | No | Number of results per page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Webhook Endpoints **Slug:** `FIBER_LIST_WEBHOOK_ENDPOINTS` Free read: List every webhook endpoint configured for your organization, including each endpoint's delivery URL, subscribed event types, and paused state. Reading webhook endpoints is free. This operation does not spend credits or modify Fiber state. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Webhook Event Types **Slug:** `FIBER_LIST_WEBHOOK_EVENT_TYPES` Free read: List every event type you can subscribe a webhook endpoint to. Each entry includes a description of when the event fires and an example payload so you can build and test your receiver before creating an endpoint. This operation does not spend credits or modify Fiber state. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Find Person by Email (lite, High-volume) **Slug:** `FIBER_LITE_REVERSE_EMAIL_LOOKUP` Billable operation: Given an email address, find the person's LinkedIn profile. Lite version optimized for high-volume usage at lower cost. Skips expensive yield increasing operations. Confirm the documented credit cost immediately before calling. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `email` | string | Yes | The email address of a person whose LinkedIn profile you want to find. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Location Typeahead **Slug:** `FIBER_LOCATION_TYPEAHEAD` Billable operation: Get the latitude/longitude of a given city, including prefixes (e.g. 'san fr'). This makes it good for typeaheads in your UI. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | The search query for a location. Accepts a city name or ZIP/postal code, either complete (e.g. 'New York') or partial (e.g. 'san fr'). Neighborhoods, street addresses, states, and countries are not supported. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Manually Spawn Saved Search Run **Slug:** `FIBER_MANUALLY_SPAWN_SAVED_SEARCH_RUN` Billable asynchronous trigger: Manually spawn a new saved search run. Check progress or retrieve results with FIBER_GET_SAVED_SEARCH_RUN_STATUS. Confirm the expected credit charge immediately before starting work; do not retry merely because results are not yet ready. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `saved_search_id` | string | Yes | The ID of the saved search | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Multi-source AI Search **Slug:** `FIBER_MULTI_SOURCE_SEARCH` Billable operation: AI-powered natural language search across multiple sources (LinkedIn, Google Maps, web, and more). Ideal for local business search where companies/employees have spotty web or LinkedIn presence. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `search` | string | Yes | Search filters and criteria that define which matching people or companies to include. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Parse Natural Language to Search Params **Slug:** `FIBER_NLP_SEARCH_PARSE` Billable operation: Parses a natural language query into structured search parameters without executing the search. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Natural language search query to parse into structured filters. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Poll Batch Contact Reveal **Slug:** `FIBER_POLL_BATCH_CONTACT_REVEAL` Free read: fetch current status and one page of highly sensitive results for an existing batch contact-reveal task. Pass output.nextCursor back as next_cursor to continue; omit it for the first page. This action never starts or cancels work. Protect and retain returned personal data only as authorized. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `take` | integer | No | Maximum results to return on this page (1-100). | | `task_id` | string | Yes | Task ID returned by FIBER_START_BATCH_CONTACT_REVEAL. | | `next_cursor` | string | No | Opaque nextCursor from the previous poll response; omit for the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Poll Batch Live Enrichment **Slug:** `FIBER_POLL_BATCH_LIVE_ENRICH` Read-only asynchronous poll: Polls a batch live enrichment task for progress and results. Returns paginated enrichment results as they complete. Call repeatedly until status is 'completed' or 'failed'. For profile batches, pass `getDetailedEducation`/`getDetailedWorkExperience` on a given poll call to include deep education/work-experience details in that page's results; this slows the call down, so only enable it if you need it. Use it only for work started by FIBER_START_BATCH_LIVE_ENRICH. No polling charge is documented; it does not start another job or modify Fiber state. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `take` | integer | No | Number of results per page. Defaults to 100. | | `cursor` | string | No | Pagination cursor from the previous poll response. Omit for the first request. | | `task_id` | string | Yes | The batch ID returned from the start endpoint | | `get_detailed_education` | boolean | No | Whether to include deep details about each educational item, like the school's LinkedIn URL, website, location, etc. That'll be put in the detailedEducation array. This slows down the API call, so only enable this if you need it. | | `get_detailed_work_experience` | boolean | No | Whether to include deep details about each work experience item, like the company's LinkedIn URL, website, location, etc. That'll be put in the detailedWorkExperience array. This slows down the API call, so only enable this if you need it. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Poll Depth Chart Generation Result **Slug:** `FIBER_POLL_DEPTH_CHART` Read-only asynchronous poll: Retrieves the employee breakdown started by the `depth-chart/start` endpoint. Pass the report ID you received when you started the report. Returns the current status and, once complete, numerical counts of employees grouped by department, seniority, or both, plus a printable markdown summary in tabular format useful for CLI output or for LLMs building reports. Returns summary stats per bucket, not the individual people in each bucket. Use it only for work started by FIBER_START_DEPTH_CHART. Fiber documents this poll as free; it does not start another job or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `report_id` | string | Yes | Report ID returned by the /depth-chart/start endpoint | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Poll Exhaustive Contact Reveal **Slug:** `FIBER_POLL_EXHAUSTIVE_CONTACT_REVEAL` Free read: fetch status and the eventual highly sensitive result of an existing exhaustive contact-reveal task. This action never starts another reveal. Poll until output.done is true or profile.status is completed or failed. Exclude lowQualityEmails from use and protect all returned personal data according to the authorized purpose and retention policy. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `task_id` | string | Yes | Task ID returned by FIBER_START_EXHAUSTIVE_CONTACT_REVEAL. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Poll Google Maps Search Results **Slug:** `FIBER_POLL_GOOGLE_MAPS_RESULTS` Read-only asynchronous result retrieval: Retrieve a paginated page of Google Maps result rows for a search started by FIBER_START_GOOGLE_MAPS_SEARCH. Pass the returned cursor to retrieve subsequent pages; use FIBER_CHECK_GOOGLE_MAPS_RESULTS when only readiness or progress is needed. No polling charge is documented; it does not start another job or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | A pagination cursor returned from a previous search response. Use this to fetch the next page of results. If this is null, then the first page of results will be returned. | | `page_size` | integer | No | The number of results to return per page. | | `search_id` | string | Yes | The ID of the Google Maps search. You should get this from the start endpoint. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Poll Local Business Search **Slug:** `FIBER_POLL_LOCAL_BUSINESS_SEARCH` Read-only asynchronous poll: Poll Local Business Agent search results for a given researchRunId. Use it only for work started by FIBER_START_LOCAL_BUSINESS_SEARCH. No polling charge is documented; it does not start another job or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | A pagination cursor returned from a previous search response. Use this to fetch the next page of results. If this is null, then the first page of results will be returned. | | `page_size` | integer | No | The number of results to return per page | | `research_run_id` | string | Yes | Research run ID of the local business search | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Poll Mosaic Run Status **Slug:** `FIBER_POLL_MOSAIC` Read-only asynchronous poll: Retrieves the status of a Mosaic job started by `/mosaic/start`. When the run is done, the response includes temporary download links for the enriched CSV and the summary report. Use it only for work started by FIBER_START_MOSAIC. Fiber documents this poll as free; it does not start another job or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `run_id` | string | Yes | Run ID returned by the /mosaic/start endpoint | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch LinkedIn Post Comments **Slug:** `FIBER_POST_COMMENTS_LIVE_FETCH` Billable operation: Fetches paginated comments for a LinkedIn post. Each page contains up to 10 comments. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Pagination cursor for fetching additional pages of posts | | `content_id` | string | Yes | You can get LinkedIn posts from the Profile or Company Posts endpoints. (e.g., 'urn:li:activity:7123456789012345678' or 'urn:li:ugcPost:7391650829398675456') | | `include_tagged_users` | boolean | No | When true, also returns the LinkedIn users @-mentioned (tagged) inside each comment. This might be slower so only enable it if needed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch LinkedIn Post Reactions **Slug:** `FIBER_POST_REACTIONS_LIVE_FETCH` Billable operation: Fetches paginated reactions of a specific type for a LinkedIn post. Each page contains up to 10 reactions. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Pagination cursor for fetching additional pages of posts | | `content_id` | string | Yes | You can get LinkedIn posts from the Profile or Company Posts endpoints. (e.g., 'urn:li:activity:7123456789012345678' or 'urn:li:ugcPost:7391650829398675456') | | `reaction_type` | string ("LIKE" | "LOVE" | "INSIGHTFUL" | "CELEBRATE" | "SUPPORT" | "FUNNY" | "CURIOUS") | No | Type of reaction to fetch. If null, all reactions will be fetched. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search LinkedIn Posts by Keywords **Slug:** `FIBER_POST_SEARCH_BY_KEYWORDS` Billable operation: Search LinkedIn posts using keyword-based queries. Returns a paginated list of matching posts. A page contains at most 50 posts and may contain fewer. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Pagination cursor for fetching additional pages of posts | | `recency` | string ("Day" | "Week" | "Month" | "Quarter" | "HalfYear" | "Year") | No | Filter posts by how recently they were published. Omit to search posts from any time. Windows longer than a month can return fewer posts per page. | | `keywords` | string | Yes | Boolean keyword query for LinkedIn posts. Use at most 5 AND/OR/NOT operators in total; operators inside quoted phrases don't count. See the endpoint description for syntax. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Preview a Signal **Slug:** `FIBER_PREVIEW_TRACKER_SIGNAL` Free read: Returns an example signal payload for a given rule configuration. No side effects nothing is created or dispatched. Free to call. Useful for understanding signal shapes before creating rules. This operation does not spend credits or modify Fiber state. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `config` | string | Yes | Rule configuration to preview. Same shape as when creating a rule. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch LinkedIn Profile Comments **Slug:** `FIBER_PROFILE_COMMENTS_LIVE_FETCH` Billable operation: Fetches comments made by a LinkedIn profile. Returns a paginated feed of comments with optional cursor for pagination. Each page returns up to 10 comments. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Pagination cursor for fetching additional pages of comments | | `identifier` | string | Yes | Identifier can be a profile's LinkedIn slug (e.g. 'williamhgates' from ), a Sales Navigator URN (e.g. 'ACwAAA.....'), or a full LinkedIn URL (e.g. 'https://www.linkedin.com/in/williamhgates/') | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Live Fetch LinkedIn Profile **Slug:** `FIBER_PROFILE_LIVE_ENRICH` Billable operation: Returns an enriched profile with details (work experience, education, skills, location, etc.) for a given LinkedIn profile identifier. **Note:** This endpoint does NOT return emails or phone numbers. To retrieve a person's contact details (emails and phone numbers), use the `POST /contact-details/single` endpoint (synchronous, recommended) or the `POST /individual-reveal/start` + `POST /individual-reveal/poll` pair (asynchronous). These can be found under the **Contact details** section. Confirm the documented credit cost immediately before calling. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `identifier` | string | Yes | The profile's LinkedIn slug (e.g. 'williamhgates'), full LinkedIn URL (e.g. 'https://www.linkedin.com/in/williamhgates/'), Sales Navigator URN, or LinkedIn user ID (e.g. '443105112'). | | `get_detailed_education` | boolean | No | Whether to include deep details about each educational item, like the school's LinkedIn URL, website, location, etc. That'll be put in the detailedEducation array. This slows down the API call, so only enable this if you need it. | | `get_detailed_work_experience` | boolean | No | Whether to include deep details about each work experience item, like the company's LinkedIn URL, website, location, etc. That'll be put in the detailedWorkExperience array. This slows down the API call, so only enable this if you need it. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch LinkedIn Profile Posts **Slug:** `FIBER_PROFILE_POSTS_LIVE_FETCH` Billable operation: Fetches recent posts from a LinkedIn profile. Returns a paginated feed of posts with optional cursor for pagination. Each page returns up to 50 posts. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Pagination cursor for fetching additional pages of posts | | `identifier` | string | Yes | Identifier can be a profile's LinkedIn slug (e.g. 'williamhgates' from ), a Sales Navigator URN (e.g. 'ACwAAA.....'), or a full LinkedIn URL (e.g. 'https://www.linkedin.com/in/williamhgates/') | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch LinkedIn Profile Reactions **Slug:** `FIBER_PROFILE_REACTIONS_LIVE_FETCH` Billable operation: Fetches reactions made by a LinkedIn profile. Returns a paginated feed of reactions with optional cursor for pagination. Each page returns up to 10 reactions. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Pagination cursor for fetching additional pages of reactions | | `identifier` | string | Yes | Identifier can be a profile's LinkedIn slug (e.g. 'williamhgates' from ), a Sales Navigator URN (e.g. 'ACwAAA.....'), or a full LinkedIn URL (e.g. 'https://www.linkedin.com/in/williamhgates/') | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch Post Comments **Slug:** `FIBER_REDDIT_POST_COMMENTS` Billable operation: Fetch comments for a Reddit post by URL or `t3_` identifier. Returns the parent post (when available) and a paginated, depth-first flat list of comments that includes nested replies. Each entry's `parentCommentId` is null for top-level comments or points at the parent comment for replies; group on `parentCommentId` to rebuild the thread tree. Use the `nextPageToken` field from the response to retrieve subsequent pages of top-level comments (their nested replies come along automatically). Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `post_url_or_id` | string | Yes | Full Reddit post URL/permalink or post ID (e.g. 't3_ablzuq'). | | `next_page_token` | string | No | Pagination token from a previous response to retrieve the next page. Omit for the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Reddit Posts **Slug:** `FIBER_REDDIT_SEARCH` Billable operation: Search Reddit posts across all subreddits by query, optionally filtered by sort order and timeframe. Returns a paginated list of posts. Use the `nextPageToken` field from the response to retrieve subsequent pages. A query with no matching posts returns an empty list and is still charged. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("relevance" | "new" | "top" | "comment_count") | No | Sort order for global Reddit post search. Use `relevance` for research queries and `new` for monitoring a topic. `new` can include off-topic posts and posts outside `timeframe`, so check `publishedAt`. | | `query` | string | Yes | Search query. | | `timeframe` | string ("all" | "day" | "week" | "month" | "year") | No | Time window for global search filtering. | | `next_page_token` | string | No | Pagination token from a previous response to retrieve the next page. Omit for the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Subreddit Posts **Slug:** `FIBER_REDDIT_SUBREDDIT_POSTS` Billable operation: List posts from a subreddit, optionally filtered by sort order and timeframe. Returns a paginated list of posts. Use the `nextPageToken` field from the response to retrieve subsequent pages. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("best" | "hot" | "new" | "top" | "rising") | No | Sort order for subreddit posts. | | `subreddit` | string | Yes | Subreddit name (e.g. 'AskReddit'), r/ prefix form (e.g. 'r/AskReddit'), or full subreddit URL. | | `timeframe` | string ("all" | "day" | "week" | "month" | "year") | No | Time window for filtering. Only applies when `sort` is 'top'; ignored for other sort modes (which are inherently time-ordered). | | `next_page_token` | string | No | Pagination token from a previous response to retrieve the next page. Omit for the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Within a Subreddit **Slug:** `FIBER_REDDIT_SUBREDDIT_SEARCH` Billable operation: Search posts within a subreddit by query, optionally filtered by sort order and timeframe. Returns a paginated list of posts. Use the `nextPageToken` field from the response to retrieve subsequent pages. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("relevance" | "hot" | "top" | "new" | "comment_count") | No | Sort order for subreddit search results. | | `query` | string | Yes | Search query. | | `subreddit` | string | Yes | Subreddit name (e.g. 'AskReddit'), r/ prefix form (e.g. 'r/AskReddit'), or full subreddit URL. | | `timeframe` | string ("all" | "day" | "week" | "month" | "year") | No | Time window for subreddit search filtering. | | `next_page_token` | string | No | Pagination token from a previous response to retrieve the next page. Omit for the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Refresh Company Tracker List **Slug:** `FIBER_REFRESH_TRACKER_COMPANY_LIST` Billable operation: Initiate an immediate refresh of all tracked companies in this list. Each entity is checked for changes against its current monitoring rules. Credits are charged per entity processed. Confirm the documented credit cost immediately before calling. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | string | Yes | The unique ID of the tracker list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Refresh Person Tracker List **Slug:** `FIBER_REFRESH_TRACKER_PERSON_LIST` Billable operation: Initiate an immediate refresh of all tracked people in this list. Each entity is checked for changes against its current monitoring rules. Credits are charged per entity processed. Confirm the documented credit cost immediately before calling. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | string | Yes | The unique ID of the tracker list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Company from Company Exclusion List **Slug:** `FIBER_REMOVE_COMPANY_FROM_EXCLUSION_LIST` Destructive or state-removing change: Remove a company from a company exclusion list. Obtain explicit confirmation and verify all target identifiers immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | string | Yes | The ID of the company exclusion list to remove the company from. | | `excluded_company_details` | object | Yes | Details of the companies to remove from the exclusion list | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Prospect from Prospect Exclusion List **Slug:** `FIBER_REMOVE_PROSPECT_FROM_EXCLUSION_LIST` Destructive or state-removing change: Remove a prospect from a prospect exclusion list. Obtain explicit confirmation and verify all target identifiers immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | string | Yes | The ID of the prospect exclusion list to remove the prospect from. | | `excluded_prospect_details` | object | Yes | Details of the prospects to remove from the exclusion list | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Companies from Tracker List **Slug:** `FIBER_REMOVE_TRACKER_COMPANIES` Destructive or state-removing change: Remove companies from a company tracker list. Deactivates them so they are no longer monitored, but preserves their signal history. Uses the same identifier format as add-companies. Obtain explicit confirmation and verify all target identifiers immediately before calling. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | string | Yes | The unique ID of the tracker list. | | `companies` | array | Yes | Companies to remove. Uses the same identifier format as add-companies. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove People from Tracker List **Slug:** `FIBER_REMOVE_TRACKER_PEOPLE` Destructive or state-removing change: Remove people from a person tracker list. Deactivates them so they are no longer monitored, but preserves their signal history. Uses the same identifier format as add-people. Obtain explicit confirmation and verify all target identifiers immediately before calling. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `people` | array | Yes | People to remove. Uses the same identifier format as add-people. | | `list_id` | string | Yes | The unique ID of the tracker list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reschedule Company Tracker List Refresh **Slug:** `FIBER_RESCHEDULE_TRACKER_COMPANY_LIST` Free persistent-state operation: Move this list's next scheduled refresh to a chosen date (UTC) later (for example to skip a cycle or align with a billing period) or earlier, as long as the date is tomorrow or later. The refresh runs on the chosen date and checks all tracked companies in the list, with credits charged per entity as usual. Future refreshes continue at the list's regular interval, counted from the rescheduled run. Changing the list's refresh interval later resets the schedule from that moment. To refresh a list immediately, use the refresh endpoint instead. Confirm the intended target before changing Fiber state. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | string | Yes | The unique ID of the tracker list. | | `next_refresh_date` | string | Yes | The date (YYYY-MM-DD, UTC) on which the next scheduled refresh should run. Must be tomorrow (UTC) or later, and at most 360 days ahead. To refresh a list immediately, use the refresh endpoint instead. Subsequent refreshes continue at the list's regular interval, counted from this run. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reschedule Person Tracker List Refresh **Slug:** `FIBER_RESCHEDULE_TRACKER_PERSON_LIST` Free persistent-state operation: Move this list's next scheduled refresh to a chosen date (UTC) later (for example to skip a cycle or align with a billing period) or earlier, as long as the date is tomorrow or later. The refresh runs on the chosen date and checks all tracked people in the list, with credits charged per entity as usual. Future refreshes continue at the list's regular interval, counted from the rescheduled run. Changing the list's refresh interval later resets the schedule from that moment. To refresh a list immediately, use the refresh endpoint instead. Confirm the intended target before changing Fiber state. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | string | Yes | The unique ID of the tracker list. | | `next_refresh_date` | string | Yes | The date (YYYY-MM-DD, UTC) on which the next scheduled refresh should run. Must be tomorrow (UTC) or later, and at most 360 days ahead. To refresh a list immediately, use the refresh endpoint instead. Subsequent refreshes continue at the list's regular interval, counted from this run. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Resolve Companies **Slug:** `FIBER_RESOLVE_COMPANIES` Billable and privacy-sensitive: resolve up to 100 supplied company identifiers to complete business records. Fiber charges 1 credit per company resolved and reports the actual charge in chargeInfo. Use only for an authorized purpose, request and retain only necessary data, call FIBER_GET_ORG_CREDITS first, and obtain explicit user confirmation immediately before every call. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `companies` | array | Yes | Companies to resolve. Each entry is an { identifier, value } pair where identifier is "linkedinSlug", "linkedinOrgId", "linkedinUrl", or "domain". Max 100 per request. You are charged only for the ones that resolve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Resolve People **Slug:** `FIBER_RESOLVE_PEOPLE` Billable and privacy-sensitive: resolve up to 100 supplied person identifiers to personal and professional profile records; this is identifier resolution, not contact reveal. Fiber charges 1 credit per person resolved and reports the actual charge in chargeInfo. Use only for authorized people, request and retain only necessary data, call FIBER_GET_ORG_CREDITS first, and obtain explicit user confirmation immediately before every call. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `people` | array | Yes | People to resolve. Each entry is an { identifier, value } pair where identifier is "linkedinSlug", "linkedinUserId", "linkedinUrl", or "entityUrn". Max 100 per request. You are charged only for the ones that resolve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reveal Contact Details **Slug:** `FIBER_REVEAL_CONTACT_DETAILS` Billable and highly privacy-sensitive: use Fiber's Normal/balanced live tier to reveal selected work emails, personal emails, and/or phone numbers for one authorized person. It balances coverage, latency, and cost between cheaper lower-coverage Lite and faster higher-cost Turbo. Request only necessary channels; the documented cost ranges from 2 to 5 credits and actual cost is reported in chargeInfo. Call FIBER_GET_ORG_CREDITS and obtain explicit user confirmation immediately before every call. Use only for an authorized purpose and subject, and retain only necessary personal data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `company` | string | No | Optional current company. Work emails with a nonmatching domain are returned in unmatchedWorkEmails rather than emails. | | `patience` | string ("MINIMUM" | "LOW" | "MEDIUM" | "HIGH" | "EXTREME" | "MAXIMUM") | No | How long to wait for email deliverability validation after finding a contact. Higher patience improves accuracy but increases response time. | | `linkedin_url` | string | Yes | The person's LinkedIn identifier: a full profile URL, bare slug, Sales Navigator URN, or numeric LinkedIn user ID. | | `enrichment_type` | object | No | Contact channels to reveal. Disable every channel that is not necessary; Fiber charges according to the selected channels and delivered data. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reveal Contact Details Instant **Slug:** `FIBER_REVEAL_CONTACT_DETAILS_INSTANT` Billable and highly privacy-sensitive: return contact data already on file for one known person, with no live lookup or request-time re-verification. This is the fastest and lowest-coverage tier; each delivered email or phone channel costs 1 credit and chargeInfo is authoritative. Use Lite or Normal when fresh lookup or validation is required. Call FIBER_GET_ORG_CREDITS and obtain explicit user confirmation immediately before every call. Use only for an authorized purpose and subject, minimize requested channels, treat unknown validation status cautiously, and retain only necessary personal data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `input` | string | Yes | Person lookup parameters using LinkedIn or a name and company domain. | | `company` | string | No | Optional current company. Work emails on another domain are returned in unmatchedWorkEmails. | | `enrichment_type` | object | No | Contact channels to return from on-file data. Defaults to work email. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reveal Contact Details Lite **Slug:** `FIBER_REVEAL_CONTACT_DETAILS_LITE` Billable and highly privacy-sensitive: run Fiber's cheapest live contact lookup for one known person, accepting lower coverage than Normal. Lite costs 1 credit per delivered email channel and 2 per delivered phone channel; chargeInfo is authoritative. Use Instant for on-file-only speed, Normal for balanced coverage, or Turbo for lower latency. Call FIBER_GET_ORG_CREDITS and obtain explicit user confirmation immediately before every call. Use only for an authorized purpose and subject, minimize requested channels, and retain only necessary personal data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `input` | string | Yes | Person lookup parameters using LinkedIn or a name and company domain. | | `company` | string | No | Optional current company. Work emails on another domain are returned in unmatchedWorkEmails. | | `patience` | string ("MINIMUM" | "LOW" | "MEDIUM" | "HIGH" | "EXTREME" | "MAXIMUM") | No | How long to wait for email deliverability validation. Higher patience improves accuracy but increases response time. | | `enrichment_type` | object | No | Contact channels to find. The default requests only work email. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reveal Contact Details Turbo **Slug:** `FIBER_REVEAL_CONTACT_DETAILS_TURBO` Billable and highly privacy-sensitive: run Fiber's fastest synchronous live contact lookup for one known person when latency matters more than cost. Turbo costs 3 credits for one email type, 5 for phones or both email types, and 7 for all channels; partial results bill only delivered data and chargeInfo is authoritative. Use Normal or Lite for lower cost, or Exhaustive after synchronous tiers miss. Call FIBER_GET_ORG_CREDITS and obtain explicit user confirmation immediately before every call. Use only for an authorized purpose and subject, minimize requested channels, and retain only necessary personal data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `company` | string | No | Optional current company. Work emails on another domain are returned in unmatchedWorkEmails. | | `patience` | string ("MINIMUM" | "LOW" | "MEDIUM" | "HIGH" | "EXTREME" | "MAXIMUM") | No | How long to wait for email deliverability validation. Higher patience improves accuracy but increases response time. | | `linkedin_url` | string | Yes | LinkedIn profile identifier: a full URL, bare slug, Sales Navigator URN, or numeric LinkedIn user ID. | | `enrichment_type` | object | No | Contact channels to reveal. At least one channel must be enabled. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reveal Identity-Checked Phone **Slug:** `FIBER_REVEAL_IDENTITY_CHECKED_PHONE` Billable and highly privacy-sensitive: reveal phone numbers for one LinkedIn profile and classify each identity match as exact, probable, family, business, or inconclusive. This phone-only premium lookup costs 5 credits per request and chargeInfo is authoritative; use a general contact reveal when identity scoring is unnecessary. Call FIBER_GET_ORG_CREDITS and obtain explicit user confirmation immediately before every call. Use only for an authorized purpose and subject, handle FAMILY_MEMBER and BUSINESS_LINE results with special care, and retain only necessary personal data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `patience` | string ("MINIMUM" | "LOW" | "MEDIUM" | "HIGH" | "EXTREME" | "MAXIMUM") | No | How long to wait for phone identity and reachability verification. Higher patience improves accuracy but increases response time. | | `linkedin_url` | string | Yes | LinkedIn profile identifier: a full URL, bare slug, or entity URN. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Find Person by Email (single) **Slug:** `FIBER_REVERSE_EMAIL_LOOKUP` Billable operation: Given an email address, find the person's LinkedIn profile and personal details. If the person's name, company, or other identifiers are also available, use the Kitchen Sink endpoint instead it accepts all available signals and produces better matches. To avoid 429 errors, space requests evenly (such as 1/60th the rate limit per second) rather than bursting them all at once. Confirm the documented credit cost immediately before calling. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `email` | string | Yes | The email address of a person whose LinkedIn profile you want to find. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Find Person or Company by Phone (single) **Slug:** `FIBER_REVERSE_PHONE_LOOKUP` Billable operation: Given a phone number, find the associated LinkedIn profile or company. Confirm the documented credit cost immediately before calling. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `phone_number` | string | Yes | The phone number to look up. Accepts E.164 format (+12125551234) or various national formats. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Rotate Webhook Signing Secret **Slug:** `FIBER_ROTATE_WEBHOOK_ENDPOINT_SECRET` External-effect operation: Rotate a webhook endpoint's signing secret and return the new value. The previous secret stays valid for a 24-hour grace period so in-flight deliveries keep verifying roll the new secret out to your receiver within that window. Rotating secrets is free. Confirm the target and intended side effect immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `endpoint_id` | string | Yes | The unique ID of the webhook endpoint. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Natural Language Search **Slug:** `FIBER_RUN_NATURAL_LANGUAGE_PEOPLE_COMPANY_SEARCH` Billable operation: Takes free-form text (e.g., 'Senior Product Managers at Series A FinTech startups in New York') and returns matching companies or people. The API determines the result type based on query interpretation company-specific queries return companies, everything else returns people. Supports cursor-based pagination via a single pageToken. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | No | Natural language search query. Required on the first request. Ignored when pageToken is provided. | | `page_size` | integer | No | Number of results per page (1-1000). Applied to whichever result type is returned. | | `page_token` | string | No | Pagination token from a previous response. Pass the value of nextPageToken from the prior response. | | `get_detailed_education` | boolean | No | Whether to include deep details about each educational item, like the school's LinkedIn URL, website, location, etc. That'll be put in the detailedEducation array. This slows down the API call, so only enable this if you need it. Only applies when the result type is people; ignored for company results. | | `people_exclusion_list_i_ds` | array | No | IDs of exclusion lists to filter out people. | | `company_exclusion_list_i_ds` | array | No | IDs of exclusion lists to filter out companies. Applied when returning companies, or to narrow company-based profile filtering. | | `get_detailed_work_experience` | boolean | No | Whether to include deep details about each work experience item, like the company's LinkedIn URL, website, location, etc. That'll be put in the detailedWorkExperience array. This slows down the API call, so only enable this if you need it. Only applies when the result type is people; ignored for company results. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Companies **Slug:** `FIBER_SEARCH_COMPANIES` Billable and privacy-sensitive: search Fiber's company database with the official nested filter schema, returning exactly one provider page and its native continuation cursor. Fiber charges 1 credit per company returned and 1 additional credit when include_count is true. Use only for an authorized purpose, request and retain only necessary personal data, call FIBER_GET_ORG_CREDITS first, and obtain explicit user confirmation immediately before every call. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Cursor from output.nextCursor. Omit on the first page and keep filters unchanged. | | `page_size` | integer | No | Number of companies to return on this page (1-1000). | | `include_count` | boolean | No | Return an estimated match count. This incurs one additional count credit and does not account for exclusion lists. | | `search_params` | object | Yes | Official nested Fiber company-search filters. | | `company_exclusion_list_ids` | array | No | Company exclusion-list IDs whose matching companies should be omitted. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Job Postings **Slug:** `FIBER_SEARCH_JOB_POSTINGS` Billable and privacy-sensitive: search Fiber job postings and return exactly one native cursor page. Use FIBER_COUNT_JOB_POSTINGS when only cardinality is needed. Fiber charges 1 credit per posting found and reports the actual charge in chargeInfo. Hiring filters may disclose strategic interests; use only for an authorized purpose, minimize and retain data appropriately, call FIBER_GET_ORG_CREDITS first, and obtain explicit user confirmation immediately before every call. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page_size` | integer | No | Number of jobs to return per page (max 1000) | | `next_cursor` | string | No | Pagination cursor for fetching next page of results | | `search_params` | object | Yes | Job search filter parameters | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search People **Slug:** `FIBER_SEARCH_PEOPLE` Billable and privacy-sensitive: search Fiber's people dataset with structured filters and return exactly one cursor page. Fiber reserves credits for the requested page size, charges one credit per profile found, and charges one additional credit when include_count is true; actual cost is returned in chargeInfo. Before every call, run FIBER_GET_ORG_CREDITS and obtain explicit user confirmation for the spend. Use only for an authorized purpose and authorized people, request only necessary personal data, and retain it only as long as necessary. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Cursor from output.nextCursor. Omit on the first page and keep all filters unchanged when continuing. | | `page_size` | integer | No | Number of profiles to return on this page. Fiber reserves credits based on this value. | | `include_count` | boolean | No | Return an estimated match count. This costs one additional credit and excludes exclusion-list effects. | | `search_params` | object | No | Search parameters for people search. | | `current_companies` | array | No | Companies people currently work for (up to 10,000 entries). | | `company_exclusion_list_ids` | array | No | Company exclusion-list IDs whose current employees must be omitted. | | `prospect_exclusion_list_ids` | array | No | Prospect exclusion-list IDs whose people must be omitted. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search People and Companies **Slug:** `FIBER_SEARCH_PEOPLE_AND_COMPANIES` Billable and privacy-sensitive: search companies and people together and return one provider page for each configured entity type, preserving Fiber's independent company and profile cursors. Fiber charges 1 credit per company and 1 credit per profile returned; chargeInfo reports the actual charge. Never auto-paginates. Use only for an authorized purpose, minimize and retain personal data appropriately, call FIBER_GET_ORG_CREDITS first, and obtain explicit user confirmation immediately before every call. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `company_config` | string | No | Company-search configuration. Set searchParams and pageSize; use companyCursor only to continue a previous company page. | | `profile_config` | string | No | People-search configuration. Set profile filters and pageSize; use profileCursor only to continue a previous people page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send Test Webhook Event **Slug:** `FIBER_SEND_TEST_WEBHOOK_EVENT` External-effect operation: Send an example payload of the given event type to a single webhook endpoint. Use this to verify your receiver accepts deliveries and parses payloads correctly before relying on real events. Sending test events is free. Confirm the target and intended side effect immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `event_type` | string ("reveal.completed" | "saved_search.run_completed" | "saved_search.run_upcoming" | "job.changed" | "batch_live_enrich.completed" | "batch_contact_enrich.completed" | "batch_contact_enrich_v1.completed" | "github_to_linkedin.completed" | "github_lookup.completed" | "domain_lookup.completed" | "social_media_lookup.completed" | "google_maps_search.completed" | "local_business_search.completed" | "depth_chart.completed" | "audience.enrichment_completed" | "audience.prospect_export_completed" | "audience.company_export_completed" | "audience.build_completed" | "combined_search.completed" | "sales_nav_scrape.completed" | "sales_nav_lite_scrape.completed" | "job_changes.profiles_added" | "tracker.signal_detected" | "tracker.list_run_completed" | "tracker.list_run_upcoming" | "mosaic.completed") | Yes | The event type to send an example payload for. Retrieve available event types from the webhook event types endpoint. | | `endpoint_id` | string | Yes | The unique ID of the webhook endpoint. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Skills Typeahead **Slug:** `FIBER_SKILLS_TYPEAHEAD` Free read: Search for professional skills by name. Supports prefix and partial matches with relevance-based ranking. Useful for building autocomplete in search UIs. This operation does not spend credits or modify Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Search query for skill names. Supports prefix and partial matches. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Skip Next Saved Search Auto-run **Slug:** `FIBER_SKIP_NEXT_SAVED_SEARCH_RUN` Free persistent-state operation: Skip the next scheduled auto-run for a saved search. The search will resume its normal schedule after one skipped cycle. Manual runs are not affected. Confirm the intended target before changing Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `saved_search_id` | string | Yes | The ID of the saved search to skip the next auto-run for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Poll Batch Social Media Lookup **Slug:** `FIBER_SOCIAL_MEDIA_LOOKUP_BATCH_POLLING` Read-only asynchronous poll: Poll for the results of a batch social media lookup. Returns partial results as they become available, with overall progress statistics. Use it only for work started by FIBER_SOCIAL_MEDIA_LOOKUP_BATCH_TRIGGER. No polling charge is documented; it does not start another job or modify Fiber state. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `run_id` | string | Yes | The ID of the batch run returned by the batch trigger endpoint. | | `page_size` | number | No | Number of results to return per page (default 50, max 100). | | `next_page_token` | string | No | Token from the previous response to fetch the next page. Omit for the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Start Batch Social Media Lookup **Slug:** `FIBER_SOCIAL_MEDIA_LOOKUP_BATCH_TRIGGER` Billable asynchronous trigger: Start a batch social media lookup for multiple people. Find X (Twitter) and Instagram profiles using LinkedIn URLs, user IDs, or manual name+context. Results are available via the batch polling endpoint. Check progress or retrieve results with FIBER_SOCIAL_MEDIA_LOOKUP_BATCH_POLLING. Confirm the expected credit charge immediately before starting work; do not retry merely because results are not yet ready. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `people` | array | Yes | Array of people to look up (1-100). Each person can be identified by LinkedIn URL, LinkedIn user ID, or manual name+context. | | `platforms` | array | No | Which social media platforms to search. Defaults to Twitter/X. | | `overall_context` | string | No | Optional context about this batch to help disambiguation (e.g. 'AI startup founders'). Applied to all people in the batch. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Poll Social Media Lookup **Slug:** `FIBER_SOCIAL_MEDIA_LOOKUP_POLLING` Read-only asynchronous poll: Poll for the results of a social media lookup task. Use it only for work started by FIBER_SOCIAL_MEDIA_LOOKUP_TRIGGER. No polling charge is documented; it does not start another job or modify Fiber state. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Cursor from the previous response to fetch the next page. Omit for the first page. | | `page_size` | number | No | Number of results to return per page. | | `social_media_finder_run_id` | string | Yes | The ID of the social media finder run returned by the trigger endpoint. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Start Social Media Lookup **Slug:** `FIBER_SOCIAL_MEDIA_LOOKUP_TRIGGER` Billable asynchronous trigger: Use our AI agent to find social media profiles (Twitter, Instagram) for a person using name and optional context like LinkedIn URL, work email, company, and job title. Check progress or retrieve results with FIBER_SOCIAL_MEDIA_LOOKUP_POLLING. Confirm the expected credit charge immediately before starting work; do not retry merely because results are not yet ready. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `person` | string | Yes | The person to look up. | | `platforms` | array | No | Which social media platforms to search. Defaults to Twitter. Supported: TWITTER, INSTAGRAM. | | `overall_context` | string | No | Optional context about the person to help disambiguation (e.g. "AI researcher at OpenAI"). Useful for common names. Max 1000 characters. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Standardize LinkedIn Company Identifier **Slug:** `FIBER_STANDARDIZE_COMPANY` Billable operation: Resolves a company LinkedIn identifier (slug, organization ID, or URL) to a standardized LinkedIn company URL with metadata. Useful for normalizing company identifiers from different sources. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `identifier` | string | Yes | The company's LinkedIn slug (e.g., 'microsoft'), numeric LinkedIn organization ID (e.g., '1035'), or full LinkedIn URL (e.g., 'https://www.linkedin.com/company/microsoft'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Bulk Standardize LinkedIn Company Identifiers **Slug:** `FIBER_STANDARDIZE_COMPANY_BULK` Billable operation: Resolves many company LinkedIn identifiers (slug, organization ID, or URL) to standardized LinkedIn company URLs with metadata. Unresolved identifiers are listed separately and are not charged. If you have company names or domains instead of LinkedIn identifiers, use the bulk kitchen sink endpoint (POST /v1/kitchen-sink/bulk/company) instead. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `identifiers` | array | Yes | Company identifiers to standardize. Max 50 per request. Duplicate identifiers — including the same company submitted as a slug, a full LinkedIn URL, or in different letter casing — are deduped and charged only once. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Standardize LinkedIn Profile Entity URN **Slug:** `FIBER_STANDARDIZE_PROFILE` Billable operation: Resolves a LinkedIn entity URN to a proper LinkedIn profile URL. Supports a variety of URN formats from different LinkedIn sources (including ACoAA... and ACwAA... prefixes). Accepts either a raw entity URN or a full LinkedIn URL containing an entity URN in the slug position (e.g., 'https://www.linkedin.com/in/ACoAADVMtbkB...'). Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `identifier` | string | Yes | A LinkedIn entity URN (e.g., 'ACoAADVMtbkBbZIxJxJjGEQV7SrQCMml8ni7qyg') or a full LinkedIn profile URL containing an entity URN (e.g., 'https://www.linkedin.com/in/ACoAADVMtbkBbZIxJxJjGEQV7SrQCMml8ni7qyg'). Entity URNs typically start with 'ACo' or 'ACw'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Start Batch Contact Reveal **Slug:** `FIBER_START_BATCH_CONTACT_REVEAL` Billable, irreversible, and highly privacy-sensitive: start one asynchronous contact reveal for up to 2,000 authorized people. Fiber charges upfront for unique people after deduplication and refunds undelivered operations. Costs depend on requested channels, and chargeInfo is authoritative. Prefer this action over looping single-person reveal actions. Call FIBER_GET_ORG_CREDITS and obtain explicit user confirmation immediately before each call. Poll with FIBER_POLL_BATCH_CONTACT_REVEAL; do not start duplicate jobs. Request and retain only necessary personal data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `person_details` | array | Yes | People to enqueue, from 1 through 2,000 entries. | | `enrichment_types` | object | No | Contact channels to request for every person. Disable channels that are not needed because Fiber charges according to the selected channels. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Start Batch Live Enrichment **Slug:** `FIBER_START_BATCH_LIVE_ENRICH` Billable asynchronous trigger: Starts a batch live enrichment job for multiple LinkedIn profiles or companies (up to 10,000). This is an asynchronous task; use the polling endpoint to check progress and get results. Check progress or retrieve results with FIBER_POLL_BATCH_LIVE_ENRICH. Confirm the expected credit charge immediately before starting work; do not retry merely because results are not yet ready. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("PROFILE" | "COMPANY") | Yes | Whether to enrich people or companies | | `identifiers` | array | Yes | List of LinkedIn identifiers. For profiles: LinkedIn URL (e.g. 'https://www.linkedin.com/in/williamhgates'), profile slug (e.g. 'williamhgates'), or Sales Navigator URN (e.g. 'ACwAAAjNR6wBsr_od4UG9Y-HRxg21mwhv5xO0FE') or numeric user ID (e.g. '4532776'). For companies: LinkedIn URL (e.g. 'https://www.linkedin.com/company/microsoft'), company slug (e.g. 'microsoft'), or numeric org ID (e.g. '1035'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Start Depth Chart Generation **Slug:** `FIBER_START_DEPTH_CHART` Billable asynchronous trigger: Generates a breakdown of the number of employees at a given company by department/function (Engineering, Sales, Marketing, etc.), seniority (Junior through Executive), or both. This helps answer questions like, 'how many senior engineers does this company have?'. Asynchronous; use the polling endpoint to get your results. Processes up to 10,000 employees per report. This is a more thorough alternative to guessing a company's internal org chart. Check progress or retrieve results with FIBER_POLL_DEPTH_CHART. Confirm the expected credit charge immediately before starting work; do not retry merely because results are not yet ready. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `company` | string | Yes | Company identifier. Set identifier to 'linkedinUrl', 'linkedinSlug', 'linkedinOrgId', or 'domain' and provide the corresponding value. | | `functions` | array | No | Optional list of function/department labels to classify employees into (e.g. ['Engineering', 'Sales', 'Legal Practice']). When omitted, functions are auto-detected based on the company's employee titles. An 'Other' category is automatically appended if not already included, to catch employees that don't fit the provided labels. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Start Exhaustive Contact Reveal **Slug:** `FIBER_START_EXHAUSTIVE_CONTACT_REVEAL` Billable, irreversible, and highly privacy-sensitive: start Fiber's deepest asynchronous contact reveal for one authorized person after less expensive synchronous tiers miss and waiting is acceptable. The requested exhaustive bundle costs 4-12 credits upfront; undelivered data is refunded per operation and chargeInfo is authoritative. Call FIBER_GET_ORG_CREDITS and obtain explicit user confirmation immediately before each call. Poll with FIBER_POLL_EXHAUSTIVE_CONTACT_REVEAL. Request and retain only necessary data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `linkedin_url` | string | Yes | LinkedIn profile URL, bare slug, Sales Navigator URN, or numeric LinkedIn user ID for the person. | | `enrichment_type` | object | No | Contact channels to reveal. Disable channels that are not needed because Fiber charges according to the requested exhaustive bundle. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Start Google Maps Search **Slug:** `FIBER_START_GOOGLE_MAPS_SEARCH` Billable asynchronous trigger: Start a background search for local businesses or other places of interest on Google Maps, polled for results and able to collect far more than one page. Describe the search either with 'query' plus 'strategy', or with a 'googleMapsUrl' copied from the address bar of a Google Maps search. For a single page of results returned immediately, use POST /v1/google-maps/search instead. Check progress or retrieve results with FIBER_CHECK_GOOGLE_MAPS_RESULTS or FIBER_POLL_GOOGLE_MAPS_RESULTS. Confirm the expected credit charge immediately before starting work; do not retry merely because results are not yet ready. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | An optional name for the project for reference purposes. | | `query` | string | No | The search query to run on Google Maps. Do not include a location info here. Examples: 'dominos pizza', 'real estate agent'. Omit this when you pass a Google Maps URL instead. | | `strategy` | string | No | The strategy for searching places. Omit this when you pass a Google Maps URL instead. | | `max_results` | integer | No | The maximum number of Google Maps results to return. | | `google_maps_url` | string | No | A link to a Google Maps search, taken from the address bar after searching. The search term and the area to search are read from the link. The term is used exactly as it appears in the link, so it may name a location even though you should leave locations out of 'query' — the area to search comes from the link, not from the term. Omit this when you pass a query and strategy instead. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Start Local Business AI Search **Slug:** `FIBER_START_LOCAL_BUSINESS_SEARCH` Billable asynchronous trigger: Use our AI agent to search for local businesses and grab contact details. Results are polled asynchronously via the returned researchRunId. Max 500 companies per request. Estimated completion: 1800 seconds. Check progress or retrieve results with FIBER_POLL_LOCAL_BUSINESS_SEARCH. Confirm the expected credit charge immediately before starting work; do not retry merely because results are not yet ready. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `companies` | array | Yes | The companies to search for. | | `job_titles` | array | No | Job titles to search for at each company (e.g. ['CEO', 'Owner']). Omit or null to skip person search. | | `contact_preferences` | object | No | Controls which contact data to fetch for all companies in this payload. | | `strict_job_title_match` | boolean | No | If true, only match the same role with different wording (e.g. CEO = Chief Executive Officer). Rejects different roles even if senior/similar (e.g. CEO ≠ Chairman). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Start Mosaic CSV Healing **Slug:** `FIBER_START_MOSAIC` Billable asynchronous trigger: Starts an asynchronous Mosaic job that heals and enriches an arbitrary CSV, TXT, XLSX, or public Google Sheet. Pass a public HTTPS URL (Google Drive / Sheets, Dropbox, OneDrive, or a direct file link). The file is securely fetched and stored before processing. Credits are charged inside the background job after the file is parsed (based on row count and selected options). The first Mosaic run for an organization may be a free trial (first 1,000 rows free; overage billed against normal credits). Use the polling endpoint with the returned run ID to retrieve status and download links. Check progress or retrieve results with FIBER_POLL_MOSAIC. Confirm the expected credit charge immediately before starting work; do not retry merely because results are not yet ready. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `options` | object | No | Feature toggles that control billing and enrichment (contact info, company details, live fetch, redline, max rows). | | `source_url` | string | Yes | HTTPS URL of the input file. Supported formats: CSV, TXT (one LinkedIn profile URL per line), XLSX, or a public Google Sheet. You may also pass a public Google Drive file link, Dropbox share link, or OneDrive / SharePoint share link. The link must be publicly accessible (e.g. Google Sheets / Drive: "Anyone with the link can view"; Dropbox / OneDrive: link allows direct download) or the fetch will fail. Google Sheets export the first tab only. For XLSX workbooks we auto-detect the most likely worksheet and header row; if detection is unavailable we use the sheet with the most rows and treat row 1 as the header. Maximum file size is 50 MiB. The file is securely fetched and stored before processing. | | `custom_instructions` | string | No | Optional additional instructions for the AI on top of our system prompt — not a replacement for it. Use this to steer enrichment when your file needs extra context. Examples: "I really want personal emails but I don't care about phones"; "These are all doctors — make sure you get office phones, not home phones". | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Count Stealth/ex-stealth Founders **Slug:** `FIBER_STEALTH_FOUNDERS_COUNT` Billable operation: Count profiles matching stealth founder filters. Uses the same filters as the stealth founders search endpoint but returns only the total count. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `search_params` | object | No | Profile search filters to narrow results within the stealth population. All fields are optional — omit to search all stealth founders. | | `stealth_config` | string | Yes | Stealth mode configuration. Use in-stealth for current stealth founders, or left-stealth for exited stealth founders. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Stealth/ex-stealth Founders **Slug:** `FIBER_STEALTH_FOUNDERS_SEARCH` Billable operation: Find stealth founders people currently at stealth-mode companies, or who recently left stealth (launched). Supports profile search filters to narrow results by location, keywords, job history, education, and more. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque cursor from the previous response. Omit for the first page. | | `page_size` | integer | No | Number of profiles to return per page. | | `search_params` | object | No | Profile search filters to narrow results within the stealth population. All fields are optional — omit to search all stealth founders. | | `stealth_config` | string | Yes | Stealth mode configuration. Use in-stealth for current stealth founders, or left-stealth for exited stealth founders. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch TikTok Comment Replies **Slug:** `FIBER_TIKTOK_COMMENT_REPLIES` Billable operation: Fetches replies to a TikTok comment. Returns a paginated list of replies. Use the `nextPageToken` field from the response to retrieve subsequent pages. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `video_url` | string | Yes | Full TikTok video URL the comment belongs to (e.g. 'https://www.tiktok.com/@therock/video/1234567890'). | | `comment_id` | string | Yes | Unique comment ID to fetch replies for. | | `next_page_token` | string | No | Pagination token from a previous response to retrieve the next page. Omit for the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch Popular TikTok Songs **Slug:** `FIBER_TIKTOK_POPULAR_SONGS` Billable operation: Fetches a list of currently popular songs/sounds on TikTok. Confirm the documented credit cost immediately before calling. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch TikTok User Profile **Slug:** `FIBER_TIKTOK_PROFILE` Billable operation: Fetches profile information for a TikTok user including follower counts, bio, and account type. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `handle` | string | Yes | TikTok handle to look up. Accepts with or without a leading '@' (e.g. 'therock' or '@therock'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search TikTok Hashtag Videos **Slug:** `FIBER_TIKTOK_SEARCH_HASHTAG` Billable operation: Fetches videos for a TikTok hashtag along with hashtag metadata. Returns a paginated list of videos. Use the `nextPageToken` field from the response to retrieve subsequent pages. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Hashtag to search for (with or without leading '#', e.g. 'fitness' or '#fitness'). The '#' is stripped automatically. | | `next_page_token` | string | No | Pagination token from a previous response to retrieve the next page. Omit for the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search TikTok Videos by Keyword **Slug:** `FIBER_TIKTOK_SEARCH_KEYWORD` Billable operation: Searches for TikTok videos by keyword or phrase. Returns a paginated list of matching videos. Use the `nextPageToken` field from the response to retrieve subsequent pages. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Keyword or phrase to search for TikTok videos (e.g. 'fitness motivation'). | | `next_page_token` | string | No | Pagination token from a previous response to retrieve the next page. Omit for the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search TikTok Users **Slug:** `FIBER_TIKTOK_SEARCH_USERS` Billable operation: Searches for TikTok users by name or keyword. Returns a paginated list of matching accounts. Use the `nextPageToken` field from the response to retrieve subsequent pages. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Search query to find TikTok users (e.g. 'Dwayne Johnson'). | | `next_page_token` | string | No | Pagination token from a previous response to retrieve the next page. Omit for the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch TikTok Song Details **Slug:** `FIBER_TIKTOK_SONG_DETAILS` Billable operation: Fetches details about a TikTok song/sound including title, artist, and usage statistics. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `song_url` | string | Yes | Full TikTok music/song URL (e.g. 'https://www.tiktok.com/music/song-title-7439295283975702544'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch TikTok Videos Using a Song **Slug:** `FIBER_TIKTOK_SONG_VIDEOS` Billable operation: Fetches TikTok videos that use a specific song/sound. Returns a paginated list. Use the `nextPageToken` field from the response to retrieve subsequent pages. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `song_url` | string | Yes | Full TikTok music/song URL (e.g. 'https://www.tiktok.com/music/song-title-7439295283975702544'). | | `next_page_token` | string | No | Pagination token from a previous response to retrieve the next page. Omit for the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch TikTok Trending Feed **Slug:** `FIBER_TIKTOK_TRENDING_FEED` Billable operation: Fetches the current TikTok trending feed. Returns a paginated list of trending videos. Use the `nextPageToken` field from the response to retrieve subsequent pages. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `next_page_token` | string | No | Pagination token from a previous response to retrieve the next page. Omit for the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### TikTok Unified Search **Slug:** `FIBER_TIKTOK_UNIFIED_SEARCH` Billable operation: Searches TikTok and returns both matching videos and user accounts for a query in a single response. Use the `nextPageToken` field from the response to retrieve subsequent pages. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Query string for a unified search returning both videos and users (e.g. 'cooking'). | | `next_page_token` | string | No | Pagination token from a previous response to retrieve the next page. Omit for the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch TikTok User Followers **Slug:** `FIBER_TIKTOK_USER_FOLLOWERS` Billable operation: Fetches the followers of a TikTok user. Returns a paginated list. Use the `nextPageToken` field from the response to retrieve subsequent pages. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `handle` | string | Yes | TikTok handle (with or without leading '@'). | | `next_page_token` | string | No | Pagination token from a previous response to retrieve the next page. Omit for the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch TikTok User Following **Slug:** `FIBER_TIKTOK_USER_FOLLOWING` Billable operation: Fetches the accounts that a TikTok user follows. Returns a paginated list. Use the `nextPageToken` field from the response to retrieve subsequent pages. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `handle` | string | Yes | TikTok handle (with or without leading '@'). | | `next_page_token` | string | No | Pagination token from a previous response to retrieve the next page. Omit for the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch TikTok User Videos **Slug:** `FIBER_TIKTOK_USER_VIDEOS` Billable operation: Fetches the latest videos for a TikTok user. Returns a paginated list of videos with engagement metrics. Use the `nextPageToken` field from the response to retrieve subsequent pages. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `handle` | string | Yes | TikTok handle (with or without leading '@'). | | `next_page_token` | string | No | Pagination token from a previous response to retrieve the next page. Omit for the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch TikTok Video Comments **Slug:** `FIBER_TIKTOK_VIDEO_COMMENTS` Billable operation: Fetches comments for a TikTok video. Returns a paginated list of comments. Use the `nextPageToken` field from the response to retrieve subsequent pages. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `video_url` | string | Yes | Full TikTok video URL (e.g. 'https://www.tiktok.com/@therock/video/1234567890'). | | `next_page_token` | string | No | Pagination token from a previous response to retrieve the next page. Omit for the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch TikTok Video Details **Slug:** `FIBER_TIKTOK_VIDEO_DETAILS` Billable operation: Fetches detailed information about a TikTok video including engagement metrics and video metadata. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `video_url` | string | Yes | Full TikTok video URL (e.g. 'https://www.tiktok.com/@therock/video/1234567890'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch TikTok Video Transcript **Slug:** `FIBER_TIKTOK_VIDEO_TRANSCRIPT` Billable operation: Fetches the spoken word transcript for a TikTok video, broken into timed segments. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `video_url` | string | Yes | Full TikTok video URL (e.g. 'https://www.tiktok.com/@therock/video/1234567890'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Trigger Audience Enrichment **Slug:** `FIBER_TRIGGER_ENRICHMENT` Billable asynchronous trigger: Triggers the audience enrichment process. This runs company and prospect enrichment (live data, Sales Navigator, contact details) based on the configured enrichment types. The enrichment runs asynchronously - use the get-enrichment-status endpoint to poll for completion. Credits are charged immediately based on the estimated cost. Check progress or retrieve results with FIBER_GET_ENRICHMENT_STATUS. Confirm the expected credit charge immediately before starting work; do not retry merely because results are not yet ready. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_email` | string | No | Optional email address to receive completion notifications. If not provided, no email will be sent. | | `audience_id` | string | Yes | The unique ID of the audience. | | `enrichment_type` | object | Yes | Enrichment types to request. Credits are charged only for selected types. | | `run_profile_sales_nav` | boolean | No | Whether to run Sales Navigator profile enrichment | | `run_contact_enrichment` | boolean | No | Whether to run contact enrichment (emails/phones) | | `max_prospects_to_enrich` | integer | Yes | Maximum number of prospects to enrich for this run (must be a positive integer; very large values may be rejected by internal safety limits). | | `run_company_live_enrichment` | boolean | No | Whether to run live enrichment for companies | | `run_profile_live_enrichment` | boolean | No | Whether to run live enrichment for profiles | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Find LinkedIn URL from X (Twitter) Handle **Slug:** `FIBER_TWITTER_HANDLE_TO_LINKEDIN_URL` Billable operation: Given an X (Twitter) handle, find the person's LinkedIn profile URL. Accepts bare handles (with or without '@') and full X / Twitter profile URLs. Confirm the documented credit cost immediately before calling. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `handle` | string | Yes | Twitter/X handle to look up. Accepts a bare handle with or without a leading '@' (e.g. 'elonmusk', '@elonmusk'), or a full X/Twitter profile URL (e.g. 'https://x.com/elonmusk', 'twitter.com/@elonmusk'). | | `context` | string | No | Optional hint about the person, used to disambiguate common-name handles (e.g. "VC at a16z" or "YC W23 founder"). Improves accuracy on ambiguous handles. Max 1000 characters. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch Twitter/X User Profile **Slug:** `FIBER_TWITTER_PROFILE` Billable operation: Fetches the public profile for a Twitter/X user by handle. Returns follower/following counts, bio, verification status, and account metadata. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `handle` | string | Yes | Twitter/X handle to look up. Accepts with or without a leading '@' (e.g. 'elonmusk' or '@elonmusk'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Twitter/X Tweets **Slug:** `FIBER_TWITTER_SEARCH` Billable operation: Searches for tweets matching a query. Returns a paginated list of matching tweets. Use the `cursor` field from the response to retrieve subsequent pages. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Tweet search query string (e.g. 'TypeScript from:elonmusk'). Supports standard Twitter/X search operators. | | `cursor` | string | No | Pagination cursor from a previous response to retrieve the next page of results. Omit for the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch Twitter/X Tweet Details **Slug:** `FIBER_TWITTER_TWEET_DETAILS` Billable operation: Fetches details for a single tweet by its numeric ID. Returns full text, engagement metrics (likes, retweets, replies, views), and metadata. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tweet_id` | string | Yes | Numeric tweet ID to fetch (e.g. '1234567890123456789'). Must contain only digits. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch Twitter/X Tweet Quote Tweets **Slug:** `FIBER_TWITTER_TWEET_QUOTES` Billable operation: Fetches a page of quote tweets for a tweet. Use the `cursor` field from the response to retrieve subsequent pages. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Pagination cursor from a previous response to retrieve the next page of quote tweets. Omit for the first page. | | `tweet_id` | string | Yes | Numeric tweet ID to fetch quote tweets for (e.g. '1234567890123456789'). Must contain only digits. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch Twitter/X Tweet Replies **Slug:** `FIBER_TWITTER_TWEET_REPLIES` Billable operation: Fetches a page of replies to a tweet. Use the `cursor` field from the response to retrieve subsequent pages. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Pagination cursor from a previous response to retrieve the next page of replies. Omit for the first page. | | `tweet_id` | string | Yes | Numeric tweet ID to fetch replies for (e.g. '1234567890123456789'). Must contain only digits. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch Twitter/X Tweet Retweeters **Slug:** `FIBER_TWITTER_TWEET_RETWEETERS` Billable operation: Fetches a page of users who retweeted a tweet. Use the `cursor` field from the response to retrieve subsequent pages. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Pagination cursor from a previous response to retrieve the next page of retweeters. Omit for the first page. | | `tweet_id` | string | Yes | Numeric tweet ID to fetch retweeters for (e.g. '1234567890123456789'). Must contain only digits. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch Twitter/X User Followers **Slug:** `FIBER_TWITTER_USER_FOLLOWERS` Billable operation: Fetches a page of followers for a Twitter/X user. Use the `cursor` field from the response to retrieve subsequent pages. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Pagination cursor from a previous response to retrieve the next page of followers. Omit for the first page. Use each cursor promptly to fetch the next page — cursors may become invalid if reused after a long delay. | | `handle` | string | Yes | Twitter/X handle to fetch followers for. Accepts a bare handle with or without a leading '@' (e.g. 'elonmusk' or '@elonmusk') or a full profile URL (e.g. 'https://x.com/elonmusk' or 'https://twitter.com/elonmusk'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch Twitter/X User Following **Slug:** `FIBER_TWITTER_USER_FOLLOWING` Billable operation: Fetches a page of accounts a Twitter/X user follows. Use the `cursor` field from the response to retrieve subsequent pages. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Pagination cursor from a previous response to retrieve the next page. Omit for the first page. | | `handle` | string | Yes | Twitter/X handle to fetch following accounts for. Accepts with or without a leading '@'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch Twitter/X User Mentions **Slug:** `FIBER_TWITTER_USER_MENTIONS` Billable operation: Fetches a page of tweets that mention a Twitter/X user. Use the `cursor` field from the response to retrieve subsequent pages. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Pagination cursor from a previous response to retrieve the next page of mentions. Omit for the first page. | | `handle` | string | Yes | Twitter/X handle to fetch mentions for. Accepts with or without a leading '@'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch Twitter/X User Tweets **Slug:** `FIBER_TWITTER_USER_TWEETS` Billable operation: Fetches the latest tweets for a Twitter/X user. Returns a paginated list of tweets with engagement metrics. Use the `cursor` field from the response to retrieve subsequent pages. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Pagination cursor from a previous response to retrieve the next page of tweets. Omit for the first page. | | `handle` | string | Yes | Twitter/X handle to fetch tweets for. Accepts with or without a leading '@' (e.g. 'elonmusk' or '@elonmusk'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Undo Skip Next Saved Search Auto-run **Slug:** `FIBER_UNDO_SKIP_NEXT_SAVED_SEARCH_RUN` Free persistent-state operation: Undo a pending skip-next-run on a saved search. The auto-spawn cron will resume considering this search for automatic runs. Idempotent: calling this when no skip is active succeeds. Confirm the intended target before changing Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `saved_search_id` | string | Yes | The ID of the saved search to undo the pending skip for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update API Key Expiration **Slug:** `FIBER_UPDATE_API_KEY_EXPIRATION` Free persistent-state operation: Change the expiration of an API key. Acts on the key that authenticates this request unless target is OTHER. Choose set to pin an absolute date, extend or prepone to move the date by a number of days, or remove to make the key never expire. Once a key expires it can no longer authenticate. First-time users: create your initial API key at https://app.fiber.ai or via POST /v1/account/send-otp + verify-otp. This endpoint manages keys once you have one. Confirm the intended target before changing Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `days` | integer | No | How many days to move the expiration by. Required for the extend and prepone operations; ignored otherwise. | | `target` | string ("SELF" | "OTHER") | No | Which key to act on. SELF acts on the key that authenticates this request. OTHER acts on a different key in your organization, supplied in targetApiKey. | | `operation` | string ("set" | "extend" | "prepone" | "remove") | Yes | set: use an absolute date. extend: push the expiration later by a number of days. prepone: pull it earlier by a number of days. remove: make the key never expire. | | `expires_at` | string | No | The new absolute expiration timestamp (ISO 8601). Required for the set operation and must be in the future; ignored otherwise. | | `target_api_key` | string | No | The key to act on when target is OTHER. Must belong to your organization. You can pass prefix, id, or the raw key. Omit when target is SELF. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update API Key Credit Limit **Slug:** `FIBER_UPDATE_API_KEY_LIMIT` Free persistent-state operation: Change the lifetime credit ceiling of an API key. Acts on the key that authenticates this request unless target is OTHER. Use set to pin an absolute limit, increase or decrease to adjust it by a number of credits, multiply or divide to scale it, or remove to make the key unlimited. Once a key's usage reaches its limit it can no longer authenticate until the limit is raised or removed. First-time users: create your initial API key at https://app.fiber.ai or via POST /v1/account/send-otp + verify-otp. This endpoint manages keys once you have one. Confirm the intended target before changing Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `factor` | number | No | The factor to scale the current ceiling by. Required for multiply and divide; ignored otherwise. | | `target` | string ("SELF" | "OTHER") | No | Which key to act on. SELF acts on the key that authenticates this request. OTHER acts on a different key in your organization, supplied in targetApiKey. | | `credits` | number | No | The credit amount. Required for set (zero or greater), increase, and decrease (greater than zero); ignored otherwise. | | `operation` | string ("set" | "increase" | "decrease" | "multiply" | "divide" | "remove") | Yes | set: pin an absolute credit ceiling. increase/decrease: adjust the current ceiling by a number of credits. multiply/divide: scale the current ceiling by a factor. remove: make the key unlimited. increase, decrease, multiply, and divide have no effect on an already-unlimited key; use set to establish a ceiling first. | | `target_api_key` | string | No | The key to act on when target is OTHER. Must belong to your organization. You can pass prefix, id, or the raw key. Omit when target is SELF. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Set Audience Search Parameters **Slug:** `FIBER_UPDATE_AUDIENCE_SEARCH_PARAMS` Free persistent-state operation: Updates the company and prospect search parameters (filters) for an audience. Both companySearchParams and prospectSearchParams are required on every call because live provider behavior clears an omitted field; pass an object to set filters or null to explicitly clear that filter group. The audience must be in DRAFT status. Confirm the intended target before changing Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `audience_id` | string | Yes | The unique ID of the audience. | | `company_search_params` | string | Yes | Required on every update. Pass company search parameters as an object, or pass null to explicitly clear the company filters. | | `prospect_search_params` | string | Yes | Required on every update. Pass prospect search parameters as an object, or pass null to explicitly clear the prospect filters. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Job Change List **Slug:** `FIBER_UPDATE_JOB_CHANGE_LIST` Free persistent-state operation: Update the name or active status of a job changes list. Confirm the intended target before changing Fiber state. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `new_name` | string | No | The new name for the job change list. | | `is_active` | boolean | No | Set the list to active or inactive. | | `job_change_list_id` | string | Yes | The ID of the job change list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Saved Search **Slug:** `FIBER_UPDATE_SAVED_SEARCH` Free persistent-state operation: Update a saved search. Confirm the intended target before changing Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The ID of the saved search. | | `name` | string | No | The name of the saved search. Omit to keep the current name. | | `is_active` | boolean | No | Whether the saved search is active. Omit to keep the current status. | | `company_params` | object | No | The company search parameters. Uses the same schema as the company search endpoint. Omit to keep the current parameters. | | `profile_params` | object | No | The profile search parameters. Uses the same schema as the profile search endpoint. Omit to keep the current parameters. | | `spawn_frequency_days` | integer | No | The frequency of the saved search in days. Minimum is 7 days. Omit to keep the current frequency. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Company Tracker List **Slug:** `FIBER_UPDATE_TRACKER_COMPANY_LIST` Free persistent-state operation: Update a company tracker list. Supports replace-all (`trackingRules`) or granular (`addRules`/`removeRuleIds`) rule management but not both in one request. Adding a premium rule (marked `isPremium` in GET /tracker/rules) makes the list bill at a minimum per-entity rate see your plan's pricing for rates. Confirm the intended target before changing Fiber state. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | New name for the list. | | `list_id` | string | Yes | The unique ID of the tracker list. | | `add_rules` | array | No | Add rules to the existing set without removing others. The total active rules on the list (existing + added) must not exceed the per-list cap. Cannot be used with `trackingRules`. | | `is_active` | boolean | No | Pause or resume monitoring on the list. | | `tracking_rules` | array | No | Replace ALL existing rules with this set. Pass empty array to clear all rules. Omit to leave unchanged. Cannot be used with `addRules`/`removeRuleIds`. Rules marked `isPremium` in GET /tracker/rules make the list bill at a minimum per-entity rate. | | `initial_signals` | object | No | When provided, generates signals immediately for recent events (funding rounds, news, job postings, social posts) without waiting for the first tracking cycle. Only certain rule types support initial signals. | | `remove_rule_ids` | array | No | Rule IDs to remove. Cannot be used with `trackingRules`. | | `update_rule_flags` | array | No | Toggle `isDummy` on existing rules by ID. Use this to convert a real rule into a dummy rule (or vice versa) without recreating it. | | `max_dynamic_members` | integer | No | For dynamic lists only: update the maximum number of companies to keep in the list. Lowering it applies going forward (the refresh stops adding past the new cap; existing over-cap members are not evicted). Ignored for static lists. | | `refresh_interval_days` | integer | No | New check interval in days. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Person Tracker List **Slug:** `FIBER_UPDATE_TRACKER_PERSON_LIST` Free persistent-state operation: Update a person tracker list. Supports replace-all (`trackingRules`) or granular (`addRules`/`removeRuleIds`) rule management but not both in one request. Adding a premium rule (marked `isPremium` in GET /tracker/rules) makes the list bill at a minimum per-entity rate see your plan's pricing for rates. Confirm the intended target before changing Fiber state. Handle returned or submitted personal data only for an authorized purpose and minimize retention. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | New name for the list. | | `list_id` | string | Yes | The unique ID of the tracker list. | | `add_rules` | array | No | Add rules to the existing set without removing others. The total active rules on the list (existing + added) must not exceed the per-list cap. Cannot be used with `trackingRules`. | | `is_active` | boolean | No | Pause or resume monitoring on the list. | | `tracking_rules` | array | No | Replace ALL existing rules with this set. Pass empty array to clear all rules. Omit to leave unchanged. Cannot be used with `addRules`/`removeRuleIds`. Rules marked `isPremium` in GET /tracker/rules make the list bill at a minimum per-entity rate. | | `initial_signals` | object | No | When provided, generates signals immediately for recent events (funding rounds, news, job postings, social posts) without waiting for the first tracking cycle. Only certain rule types support initial signals. | | `remove_rule_ids` | array | No | Rule IDs to remove. Cannot be used with `trackingRules`. | | `update_rule_flags` | array | No | Toggle `isDummy` on existing rules by ID. Use this to convert a real rule into a dummy rule (or vice versa) without recreating it. | | `max_dynamic_members` | integer | No | For dynamic lists only: update the maximum number of people to keep in the list. Lowering it applies going forward (the refresh stops adding past the new cap; existing over-cap members are not evicted). Ignored for static lists. | | `refresh_interval_days` | integer | No | New check interval in days. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Webhook Endpoint **Slug:** `FIBER_UPDATE_WEBHOOK_ENDPOINT` Free persistent-state operation: Update a webhook endpoint. Change its URL, replace the event types it is subscribed to, update its description, or pause and resume delivery. Only the fields you provide are changed. Updating webhooks is free. Confirm the intended target before changing Fiber state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | No | A new HTTPS URL to receive event payloads. | | `disabled` | boolean | No | Set to true to pause delivery, or false to resume it. | | `description` | string | No | A new human-readable label for this endpoint. | | `endpoint_id` | string | Yes | The unique ID of the webhook endpoint. | | `event_types` | array | No | A new set of event types to subscribe this endpoint to. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Verify Email **Slug:** `FIBER_VERIFY_EMAIL` Billable and privacy-sensitive: assess one authorized email address for deliverability, catch-all, role-based, disposable, and consumer-provider signals. Fiber charges 1 credit per check and reports the actual cost in chargeInfo. Use only for an authorized purpose and subject, request and retain only necessary personal data, call FIBER_GET_ORG_CREDITS, and obtain explicit user confirmation immediately before every call. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `email` | string | Yes | The email address to validate. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Verify Phone **Slug:** `FIBER_VERIFY_PHONE` Billable and highly privacy-sensitive: validate one authorized phone number and return normalized formats, reachability, carrier, porting, roaming, caller-ID, and validation signals. Costs 3 credits even for invalid numbers and reports actual cost in chargeInfo. Use only for an authorized purpose and authorized subject, request and retain only necessary personal data, call FIBER_GET_ORG_CREDITS, and obtain explicit user confirmation immediately before every call. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `patience` | string ("MINIMUM" | "LOW" | "MEDIUM" | "HIGH" | "EXTREME" | "MAXIMUM") | No | How long to wait for phone-number verification after a number is found. Higher patience increases average response time but improves identity and reachability accuracy. MINIMUM is the least thorough verification option. | | `phone_number` | string | Yes | Phone number to validate. E.164 (e.g. +14155551234) is recommended; other formats with spaces, dashes, or parentheses are accepted. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Capture Webpage Screenshot **Slug:** `FIBER_WEBPAGE_SCREENSHOT` Billable operation: Captures a screenshot of a public webpage and returns a hosted image URL. Supports both viewport-only and full-page captures. The returned URL is permanent and does not expire. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | Yes | The URL of the webpage to capture (e.g. 'https://stripe.com/pricing'). Bare domains like 'stripe.com' are also accepted and will be treated as HTTPS. | | `format` | string ("mobile" | "desktop") | No | Device format for the capture. 'mobile' uses a phone-sized viewport, 'desktop' uses a standard widescreen viewport. Defaults to 'desktop'. | | `country` | string | No | ISO 3166-1 alpha-3 country code for geo-located capture (e.g. 'USA', 'GBR', 'DEU'). If omitted, defaults to a US-based capture. | | `full_page` | boolean | No | If true, captures the entire scrollable page. Defaults to false (viewport only). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a Yelp Business Page **Slug:** `FIBER_YELP_PLACE` Billable operation: Get detailed information about a Yelp Place. Search for Yelp places via /yelp/search endpoint. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `place_id` | string | Yes | Yelp business ID, or the business slug from its yelp.com page (e.g. 'juniors-restaurant-new-york-9'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Yelp Business Reviews **Slug:** `FIBER_YELP_REVIEWS` Billable operation: Get reviews of a Yelp business, paginated, with reviewer details, ratings, and full review text. Obtain the business ID via the /yelp/search endpoint. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ratings` | array | No | Only return reviews with these star ratings (e.g. [5] for five-star reviews only, [5, 4] for five- and four-star reviews). Omit (or pass []) to include all ratings. | | `sort_by` | string ("relevance" | "newestFirst" | "oldestFirst" | "highestRated" | "lowestRated" | "elitesFirst") | No | Sort criterion for reviews. 'relevance' is the platform's default ranking. 'elitesFirst' puts reviews from elite reviewers first. Omit to sort by relevance. | | `keywords` | array | No | Only return reviews whose text matches these keywords (e.g. ['crust', 'delivery']). Omit (or pass []) to include all reviews. | | `place_id` | string | Yes | Yelp business ID (e.g. 'U5hCNNyJmb7f3dmC1HTzSQ'). Obtain it from the `placeId` of a result returned by the Yelp search endpoint (`POST /v1/yelp/search`). | | `language_code` | string | No | Language for review text (e.g. 'en', 'es', 'fr'). Omit for English. | | `next_page_token` | string | No | Pagination token from a prior reviews response's `nextPageToken`. Omit (or pass null) to fetch the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Yelp Businesses **Slug:** `FIBER_YELP_SEARCH` Billable operation: Searches Yelp for businesses matching a query in a location, and returns matching businesses with ratings, review counts, and contact details. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort_by` | string ("relevance" | "highestRated" | "mostReviewed") | No | Sort criterion for results. 'relevance' ranks by overall match. 'highestRated' sorts by rating. 'mostReviewed' sorts by review count. Omit to sort by relevance. | | `location` | string | Yes | Where to search. Accepts a city and state ('Austin, TX'), a full address ('706 Mission St, San Francisco, CA'), or a ZIP code ('94103'). | | `categories` | array | No | Categories or terms to search for (e.g. ['pizza', 'italian'] or ['coffee shop']). A business name ('Sushi Ran') also works as a term. Omit (or pass []) to browse all businesses in the location. | | `next_page_token` | string | No | Pagination token from a prior search response's `nextPageToken`. Omit (or pass null) to fetch the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch YouTube Channel Info and Videos **Slug:** `FIBER_YOUTUBE_CHANNEL` Billable operation: Fetches metadata and videos for a YouTube channel. Returns subscriber count, description, video count, total views, and a paginated list of videos. Use `nextPageToken` from the response to paginate through additional video pages. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `next_page_token` | string | No | Pagination token from a previous response to retrieve the next page of channel videos. Omit for the first page. | | `channel_identifier` | string | Yes | YouTube channel @handle, channel ID, or full channel URL. Accepts a @handle (e.g. '@veritasium'), a channel ID (e.g. 'UCBcRF18a7Qf58cCRy5xuWwQ'), or a URL (e.g. 'https://www.youtube.com/@veritasium'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search YouTube Videos **Slug:** `FIBER_YOUTUBE_SEARCH` Billable operation: Searches YouTube for videos matching a query. Returns video titles, links, channel information, view counts, and durations. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | The search query string to find YouTube videos (e.g. 'React Hooks tutorial'). | | `next_page_token` | string | No | Pagination token from a previous response to retrieve the next page of search results. Omit for the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch YouTube Video Transcript **Slug:** `FIBER_YOUTUBE_TRANSCRIPT` Billable operation: Fetches the timestamped transcript for a YouTube video. Returns all transcript segments and the list of languages available. Provide a full YouTube URL or a bare 11-character video ID. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `video_id` | string | Yes | YouTube video ID or full URL. Accepts a bare 11-character ID (e.g. '094y1Z2wpJg') or a full YouTube URL (e.g. 'https://www.youtube.com/watch?v=094y1Z2wpJg'). | | `language_code` | string | No | Transcript BCP-47 language code (e.g. 'en' for English, 'es' for Spanish, 'fr' for French, 'pt-BR' for Brazilian Portuguese). Omit to receive the default language transcript. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch YouTube Video Comments **Slug:** `FIBER_YOUTUBE_VIDEO_COMMENTS` Billable operation: Fetches a page of comments for a YouTube video. Returns comment text, author, like count, and reply count. Use `nextPageToken` from the response to paginate through additional pages. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `video_id` | string | Yes | YouTube video ID or full URL. Accepts a bare 11-character ID (e.g. '094y1Z2wpJg') or a full YouTube URL (e.g. 'https://www.youtube.com/watch?v=094y1Z2wpJg'). | | `next_page_token` | string | No | Pagination token from a previous response to retrieve the next page of comments. Omit for the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch YouTube Video Details **Slug:** `FIBER_YOUTUBE_VIDEO_DETAILS` Billable operation: Fetches detailed metadata for a YouTube video including title, view count, like count, channel information, chapters, key moments, and available transcript languages. Confirm the documented credit cost immediately before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `video_id` | string | Yes | YouTube video ID or full URL. Accepts a bare 11-character ID (e.g. '094y1Z2wpJg') or a full YouTube URL (e.g. 'https://www.youtube.com/watch?v=094y1Z2wpJg'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |