> **For AI agents:** this is the Fiber AI operation index. Start with > [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) for routing rules, then open the focused > per-operation page you need from [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # Fiber AI API — Operation Index This index lists every public operation with a canonical per-operation markdown page at `/ai-docs/.md`. Operations with curated agent guidance include a routing note; the rest fall back to OpenAPI-derived content. ## AI research - [`domainLookupPolling`](/ai-docs/domainLookupPolling.md) `POST /v1/domain-lookup/polling` — Poll Domain lookup - [`domainLookupTrigger`](/ai-docs/domainLookupTrigger.md) `POST /v1/domain-lookup/trigger` — Start Domain lookup - [`pollLocalBusinessSearch`](/ai-docs/pollLocalBusinessSearch.md) `POST /v1/local-business-search/poll` — Poll local business search - [`startLocalBusinessSearch`](/ai-docs/startLocalBusinessSearch.md) `POST /v1/local-business-search/start` — Start Local business AI search ## API key - [`createSandboxApiKey`](/ai-docs/createSandboxApiKey.md) `POST /v1/api-keys/create-sandbox` — Create sandbox API key - [`getAllApiKeys`](/ai-docs/getAllApiKeys.md) `POST /v1/api-keys` — List API keys - [`getCurrentApiKey`](/ai-docs/getCurrentApiKey.md) `POST /v1/api-keys/current` — Get API key - [`resetApiKeyUsage`](/ai-docs/resetApiKeyUsage.md) `POST /v1/api-keys/usage/reset` — Reset API key usage - [`revokeCurrentApiKey`](/ai-docs/revokeCurrentApiKey.md) `POST /v1/api-keys/revoke` — Revoke API key - [`updateApiKeyExpiration`](/ai-docs/updateApiKeyExpiration.md) `POST /v1/api-keys/expiration` — Update API key expiration - [`updateApiKeyLimit`](/ai-docs/updateApiKeyLimit.md) `POST /v1/api-keys/limit` — Update API key credit limit ## API requests - [`listApiRequests`](/ai-docs/listApiRequests.md) `POST /v1/api-requests` — List your past API requests ## Account - [`accountSendOtp`](/ai-docs/accountSendOtp.md) `POST /v1/account/send-otp` — Start signup (send OTP) - [`accountVerifyOtp`](/ai-docs/accountVerifyOtp.md) `POST /v1/account/verify-otp` — Complete signup (verify OTP) - [`buyCredits`](/ai-docs/buyCredits.md) `POST /v1/buy-credits` — Buy credits - [`cardsAttach`](/ai-docs/cardsAttach.md) `POST /v1/cards/attach` — Attach card to trial account - [`getAutoTopupSettings`](/ai-docs/getAutoTopupSettings.md) `GET /v1/auto-topup/settings` — Get auto top-up settings - [`getOrgCredits`](/ai-docs/getOrgCredits.md) `GET /v1/get-org-credits` — Get organization credits - [`getRateLimits`](/ai-docs/getRateLimits.md) `GET /v1/rate-limits` — Get organization rate limits - [`updateAutoTopupSettings`](/ai-docs/updateAutoTopupSettings.md) `POST /v1/auto-topup/configure` — Update auto top-up settings ## Agentic search - [`multiSourceSearch`](/ai-docs/multiSourceSearch.md) `POST /v1/multi-source/search` — Multi-source AI search - [`nlpSearchParse`](/ai-docs/nlpSearchParse.md) `POST /v1/nlp-search/parse` — Parse natural language to search params - [`slushieRun`](/ai-docs/slushieRun.md) `POST /v1/nlp-search/run` — Natural language search ## Audiences - [`buildAudience`](/ai-docs/buildAudience.md) `POST /v1/audiences/{audienceId}/build` — Build audience from search parameters - [`createAudience`](/ai-docs/createAudience.md) `POST /v1/audiences/create` — Create a new audience - [`deleteAudience`](/ai-docs/deleteAudience.md) `DELETE /v1/audiences/{audienceId}` — Archive an audience - [`estimateEnrichmentCost`](/ai-docs/estimateEnrichmentCost.md) `POST /v1/audiences/{audienceId}/enrichment/estimate` — Estimate enrichment cost - [`exportCompanies`](/ai-docs/exportCompanies.md) `POST /v1/audiences/{audienceId}/export/companies` — Export audience companies to CSV - [`exportProspects`](/ai-docs/exportProspects.md) `POST /v1/audiences/{audienceId}/export/prospects` — Export audience prospects to CSV - [`getAudienceCompanies`](/ai-docs/getAudienceCompanies.md) `GET /v1/audiences/{audienceId}/companies` — Get companies in an audience - [`getAudienceProspects`](/ai-docs/getAudienceProspects.md) `GET /v1/audiences/{audienceId}/prospects` — Get prospects in an audience - [`getAudienceStatus`](/ai-docs/getAudienceStatus.md) `GET /v1/audiences/{audienceId}/status` — Get audience status - [`getEnrichmentStatus`](/ai-docs/getEnrichmentStatus.md) `GET /v1/audiences/{audienceId}/enrichment/status` — Get enrichment status - [`listAudiences`](/ai-docs/listAudiences.md) `GET /v1/audiences` — List all audiences - [`triggerEnrichment`](/ai-docs/triggerEnrichment.md) `POST /v1/audiences/{audienceId}/enrich` — Trigger audience enrichment - [`updateAudienceSearchParams`](/ai-docs/updateAudienceSearchParams.md) `PATCH /v1/audiences/{audienceId}/search-params` — Set audience search parameters ## Blue collar jobs - [`blueCollarJobsSearch`](/ai-docs/blueCollarJobsSearch.md) `POST /v1/blue-collar-jobs/search` — Search blue collar job listings - [`blueCollarResolveCompany`](/ai-docs/blueCollarResolveCompany.md) `POST /v1/blue-collar-jobs/resolve-company` — Resolve company to blue collar job board identifier ## Company info - [`bulkCompanyLogos`](/ai-docs/bulkCompanyLogos.md) `POST /v1/company-logos/bulk` — Bulk company logos - [`companyLogo`](/ai-docs/companyLogo.md) `POST /v1/company-logos/single` — Company logo - [`getCompanyRevenue`](/ai-docs/getCompanyRevenue.md) `POST /v1/company-revenue` — Get company revenue estimate - [`getDepartmentSize`](/ai-docs/getDepartmentSize.md) `POST /v1/department-size` — Count employees per department - [`getScoutingReport`](/ai-docs/getScoutingReport.md) `POST /v1/scouting-report` — Get company scouting report - [`getTalentFlow`](/ai-docs/getTalentFlow.md) `POST /v1/talent-flow` — Get talent flow analysis for a company - [`getTalentFlowRivals`](/ai-docs/getTalentFlowRivals.md) `POST /v1/talent-flow/rivals` — Get top talent sources/destinations for a company - [`listCompanyRankings`](/ai-docs/listCompanyRankings.md) `POST /v1/company-rankings` — Download a ranked company list - [`pollDepthChart`](/ai-docs/pollDepthChart.md) `POST /v1/depth-chart/poll` — Poll depth chart generation result - [`startDepthChart`](/ai-docs/startDepthChart.md) `POST /v1/depth-chart/start` — Start depth chart generation ## Contact details - [`cancelBatchContactDetails`](/ai-docs/cancelBatchContactDetails.md) `POST /v1/contact-details/batch/cancel` — Cancel batch contact details - [`instantContactReveal`](/ai-docs/instantContactReveal.md) `POST /v1/contact-details/instant` — Reveal contact details (instant) - [`liteContactReveal`](/ai-docs/liteContactReveal.md) `POST /v1/contact-details/lite` — Reveal contact details (lite) - [`pollBatchContactDetails`](/ai-docs/pollBatchContactDetails.md) `POST /v1/contact-details/batch/poll` — Poll batch contact details - [`pollExhaustiveContactEnrichmentResult`](/ai-docs/pollExhaustiveContactEnrichmentResult.md) `POST /v1/contact-details/exhaustive/poll` — Poll exhaustive contact details reveal result - [`premiumPhoneReveal`](/ai-docs/premiumPhoneReveal.md) `POST /v1/contact-details/premium-phone/sync` — Premium phone number lookup - [`startBatchContactDetails`](/ai-docs/startBatchContactDetails.md) `POST /v1/contact-details/batch/start` — Start batch contact details - [`syncQuickContactReveal`](/ai-docs/syncQuickContactReveal.md) `POST /v1/contact-details/single` — Reveal contact details (standard) - [`syncTurboContactEnrichment`](/ai-docs/syncTurboContactEnrichment.md) `POST /v1/contact-details/turbo/sync` — Reveal contact details (turbo) - [`triggerExhaustiveContactEnrichment`](/ai-docs/triggerExhaustiveContactEnrichment.md) `POST /v1/contact-details/exhaustive/start` — Start exhaustive contact details reveal ## Enums - [`getAccelerators`](/ai-docs/getAccelerators.md) `GET /v1/enums/accelerators` — List accelerators - [`getFlightRegions`](/ai-docs/getFlightRegions.md) `GET /v1/enums/flight-regions` — List flight region aliases - [`getHotelAmenities`](/ai-docs/getHotelAmenities.md) `GET /v1/enums/hotels/amenities` — List hotel amenity filters - [`getHotelBrands`](/ai-docs/getHotelBrands.md) `GET /v1/enums/hotels/brands` — List hotel brand filters - [`getHotelPropertyTypes`](/ai-docs/getHotelPropertyTypes.md) `GET /v1/enums/hotels/property-types` — List hotel property type filters - [`getIndustries`](/ai-docs/getIndustries.md) `GET /v1/enums/industries` — List industries - [`getLanguages`](/ai-docs/getLanguages.md) `GET /v1/enums/languages` — List languages - [`getMetroAreas`](/ai-docs/getMetroAreas.md) `GET /v1/enums/metro-areas` — List preset metro areas - [`getNaicsCodes`](/ai-docs/getNaicsCodes.md) `GET /v1/enums/naics-codes` — List NAICS codes - [`getRegions`](/ai-docs/getRegions.md) `GET /v1/enums/regions` — List countries and regions - [`getSkills`](/ai-docs/getSkills.md) `GET /v1/enums/skills` — List skills - [`getSubdivisions`](/ai-docs/getSubdivisions.md) `GET /v1/enums/subdivisions` — List subdivisions by country - [`getTags`](/ai-docs/getTags.md) `GET /v1/enums/tags` — List profile and company tags - [`getTechnologies`](/ai-docs/getTechnologies.md) `GET /v1/enums/technologies` — List technologies - [`getTimeZones`](/ai-docs/getTimeZones.md) `GET /v1/enums/time-zones` — List time zones ## Exclusions - [`addCompaniesToExclusionList`](/ai-docs/addCompaniesToExclusionList.md) `POST /v1/exclusions/companies/add-to-list` — Add companies to a company exclusion list - [`addProspectsToExclusionList`](/ai-docs/addProspectsToExclusionList.md) `POST /v1/exclusions/prospects/add-to-list` — Add prospects to a prospect exclusion list - [`createCompanyExclusionList`](/ai-docs/createCompanyExclusionList.md) `POST /v1/exclusions/companies/create-list` — Create company exclusion list - [`createCompanyExclusionListFromAudience`](/ai-docs/createCompanyExclusionListFromAudience.md) `POST /v1/exclusions/companies/audience/create-list` — Create company exclusion list from audience - [`createProspectExclusionList`](/ai-docs/createProspectExclusionList.md) `POST /v1/exclusions/prospects/create-list` — Create prospect exclusion list - [`createProspectExclusionListFromAudience`](/ai-docs/createProspectExclusionListFromAudience.md) `POST /v1/exclusions/prospects/audience/create-list` — Create prospect exclusion list from audience - [`deleteCompanyExclusionList`](/ai-docs/deleteCompanyExclusionList.md) `POST /v1/exclusions/companies/delete-list` — Delete company exclusion list - [`deleteProspectExclusionList`](/ai-docs/deleteProspectExclusionList.md) `POST /v1/exclusions/prospects/delete-list` — Delete prospect exclusion list - [`getCompanyExclusionLists`](/ai-docs/getCompanyExclusionLists.md) `POST /v1/exclusions/companies/get-lists` — Get company exclusion list - [`getExcludedCompaniesForExclusionList`](/ai-docs/getExcludedCompaniesForExclusionList.md) `POST /v1/exclusions/companies/read-from-list` — Get excluded companies for exclusion list - [`getExcludedProspectsForExclusionList`](/ai-docs/getExcludedProspectsForExclusionList.md) `POST /v1/exclusions/prospects/read-from-list` — Get excluded prospects for exclusion list - [`getProspectExclusionLists`](/ai-docs/getProspectExclusionLists.md) `POST /v1/exclusions/prospects/get-lists` — Get prospect exclusion lists - [`removeCompanyFromExclusionList`](/ai-docs/removeCompanyFromExclusionList.md) `POST /v1/exclusions/companies/remove-from-list` — Remove company from company exclusion list - [`removeProspectFromExclusionList`](/ai-docs/removeProspectFromExclusionList.md) `POST /v1/exclusions/prospects/remove-from-list` — Remove prospect from prospect exclusion list ## GitHub - [`githubLookupPoll`](/ai-docs/githubLookupPoll.md) `POST /v1/github-lookup/poll` — Poll GitHub lookup results - [`githubLookupTrigger`](/ai-docs/githubLookupTrigger.md) `POST /v1/github-lookup/trigger` — Start GitHub lookup - [`githubToLinkedInPolling`](/ai-docs/githubToLinkedInPolling.md) `POST /v1/github-to-linkedin/polling` — Poll GitHub to LinkedIn lookup - [`githubToLinkedInTrigger`](/ai-docs/githubToLinkedInTrigger.md) `POST /v1/github-to-linkedin/trigger` — Start GitHub to LinkedIn lookup - [`githubToLinkedinSingle`](/ai-docs/githubToLinkedinSingle.md) `POST /v1/github-to-linkedin/single` — Find person by GitHub username (single) ## Google maps - [`check-google-maps-results`](/ai-docs/check-google-maps-results.md) `POST /v1/google-maps-search/check` — Check progress for Google Maps results - [`google-maps-search`](/ai-docs/google-maps-search.md) `POST /v1/google-maps-search/start` — Start a search on Google Maps - [`poll-google-maps-results`](/ai-docs/poll-google-maps-results.md) `POST /v1/google-maps-search/poll` — Poll for Google Maps results ## Instagram - [`instagramPostComments`](/ai-docs/instagramPostComments.md) `POST /v1/instagram/post-comments` — Fetch Instagram post comments - [`instagramPostDetails`](/ai-docs/instagramPostDetails.md) `POST /v1/instagram/post-details` — Fetch Instagram post details - [`instagramProfile`](/ai-docs/instagramProfile.md) `POST /v1/instagram/profile` — Fetch Instagram user profile - [`instagramUserPosts`](/ai-docs/instagramUserPosts.md) `POST /v1/instagram/user-posts` — Fetch Instagram user posts - [`instagramUserReels`](/ai-docs/instagramUserReels.md) `POST /v1/instagram/user-reels` — Fetch Instagram user reels ## Job changes - [`addProfilesToList`](/ai-docs/addProfilesToList.md) `POST /v1/job-changes/add-profiles` — Add profiles to the job change list - [`createJobChangeList`](/ai-docs/createJobChangeList.md) `POST /v1/job-changes/create-list` — Create job change list - [`deleteJobChangeList`](/ai-docs/deleteJobChangeList.md) `POST /v1/job-changes/delete-list` — Delete a job changes list - [`deleteProfilesFromJobChangeList`](/ai-docs/deleteProfilesFromJobChangeList.md) `POST /v1/job-changes/delete-profiles` — Delete profiles from a job change list - [`getJobChangeList`](/ai-docs/getJobChangeList.md) `POST /v1/job-changes/get-list` — Get a job changes list - [`listAllJobChangeLists`](/ai-docs/listAllJobChangeLists.md) `POST /v1/job-changes/list-all` — List all job changes lists - [`listAllProfilesFromJobChangeList`](/ai-docs/listAllProfilesFromJobChangeList.md) `POST /v1/job-changes/list-all-profiles` — Lists all profiles from a job change list - [`updateJobChangeList`](/ai-docs/updateJobChangeList.md) `POST /v1/job-changes/update-list` — Update job change list ## Kitchen sink - [`KitchenSinkBulkProfile`](/ai-docs/KitchenSinkBulkProfile.md) `POST /v1/kitchen-sink/bulk/profile` — Kitchen sink bulk profile lookup - [`KitchenSinkProfile`](/ai-docs/KitchenSinkProfile.md) `POST /v1/kitchen-sink/person` — Kitchen sink person lookup - [`kitchenSinkBulkCompany`](/ai-docs/kitchenSinkBulkCompany.md) `POST /v1/kitchen-sink/bulk/company` — Kitchen sink bulk company lookup - [`kitchenSinkCompany`](/ai-docs/kitchenSinkCompany.md) `POST /v1/kitchen-sink/company` — Kitchen sink company lookup ## LinkedIn activity - [`companyPostsLiveFetch`](/ai-docs/companyPostsLiveFetch.md) `POST /v1/linkedin-live-fetch/company-posts` — Fetch LinkedIn company posts - [`postCommentsLiveFetch`](/ai-docs/postCommentsLiveFetch.md) `POST /v1/linkedin-live-fetch/post-comments` — Fetch LinkedIn post comments - [`postReactionsLiveFetch`](/ai-docs/postReactionsLiveFetch.md) `POST /v1/linkedin-live-fetch/post-reactions` — Fetch LinkedIn post reactions - [`postSearchByKeywords`](/ai-docs/postSearchByKeywords.md) `POST /v1/linkedin-live-fetch/posts/search` — Search LinkedIn posts by keywords - [`profileCommentsLiveFetch`](/ai-docs/profileCommentsLiveFetch.md) `POST /v1/linkedin-live-fetch/profile-comments` — Fetch LinkedIn profile comments - [`profilePostsLiveFetch`](/ai-docs/profilePostsLiveFetch.md) `POST /v1/linkedin-live-fetch/profile-posts` — Fetch LinkedIn profile posts - [`profileReactionsLiveFetch`](/ai-docs/profileReactionsLiveFetch.md) `POST /v1/linkedin-live-fetch/profile-reactions` — Fetch LinkedIn profile reactions ## Live fetch - [`companyLiveEnrich`](/ai-docs/companyLiveEnrich.md) `POST /v1/linkedin-live-fetch/company/single` — Live fetch LinkedIn company - [`pollBatchLiveEnrich`](/ai-docs/pollBatchLiveEnrich.md) `POST /v1/linkedin-live-fetch/batch/poll` — Poll batch live enrichment - [`profileLiveEnrich`](/ai-docs/profileLiveEnrich.md) `POST /v1/linkedin-live-fetch/profile/single` — Live fetch LinkedIn profile - [`startBatchLiveEnrich`](/ai-docs/startBatchLiveEnrich.md) `POST /v1/linkedin-live-fetch/batch/start` — Start batch live enrichment ## Market intelligence - [`fetchRealEstateListings`](/ai-docs/fetchRealEstateListings.md) `POST /v1/real-estate/listings` — Fetch real estate listings - [`financialInstrumentLookup`](/ai-docs/financialInstrumentLookup.md) `POST /v1/finance/instrument` — Look up a financial instrument - [`flightBookingOptions`](/ai-docs/flightBookingOptions.md) `POST /v1/flights/booking-options` — Get flight booking options - [`flightSearch`](/ai-docs/flightSearch.md) `POST /v1/flights/search` — Search flights - [`hotelProperty`](/ai-docs/hotelProperty.md) `POST /v1/hotels/property` — Get hotel property details - [`hotelSearch`](/ai-docs/hotelSearch.md) `POST /v1/hotels/search` — Search hotels ## Profile info - [`bulkProfilePic`](/ai-docs/bulkProfilePic.md) `POST /v1/profile-pic/bulk` — Bulk profile pics ## Quickstart - [`getQuickstartScript`](/ai-docs/getQuickstartScript.md) `GET /quickstart` — Get quickstart install script ## Reddit - [`redditPostComments`](/ai-docs/redditPostComments.md) `POST /v1/reddit/post/comments` — Fetch post comments - [`redditSearch`](/ai-docs/redditSearch.md) `POST /v1/reddit/search` — Search Reddit posts - [`redditSubredditPosts`](/ai-docs/redditSubredditPosts.md) `POST /v1/reddit/subreddit/posts` — List subreddit posts - [`redditSubredditSearch`](/ai-docs/redditSubredditSearch.md) `POST /v1/reddit/subreddit/search` — Search within a subreddit ## Repair Data - [`pollMosaic`](/ai-docs/pollMosaic.md) `POST /v1/mosaic/poll` — Poll Mosaic run status - [`standardizeCompany`](/ai-docs/standardizeCompany.md) `POST /v1/standardize/company/single` — Standardize LinkedIn company identifier - [`standardizeCompanyBulk`](/ai-docs/standardizeCompanyBulk.md) `POST /v1/standardize/company/bulk` — Bulk standardize LinkedIn company identifiers - [`standardizeProfile`](/ai-docs/standardizeProfile.md) `POST /v1/standardize/profile/single` — Standardize LinkedIn profile entity URN - [`startMosaic`](/ai-docs/startMosaic.md) `POST /v1/mosaic/start` — Start Mosaic CSV healing ## Reverse lookup - [`liteReverseEmailLookup`](/ai-docs/liteReverseEmailLookup.md) `POST /v1/email-to-person/single/lite` — Find person by email (lite, high-volume) - [`reverseEmailLookup`](/ai-docs/reverseEmailLookup.md) `POST /v1/email-to-person/single` — Find person by email (single) - [`reversePhoneLookup`](/ai-docs/reversePhoneLookup.md) `POST /v1/phone-to-person/single` — Find person or company by phone (single) ## Saved search - [`createSavedSearch`](/ai-docs/createSavedSearch.md) `POST /v1/saved-search/create` — Create saved search - [`getCurrentCompaniesInSavedSearch`](/ai-docs/getCurrentCompaniesInSavedSearch.md) `POST /v1/saved-search/current/companies` — Get current companies in saved search - [`getCurrentProfilesInSavedSearch`](/ai-docs/getCurrentProfilesInSavedSearch.md) `POST /v1/saved-search/current/profiles` — Get current profiles in saved search - [`getLatestSavedSearchRun`](/ai-docs/getLatestSavedSearchRun.md) `POST /v1/saved-search/run/get-latest` — Get latest saved search run - [`getSavedSearch`](/ai-docs/getSavedSearch.md) `POST /v1/saved-search/get` — Get saved search - [`getSavedSearchRun`](/ai-docs/getSavedSearchRun.md) `POST /v1/saved-search/run/get` — Get saved search run - [`getSavedSearchRunCompanies`](/ai-docs/getSavedSearchRunCompanies.md) `POST /v1/saved-search/run/companies` — Get saved search run companies - [`getSavedSearchRunProfiles`](/ai-docs/getSavedSearchRunProfiles.md) `POST /v1/saved-search/run/profiles` — Get saved search run profiles - [`getSavedSearchRunStatus`](/ai-docs/getSavedSearchRunStatus.md) `POST /v1/saved-search/run/status` — Get saved search run status - [`listSavedSearch`](/ai-docs/listSavedSearch.md) `POST /v1/saved-search/list` — List saved searches - [`listSavedSearchRuns`](/ai-docs/listSavedSearchRuns.md) `POST /v1/saved-search/run/list` — List saved search runs - [`manuallySpawnSavedSearchRun`](/ai-docs/manuallySpawnSavedSearchRun.md) `POST /v1/saved-search/spawn` — Manually spawn saved search run - [`skipNextSavedSearchRun`](/ai-docs/skipNextSavedSearchRun.md) `POST /v1/saved-search/skip-next-run` — Skip next saved search auto-run - [`undoSkipNextSavedSearchRun`](/ai-docs/undoSkipNextSavedSearchRun.md) `POST /v1/saved-search/undo-skip` — Undo skip next saved search auto-run - [`updateSavedSearch`](/ai-docs/updateSavedSearch.md) `POST /v1/saved-search/update` — Update saved search ## Search - [`combinedSearchCount`](/ai-docs/combinedSearchCount.md) `POST /v1/combined-search/count` — Combined search count - [`companyCount`](/ai-docs/companyCount.md) `POST /v1/company-count` — Company count - [`companySearch`](/ai-docs/companySearch.md) `POST /v1/company-search` — Company search - [`jobPostingSearch`](/ai-docs/jobPostingSearch.md) `POST /v1/job-search` — Job postings search - [`jobPostingSearchCount`](/ai-docs/jobPostingSearchCount.md) `POST /v1/job-search/count` — Job postings count - [`paginatedCombinedSearch`](/ai-docs/paginatedCombinedSearch.md) `POST /v1/combined-search/paginated` — Combined people + company search - [`peopleSearch`](/ai-docs/peopleSearch.md) `POST /v1/people-search` — People search - [`peopleSearchCount`](/ai-docs/peopleSearchCount.md) `POST /v1/people-search/count` — People search count - [`quickCompanyResolve`](/ai-docs/quickCompanyResolve.md) `POST /v1/company-resolve` — Quickly resolve company identifiers - [`quickPersonResolve`](/ai-docs/quickPersonResolve.md) `POST /v1/person-resolve` — Quickly resolve person identifiers ## Social media lookup - [`socialMediaLookupBatchPolling`](/ai-docs/socialMediaLookupBatchPolling.md) `POST /v1/social-media-lookup/batch/poll` — Poll batch social media lookup - [`socialMediaLookupBatchTrigger`](/ai-docs/socialMediaLookupBatchTrigger.md) `POST /v1/social-media-lookup/batch/trigger` — Start batch social media lookup (X, Instagram) - [`socialMediaLookupPolling`](/ai-docs/socialMediaLookupPolling.md) `POST /v1/social-media-lookup/polling` — Poll social media lookup - [`socialMediaLookupTrigger`](/ai-docs/socialMediaLookupTrigger.md) `POST /v1/social-media-lookup/trigger` — Start social media lookup - [`twitterHandleToLinkedinUrl`](/ai-docs/twitterHandleToLinkedinUrl.md) `POST /v1/twitter-handle-to-linkedin/single` — Find LinkedIn URL from X (Twitter) handle ## Stealth - [`stealthFoundersCount`](/ai-docs/stealthFoundersCount.md) `POST /v1/stealth-founders/count` — Count stealth/ex-stealth founders - [`stealthFoundersSearch`](/ai-docs/stealthFoundersSearch.md) `POST /v1/stealth-founders/search` — Search stealth/ex-stealth founders ## TikTok - [`tiktokCommentReplies`](/ai-docs/tiktokCommentReplies.md) `POST /v1/tiktok/comment-replies` — Fetch TikTok comment replies - [`tiktokPopularSongs`](/ai-docs/tiktokPopularSongs.md) `POST /v1/tiktok/popular-songs` — Fetch popular TikTok songs - [`tiktokProfile`](/ai-docs/tiktokProfile.md) `POST /v1/tiktok/profile` — Fetch TikTok user profile - [`tiktokSearchHashtag`](/ai-docs/tiktokSearchHashtag.md) `POST /v1/tiktok/search-hashtag` — Search TikTok hashtag videos - [`tiktokSearchKeyword`](/ai-docs/tiktokSearchKeyword.md) `POST /v1/tiktok/search-keyword` — Search TikTok videos by keyword - [`tiktokSearchUsers`](/ai-docs/tiktokSearchUsers.md) `POST /v1/tiktok/search-users` — Search TikTok users - [`tiktokSongDetails`](/ai-docs/tiktokSongDetails.md) `POST /v1/tiktok/song-details` — Fetch TikTok song details - [`tiktokSongVideos`](/ai-docs/tiktokSongVideos.md) `POST /v1/tiktok/song-videos` — Fetch TikTok videos using a song - [`tiktokTrendingFeed`](/ai-docs/tiktokTrendingFeed.md) `POST /v1/tiktok/trending-feed` — Fetch TikTok trending feed - [`tiktokUnifiedSearch`](/ai-docs/tiktokUnifiedSearch.md) `POST /v1/tiktok/unified-search` — TikTok unified search - [`tiktokUserFollowers`](/ai-docs/tiktokUserFollowers.md) `POST /v1/tiktok/user-followers` — Fetch TikTok user followers - [`tiktokUserFollowing`](/ai-docs/tiktokUserFollowing.md) `POST /v1/tiktok/user-following` — Fetch TikTok user following - [`tiktokUserVideos`](/ai-docs/tiktokUserVideos.md) `POST /v1/tiktok/user-videos` — Fetch TikTok user videos - [`tiktokVideoComments`](/ai-docs/tiktokVideoComments.md) `POST /v1/tiktok/video-comments` — Fetch TikTok video comments - [`tiktokVideoDetails`](/ai-docs/tiktokVideoDetails.md) `POST /v1/tiktok/video-details` — Fetch TikTok video details - [`tiktokVideoTranscript`](/ai-docs/tiktokVideoTranscript.md) `POST /v1/tiktok/video-transcript` — Fetch TikTok video transcript ## Tracker - [`addTrackerCompanies`](/ai-docs/addTrackerCompanies.md) `PUT /v1/tracker/company-lists/{listId}/companies` — Add companies to tracker list - [`addTrackerPeople`](/ai-docs/addTrackerPeople.md) `PUT /v1/tracker/person-lists/{listId}/people` — Add people to tracker list - [`createTrackerCompanyList`](/ai-docs/createTrackerCompanyList.md) `POST /v1/tracker/company-lists` — Create company tracker list - [`createTrackerPersonList`](/ai-docs/createTrackerPersonList.md) `POST /v1/tracker/person-lists` — Create person tracker list - [`deleteTrackerCompanyList`](/ai-docs/deleteTrackerCompanyList.md) `DELETE /v1/tracker/company-lists/{listId}` — Archive company tracker list - [`deleteTrackerPersonList`](/ai-docs/deleteTrackerPersonList.md) `DELETE /v1/tracker/person-lists/{listId}` — Archive person tracker list - [`fireTrackerDummy`](/ai-docs/fireTrackerDummy.md) `POST /v1/tracker/fire-dummy/{listId}` — Fire test signals - [`getTrackerCompanyList`](/ai-docs/getTrackerCompanyList.md) `GET /v1/tracker/company-lists/{listId}` — Get company tracker list - [`getTrackerOverview`](/ai-docs/getTrackerOverview.md) `GET /v1/tracker/overview` — Summarize all tracker lists - [`getTrackerPersonList`](/ai-docs/getTrackerPersonList.md) `GET /v1/tracker/person-lists/{listId}` — Get person tracker list - [`listAvailableTrackerRules`](/ai-docs/listAvailableTrackerRules.md) `GET /v1/tracker/rules` — List available tracker rules - [`listTrackerCompanyLists`](/ai-docs/listTrackerCompanyLists.md) `GET /v1/tracker/company-lists` — List company tracker lists - [`listTrackerPersonLists`](/ai-docs/listTrackerPersonLists.md) `GET /v1/tracker/person-lists` — List person tracker lists - [`listTrackerSignals`](/ai-docs/listTrackerSignals.md) `GET /v1/tracker/signals/{listId}` — List signals - [`previewTrackerSignal`](/ai-docs/previewTrackerSignal.md) `POST /v1/tracker/rules/preview-signal` — Preview a signal - [`refreshTrackerCompanyList`](/ai-docs/refreshTrackerCompanyList.md) `POST /v1/tracker/company-lists/{listId}/refresh` — Refresh company tracker list - [`refreshTrackerPersonList`](/ai-docs/refreshTrackerPersonList.md) `POST /v1/tracker/person-lists/{listId}/refresh` — Refresh person tracker list - [`removeTrackerCompanies`](/ai-docs/removeTrackerCompanies.md) `DELETE /v1/tracker/company-lists/{listId}/companies` — Remove companies from tracker list - [`removeTrackerPeople`](/ai-docs/removeTrackerPeople.md) `DELETE /v1/tracker/person-lists/{listId}/people` — Remove people from tracker list - [`updateTrackerCompanyList`](/ai-docs/updateTrackerCompanyList.md) `PATCH /v1/tracker/company-lists/{listId}` — Update company tracker list - [`updateTrackerPersonList`](/ai-docs/updateTrackerPersonList.md) `PATCH /v1/tracker/person-lists/{listId}` — Update person tracker list ## Typeaheads - [`companyTypeahead`](/ai-docs/companyTypeahead.md) `POST /v1/typeahead/company` — Company/School/Investor Typeahead - [`jobTitleRewrite`](/ai-docs/jobTitleRewrite.md) `POST /v1/typeahead/job-title` — Job Title Synonym Expansion - [`locationTypeahead`](/ai-docs/locationTypeahead.md) `POST /v1/typeahead/location` — Location typeahead - [`skillsTypeahead`](/ai-docs/skillsTypeahead.md) `POST /v1/typeahead/skills` — Skills Typeahead ## Utility - [`getOpenApi`](/ai-docs/getOpenApi.md) `GET /openapi.json` — Get OpenAPI schema - [`healthCheck`](/ai-docs/healthCheck.md) `GET /health` — Health check ## Validation - [`emailBounceDetection`](/ai-docs/emailBounceDetection.md) `POST /v1/validate-email/single` — Validate a single email - [`validatePhoneNumber`](/ai-docs/validatePhoneNumber.md) `POST /v1/validate-phone/single` — Validate a single phone number ## Web Research - [`webpageScreenshot`](/ai-docs/webpageScreenshot.md) `POST /v1/live-fetch/webpage/screenshot` — Capture webpage screenshot ## Webhooks - [`createWebhookEndpoint`](/ai-docs/createWebhookEndpoint.md) `POST /v1/webhooks/endpoints` — Create webhook endpoint - [`deleteWebhookEndpoint`](/ai-docs/deleteWebhookEndpoint.md) `DELETE /v1/webhooks/endpoints/{endpointId}` — Delete webhook endpoint - [`getWebhookEndpoint`](/ai-docs/getWebhookEndpoint.md) `GET /v1/webhooks/endpoints/{endpointId}` — Get webhook endpoint - [`listWebhookEndpoints`](/ai-docs/listWebhookEndpoints.md) `GET /v1/webhooks/endpoints` — List webhook endpoints - [`listWebhookEventTypes`](/ai-docs/listWebhookEventTypes.md) `GET /v1/webhooks/event-types` — List webhook event types - [`rotateWebhookEndpointSecret`](/ai-docs/rotateWebhookEndpointSecret.md) `POST /v1/webhooks/endpoints/{endpointId}/rotate-secret` — Rotate webhook signing secret - [`sendTestWebhookEvent`](/ai-docs/sendTestWebhookEvent.md) `POST /v1/webhooks/endpoints/{endpointId}/test-event` — Send test webhook event - [`updateWebhookEndpoint`](/ai-docs/updateWebhookEndpoint.md) `PATCH /v1/webhooks/endpoints/{endpointId}` — Update webhook endpoint ## X - [`twitterProfile`](/ai-docs/twitterProfile.md) `POST /v1/twitter/profile` — Fetch Twitter/X user profile - [`twitterSearch`](/ai-docs/twitterSearch.md) `POST /v1/twitter/search` — Search Twitter/X tweets - [`twitterTweetDetails`](/ai-docs/twitterTweetDetails.md) `POST /v1/twitter/tweet-details` — Fetch Twitter/X tweet details - [`twitterTweetQuotes`](/ai-docs/twitterTweetQuotes.md) `POST /v1/twitter/tweet-quotes` — Fetch Twitter/X tweet quote tweets - [`twitterTweetReplies`](/ai-docs/twitterTweetReplies.md) `POST /v1/twitter/tweet-replies` — Fetch Twitter/X tweet replies - [`twitterTweetRetweeters`](/ai-docs/twitterTweetRetweeters.md) `POST /v1/twitter/tweet-retweeters` — Fetch Twitter/X tweet retweeters - [`twitterUserFollowers`](/ai-docs/twitterUserFollowers.md) `POST /v1/twitter/user-followers` — Fetch Twitter/X user followers - [`twitterUserFollowing`](/ai-docs/twitterUserFollowing.md) `POST /v1/twitter/user-following` — Fetch Twitter/X user following - [`twitterUserMentions`](/ai-docs/twitterUserMentions.md) `POST /v1/twitter/user-mentions` — Fetch Twitter/X user mentions - [`twitterUserTweets`](/ai-docs/twitterUserTweets.md) `POST /v1/twitter/user-tweets` — Fetch Twitter/X user tweets ## Yelp - [`yelpPlace`](/ai-docs/yelpPlace.md) `POST /v1/yelp/place` — Get a Yelp business page - [`yelpReviews`](/ai-docs/yelpReviews.md) `POST /v1/yelp/reviews` — Get Yelp business reviews - [`yelpSearch`](/ai-docs/yelpSearch.md) `POST /v1/yelp/search` — Search Yelp businesses ## YouTube - [`youtubeChannel`](/ai-docs/youtubeChannel.md) `POST /v1/youtube/channel` — Fetch YouTube channel info and videos - [`youtubeSearch`](/ai-docs/youtubeSearch.md) `POST /v1/youtube/search` — Search YouTube videos - [`youtubeTranscript`](/ai-docs/youtubeTranscript.md) `POST /v1/youtube/transcript` — Fetch YouTube video transcript - [`youtubeVideoComments`](/ai-docs/youtubeVideoComments.md) `POST /v1/youtube/video-comments` — Fetch YouTube video comments - [`youtubeVideoDetails`](/ai-docs/youtubeVideoDetails.md) `POST /v1/youtube/video-details` — Fetch YouTube video details --- ★ = curated agent guidance available (use-when, avoid-when, quality checks). Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Instructions: [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # KitchenSinkBulkProfile `POST /v1/kitchen-sink/bulk/profile` **Tags:** `Kitchen sink` Kitchen sink bulk profile lookup **Endpoint:** `https://api.fiber.ai/v1/kitchen-sink/bulk/profile` ## Description Search for many people using a variety of parameters such as LinkedIn slug, LinkedIn URL, or current company information. Returns profile data for each person if found. Providing more information per person (e.g. name + company + LinkedIn) improves match accuracy. ⚡ Rate limit: 60 requests per 1 minute 💰 Cost: Pay per person: 2 credits per lookup, plus 2 additional credits when the liveFetch flag is set. ⓘ ⏱ Recommended timeout: 3 minutes ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "profiles": { "type": "array", "items": { "type": "object", "properties": { "companyDomain": { "type": [ "object", "null" ], "properties": { "value": { "type": [ "string", "null" ], "minLength": 1, "description": "The domain of the company the person is currently working at" } }, "description": "Domain of the person's current company (e.g. 'fiber.ai'). Used with personName for matching." }, "companyName": { "type": [ "object", "null" ], "properties": { "value": { "type": [ "string", "null" ], "minLength": 1, "description": "The name of the company the person is currently working at" } } }, "jobTitle": { "type": [ "object", "null" ], "properties": { "value": { "type": [ "string", "null" ], "minLength": 1, "description": "The job title of the person to search for" } } }, "personName": { "type": [ "object", "null" ], "properties": { "value": { "type": [ "string", "null" ], "minLength": 1, "description": "The name of the person to search for. It can have first name and/or last name. Try to pass in names as present on LinkedIn." }, "looseMatch": { "type": "boolean", "default": false, "description": "If true, allows partial and out-of-order matches. If false, only exact full name matches are returned." } }, "description": "Person's name for matching. Best used with companyDomain or companyIdentifier." }, "numProfiles": { "type": "integer", "minimum": 1, "maximum": 10, "default": 1, "description": "Maximum number of profile results to return per lookup. Defaults to 1." }, "profileIdentifier": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinSlug" ] }, "value": { "type": "string", "description": "The LinkedIn slug of the person (e.g. 'williamhgates' from linkedin.com/in/williamhgates)." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinUrl" ] }, "value": { "type": "string", "description": "The LinkedIn URL of the person (e.g. 'https://www.linkedin.com/in/williamhgates'). The https:// and www prefixes are optional." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "userID" ] }, "value": { "type": "string", "description": "The LinkedIn user ID of the person." } }, "required": [ "identifier", "value" ] }, { "type": "null" } ], "description": "LinkedIn profile identifier (slug or URL). Provides the best match accuracy." }, "companyIdentifier": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinSlug" ] }, "value": { "type": "string", "description": "The LinkedIn slug of the person's current company." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinUrl" ] }, "value": { "type": "string", "description": "The LinkedIn URL of the person's current company." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinOrgID" ] }, "value": { "type": "string", "description": "The LinkedIn organization ID of the person's current company." } }, "required": [ "identifier", "value" ] }, { "type": "null" } ], "description": "LinkedIn identifier for the person's current company. Used with personName for matching." }, "emailAddress": { "type": [ "string", "null" ], "format": "email", "description": "Email address to look up. Second-best accuracy after profileIdentifier." } }, "description": "Parameters for searching for a person. Provide at least one parameter. More parameters improve match accuracy." }, "minItems": 1, "maxItems": 50 }, "liveFetch": { "type": [ "boolean", "null" ], "default": false, "description": "When true, triggers a real-time LinkedIn profile fetch. Costs additional credits. Useful for profiles not yet in the database or to get the freshest data." }, "forceCompanyMatch": { "type": [ "boolean", "null" ], "default": false, "description": "When true, requires that the matched profile works at the specified company. Without this, the API may return profiles that match by name but work elsewhere." }, "fuzzySearch": { "type": [ "boolean", "null" ], "default": false, "description": "When true, enables fuzzy name matching. Useful when exact name spelling is uncertain." }, "thoroughness": { "type": [ "string", "null" ], "enum": [ "low", "high", null ], "default": "low", "description": "Controls how thoroughly to search across all profiles in the batch. Higher values recover more matches at the cost of additional per-row latency; lower values return faster. Omit to use the recommended default." }, "getDetailedEducation": { "type": [ "boolean", "null" ], "default": false, "description": "When true, returns detailed_education[] with school_details for each education entry." }, "getDetailedWorkExperience": { "type": [ "boolean", "null" ], "default": false, "description": "When true, returns detailed_work_experiences[] with company_details (domains, preferred_name, linkedin_primary_slug, li_org_id) for each work experience. Use this to get company domains for a person." } }, "required": [ "apiKey", "profiles" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "array", "items": { "type": "object", "properties": { "articles": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "date_published": { "type": [ "string", "null" ] } } } }, "certifications": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "credential_id": { "type": [ "string", "null" ] }, "verify_url": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "date": { "type": [ "string", "null" ] } } } }, "connection_count": { "type": [ "number", "null" ] }, "courses": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "course_number": { "type": [ "string", "null" ] }, "association": { "type": "null" } } } }, "dob": { "type": [ "string", "null" ] }, "education": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "school_id": { "type": [ "string", "null" ] }, "school_name": { "type": [ "string", "null" ] }, "field_of_study_id": { "type": [ "string", "null" ] }, "field_of_study_name": { "type": [ "string", "null" ] }, "degree": { "type": [ "string", "null" ] }, "grade": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "activities": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } } } }, "experiences": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } } }, "first_name": { "type": [ "string", "null" ] }, "follower_count": { "type": [ "number", "null" ] }, "headline": { "type": [ "string", "null" ] }, "inferred_location": { "type": [ "object", "null" ], "properties": { "street_address": { "type": [ "string", "null" ] }, "neighborhood": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "state_name": { "type": [ "string", "null" ] }, "state_code": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] }, "country_code": { "type": [ "string", "null" ] }, "country_name": { "type": [ "string", "null" ] }, "coordinates": { "type": [ "object", "null" ], "properties": { "lat": { "type": "number" }, "lon": { "type": "number" } }, "required": [ "lat", "lon" ] }, "timezone": { "type": [ "string", "null" ] }, "full_address": { "type": [ "string", "null" ] }, "formatted_address": { "type": [ "string", "null" ] } } }, "interests": { "type": [ "array", "null" ], "items": { "type": "string" } }, "last_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "patents": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "number": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "date": { "type": [ "string", "null" ] } } } }, "profile_pic": { "type": [ "string", "null" ] }, "projects": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "project_id": { "type": [ "string", "null" ] }, "project_title": { "type": [ "string", "null" ] }, "project_url": { "type": [ "string", "null" ] }, "project_summary": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] } } } }, "publications": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "collaborators": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } } } }, "date": { "type": [ "string", "null" ] }, "id": { "type": [ "string", "null" ] }, "publisher": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } } } }, "skills": { "type": [ "array", "null" ], "items": { "type": "string" } }, "primary_slug": { "type": "string" }, "slugs": { "type": [ "array", "null" ], "items": { "type": "string" } }, "summary": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "user_id": { "type": [ "string", "null" ] }, "volunteering": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "role": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "cause": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] } } } }, "tenures": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "date_range": { "type": "object", "properties": { "gte": { "type": [ "string", "null" ] }, "lte": { "type": [ "string", "null" ] } } }, "range_length_days": { "type": [ "number", "null" ] }, "titles": { "type": "array", "items": { "type": "string" } }, "localities": { "type": "array", "items": { "type": "string" } } }, "required": [ "date_range", "titles", "localities" ] } }, "career_began_at": { "type": [ "string", "null" ] }, "tags": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "student", "attended-top-us-university", "attended-top-global-university", "second-time-founder", "deep-technical-background", "major-tech-company-experience", "fortune-500-executive", "recently-changed-companies", "recently-promoted", "decision-maker", "c-suite", "experienced-executive", "phd", "influencer", "board-member" ] } }, "entity_urn": { "type": [ "string", "null" ] }, "open_to_work": { "type": [ "boolean", "null" ] }, "premium": { "type": [ "boolean", "null" ] }, "influencer": { "type": [ "boolean", "null" ] }, "organizations": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] } } } }, "entity_urns": { "type": [ "array", "null" ], "items": { "type": "string" } }, "is_hiring": { "type": [ "boolean", "null" ] }, "websites": { "type": [ "array", "null" ], "items": { "type": "string" } }, "is_verified": { "type": [ "boolean", "null" ] }, "verifications": { "type": [ "object", "null" ], "properties": { "is_verified": { "type": [ "boolean", "null" ] }, "joined_date": { "type": [ "string", "null" ] }, "verification_types": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "subtitle": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] } } } } } }, "is_top_voice": { "type": [ "boolean", "null" ] }, "current_job": { "type": [ "object", "null" ], "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } }, "custom_data": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "relevance_score": { "type": [ "number", "null" ] }, "last_sort_key": { "type": [ "string", "null" ] }, "industry_name": { "type": [ "string", "null" ] }, "last_updated_at": { "type": [ "string", "null" ] }, "languages": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "proficiency_id": { "type": [ "string", "null" ] }, "proficiency_name": { "type": [ "string", "null" ] } } } }, "detailed_education": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "school_details": { "type": [ "object", "null" ], "properties": { "linkedin_ids": { "type": [ "array", "null" ], "items": { "type": "string" } }, "li_org_id": { "type": [ "string", "null" ] }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "preferred_name": { "type": [ "string", "null" ] } } }, "school_id": { "type": [ "string", "null" ] }, "school_name": { "type": [ "string", "null" ] }, "field_of_study_id": { "type": [ "string", "null" ] }, "field_of_study_name": { "type": [ "string", "null" ] }, "degree": { "type": [ "string", "null" ] }, "grade": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "activities": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } } } }, "detailed_work_experiences": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "company_details": { "type": [ "object", "null" ], "properties": { "linkedin_ids": { "type": [ "array", "null" ], "items": { "type": "string" } }, "li_org_id": { "type": [ "string", "null" ] }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "preferred_name": { "type": [ "string", "null" ] }, "crunchbase_slug": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "standard_industries": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "li_industries": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } } } }, "required": [ "primary_slug" ] } }, "description": "Profiles found for each lookup. A 2D array because each lookup may yield multiple profiles." }, "message": { "type": [ "string", "null" ], "description": "Additional context if no matching profile was found." } }, "required": [ "data" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # KitchenSinkProfile `POST /v1/kitchen-sink/person` **Tags:** `Kitchen sink` Kitchen sink person lookup **Endpoint:** `https://api.fiber.ai/v1/kitchen-sink/person` ## Description Search for a person using a variety of parameters such as LinkedIn slug, LinkedIn URL, email, or current company information. Returns profile data for the person if found. Providing more information (e.g. name + company + LinkedIn) improves match accuracy. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: Pay per person: 2 credits per lookup, plus 2 additional credits when the liveFetch flag is set. ⓘ ⏱ Recommended timeout: 1 minute ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "profileIdentifier": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinSlug" ] }, "value": { "type": "string", "description": "The LinkedIn slug of the person (e.g. 'williamhgates' from linkedin.com/in/williamhgates)." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinUrl" ] }, "value": { "type": "string", "description": "The LinkedIn URL of the person (e.g. 'https://www.linkedin.com/in/williamhgates'). The https:// and www prefixes are optional." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "userID" ] }, "value": { "type": "string", "description": "The LinkedIn user ID of the person." } }, "required": [ "identifier", "value" ] }, { "type": "null" } ], "description": "LinkedIn profile identifier (slug or URL). Provides the best match accuracy." }, "emailAddress": { "type": [ "string", "null" ], "format": "email", "description": "Email address to look up. Second-best accuracy after profileIdentifier." }, "personName": { "type": [ "object", "null" ], "properties": { "value": { "type": [ "string", "null" ], "minLength": 1, "description": "The name of the person to search for. It can have first name and/or last name. Try to pass in names as present on LinkedIn." }, "looseMatch": { "type": "boolean", "default": false, "description": "If true, allows partial and out-of-order matches. If false, only exact full name matches are returned." } }, "description": "Person's name for matching. Best used with companyDomain or companyIdentifier." }, "jobTitle": { "type": [ "object", "null" ], "properties": { "value": { "type": [ "string", "null" ], "minLength": 1, "description": "The job title of the person to search for" } } }, "companyIdentifier": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinSlug" ] }, "value": { "type": "string", "description": "The LinkedIn slug of the person's current company." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinUrl" ] }, "value": { "type": "string", "description": "The LinkedIn URL of the person's current company." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinOrgID" ] }, "value": { "type": "string", "description": "The LinkedIn organization ID of the person's current company." } }, "required": [ "identifier", "value" ] }, { "type": "null" } ], "description": "LinkedIn identifier for the person's current company. Used with personName for matching." }, "linkedinHeadline": { "type": [ "object", "null" ], "properties": { "value": { "type": [ "string", "null" ], "minLength": 1, "description": "The headline of the person's LinkedIn profile. This is the first line of their profile." }, "looseMatch": { "type": "boolean", "default": false, "description": "Whether to allow a loose match on the headline. If true, we allow for additional words between the terms in the headline (e.g. 'Software Engineer' would match 'Software Development Engineer'). If false, we require a strict phrase match." } } }, "companyName": { "type": [ "object", "null" ], "properties": { "value": { "type": [ "string", "null" ], "minLength": 1, "description": "The name of the company the person is currently working at" } } }, "companyDomain": { "type": [ "object", "null" ], "properties": { "value": { "type": [ "string", "null" ], "minLength": 1, "description": "The domain of the company the person is currently working at" } }, "description": "Domain of the person's current company (e.g. 'fiber.ai'). Used with personName for matching." }, "profileLocation": { "type": [ "object", "null" ], "properties": { "countryCode": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 3, "description": "ISO 3166-1 alpha-3 country code (e.g. 'USA', 'GBR')." }, "stateName": { "type": [ "string", "null" ], "description": "State or region name in plain text (e.g. 'California', 'New York')." }, "locality": { "type": [ "string", "null" ], "description": "Free-text location string. Use this when the location data does not clearly separate into country, state, or city." } }, "description": "Location of the person. Accepts country code, state name, and/or a free-text locality string." }, "numProfiles": { "type": "integer", "minimum": 1, "maximum": 10, "default": 1, "description": "Maximum number of profile results to return per lookup. Defaults to 1." }, "liveFetch": { "type": [ "boolean", "null" ], "default": false, "description": "When true, triggers a real-time LinkedIn profile fetch. Costs additional credits. Useful for profiles not yet in the database or to get the freshest data." }, "forceCompanyMatch": { "type": [ "boolean", "null" ], "default": false, "description": "When true, requires that the matched profile works at the specified company. Without this, the API may return profiles that match by name but work elsewhere." }, "schoolName": { "type": [ "object", "null" ], "properties": { "value": { "type": [ "string", "null" ], "minLength": 1, "description": "The name of the school the person is currently attending or has attended. If provided, we will lookup the person by school name." } } }, "schoolIdentifier": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinOrgID" ] }, "value": { "type": "string", "description": "The LinkedIn organization ID of the school" } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinUrl" ] }, "value": { "type": "string", "description": "The LinkedIn URL of the school" } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinSlug" ] }, "value": { "type": "string", "description": "The LinkedIn slug of the school" } }, "required": [ "identifier", "value" ] }, { "type": "null" } ], "description": "The identifier of the school the person is currently attending or has attended. If provided, we will lookup the person by school identifier." }, "schoolDomain": { "type": [ "object", "null" ], "properties": { "value": { "type": [ "string", "null" ], "minLength": 1, "description": "The domain of the school the person is currently attending or has attended. If provided, we will lookup the person by school domain." } } }, "fuzzySearch": { "type": [ "boolean", "null" ], "default": false, "description": "When true, enables fuzzy name matching. Useful when exact name spelling is uncertain." }, "thoroughness": { "type": [ "string", "null" ], "enum": [ "low", "high", null ], "default": "high", "description": "Controls how thoroughly to search. Higher values recover more matches at the cost of additional latency; lower values return faster. Omit to use the recommended default." }, "getDetailedEducation": { "type": [ "boolean", "null" ], "default": false, "description": "When true, returns detailed_education[] with school_details for each education entry." }, "getDetailedWorkExperience": { "type": [ "boolean", "null" ], "default": false, "description": "When true, returns detailed_work_experiences[] with company_details (domains, preferred_name, linkedin_primary_slug, li_org_id) for each work experience. Use this to get company domains for a person." } }, "required": [ "apiKey" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "articles": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "date_published": { "type": [ "string", "null" ] } } } }, "certifications": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "credential_id": { "type": [ "string", "null" ] }, "verify_url": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "date": { "type": [ "string", "null" ] } } } }, "connection_count": { "type": [ "number", "null" ] }, "courses": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "course_number": { "type": [ "string", "null" ] }, "association": { "type": "null" } } } }, "dob": { "type": [ "string", "null" ] }, "education": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "school_id": { "type": [ "string", "null" ] }, "school_name": { "type": [ "string", "null" ] }, "field_of_study_id": { "type": [ "string", "null" ] }, "field_of_study_name": { "type": [ "string", "null" ] }, "degree": { "type": [ "string", "null" ] }, "grade": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "activities": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } } } }, "experiences": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } } }, "first_name": { "type": [ "string", "null" ] }, "follower_count": { "type": [ "number", "null" ] }, "headline": { "type": [ "string", "null" ] }, "inferred_location": { "type": [ "object", "null" ], "properties": { "street_address": { "type": [ "string", "null" ] }, "neighborhood": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "state_name": { "type": [ "string", "null" ] }, "state_code": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] }, "country_code": { "type": [ "string", "null" ] }, "country_name": { "type": [ "string", "null" ] }, "coordinates": { "type": [ "object", "null" ], "properties": { "lat": { "type": "number" }, "lon": { "type": "number" } }, "required": [ "lat", "lon" ] }, "timezone": { "type": [ "string", "null" ] }, "full_address": { "type": [ "string", "null" ] }, "formatted_address": { "type": [ "string", "null" ] } } }, "interests": { "type": [ "array", "null" ], "items": { "type": "string" } }, "last_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "patents": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "number": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "date": { "type": [ "string", "null" ] } } } }, "profile_pic": { "type": [ "string", "null" ] }, "projects": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "project_id": { "type": [ "string", "null" ] }, "project_title": { "type": [ "string", "null" ] }, "project_url": { "type": [ "string", "null" ] }, "project_summary": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] } } } }, "publications": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "collaborators": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } } } }, "date": { "type": [ "string", "null" ] }, "id": { "type": [ "string", "null" ] }, "publisher": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } } } }, "skills": { "type": [ "array", "null" ], "items": { "type": "string" } }, "primary_slug": { "type": "string" }, "slugs": { "type": [ "array", "null" ], "items": { "type": "string" } }, "summary": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "user_id": { "type": [ "string", "null" ] }, "volunteering": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "role": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "cause": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] } } } }, "tenures": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "date_range": { "type": "object", "properties": { "gte": { "type": [ "string", "null" ] }, "lte": { "type": [ "string", "null" ] } } }, "range_length_days": { "type": [ "number", "null" ] }, "titles": { "type": "array", "items": { "type": "string" } }, "localities": { "type": "array", "items": { "type": "string" } } }, "required": [ "date_range", "titles", "localities" ] } }, "career_began_at": { "type": [ "string", "null" ] }, "tags": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "student", "attended-top-us-university", "attended-top-global-university", "second-time-founder", "deep-technical-background", "major-tech-company-experience", "fortune-500-executive", "recently-changed-companies", "recently-promoted", "decision-maker", "c-suite", "experienced-executive", "phd", "influencer", "board-member" ] } }, "entity_urn": { "type": [ "string", "null" ] }, "open_to_work": { "type": [ "boolean", "null" ] }, "premium": { "type": [ "boolean", "null" ] }, "influencer": { "type": [ "boolean", "null" ] }, "organizations": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] } } } }, "entity_urns": { "type": [ "array", "null" ], "items": { "type": "string" } }, "is_hiring": { "type": [ "boolean", "null" ] }, "websites": { "type": [ "array", "null" ], "items": { "type": "string" } }, "is_verified": { "type": [ "boolean", "null" ] }, "verifications": { "type": [ "object", "null" ], "properties": { "is_verified": { "type": [ "boolean", "null" ] }, "joined_date": { "type": [ "string", "null" ] }, "verification_types": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "subtitle": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] } } } } } }, "is_top_voice": { "type": [ "boolean", "null" ] }, "current_job": { "type": [ "object", "null" ], "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } }, "custom_data": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "relevance_score": { "type": [ "number", "null" ] }, "last_sort_key": { "type": [ "string", "null" ] }, "industry_name": { "type": [ "string", "null" ] }, "last_updated_at": { "type": [ "string", "null" ] }, "languages": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "proficiency_id": { "type": [ "string", "null" ] }, "proficiency_name": { "type": [ "string", "null" ] } } } }, "detailed_education": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "school_details": { "type": [ "object", "null" ], "properties": { "linkedin_ids": { "type": [ "array", "null" ], "items": { "type": "string" } }, "li_org_id": { "type": [ "string", "null" ] }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "preferred_name": { "type": [ "string", "null" ] } } }, "school_id": { "type": [ "string", "null" ] }, "school_name": { "type": [ "string", "null" ] }, "field_of_study_id": { "type": [ "string", "null" ] }, "field_of_study_name": { "type": [ "string", "null" ] }, "degree": { "type": [ "string", "null" ] }, "grade": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "activities": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } } } }, "detailed_work_experiences": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "company_details": { "type": [ "object", "null" ], "properties": { "linkedin_ids": { "type": [ "array", "null" ], "items": { "type": "string" } }, "li_org_id": { "type": [ "string", "null" ] }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "preferred_name": { "type": [ "string", "null" ] }, "crunchbase_slug": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "standard_industries": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "li_industries": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } } } }, "required": [ "primary_slug" ] }, "description": "The list of profiles found for the given query" }, "message": { "type": [ "string", "null" ], "description": "Additional context if no matching profile was found." } }, "required": [ "data" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # accountSendOtp `POST /v1/account/send-otp` **Tags:** `Account` Start signup (send OTP) **Endpoint:** `https://api.fiber.ai/v1/account/send-otp` ## Description Step 1 of signup. No API key is required. Send a one-time verification code to a work email to start a Fiber API trial. Optional firstName, lastName, and companyName are stored and used when the account is created. After the code arrives, call POST /v1/account/verify-otp with the returned verificationId and the code from email. That completes signup and returns your live API key (and a sandbox key when minted). ⚡ Rate limit: 6 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "email": { "type": "string", "minLength": 1, "description": "Work email to start signup. A one-time code is sent here; pass it to POST /v1/account/verify-otp with the returned verificationId." }, "purpose": { "type": "string", "enum": [ "agent-api", "slushie" ], "description": "Which product surface this trial is for. Defaults to agent-api for backward compatibility.", "default": "agent-api" }, "firstName": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 50, "description": "Optional first name for the account. When omitted, derived from the email local-part." }, "lastName": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 50, "description": "Optional last name for the account. When omitted, a default value is used." }, "companyName": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 100, "description": "Optional organization display name. When omitted, derived from the email local-part." } }, "required": [ "email" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "otp_sent" ] }, "verificationId": { "type": "string", "description": "Pass this unchanged to POST /v1/account/verify-otp." }, "message": { "type": "string" }, "next": { "type": "object", "properties": { "method": { "type": "string", "enum": [ "POST" ] }, "path": { "type": "string", "description": "Call this endpoint with the OTP from email to finish signup.", "enum": [ "/v1/account/verify-otp" ] }, "body": { "type": "object", "properties": { "verificationId": { "type": "string", "description": "Same verificationId returned in this response." }, "otp": { "type": "string", "description": "Replace with the one-time code delivered to the email inbox." } }, "required": [ "verificationId", "otp" ] } }, "required": [ "method", "path", "body" ], "description": "Next request an agent or client should make after reading the OTP from email." } }, "required": [ "status", "verificationId", "message", "next" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # accountVerifyOtp `POST /v1/account/verify-otp` **Tags:** `Account` Complete signup (verify OTP) **Endpoint:** `https://api.fiber.ai/v1/account/verify-otp` ## Description Step 2 of signup. Completes the flow started by POST /v1/account/send-otp. Pass the verificationId from that response and the one-time code from email. On success this creates the trial account and returns a live API key (sk_live_...) plus a companion sandbox API key (sk_test_...) when one was minted. Store both securely — they cannot be retrieved later. First-time users without a key yet must start at send-otp; existing users create extra sandbox keys via POST /v1/api-keys/create-sandbox. ⚡ Rate limit: 12 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "verificationId": { "type": "string", "minLength": 1, "description": "The verification identifier returned by send-otp." }, "otp": { "type": "string", "minLength": 1, "description": "The one-time code delivered by email." } }, "required": [ "verificationId", "otp" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "created" ] }, "apiKey": { "type": "string", "description": "The live API key for the new trial organization (starts with sk_live_). Store it securely — it cannot be retrieved later." }, "sandboxApiKey": { "type": [ "string", "null" ], "description": "Companion sandbox API key (starts with sk_test_...) for local development and integration tests. Null if it was not minted at signup — create one via POST /v1/api-keys/create-sandbox." }, "creditsAwarded": { "type": "integer", "minimum": 0, "description": "Number of credits granted with this trial." }, "organizationId": { "type": "string" }, "message": { "type": "string" } }, "required": [ "status", "apiKey", "creditsAwarded", "organizationId", "message" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # addCompaniesToExclusionList `POST /v1/exclusions/companies/add-to-list` **Tags:** `Exclusions` Add companies to a company exclusion list **Endpoint:** `https://api.fiber.ai/v1/exclusions/companies/add-to-list` ## Description Add companies to a company exclusion list ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "listId": { "type": "string", "description": "The ID of the company exclusion list to add companies to." }, "companies": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": [ "string", "null" ], "description": "A company domain, like 'example.com'." }, "linkedinUrl": { "type": [ "string", "null" ], "description": "A LinkedIn company URL, like 'https://www.linkedin.com/company/google'." } } }, "maxItems": 5000, "description": "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." } }, "required": [ "apiKey", "listId", "companies" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "listId": { "type": "string", "description": "The ID of the company exclusion list." }, "companiesAdded": { "type": "number", "description": "Number of companies added to the exclusion list" }, "invalidIdentifiers": { "type": "array", "items": { "type": "object", "properties": { "input": { "type": "object", "properties": { "domain": { "type": [ "string", "null" ] }, "linkedinUrl": { "type": [ "string", "null" ] } }, "description": "The original entry as submitted." }, "reason": { "type": "string", "description": "The specific reason this entry could not be added." } }, "required": [ "input", "reason" ] }, "description": "Entries that could not be added because they had no valid company domain or LinkedIn company URL. Valid entries in the same request are still added." } }, "required": [ "listId", "companiesAdded", "invalidIdentifiers" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # addProfilesToList `POST /v1/job-changes/add-profiles` **Tags:** `Job changes` Add profiles to the job change list **Endpoint:** `https://api.fiber.ai/v1/job-changes/add-profiles` ## Description 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. ⚡ Rate limit: 60 requests per 1 minute 💰 Cost: 1 credit per per profile tracked ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "jobChangeListId": { "type": "string", "description": "The job change list id." }, "profiles": { "type": "array", "items": { "type": "object", "properties": { "linkedinUrl": { "type": "string", "pattern": "^(?:https?:\\/\\/)?(?:[a-z]+\\.)?linkedin\\.[a-z]{2,}\\/(?:in|sales\\/lead|talent\\/profile)\\/(?:[^/\\\\?,#]+)\\/?(?:[\\?,#].*)?", "description": "A LinkedIn URL, like 'https://www.linkedin.com/in/jake'" } }, "required": [ "linkedinUrl" ] }, "minItems": 1, "maxItems": 5000 } }, "required": [ "apiKey", "jobChangeListId", "profiles" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "message": { "type": "string" }, "invalidProfiles": { "type": "array", "items": { "type": "string" } } }, "required": [ "message", "invalidProfiles" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # addProspectsToExclusionList `POST /v1/exclusions/prospects/add-to-list` **Tags:** `Exclusions` Add prospects to a prospect exclusion list **Endpoint:** `https://api.fiber.ai/v1/exclusions/prospects/add-to-list` ## Description Add prospects to a prospect exclusion list ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "listId": { "type": "string", "description": "The ID of the prospect exclusion list to add prospects to." }, "prospects": { "type": "array", "items": { "type": "object", "properties": { "linkedinUrl": { "type": [ "string", "null" ] } } }, "maxItems": 5000, "description": "The prospects to add to the exclusion list. A maximum of 5000 prospects can be added at a time." } }, "required": [ "apiKey", "listId", "prospects" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "listId": { "type": "string", "description": "The ID of the prospect exclusion list." }, "prospectsAdded": { "type": "number", "description": "Number of prospects added to the exclusion list" } }, "required": [ "listId", "prospectsAdded" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # addTrackerCompanies `PUT /v1/tracker/company-lists/{listId}/companies` **Tags:** `Tracker` Add companies to tracker list **Endpoint:** `https://api.fiber.ai/v1/tracker/company-lists/{listId}/companies` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `listId` | path | yes | The unique ID of the tracker list. | ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "companies": { "type": "array", "items": { "type": "object", "properties": { "linkedinUrl": { "type": [ "string", "null" ], "minLength": 1, "description": "Full LinkedIn company URL." }, "linkedinOrgId": { "type": [ "string", "null" ], "pattern": "^\\d+$", "minLength": 1, "description": "A company's stable numeric identifier. This is NOT derived from their company page URL — retrieve it from a live enrichment lookup. Digits only." }, "linkedinSlug": { "type": [ "string", "null" ], "minLength": 1, "description": "The handle in a company page URL — e.g. `microsoft` in https://www.linkedin.com/company/microsoft/." }, "domain": { "type": [ "string", "null" ], "minLength": 1, "description": "Company website domain (e.g. 'fiber.ai'). Will be resolved to the company profile identifier." } } }, "minItems": 1, "maxItems": 10000, "description": "Companies to add. At least one identifier required per company." }, "initialSignals": { "type": [ "object", "null" ], "properties": { "lookbackPeriodDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 30, "description": "How many days back from today to search for recent events. Useful for bootstrapping a new list without waiting for the first scheduled refresh. Defaults to the list's refresh interval if not provided." } }, "description": "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." } }, "required": [ "apiKey", "companies" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "added": { "type": "integer", "minimum": 0, "description": "Number of companies successfully added." }, "skipped": { "type": "integer", "minimum": 0, "description": "Number skipped (duplicates or invalid)." }, "invalidCompanies": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "description": "Index in the input array." }, "reason": { "type": "string", "description": "Why this company was skipped." } }, "required": [ "index", "reason" ] }, "description": "Details on any companies that could not be added." }, "initialSignals": { "oneOf": [ { "type": "object", "properties": { "triggered": { "type": "boolean", "enum": [ true ] }, "companiesQueued": { "type": "integer", "minimum": 0, "description": "Number of companies queued for initial signal processing." } }, "required": [ "triggered", "companiesQueued" ] }, { "type": "object", "properties": { "triggered": { "type": "boolean", "enum": [ false ] } }, "required": [ "triggered" ] } ], "description": "Status of the initial signals request." } }, "required": [ "added", "skipped", "invalidCompanies", "initialSignals" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # addTrackerPeople `PUT /v1/tracker/person-lists/{listId}/people` **Tags:** `Tracker` Add people to tracker list **Endpoint:** `https://api.fiber.ai/v1/tracker/person-lists/{listId}/people` ## Description Add people to a person tracker list. Identify people by LinkedIn URL, user ID, or slug. At least one identifier is required per person. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `listId` | path | yes | The unique ID of the tracker list. | ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "people": { "type": "array", "items": { "type": "object", "properties": { "linkedinUrl": { "type": [ "string", "null" ], "minLength": 1, "description": "Full LinkedIn profile URL" }, "linkedinUserId": { "type": [ "string", "null" ], "pattern": "^\\d+$", "minLength": 1, "description": "A person's stable numeric identifier. This is NOT derived from their profile URL — retrieve it from a live enrichment lookup. Digits only." }, "linkedinSlug": { "type": [ "string", "null" ], "minLength": 1, "description": "The handle in a profile URL — e.g. `williamhgates` in https://www.linkedin.com/in/williamhgates/." } } }, "minItems": 1, "maxItems": 10000, "description": "People to add. At least one identifier required per person." }, "initialSignals": { "type": [ "object", "null" ], "properties": { "lookbackPeriodDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 30, "description": "How many days back from today to search for recent events. Useful for bootstrapping a new list without waiting for the first scheduled refresh. Defaults to the list's refresh interval if not provided." } }, "description": "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." } }, "required": [ "apiKey", "people" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "added": { "type": "integer", "minimum": 0, "description": "Number of people fully resolved and added to the list." }, "pending": { "type": "integer", "minimum": 0, "description": "Number of people accepted and added to the list but whose profile is still being resolved in the background. They become fully tracked once resolution finishes (usually within minutes); a profile that turns out not to exist is dropped automatically." }, "skipped": { "type": "integer", "minimum": 0, "description": "Number of people not added because they were already in the list or appeared more than once in this request. People that could not be resolved are reported in invalidPeople, not here." }, "invalidPeople": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "description": "Index in the input array." }, "reason": { "type": "string", "description": "Why this person was skipped." } }, "required": [ "index", "reason" ] }, "description": "Details on any people that could not be added." }, "initialSignals": { "oneOf": [ { "type": "object", "properties": { "triggered": { "type": "boolean", "enum": [ true ] }, "peopleQueued": { "type": "integer", "minimum": 0, "description": "Number of people queued for initial signal processing." } }, "required": [ "triggered", "peopleQueued" ] }, { "type": "object", "properties": { "triggered": { "type": "boolean", "enum": [ false ] } }, "required": [ "triggered" ] } ], "description": "Status of the initial signals request." } }, "required": [ "added", "pending", "skipped", "invalidPeople", "initialSignals" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # blueCollarJobsSearch `POST /v1/blue-collar-jobs/search` **Tags:** `Blue collar jobs` Search blue collar job listings **Endpoint:** `https://api.fiber.ai/v1/blue-collar-jobs/search` ## Description 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. ⚡ Rate limit: 300 requests per 1 minute 💰 Cost: 2 credits per search ⓘ ⏱ Recommended timeout: 1 minute ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "companySlug": { "type": [ "string", "null" ], "minLength": 1, "description": "Company identifier on the job board. Use the resolve-company endpoint to find this from a domain or name." }, "query": { "type": [ "string", "null" ], "minLength": 1, "description": "Job title or keyword to search for (e.g. 'warehouse worker', 'forklift operator')." }, "location": { "type": [ "string", "null" ], "minLength": 1, "description": "US city, state, or region to search within (e.g. 'Philadelphia, PA', 'Texas'). Only US locations are supported." }, "nextPageToken": { "type": [ "string", "null" ], "description": "Pagination token returned from a previous search. Pass to get the next page of results." } }, "required": [ "apiKey" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique job listing identifier." }, "title": { "type": "string", "description": "Job title." }, "companyName": { "type": "string", "description": "Name of the company that posted the job listing." }, "location": { "type": "string", "description": "Job location (city, state, or region)." }, "url": { "type": "string", "description": "Direct URL to the full job listing." }, "description": { "type": [ "string", "null" ], "description": "Brief description or snippet of the job posting." }, "salary": { "type": [ "object", "null" ], "properties": { "text": { "type": "string", "description": "Human-readable salary string as shown on the listing (e.g. '$18 - $22 an hour', 'From $45,000 a year')." }, "local": { "type": [ "object", "null" ], "properties": { "currency": { "type": [ "string", "null" ], "description": "ISO 4217 currency code (e.g. 'USD', 'CAD')." }, "min": { "type": [ "number", "null" ], "description": "Lower bound of compensation range." }, "max": { "type": [ "number", "null" ], "description": "Upper bound of compensation range." } }, "description": "Parsed compensation in the listed currency. Null when the salary text uses an unrecognized format that could not be parsed into structured numbers." }, "usd": { "type": [ "object", "null" ], "properties": { "min": { "type": [ "number", "null" ], "description": "Lower bound of compensation range in USD." }, "max": { "type": [ "number", "null" ], "description": "Upper bound of compensation range in USD." } }, "description": "Compensation in USD. Null when the listing currency is not USD or could not be determined." }, "period": { "type": [ "string", "null" ], "enum": [ "hourly", "daily", "monthly", "yearly", null ], "description": "Pay period. Null when the listing does not specify a recognizable pay frequency." } }, "required": [ "text" ], "description": "Compensation information. Covers various forms of pay (hourly, daily, monthly, yearly). Null when not listed." }, "estimatedPostedAt": { "type": [ "string", "null" ], "description": "Estimated date the job was posted in ISO 8601 format. Derived from approximate relative time." } }, "required": [ "id", "title", "companyName", "location", "url" ] }, "description": "List of job listings matching the search." }, "estimatedJobCount": { "type": [ "number", "null" ], "description": "Estimated total number of matching jobs across all pages." }, "nextPageToken": { "type": [ "string", "null" ], "description": "Pagination token. Pass in the next request to get more results. Null when no more pages are available." } }, "required": [ "jobs" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # blueCollarResolveCompany `POST /v1/blue-collar-jobs/resolve-company` **Tags:** `Blue collar jobs` Resolve company to blue collar job board identifier **Endpoint:** `https://api.fiber.ai/v1/blue-collar-jobs/resolve-company` ## Description 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. ⚡ Rate limit: 300 requests per 1 minute 💰 Cost: 2 credits per resolution attempt ⓘ ⏱ Recommended timeout: 30 seconds ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "companyName": { "type": [ "string", "null" ], "minLength": 1, "description": "Company name to look up (e.g. 'Caterpillar', 'Amazon'). At least one of companyName or domain must be provided." }, "domain": { "type": [ "string", "null" ], "minLength": 1, "description": "Company website domain or URL (e.g. 'caterpillar.com', 'https://walmart.com'). At least one of companyName or domain must be provided." } }, "required": [ "apiKey" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "slug": { "type": "string", "description": "Company identifier to use in the companySlug field of the search endpoint." }, "companyName": { "type": "string", "description": "Resolved company display name." }, "jobCount": { "type": [ "number", "null" ], "description": "Approximate number of currently open job listings." } }, "required": [ "slug", "companyName" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # buildAudience `POST /v1/audiences/{audienceId}/build` **Tags:** `Audiences` Build audience from search parameters **Endpoint:** `https://api.fiber.ai/v1/audiences/{audienceId}/build` ## Description 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). ⚡ Rate limit: 30 requests per 1 minute 💰 Cost: Credits are charged after the build completes based on results: 1 credits per company and 1 credits per profile found. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `audienceId` | path | yes | The unique ID of the audience. | ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" } }, "required": [ "apiKey" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "audienceId": { "type": "string", "description": "The unique ID of the audience." }, "status": { "type": "string", "description": "The status indicating the build has started.", "enum": [ "BUILDING" ] }, "message": { "type": "string", "description": "A human-readable message about the build status." } }, "required": [ "audienceId", "status", "message" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # bulkCompanyLogos `POST /v1/company-logos/bulk` **Tags:** `Company info` Bulk company logos **Endpoint:** `https://api.fiber.ai/v1/company-logos/bulk` ## Description Get logo URLs for a list of companies. Max 10,000 companies can be looked up at a time. ⚡ Rate limit: 30 requests per 1 minute 💰 Cost: 0.33 credits per company logo lookup ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "companiesIdentifier": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "domains" ] }, "domains": { "type": "array", "items": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$", "description": "A domain, like 'example.com' or 'https://example.com'" }, "minItems": 1, "maxItems": 10000 } }, "required": [ "type", "domains" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "linkedinUrls" ] }, "linkedinUrls": { "type": "array", "items": { "type": "string", "format": "uri", "pattern": "^(https?:\\/\\/)?(\\w+\\.)?linkedin\\.\\w+(\\.\\w+)?\\/(company|company-beta|showcase|organization|school|companies)\\/(?:[^\\/\\?#]+)\\/?(\\?.*)?(#.*)?$", "description": "A LinkedIn company URL, like 'https://www.linkedin.com/company/google'" }, "minItems": 1, "maxItems": 10000 } }, "required": [ "type", "linkedinUrls" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "liOrgIds" ] }, "liOrgIds": { "type": "array", "items": { "type": "string" }, "minItems": 1, "maxItems": 10000 } }, "required": [ "type", "liOrgIds" ] } ], "description": "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." } }, "required": [ "apiKey", "companiesIdentifier" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "data": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "domains" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$", "description": "The domain of the company" }, "logoUrl": { "type": "string", "format": "uri", "description": "The logo URL" } }, "required": [ "domain", "logoUrl" ] }, "maxItems": 10000 } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "linkedinUrls" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "linkedinUrl": { "type": "string", "format": "uri", "pattern": "^(https?:\\/\\/)?(\\w+\\.)?linkedin\\.\\w+(\\.\\w+)?\\/(company|company-beta|showcase|organization|school|companies)\\/(?:[^\\/\\?#]+)\\/?(\\?.*)?(#.*)?$", "description": "The linkedin URL of the company" }, "logoUrl": { "type": "string", "format": "uri", "description": "The logo URL" } }, "required": [ "linkedinUrl", "logoUrl" ] }, "maxItems": 10000 } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "liOrgIds" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "liOrgId": { "type": "string", "description": "The linkedin org ID of the company" }, "logoUrl": { "type": "string", "format": "uri", "description": "The logo URL" } }, "required": [ "liOrgId", "logoUrl" ] }, "maxItems": 10000 } }, "required": [ "type", "data" ] } ], "description": "The list of logo URLs" } }, "required": [ "data" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # bulkProfilePic `POST /v1/profile-pic/bulk` **Tags:** `Profile info` Bulk profile pics **Endpoint:** `https://api.fiber.ai/v1/profile-pic/bulk` ## Description Get profile pics for a list of profiles. Max 10,000 profiles can be looked up at a time. ⚡ Rate limit: 30 requests per 1 minute 💰 Cost: 0.33 credits per profile pic lookup ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "linkedinUrls": { "type": "array", "items": { "type": "string", "pattern": "^(?:https?:\\/\\/)?(?:[a-z]+\\.)?linkedin\\.[a-z]{2,}\\/(?:in|sales\\/lead|talent\\/profile)\\/(?:[^/\\\\?,#]+)\\/?(?:[\\?,#].*)?", "description": "A LinkedIn URL, like 'https://www.linkedin.com/in/jake'" }, "minItems": 1, "maxItems": 10000 } }, "required": [ "apiKey", "linkedinUrls" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "linkedinUrl": { "type": "string", "pattern": "^(?:https?:\\/\\/)?(?:[a-z]+\\.)?linkedin\\.[a-z]{2,}\\/(?:in|sales\\/lead|talent\\/profile)\\/(?:[^/\\\\?,#]+)\\/?(?:[\\?,#].*)?", "description": "The linkedin URL of the profile" }, "profilePicFound": { "type": "boolean" }, "profilePic": { "type": [ "string", "null" ], "description": "The profile pic of the profile" } }, "required": [ "linkedinUrl", "profilePicFound", "profilePic" ] } } }, "required": [ "data" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # buyCredits `POST /v1/buy-credits` **Tags:** `Account` Buy credits **Endpoint:** `https://api.fiber.ai/v1/buy-credits` ## Description Purchase additional credits for your organization. Saved-card purchases cost $20.00 per 1,000 credits on a subscription, or $30.00 per 1,000 credits on a pay-as-you-go plan. A one-time payment authorization charges the pay-as-you-go rate. This endpoint immediately charges real money. Confirm with a human operator before calling it from an agent. ⚡ Rate limit: 2 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "subscriptionId": { "type": [ "string", "null" ], "minLength": 1, "description": "The subscription to add credits to. Required when the organization has more than one subscription, or when charging a saved payment method. Must be omitted when paying with a one-time payment authorization; sending both is rejected." }, "creditsToBuy": { "type": "integer", "minimum": 100, "maximum": 1000000, "description": "Number of credits to purchase. One-time payment authorizations require at least 100 credits. Saved-card purchases require at least 1,000 credits." }, "sharedPaymentGrantedToken": { "type": [ "string", "null" ], "minLength": 1, "description": "A one-time payment authorization from your payment provider. When set, this purchase charges that authorization instead of a saved card. Each purchase needs a freshly minted authorization." }, "idempotencyKey": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 255, "description": "A unique key to safely retry a purchase. If a request fails or times out, resend with the same key to avoid being charged twice. When omitted, each call is a new purchase." } }, "required": [ "apiKey", "creditsToBuy" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "message": { "type": "string" }, "creditsPurchased": { "type": "integer", "exclusiveMinimum": 0 }, "centsSpent": { "type": "integer", "minimum": 0, "description": "Total amount charged in US cents for this purchase" } }, "required": [ "message", "creditsPurchased", "centsSpent" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # cancelBatchContactDetails `POST /v1/contact-details/batch/cancel` **Tags:** `Contact details` Cancel batch contact details **Endpoint:** `https://api.fiber.ai/v1/contact-details/batch/cancel` ## Description Cancels a batch contact details job that is in progress. Only unclaimed profiles will be cancelled. Profiles already processed will be charged for. Credits are refunded for cancelled profiles. ⚡ Rate limit: 60 requests per 1 minute ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "taskId": { "type": "string", "minLength": 1, "description": "The task ID returned from the start endpoint." } }, "required": [ "apiKey", "taskId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "cancelledCount": { "type": "integer", "minimum": 0, "description": "The number of profiles cancelled." }, "creditsRefunded": { "type": "number", "minimum": 0, "description": "The number of credits refunded for cancelled profiles." }, "message": { "type": "string", "description": "A human-readable summary of the cancellation result." } }, "required": [ "cancelledCount", "creditsRefunded", "message" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # cardsAttach `POST /v1/cards/attach` **Tags:** `Account` Attach card to trial account **Endpoint:** `https://api.fiber.ai/v1/cards/attach` ## Description Attach a payment card to a cardless trial organization using a single-use Stripe shared payment token. The card is verified with a temporary $1 authorization that is refunded immediately (net cost $0), and the organization's free-credit ceiling is raised. The verified card is not saved for future charges — every future paid top-up requires a freshly-minted shared payment token. ⚡ Rate limit: 3 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "sharedPaymentGrantedToken": { "type": "string", "pattern": "^spt_", "minLength": 1, "description": "Single-use Stripe shared payment token (`spt_...`) authorizing exactly one card handoff. Mint it on the buyer side (see https://docs.stripe.com/agentic-commerce/concepts/shared-payment-tokens); each request must submit a freshly-minted token." } }, "required": [ "apiKey", "sharedPaymentGrantedToken" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "attached" ] }, "creditsGranted": { "type": "integer", "description": "Additional free trial credits granted by this call. Zero when the organization was already at its trial credit ceiling (e.g. re-attaching after the ceiling was already reached)." }, "totalCreditsUnlocked": { "type": "integer", "description": "Free trial credit ceiling after this call — the maximum credits the organization can spend on the trial before it needs a paid top-up." }, "paymentMethod": { "type": "object", "properties": { "brand": { "type": [ "string", "null" ], "description": "Card network (e.g. 'visa', 'mastercard'). Null when unavailable." }, "last4": { "type": [ "string", "null" ], "description": "Last four digits of the card. Null when unavailable." } }, "description": "Display-only metadata for the card that was verified in this call. This is not a saved payment method — future paid top-ups must submit a freshly-minted shared payment token." } }, "required": [ "status", "creditsGranted", "totalCreditsUnlocked", "paymentMethod" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # check-google-maps-results `POST /v1/google-maps-search/check` **Tags:** `Google maps` Check progress for Google Maps results **Endpoint:** `https://api.fiber.ai/v1/google-maps-search/check` ## Description Check progress for Google Maps results ⚡ Rate limit: 120 requests per 1 minute ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "searchID": { "type": "string", "minLength": 1, "description": "The ID of the Google Maps search. You should get this from the start endpoint." } }, "required": [ "apiKey", "searchID" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "NOT_STARTED", "RUNNING", "COMPLETED", "FAILED" ] }, "totalPlacesFound": { "type": "integer", "minimum": 0, "description": "The total number of places found so far." }, "totalPlacesRequested": { "type": "integer", "minimum": 0, "description": "The total number of places requested." }, "percentageCompleted": { "type": "number", "minimum": 0, "maximum": 100, "description": "The percentage of the search that has been completed." } }, "required": [ "status", "totalPlacesFound", "totalPlacesRequested", "percentageCompleted" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # combinedSearchCount `POST /v1/combined-search/count` **Tags:** `Search` Combined search count **Endpoint:** `https://api.fiber.ai/v1/combined-search/count` ## Description Get the total count of companies and people matching the provided search filters. People counts are scoped to those currently or previously working (based on the job status filter) at companies that satisfy the company search filters. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: Flat charge for the company count (1 credit) and profile count (1 credit) ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "companyParams": { "type": "object", "properties": { "exactCompanyV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "domain": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$" } }, "required": [ "identifier", "domain" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/(www\\.)?linkedin\\.com\\/company\\/[a-zA-Z0-9-]+\\/?.*$" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-org-id" ] }, "org_id": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "identifier", "org_id" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "advanced" ] }, "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string", "minLength": 1 }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "identifier", "li_org_id" ] } ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "domain": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$" } }, "required": [ "identifier", "domain" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/(www\\.)?linkedin\\.com\\/company\\/[a-zA-Z0-9-]+\\/?.*$" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-org-id" ] }, "org_id": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "identifier", "org_id" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "advanced" ] }, "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string", "minLength": 1 }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "identifier", "li_org_id" ] } ] } } } }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "headquartersCountryCode": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } } } }, "headquartersStateName": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string" } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "employeeCountV2": { "type": [ "object", "null" ], "properties": { "lowerBoundExclusive": { "type": [ "integer", "null" ], "minimum": 0 }, "upperBoundInclusive": { "type": [ "integer", "null" ], "minimum": 0 } } }, "keywords": { "type": [ "object", "null" ], "properties": { "containsAll": { "type": [ "array", "null" ], "items": { "type": "string" } }, "containsAny": { "type": [ "array", "null" ], "items": { "type": "string" } }, "containsNone": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "industriesV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "allOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } } } }, "stage": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "acquired", "public", "closed", "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "series_i", "series_j", "venture_other", "private_equity", "unknown", "no_funding_yet" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "acquired", "public", "closed", "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "series_i", "series_j", "venture_other", "private_equity", "unknown", "no_funding_yet" ] } } } }, "totalFundingUSD": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "lastFundingUSD": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "lastFundedOn": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ] }, "foundedOn": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ] }, "nameLike": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string" } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "exactCompany": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string" }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "li_org_id" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string" }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "li_org_id" ] } } } }, "acceleratorsV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "acceleratorName": { "type": "string", "enum": [ "a16z_speedrun", "accel_atoms", "ai2_incubator", "alchemist_accelerator", "alliance", "antler", "berkeley_skydeck", "founders_inc", "google_startups", "launch_accelerator", "neo", "pear_x", "plug_and_play", "sosv", "south_park_commons", "startx", "techstars", "the_mint", "ycombinator" ] }, "batchSelection": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "all-batches" ] } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "only-these-batches" ] }, "batches": { "type": "array", "items": { "type": "string" }, "minItems": 0 } }, "required": [ "strategy", "batches" ] }, { "type": "null" } ] }, "years": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } } }, "required": [ "acceleratorName" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "acceleratorName": { "type": "string", "enum": [ "a16z_speedrun", "accel_atoms", "ai2_incubator", "alchemist_accelerator", "alliance", "antler", "berkeley_skydeck", "founders_inc", "google_startups", "launch_accelerator", "neo", "pear_x", "plug_and_play", "sosv", "south_park_commons", "startx", "techstars", "the_mint", "ycombinator" ] }, "batchSelection": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "all-batches" ] } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "only-these-batches" ] }, "batches": { "type": "array", "items": { "type": "string" }, "minItems": 0 } }, "required": [ "strategy", "batches" ] }, { "type": "null" } ] }, "years": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } } }, "required": [ "acceleratorName" ] } } } }, "headquartersLocation": { "type": [ "object", "null" ], "properties": { "unionAll": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "radial-distance" ] }, "center": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] }, "latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "longitude": { "type": "number", "minimum": -180, "maximum": 180 } }, "required": [ "latitude", "longitude" ] }, "radius": { "oneOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "miles" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 12500 } }, "required": [ "unit", "quantity" ] }, { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "kilometers" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 20100 } }, "required": [ "unit", "quantity" ] } ] } }, "required": [ "strategy", "center", "radius" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "free-form-city" ] }, "city": { "type": "string", "minLength": 1 }, "countryCode": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 3 }, "radius": { "oneOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "miles" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 12500 } }, "required": [ "unit", "quantity" ] }, { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "kilometers" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 20100 } }, "required": [ "unit", "quantity" ] } ] } }, "required": [ "strategy", "city", "radius" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "polygon" ] }, "vertices": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "longitude": { "type": "number", "minimum": -180, "maximum": 180 } }, "required": [ "latitude", "longitude" ] }, "minItems": 4, "maxItems": 1000 } }, "required": [ "strategy", "vertices" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "preset-region" ] }, "region": { "type": "string", "enum": [ "sf-bay-area", "sf-north-bay", … _truncated to 65536 chars for ai-docs._ ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "numCompanies": { "type": "number" }, "numProfiles": { "type": "number" } }, "required": [ "numCompanies", "numProfiles" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # companyCount `POST /v1/company-count` **Tags:** `Search` Company count **Endpoint:** `https://api.fiber.ai/v1/company-count` ## Description Get count of companies matching search filters ⚡ Rate limit: 180 requests per 1 minute 💰 Cost: 1 credit per request ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "searchParams": { "type": "object", "properties": { "exactCompanyV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "domain": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$" } }, "required": [ "identifier", "domain" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/(www\\.)?linkedin\\.com\\/company\\/[a-zA-Z0-9-]+\\/?.*$" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-org-id" ] }, "org_id": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "identifier", "org_id" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "advanced" ] }, "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string", "minLength": 1 }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "identifier", "li_org_id" ] } ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "domain": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$" } }, "required": [ "identifier", "domain" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/(www\\.)?linkedin\\.com\\/company\\/[a-zA-Z0-9-]+\\/?.*$" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-org-id" ] }, "org_id": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "identifier", "org_id" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "advanced" ] }, "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string", "minLength": 1 }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "identifier", "li_org_id" ] } ] } } } }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "headquartersCountryCode": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } } } }, "headquartersStateName": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string" } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "employeeCountV2": { "type": [ "object", "null" ], "properties": { "lowerBoundExclusive": { "type": [ "integer", "null" ], "minimum": 0 }, "upperBoundInclusive": { "type": [ "integer", "null" ], "minimum": 0 } } }, "keywords": { "type": [ "object", "null" ], "properties": { "containsAll": { "type": [ "array", "null" ], "items": { "type": "string" } }, "containsAny": { "type": [ "array", "null" ], "items": { "type": "string" } }, "containsNone": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "industriesV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "allOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } } } }, "stage": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "acquired", "public", "closed", "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "series_i", "series_j", "venture_other", "private_equity", "unknown", "no_funding_yet" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "acquired", "public", "closed", "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "series_i", "series_j", "venture_other", "private_equity", "unknown", "no_funding_yet" ] } } } }, "totalFundingUSD": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "lastFundingUSD": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "lastFundedOn": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ] }, "foundedOn": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ] }, "nameLike": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string" } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "exactCompany": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string" }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "li_org_id" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string" }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "li_org_id" ] } } } }, "acceleratorsV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "acceleratorName": { "type": "string", "enum": [ "a16z_speedrun", "accel_atoms", "ai2_incubator", "alchemist_accelerator", "alliance", "antler", "berkeley_skydeck", "founders_inc", "google_startups", "launch_accelerator", "neo", "pear_x", "plug_and_play", "sosv", "south_park_commons", "startx", "techstars", "the_mint", "ycombinator" ] }, "batchSelection": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "all-batches" ] } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "only-these-batches" ] }, "batches": { "type": "array", "items": { "type": "string" }, "minItems": 0 } }, "required": [ "strategy", "batches" ] }, { "type": "null" } ] }, "years": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } } }, "required": [ "acceleratorName" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "acceleratorName": { "type": "string", "enum": [ "a16z_speedrun", "accel_atoms", "ai2_incubator", "alchemist_accelerator", "alliance", "antler", "berkeley_skydeck", "founders_inc", "google_startups", "launch_accelerator", "neo", "pear_x", "plug_and_play", "sosv", "south_park_commons", "startx", "techstars", "the_mint", "ycombinator" ] }, "batchSelection": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "all-batches" ] } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "only-these-batches" ] }, "batches": { "type": "array", "items": { "type": "string" }, "minItems": 0 } }, "required": [ "strategy", "batches" ] }, { "type": "null" } ] }, "years": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } } }, "required": [ "acceleratorName" ] } } } }, "headquartersLocation": { "type": [ "object", "null" ], "properties": { "unionAll": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "radial-distance" ] }, "center": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] }, "latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "longitude": { "type": "number", "minimum": -180, "maximum": 180 } }, "required": [ "latitude", "longitude" ] }, "radius": { "oneOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "miles" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 12500 } }, "required": [ "unit", "quantity" ] }, { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "kilometers" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 20100 } }, "required": [ "unit", "quantity" ] } ] } }, "required": [ "strategy", "center", "radius" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "free-form-city" ] }, "city": { "type": "string", "minLength": 1 }, "countryCode": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 3 }, "radius": { "oneOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "miles" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 12500 } }, "required": [ "unit", "quantity" ] }, { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "kilometers" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 20100 } }, "required": [ "unit", "quantity" ] } ] } }, "required": [ "strategy", "city", "radius" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "polygon" ] }, "vertices": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "longitude": { "type": "number", "minimum": -180, "maximum": 180 } }, "required": [ "latitude", "longitude" ] }, "minItems": 4, "maxItems": 1000 } }, "required": [ "strategy", "vertices" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "preset-region" ] }, "region": { "type": "string", "enum": [ "sf-bay-area", "sf-north-bay", … _truncated to 65536 chars for ai-docs._ ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "count": { "type": "number", "description": "The number of companies matching the search filters." } }, "required": [ "count" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # companyLiveEnrich `POST /v1/linkedin-live-fetch/company/single` **Tags:** `Live fetch` Live fetch LinkedIn company **Endpoint:** `https://api.fiber.ai/v1/linkedin-live-fetch/company/single` ## Description Returns an enriched company with details for a given LinkedIn company identifier ⚡ Rate limit: 600 requests per 1 minute 💰 Cost: 2 credits per company live fetch ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "type": { "type": "string", "enum": [ "slug", "orgId", "liUrl" ] }, "value": { "type": "string", "minLength": 1, "description": "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')." }, "getHistoricalHeadcount": { "type": "boolean", "default": false, "description": "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." } }, "required": [ "apiKey", "type", "value" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "company": { "type": "object", "properties": { "headline": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "employee_count": { "type": [ "number", "null" ] }, "follower_count": { "type": [ "number", "null" ] }, "founded_year": { "type": [ "number", "null" ] }, "industries": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "primary": { "type": [ "boolean", "null" ] } }, "required": [ "id", "name" ] } }, "inferred_location": { "type": [ "object", "null" ], "properties": { "street_address": { "type": [ "string", "null" ] }, "neighborhood": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "state_name": { "type": [ "string", "null" ] }, "state_code": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] }, "country_code": { "type": [ "string", "null" ] }, "country_name": { "type": [ "string", "null" ] }, "coordinates": { "type": [ "object", "null" ], "properties": { "lat": { "type": "number" }, "lon": { "type": "number" } }, "required": [ "lat", "lon" ] }, "timezone": { "type": [ "string", "null" ] }, "full_address": { "type": [ "string", "null" ] }, "formatted_address": { "type": [ "string", "null" ] } } }, "linkedin_url": { "type": [ "string", "null" ] }, "locations": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "address": { "type": [ "string", "null" ] }, "is_primary": { "type": [ "boolean", "null" ] }, "location": { "type": [ "object", "null" ], "properties": { "street_address": { "type": [ "string", "null" ] }, "neighborhood": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "state_name": { "type": [ "string", "null" ] }, "state_code": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] }, "country_code": { "type": [ "string", "null" ] }, "country_name": { "type": [ "string", "null" ] }, "coordinates": { "type": [ "object", "null" ], "properties": { "lat": { "type": "number" }, "lon": { "type": "number" } }, "required": [ "lat", "lon" ] }, "timezone": { "type": [ "string", "null" ] }, "full_address": { "type": [ "string", "null" ] }, "formatted_address": { "type": [ "string", "null" ] } } } } } }, "naics_codes": { "type": [ "array", "null" ], "items": { "type": "string" } }, "name": { "type": [ "string", "null" ] }, "org_id": { "type": [ "string", "null" ] }, "slug": { "type": "string" }, "specialties": { "type": [ "array", "null" ], "items": { "type": "string" } }, "ticker": { "type": [ "string", "null" ] }, "type": { "type": [ "string", "null" ] }, "domain": { "type": [ "string", "null" ] }, "website": { "type": [ "string", "null" ] }, "est_employee_count_lower_bound": { "type": [ "number", "null" ] }, "est_employee_count_upper_bound": { "type": [ "number", "null" ] }, "standardized_industries": { "type": [ "array", "null" ], "items": { "type": "string" } }, "locations_stats": { "type": [ "object", "null" ], "properties": { "USA": { "type": "number" }, "GBR": { "type": "number" }, "FRA": { "type": "number" }, "IND": { "type": "number" }, "BRA": { "type": "number" }, "DEU": { "type": "number" }, "ESP": { "type": "number" }, "CAN": { "type": "number" }, "AUS": { "type": "number" }, "NLD": { "type": "number" }, "ITA": { "type": "number" }, "ZAF": { "type": "number" }, "BEL": { "type": "number" }, "CHN": { "type": "number" }, "TUR": { "type": "number" }, "MEX": { "type": "number" }, "CHE": { "type": "number" }, "NOR": { "type": "number" }, "ARE": { "type": "number" }, "SWE": { "type": "number" }, "POL": { "type": "number" }, "IDN": { "type": "number" }, "ARG": { "type": "number" }, "PRT": { "type": "number" }, "COL": { "type": "number" }, "CHL": { "type": "number" }, "PAK": { "type": "number" }, "DNK": { "type": "number" }, "JPN": { "type": "number" }, "NGA": { "type": "number" }, "SGP": { "type": "number" }, "PER": { "type": "number" }, "NZL": { "type": "number" }, "AUT": { "type": "number" }, "IRL": { "type": "number" }, "MYS": { "type": "number" }, "BGD": { "type": "number" }, "EGY": { "type": "number" }, "ISR": { "type": "number" }, "SAU": { "type": "number" }, "PHL": { "type": "number" }, "FIN": { "type": "number" }, "IRN": { "type": "number" }, "ROU": { "type": "number" }, "CZE": { "type": "number" }, "GRC": { "type": "number" }, "HKG": { "type": "number" }, "HUN": { "type": "number" }, "KEN": { "type": "number" }, "MAR": { "type": "number" }, "VNM": { "type": "number" }, "RUS": { "type": "number" }, "UKR": { "type": "number" }, "ECU": { "type": "number" }, "THA": { "type": "number" }, "LKA": { "type": "number" }, "KOR": { "type": "number" }, "BGR": { "type": "number" }, "GHA": { "type": "number" }, "SRB": { "type": "number" }, "TWN": { "type": "number" }, "HRV": { "type": "number" }, "LTU": { "type": "number" }, "PRI": { "type": "number" }, "SVK": { "type": "number" }, "TUN": { "type": "number" }, "EST": { "type": "number" }, "VEN": { "type": "number" }, "CRI": { "type": "number" }, "PAN": { "type": "number" }, "URY": { "type": "number" }, "LBN": { "type": "number" }, "LUX": { "type": "number" }, "CYP": { "type": "number" }, "NPL": { "type": "number" }, "JOR": { "type": "number" }, "SVN": { "type": "number" }, "MTQ": { "type": "number" }, "QAT": { "type": "number" }, "GLP": { "type": "number" }, "UGA": { "type": "number" }, "DZA": { "type": "number" }, "GTM": { "type": "number" }, "CMR": { "type": "number" }, "LVA": { "type": "number" }, "DOM": { "type": "number" }, "AZE": { "type": "number" }, "GEO": { "type": "number" }, "SEN": { "type": "number" }, "TZA": { "type": "number" }, "ZWE": { "type": "number" }, "KWT": { "type": "number" }, "MLT": { "type": "number" }, "OMN": { "type": "number" }, "BOL": { "type": "number" }, "SLV": { "type": "number" }, "ARM": { "type": "number" }, "PRY": { "type": "number" }, "IRQ": { "type": "number" }, "KHM": { "type": "number" }, "BIH": { "type": "number" }, "AGO": { "type": "number" }, "BHR": { "type": "number" }, "ALB": { "type": "number" }, "KAZ": { "type": "number" }, "CIV": { "type": "number" }, "ETH": { "type": "number" }, "MUS": { "type": "number" }, "ZMB": { "type": "number" }, "MKD": { "type": "number" }, "COD": { "type": "number" }, "BLR": { "type": "number" }, "MOZ": { "type": "number" }, "REU": { "type": "number" }, "TTO": { "type": "number" }, "GUF": { "type": "number" }, "ISL": { "type": "number" }, "MMR": { "type": "number" }, "HND": { "type": "number" }, "RWA": { "type": "number" }, "MDG": { "type": "number" }, "BEN": { "type": "number" }, "UZB": { "type": "number" }, "NAM": { "type": "number" }, "BWA": { "type": "number" }, "MDA": { "type": "number" }, "JEY": { "type": "number" }, "NIC": { "type": "number" }, "SDN": { "type": "number" }, "JAM": { "type": "number" }, "IMN": { "type": "number" }, "BFA": { "type": "number" }, "MNG": { "type": "number" }, "MNE": { "type": "number" }, "MCO": { "type": "number" }, "TGO": { "type": "number" }, "AFG": { "type": "number" }, "LBY": { "type": "number" }, "XKX": { "type": "number" }, "CYM": { "type": "number" }, "MWI": { "type": "number" }, "SOM": { "type": "number" }, "PNG": { "type": "number" }, "MDV": { "type": "number" }, "MLI": { "type": "number" }, "GIN": { "type": "number" }, "PSE": { "type": "number" }, "GAB": { "type": "number" }, "LIE": { "type": "number" }, "HTI": { "type": "number" }, "SYR": { "type": "number" }, "BRB": { "type": "number" }, "YEM": { "type": "number" }, "GGY": { "type": "number" }, "NCL": { "type": "number" }, "AND": { "type": "number" }, "SUR": { "type": "number" }, "MYT": { "type": "number" }, "KGZ": { "type": "number" }, "BHS": { "type": "number" }, "GIB": { "type": "number" }, "COG": { "type": "number" }, "FJI": { "type": "number" }, "BLM": { "type": "number" }, "CUW": { "type": "number" }, "CUB": { "type": "number" }, "SLE": { "type": "number" }, "BLZ": { "type": "number" }, "NER": { "type": "number" }, "LBR": { "type": "number" }, "VIR": { "type": "number" }, "PYF": { "type": "number" }, "GUM": { "type": "number" }, "MRT": { "type": "number" }, "ABW": { "type": "number" }, "SYC": { "type": "number" }, "GUY": { "type": "number" }, "LSO": { "type": "number" }, "SWZ": { "type": "number" }, "SSD": { "type": "number" }, "LCA": { "type": "number" }, "MAC": { "type": "number" }, "SMR": { "type": "number" }, "LAO": { "type": "number" }, "BRN": { "type": "number" }, "TCD": { "type": "number" }, "BMU": { "type": "number" }, "VGB": { "type": "number" }, "PRK": { "type": "number" }, "BTN": { "type": "number" }, "BDI": { "type": "number" }, "FRO": { "type": "number" }, "TJK": { "type": "number" }, "GMB": { "type": "number" }, "STP": { "type": "number" }, "ANT": { "type": "number" }, "VCT": { "type": "number" }, "DJI": { "type": "number" }, "CPV": { "type": "number" }, "TKM": { "type": "number" }, "ATG": { "type": "number" }, "TCA": { "type": "number" }, "KNA": { "type": "number" }, "GRD": { "type": "number" }, "ASM": { "type": "number" }, "VUT": { "type": "number" }, "GNQ": { "type": "number" }, "GRL": { "type": "number" }, "SXM": { "type": "number" }, "MNP": { "type": "number" }, "COM": { "type": "number" }, "TLS": { "type": "number" }, "SJM": { "type": "number" }, "CAF": { "type": "number" }, "DMA": { "type": "number" }, "MAF": { "type": "number" }, "WSM": { "type": "number" }, "BES": { "type": "number" }, "MHL": { "type": "number" }, "AIA": { "type": "number" }, "TON": { "type": "number" }, "COK": { "type": "number" }, "SLB": { "type": "number" }, "SPM": { "type": "number" }, "GNB": { "type": "number" }, "ATA": { "type": "number" }, "TUV": { "type": "number" }, "ALA": { "type": "number" }, "IOT": { "type": "number" }, "ERI": { "type": "number" }, "PLW": { "type": "number" }, "FSM": { "type": "number" }, "NRU": { "type": "number" }, "PCN": { "type": "number" }, "FLK": { "type": "number" }, "MSR": { "type": "number" }, "VAT": { "type": "number" }, "KIR": { "type": "number" }, "SHN": { "type": "number" }, "NIU": { "type": "number" }, "WLF": { "type": "number" }, "HMD": { "type": "number" }, "CXR": { "type": "number" }, "NFK": { "type": "number" }, "ATF": { "type": "number" }, "CCK": { "type": "number" }, "SGS": { "type": "number" }, "BVT": { "type": "number" }, "UMI": { "type": "number" }, "ESH": { "type": "number" }, "TKL": { "type": "number" }, "X-SOUTH_ASIA": { "type": "number" }, "X-SOUTH_EAST_EUROPE": { "type": "number" }, "X-NORTHERN_AFRICA": { "type": "number" }, "X-PACIFIC": { "type": "number" }, "X-SOUTH_WEST_EUROPE": { "type": "number" }, "X-SOUTHERN_AFRICA": { "type": "number" }, "X-WEST_INDIES": { "type": "number" }, "X-SOUTH_AMERICA": { "type": "number" }, "X-SOUTH_WEST_ASIA": { "type": "number" }, "X-CENTRAL_EUROPE": { "type": "number" }, "X-EASTERN_EUROPE": { "type": "number" }, "X-WESTERN_EUROPE": { "type": "number" }, "X-CENTRAL_AMERICA": { "type": "number" }, "X-WESTERN_AFRICA": { "type": "number" }, "X-SOUTH_ATLANTIC_OCEAN": { "type": "number" }, "X-SOUTH_EAST_ASIA": { "type": "number" }, "X-CENTRAL_AFRICA": { "type": "number" }, "X-NORTH_AMERICA": { "type": "number" }, "X-EAST_ASIA": { "type": "number" }, "X-NORTHERN_EUROPE": { "type": "number" }, "X-EASTERN_AFRICA": { "type": "number" }, "X-SOUTHERN_INDIAN_OCEAN": { "type": "number" }, "X-SOUTHERN_EUROPE": { "type": "number" }, "X-CENTRAL_ASIA": { "type": "number" }, "X-NORTHERN_ASIA": { "type": "number" }, "X-ASIA": { "type": "number" }, "X-EUROPE": { "type": "number" }, "X-AFRICA": { "type": "number" }, "X-OCEANIA": { "type": "number" }, "X-AMERICAS": { "type": "number" }, "X-ANTARCTICA": { "type": "number" }, "X-ATLANTIC_OCEAN": { "type": "number" }, "X-INDIAN_OCEAN": { "type": "number" }, "X-MIDDLE_EAST": { "type": "number" }, "X-MENA": { "type": "number" }, "X-EMEA": { "type": "number" }, "X-EUROPEAN_UNION": { "type": "number" }, "X-EFTA": { "type": "number" }, "X-APAC": { "type": "number" }, "X-LATAM": { "type": "number" }, "X-ANGLOSPHERE": { "type": "number" }, "X-DACH": { "type": "number" }, "X-NORDICS": { "type": "number" }, "X-BENELUX": { "type": "number" }, "X-GCC": { "type": "number" }, "X-BRICS": { "type": "number" }, "X-G20": { "type": "number" }, "X-OECD": { "type": "number" }, "X-SANCTIONED": { "type": "number" } }, "additionalProperties": false }, "logo_url": { "type": [ "string", "null" ] }, "historical_headcount": { "type": [ "object", "null" ], "properties": { "latest_snapshot_date": { "type": "string", "format": "date" }, "snapshots": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "employees": { "type": "integer" } }, "required": [ "date", "employees" ] } }, "growth": { "type": "object", "properties": { "1m": { "type": [ "object", "null" ], "properties": { "percent": { "type": "number" }, "quantity": { "type": "integer" } }, "required": [ "percent", "quantity" ] }, "2m": { "type": [ "object", "null" ], "properties": { "percent": { "type": "number" }, "quantity": { "type": "integer" } }, "required": [ "percent", "quantity" ] }, "3m": { "type": [ "object", "null" ], "properties": { "percent": { "type": "number" }, "quantity": { "type": "integer" } }, "required": [ "percent", "quantity" ] }, "6m": { "type": [ "object", "null" ], "properties": { "percent": { "type": "number" }, "quantity": { "type": "integer" } }, "required": [ "percent", "quantity" ] }, "12m": { "type": [ "object", "null" ], "properties": { "percent": { "type": "number" }, "quantity": { "type": "integer" } }, "required": [ "percent", "quantity" ] }, "18m": { "type": [ "object", "null" ], "properties": { "percent": { "type": "number" }, "quantity": { "type": "integer" } }, "required": [ "percent", "quantity" ] }, "24m": { "type": [ "object", "null" ], "properties": { "percent": { "type": "number" }, "quantity": { "type": "integer" } }, "required": [ "percent", "quantity" ] }, "36m": { "type": [ "object", "null" ], "properties": { "percent": { "type": "number" }, "quantity": { "type": "integer" } }, "required": [ "percent", "quantity" ] } } } }, "required": [ "latest_snapshot_date", "snapshots", "growth" ] }, "revenue_usd_lower_bound": { "type": [ "string", "null" ] }, "revenue_usd_upper_bound": { "type": [ "string", "null" ] } }, "required": [ "slug" ], "description": "The enriched company data. A 404 status is returned if the company was not found." }, "isCached404": { "type": [ "boolean", "null" ], "description": "True when the company is not found on LinkedIn but we have cached data in our database." } }, "required": [ "company" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # companyLogo `POST /v1/company-logos/single` **Tags:** `Company info` Company logo **Endpoint:** `https://api.fiber.ai/v1/company-logos/single` ## Description Get the logo for a single company. Accepts a LinkedIn company URL, slug, numeric organization ID, or domain — the format is auto-detected. ⚡ Rate limit: 600 requests per 1 minute 💰 Cost: 0.33 credits per company logo lookup ⓘ ⏱ Recommended timeout: 1 minute ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "identifier": { "type": "string", "minLength": 1, "description": "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." } }, "required": [ "apiKey", "identifier" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "logoUrl": { "type": [ "string", "null" ], "format": "uri", "description": "A stable URL for the company's logo image. Null when no logo is available for the company." } } }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # companyPostsLiveFetch `POST /v1/linkedin-live-fetch/company-posts` **Tags:** `LinkedIn activity` Fetch LinkedIn company posts **Endpoint:** `https://api.fiber.ai/v1/linkedin-live-fetch/company-posts` ## Description Fetches recent posts from a LinkedIn company page. Returns a paginated feed of company posts. Each page contains up to 50 posts. ⚡ Rate limit: 300 requests per 1 minute 💰 Cost: 2 credits per page of results ⓘ ⏱ Recommended timeout: 1 minute ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "identifier": { "type": "string", "description": "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')" }, "cursor": { "type": [ "string", "null" ], "description": "Pagination cursor for fetching additional pages of posts" } }, "required": [ "apiKey", "identifier" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "postId": { "type": "string" }, "author": { "type": [ "object", "null" ], "properties": { "linkedinUrl": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "profilePicture": { "type": [ "string", "null" ] }, "linkedinSlug": { "type": [ "string", "null" ] } } }, "postedAt": { "type": [ "object", "null" ], "properties": { "noLaterThan": { "type": [ "string", "null" ] }, "noEarlierThan": { "type": [ "string", "null" ] } } }, "engagement": { "type": [ "object", "null" ], "properties": { "numComments": { "type": [ "number", "null" ] }, "numShares": { "type": [ "number", "null" ] }, "numReactions": { "type": [ "number", "null" ] }, "reactionsByType": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "numReactions": { "type": [ "number", "null" ] }, "reactionType": { "type": [ "string", "null" ], "enum": [ "LIKE", "LOVE", "INSIGHTFUL", "CELEBRATE", "SUPPORT", "FUNNY", null ], "description": "One of LinkedIn's reaction types. These match the tooltips on each of LinkedIn's six reaction buttons; for instance, 'Like' is the blue thumbs-up." } } } } } }, "imageUrls": { "type": [ "array", "null" ], "items": { "type": "string" } }, "postUrl": { "type": [ "string", "null" ] }, "video": { "type": [ "object", "null" ], "properties": { "videoUrl": { "type": [ "string", "null" ] }, "thumbnailUrl": { "type": [ "string", "null" ] } } }, "caption": { "type": [ "string", "null" ] }, "subText": { "type": [ "string", "null" ] }, "resharedPost": { "type": [ "object", "null" ], "properties": { "postId": { "type": "string" }, "author": { "type": [ "object", "null" ], "properties": { "linkedinUrl": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "profilePicture": { "type": [ "string", "null" ] }, "linkedinSlug": { "type": [ "string", "null" ] } } }, "postedAt": { "type": [ "object", "null" ], "properties": { "noLaterThan": { "type": [ "string", "null" ] }, "noEarlierThan": { "type": [ "string", "null" ] } } }, "engagement": { "type": [ "object", "null" ], "properties": { "numComments": { "type": [ "number", "null" ] }, "numShares": { "type": [ "number", "null" ] }, "numReactions": { "type": [ "number", "null" ] }, "reactionsByType": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "numReactions": { "type": [ "number", "null" ] }, "reactionType": { "type": [ "string", "null" ], "enum": [ "LIKE", "LOVE", "INSIGHTFUL", "CELEBRATE", "SUPPORT", "FUNNY", null ], "description": "One of LinkedIn's reaction types. These match the tooltips on each of LinkedIn's six reaction buttons; for instance, 'Like' is the blue thumbs-up." } } } } } }, "imageUrls": { "type": [ "array", "null" ], "items": { "type": "string" } }, "postUrl": { "type": [ "string", "null" ] }, "video": { "type": [ "object", "null" ], "properties": { "videoUrl": { "type": [ "string", "null" ] }, "thumbnailUrl": { "type": [ "string", "null" ] } } }, "caption": { "type": [ "string", "null" ] }, "subText": { "type": [ "string", "null" ] } }, "required": [ "postId" ] } }, "required": [ "postId" ] } }, "cursor": { "type": [ "string", "null" ] } }, "required": [ "data" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # companySearch `POST /v1/company-search` **Tags:** `Search` Company search **Endpoint:** `https://api.fiber.ai/v1/company-search` ## Description Search for companies using filters ⚡ Rate limit: 180 requests per 1 minute 💰 Cost: 1 credit per company found, plus 1 credit when includeCount=true ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "searchParams": { "type": "object", "properties": { "exactCompanyV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "domain": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$" } }, "required": [ "identifier", "domain" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/(www\\.)?linkedin\\.com\\/company\\/[a-zA-Z0-9-]+\\/?.*$" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-org-id" ] }, "org_id": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "identifier", "org_id" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "advanced" ] }, "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string", "minLength": 1 }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "identifier", "li_org_id" ] } ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "domain": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$" } }, "required": [ "identifier", "domain" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/(www\\.)?linkedin\\.com\\/company\\/[a-zA-Z0-9-]+\\/?.*$" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-org-id" ] }, "org_id": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "identifier", "org_id" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "advanced" ] }, "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string", "minLength": 1 }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "identifier", "li_org_id" ] } ] } } } }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "headquartersCountryCode": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } } } }, "headquartersStateName": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string" } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "employeeCountV2": { "type": [ "object", "null" ], "properties": { "lowerBoundExclusive": { "type": [ "integer", "null" ], "minimum": 0 }, "upperBoundInclusive": { "type": [ "integer", "null" ], "minimum": 0 } } }, "keywords": { "type": [ "object", "null" ], "properties": { "containsAll": { "type": [ "array", "null" ], "items": { "type": "string" } }, "containsAny": { "type": [ "array", "null" ], "items": { "type": "string" } }, "containsNone": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "industriesV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "allOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } } } }, "stage": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "acquired", "public", "closed", "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "series_i", "series_j", "venture_other", "private_equity", "unknown", "no_funding_yet" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "acquired", "public", "closed", "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "series_i", "series_j", "venture_other", "private_equity", "unknown", "no_funding_yet" ] } } } }, "totalFundingUSD": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "lastFundingUSD": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "lastFundedOn": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ] }, "foundedOn": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ] }, "nameLike": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string" } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "exactCompany": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string" }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "li_org_id" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string" }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "li_org_id" ] } } } }, "acceleratorsV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "acceleratorName": { "type": "string", "enum": [ "a16z_speedrun", "accel_atoms", "ai2_incubator", "alchemist_accelerator", "alliance", "antler", "berkeley_skydeck", "founders_inc", "google_startups", "launch_accelerator", "neo", "pear_x", "plug_and_play", "sosv", "south_park_commons", "startx", "techstars", "the_mint", "ycombinator" ] }, "batchSelection": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "all-batches" ] } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "only-these-batches" ] }, "batches": { "type": "array", "items": { "type": "string" }, "minItems": 0 } }, "required": [ "strategy", "batches" ] }, { "type": "null" } ] }, "years": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } } }, "required": [ "acceleratorName" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "acceleratorName": { "type": "string", "enum": [ "a16z_speedrun", "accel_atoms", "ai2_incubator", "alchemist_accelerator", "alliance", "antler", "berkeley_skydeck", "founders_inc", "google_startups", "launch_accelerator", "neo", "pear_x", "plug_and_play", "sosv", "south_park_commons", "startx", "techstars", "the_mint", "ycombinator" ] }, "batchSelection": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "all-batches" ] } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "only-these-batches" ] }, "batches": { "type": "array", "items": { "type": "string" }, "minItems": 0 } }, "required": [ "strategy", "batches" ] }, { "type": "null" } ] }, "years": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } } }, "required": [ "acceleratorName" ] } } } }, "headquartersLocation": { "type": [ "object", "null" ], "properties": { "unionAll": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "radial-distance" ] }, "center": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] }, "latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "longitude": { "type": "number", "minimum": -180, "maximum": 180 } }, "required": [ "latitude", "longitude" ] }, "radius": { "oneOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "miles" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 12500 } }, "required": [ "unit", "quantity" ] }, { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "kilometers" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 20100 } }, "required": [ "unit", "quantity" ] } ] } }, "required": [ "strategy", "center", "radius" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "free-form-city" ] }, "city": { "type": "string", "minLength": 1 }, "countryCode": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 3 }, "radius": { "oneOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "miles" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 12500 } }, "required": [ "unit", "quantity" ] }, { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "kilometers" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 20100 } }, "required": [ "unit", "quantity" ] } ] } }, "required": [ "strategy", "city", "radius" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "polygon" ] }, "vertices": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "longitude": { "type": "number", "minimum": -180, "maximum": 180 } }, "required": [ "latitude", "longitude" ] }, "minItems": 4, "maxItems": 1000 } }, "required": [ "strategy", "vertices" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "preset-region" ] }, "region": { "type": "string", "enum": [ "sf-bay-area", "sf-north-bay", … _truncated to 65536 chars for ai-docs._ ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "linkedin_id": { "type": [ "string", "null" ] }, "accelerator_statuses": { "type": [ "array", "null" ], "items": { "type": "string" } }, "accelerators": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "slug": { "type": [ "string", "null" ] }, "tags": { "type": [ "array", "null" ], "items": { "type": "string" } }, "year": { "type": [ "number", "null" ] }, "batch": { "type": [ "string", "null" ] }, "founders": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "full_name": { "type": [ "string", "null" ] }, "bio": { "type": [ "string", "null" ] }, "job_title": { "type": [ "string", "null" ] }, "is_active": { "type": [ "boolean", "null" ] }, "email_address": { "type": [ "string", "null" ] }, "facebook_url": { "type": [ "string", "null" ] }, "twitter_handle": { "type": [ "string", "null" ] }, "linkedin_slug": { "type": [ "string", "null" ] }, "github_username": { "type": [ "string", "null" ] } } } }, "description": { "type": [ "string", "null" ] }, "one_liner": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "company_domain": { "type": [ "string", "null" ] }, "accelerator_name": { "type": [ "string", "null" ] }, "accelerator_domain": { "type": [ "string", "null" ] } } } }, "blog_urls": { "type": [ "array", "null" ], "items": { "type": "string" } }, "custom_data": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "emails": { "type": [ "array", "null" ], "items": { "type": "string" } }, "phone_numbers": { "type": [ "array", "null" ], "items": { "type": "string" } }, "employee_count_consensus": { "type": [ "object", "null" ], "properties": { "gte": { "type": [ "number", "null" ] }, "lte": { "type": [ "number", "null" ] } } }, "facebook_urls": { "type": [ "array", "null" ], "items": { "type": "string" } }, "fortune_rankings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "list": { "type": "string", "enum": [ "fortune-500-usa", "forbes-global-2000" ] }, "year": { "type": "number" }, "rank": { "type": "number" } }, "required": [ "list", "year", "rank" ] } }, "founded_on_consensus": { "type": [ "string", "null" ] }, "github_usernames": { "type": [ "array", "null" ], "items": { "type": "string" } }, "instagram_handles": { "type": [ "array", "null" ], "items": { "type": "string" } }, "latest_funding_consensus": { "type": [ "number", "null" ] }, "linkedin_slugs": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "li_org_id": { "type": [ "string", "null" ] }, "li_category": { "type": [ "string", "null" ], "enum": [ "W", "S", "C", null ] }, "li_job_posts_stats": { "type": [ "object", "null" ], "properties": { "total_count": { "type": "number" }, "seniority_stats": { "type": [ "object", "null" ], "properties": { "Entry level": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Director": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Associate": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Mid-Senior level": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Internship": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Executive": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Not Applicable": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] } }, "additionalProperties": false }, "employment_type_stats": { "type": [ "object", "null" ], "properties": { "Full-time": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Temporary": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Internship": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Contract": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Part-time": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Volunteer": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Other": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] } }, "additionalProperties": false }, "country_location_stats": { "type": [ "object", "null" ], "properties": { "USA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GBR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "FRA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IND": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BRA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "DEU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ESP": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CAN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "AUS": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NLD": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ITA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ZAF": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BEL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CHN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "TUR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MEX": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CHE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NOR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ARE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SWE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "POL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IDN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ARG": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PRT": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "COL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CHL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PAK": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "DNK": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "JPN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NGA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SGP": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PER": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NZL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "AUT": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IRL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MYS": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BGD": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "EGY": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ISR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SAU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PHL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "FIN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IRN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ROU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CZE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GRC": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "HKG": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "HUN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "KEN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MAR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "VNM": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "RUS": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "UKR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ECU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "THA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LKA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "KOR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BGR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GHA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SRB": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "TWN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "HRV": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LTU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PRI": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SVK": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "TUN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "EST": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "VEN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CRI": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PAN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "URY": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LBN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LUX": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CYP": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NPL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "JOR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SVN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MTQ": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "QAT": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GLP": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "UGA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "DZA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GTM": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CMR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LVA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "DOM": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "AZE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GEO": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SEN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "TZA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ZWE": { "type": "object", "properties": { "count": { "type": "number" }, "fractio … _truncated to 65536 chars for ai-docs._ ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # companyTypeahead `POST /v1/typeahead/company` **Tags:** `Typeaheads` Company/School/Investor Typeahead **Endpoint:** `https://api.fiber.ai/v1/typeahead/company` ## Description Search for companies, schools/universities, and investors by name. Supports partial inputs, which can enable typeaheads in your UI. ⚡ Rate limit: 240 requests per 1 minute 💰 Cost: 1 credit per request ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "startsWith": { "type": "string", "minLength": 1 }, "orgType": { "type": [ "string", "null" ], "enum": [ "investor", "school", null ], "description": "The organization type filter. Use 'investor', 'school', or omit for all types." } }, "required": [ "apiKey", "startsWith" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "array", "items": { "type": "object", "properties": { "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "li_org_id": { "type": [ "string", "null" ] } } } }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # createAudience `POST /v1/audiences/create` **Tags:** `Audiences` Create a new audience **Endpoint:** `https://api.fiber.ai/v1/audiences/create` ## Description 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. ⚡ Rate limit: 30 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "name": { "type": "string", "minLength": 1, "maxLength": 200, "description": "The name of the audience (e.g. 'Fintech VPs in NYC')." }, "creationMethod": { "type": [ "string", "null" ], "enum": [ "NORMAL", "START_FROM_PROSPECTS", null ], "default": "NORMAL", "description": "How the audience will be created. NORMAL: search companies then prospects. START_FROM_PROSPECTS: search prospects only." } }, "required": [ "apiKey", "name" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "audienceId": { "type": "string", "description": "The unique ID of the created audience." }, "name": { "type": "string", "description": "The name of the audience." }, "status": { "type": "string", "enum": [ "NORMAL", "HEALING_COMPANIES", "DRAFT", "BUILDING", "SAVING_COMPANIES", "SAVING_PROSPECTS", "LINKING_PROSPECTS_WITH_COMPANIES", "FAILED" ], "description": "The current status of the audience." }, "createdAt": { "type": "string", "description": "The timestamp when the audience was created." } }, "required": [ "audienceId", "name", "status", "createdAt" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # createCompanyExclusionList `POST /v1/exclusions/companies/create-list` **Tags:** `Exclusions` Create company exclusion list **Endpoint:** `https://api.fiber.ai/v1/exclusions/companies/create-list` ## Description Create a company exclusion list ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "name": { "type": "string", "minLength": 1, "description": "The name of the company exclusion list." }, "isOrganizationWide": { "type": "boolean", "default": false, "description": "Whether the company exclusion list is organization-wide." } }, "required": [ "apiKey", "name" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "listId": { "type": "string", "description": "The ID of the company exclusion list." }, "name": { "type": "string", "description": "The name of the company exclusion list." } }, "required": [ "listId", "name" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # createCompanyExclusionListFromAudience `POST /v1/exclusions/companies/audience/create-list` **Tags:** `Exclusions` Create company exclusion list from audience **Endpoint:** `https://api.fiber.ai/v1/exclusions/companies/audience/create-list` ## Description This endpoint creates a new company exclusion list by extracting all companies from a specified audience. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "audienceId": { "type": "string", "minLength": 1, "description": "The ID of the audience to create the exclusion list from." }, "name": { "type": [ "string", "null" ], "description": "The name of the company exclusion list. Defaults to 'Exclusion list from {audienceName}' if not provided." }, "isOrganizationWide": { "type": "boolean", "default": false, "description": "Whether the company exclusion list is organization-wide." } }, "required": [ "apiKey", "audienceId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "listId": { "type": "string", "description": "The ID of the company exclusion list." }, "name": { "type": "string", "description": "The name of the company exclusion list." }, "companiesAdded": { "type": "number", "description": "The number of companies added to the exclusion list." } }, "required": [ "listId", "name", "companiesAdded" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # createJobChangeList `POST /v1/job-changes/create-list` **Tags:** `Job changes` Create job change list **Endpoint:** `https://api.fiber.ai/v1/job-changes/create-list` ## Description Create a new job changes list to monitor when tracked prospects change jobs. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "name": { "type": "string", "description": "The name of the job change list." } }, "required": [ "apiKey", "name" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the job change list." }, "name": { "type": "string", "description": "The name of the job change list." }, "status": { "type": "string", "enum": [ "NORMAL", "DRAFT", "BUILDING", "ERROR" ], "description": "Status of the job changes list. 'NORMAL' = list has profiles and is ready to use. 'DRAFT' = list is empty, no profiles added yet. 'BUILDING' = profiles are currently being added to the list. 'ERROR' = an error occurred while processing the list; contact support." }, "isActive": { "type": "boolean", "description": "Whether the list is active. Defaults to inactive." } }, "required": [ "id", "name", "status", "isActive" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # createProspectExclusionList `POST /v1/exclusions/prospects/create-list` **Tags:** `Exclusions` Create prospect exclusion list **Endpoint:** `https://api.fiber.ai/v1/exclusions/prospects/create-list` ## Description Create a prospect exclusion list ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "name": { "type": "string", "minLength": 1, "description": "The name of the prospect exclusion list." }, "isOrganizationWide": { "type": "boolean", "default": false, "description": "Whether the prospect exclusion list is organization-wide." } }, "required": [ "apiKey", "name" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "listId": { "type": "string", "description": "The ID of the prospect exclusion list." }, "name": { "type": "string", "description": "The name of the prospect exclusion list." } }, "required": [ "listId", "name" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # createProspectExclusionListFromAudience `POST /v1/exclusions/prospects/audience/create-list` **Tags:** `Exclusions` Create prospect exclusion list from audience **Endpoint:** `https://api.fiber.ai/v1/exclusions/prospects/audience/create-list` ## Description Create a prospect exclusion list from an audience's prospects ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "audienceId": { "type": "string", "minLength": 1, "description": "The ID of the audience to create the exclusion list from." }, "name": { "type": [ "string", "null" ], "description": "The name of the prospect exclusion list. Defaults to 'Exclusion list from {audienceName}' if not provided." }, "isOrganizationWide": { "type": "boolean", "default": false, "description": "Whether the prospect exclusion list is organization-wide." } }, "required": [ "apiKey", "audienceId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "listId": { "type": "string", "description": "The ID of the prospect exclusion list." }, "name": { "type": "string", "description": "The name of the prospect exclusion list." }, "prospectsAdded": { "type": "number", "description": "The number of prospects added to the exclusion list." } }, "required": [ "listId", "name", "prospectsAdded" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # createSandboxApiKey `POST /v1/api-keys/create-sandbox` **Tags:** `API key` Create sandbox API key **Endpoint:** `https://api.fiber.ai/v1/api-keys/create-sandbox` ## Description 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. ⚡ Rate limit: 30 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "name": { "type": "string", "minLength": 1, "maxLength": 100, "description": "Human-readable label to identify this key later (e.g. 'CI runner', 'local dev')." } }, "required": [ "apiKey", "name" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "id": { "type": "string", "description": "id of your api key. This or prefix can be used to identify the key." }, "name": { "type": "string", "description": "Name of your api key." }, "prefix": { "type": "string", "description": "Non secret prefix of your api key. Used for identification." }, "expiresAt": { "type": [ "string", "null" ], "format": "date-time", "description": "When the key expires. Null implies key never expires." }, "maxCredits": { "type": [ "number", "null" ], "minimum": 0, "description": "The lifetime credit ceiling for this key. Null implies key has no per-key credit limit." }, "creditsUsed": { "type": "number", "minimum": 0, "description": "Credits consumed by this key so far over its lifetime." }, "createdAt": { "type": "string", "format": "date-time", "description": "When the key was created, as an ISO 8601 timestamp." }, "isRevoked": { "type": "boolean", "description": "Whether the key has been revoked. Revoked keys can no longer authenticate. Only ever true in listings that include revoked keys." }, "apiKey": { "type": "string", "description": "The plaintext sandbox API key (starts with sk_test_). Shown once — store it securely, it cannot be retrieved later." } }, "required": [ "id", "name", "prefix", "expiresAt", "maxCredits", "creditsUsed", "createdAt", "isRevoked", "apiKey" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # createSavedSearch `POST /v1/saved-search/create` **Tags:** `Saved search` Create saved search **Endpoint:** `https://api.fiber.ai/v1/saved-search/create` ## Description 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. ⚡ Rate limit: 10 requests per 1 minute 💰 Cost: 2 credits per prospect/company found in search ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "name": { "type": "string", "description": "The name of the saved search." }, "searchParams": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "description": "The search type: combined companies and profiles.", "enum": [ "combined" ] }, "companySearchParams": { "type": "object", "properties": { "exactCompanyV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "domain": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$" } }, "required": [ "identifier", "domain" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/(www\\.)?linkedin\\.com\\/company\\/[a-zA-Z0-9-]+\\/?.*$" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-org-id" ] }, "org_id": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "identifier", "org_id" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "advanced" ] }, "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string", "minLength": 1 }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "identifier", "li_org_id" ] } ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "domain": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$" } }, "required": [ "identifier", "domain" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/(www\\.)?linkedin\\.com\\/company\\/[a-zA-Z0-9-]+\\/?.*$" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-org-id" ] }, "org_id": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "identifier", "org_id" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "advanced" ] }, "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string", "minLength": 1 }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "identifier", "li_org_id" ] } ] } } } }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "headquartersCountryCode": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } } } }, "headquartersStateName": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string" } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "employeeCountV2": { "type": [ "object", "null" ], "properties": { "lowerBoundExclusive": { "type": [ "integer", "null" ], "minimum": 0 }, "upperBoundInclusive": { "type": [ "integer", "null" ], "minimum": 0 } } }, "keywords": { "type": [ "object", "null" ], "properties": { "containsAll": { "type": [ "array", "null" ], "items": { "type": "string" } }, "containsAny": { "type": [ "array", "null" ], "items": { "type": "string" } }, "containsNone": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "industriesV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "allOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } } } }, "stage": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "acquired", "public", "closed", "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "series_i", "series_j", "venture_other", "private_equity", "unknown", "no_funding_yet" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "acquired", "public", "closed", "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "series_i", "series_j", "venture_other", "private_equity", "unknown", "no_funding_yet" ] } } } }, "totalFundingUSD": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "lastFundingUSD": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "lastFundedOn": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ] }, "foundedOn": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ] }, "nameLike": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string" } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "exactCompany": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string" }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "li_org_id" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string" }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "li_org_id" ] } } } … _truncated to 65536 chars for ai-docs._ ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the saved search." } }, "required": [ "id" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # createTrackerCompanyList `POST /v1/tracker/company-lists` **Tags:** `Tracker` Create company tracker list **Endpoint:** `https://api.fiber.ai/v1/tracker/company-lists` ## Description 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 (see your plan's pricing for exact rates). Creating the list itself is free. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "name": { "type": "string", "minLength": 1, "maxLength": 200, "description": "Human-readable name for the tracker list." }, "refreshIntervalDays": { "type": "integer", "minimum": 1, "maximum": 90, "description": "How often to check tracked companies for changes, in days." }, "trackingRules": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "headcount_crossed_threshold" }, "entityType": { "type": "string", "const": "company" }, "direction": { "type": "string", "enum": [ "above", "below" ], "description": "Whether to alert when headcount crosses the threshold going up or down" }, "threshold": { "type": "integer", "exclusiveMinimum": 0, "description": "The employee count threshold to watch for crossing. Any positive integer is accepted." } }, "required": [ "type", "entityType", "direction", "threshold" ], "title": "Headcount crossed threshold" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "headcount_growth_percent" }, "entityType": { "type": "string", "const": "company" }, "minPercentChange": { "type": "number", "exclusiveMinimum": 0, "maximum": 1000, "description": "Minimum percent change to trigger (e.g. 20 means 20% growth)" }, "direction": { "type": "string", "enum": [ "grew", "shrank", "either" ], "description": "Whether to alert on growth, shrinkage, or either" }, "minStartingHeadcount": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Only alert if the company had at least this many employees before the change. Omit for any starting size." } }, "required": [ "type", "entityType", "minPercentChange", "direction" ], "title": "Headcount growth percent" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "new_funding_round" }, "entityType": { "type": "string", "const": "company" }, "minAmountUsd": { "type": [ "number", "null" ], "minimum": 0, "description": "Only alert for rounds above this amount. Omit for any amount." }, "roundTypes": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "pre_seed", "seed", "angel", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "private_equity", "debt_financing", "grant", "convertible_note", "corporate_round", "undisclosed" ] }, "minItems": 1, "description": "Round types to alert on. Defaults to equity-focused types when omitted. Set explicitly to include debt/grant types." } }, "required": [ "type", "entityType" ], "title": "New funding round" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "funding_stage_changed" }, "entityType": { "type": "string", "const": "company" }, "toStages": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "private_equity", "public", "acquired" ] }, "minItems": 1, "description": "Only alert if new stage is one of these. Omit for any stage change." } }, "required": [ "type", "entityType" ], "title": "Funding stage changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "job_posting_with_keyword" }, "entityType": { "type": "string", "const": "company" }, "keywords": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Alert when a job posting title contains any of these keywords" }, "seniorityLevels": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Internship", "Entry level", "Associate", "Mid-Senior level", "Director", "Executive" ] }, "minItems": 1, "description": "Only alert for these seniority levels. Omit for any level." }, "modalities": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "On-site", "Remote", "Hybrid" ] }, "minItems": 1, "description": "Only alert for these job modalities. Omit for any." }, "locationTypes": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "remote", "on_site", "hybrid" ] }, "minItems": 1, "description": "Deprecated. Use modalities instead.", "deprecated": true }, "minPostings": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Only alert if at least this many NEW matching postings are detected in a single check cycle. Omit for 1 (any new match)." } }, "required": [ "type", "entityType", "keywords" ], "title": "Job posting with keyword" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "job_posting_in_function" }, "entityType": { "type": "string", "const": "company" }, "jobFunctions": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Accounting", "Administrative", "Advertising", "Analyst", "Art / Creative", "Business Development", "Community & Social Services", "Consulting", "Customer Service", "Design", "Distribution", "Education", "Engineering", "Entrepreneurship", "Finance", "General Business", "Health Care Provider", "Human Resources", "Information Technology", "Legal", "Management", "Manufacturing", "Marketing", "Military & Protective Services", "Other", "Product Management", "Production", "Program & Product Management", "Project Management", "Public Relations", "Purchasing", "Quality Assurance", "Real Estate", "Research", "Sales", "Science", "Strategy / Planning", "Supply Chain", "Training", "Writing / Editing" ] }, "description": "Alert when a job posting is in any of these departments/functions." }, "minPostings": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Only alert if at least this many NEW matching postings are detected in a single check cycle. Omit for 1 (any new match)." } }, "required": [ "type", "entityType", "jobFunctions" ], "title": "Job posting in function" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "news_with_keyword" }, "entityType": { "type": "string", "const": "company" }, "keywords": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Alert when a news article title or summary matches any keyword" }, "sentiment": { "type": [ "string", "null" ], "enum": [ "positive", "negative", "neutral", null ], "description": "Only alert for news with this sentiment. Omit for any sentiment." } }, "required": [ "type", "entityType", "keywords" ], "title": "News with keyword" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_news" }, "entityType": { "type": "string", "const": "company" }, "sentiment": { "type": [ "string", "null" ], "enum": [ "positive", "negative", "neutral", null ], "description": "Only alert for news with this sentiment. Omit for any sentiment." }, "minArticles": { "type": [ "integer", "null" ], "minimum": 1, "description": "Only alert when at least this many articles are detected in a single check. Useful for filtering noise from single tangential mentions. Omit for any count." } }, "required": [ "type", "entityType" ], "title": "Company news" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "hq_location_changed" }, "entityType": { "type": "string", "const": "company" } }, "required": [ "type", "entityType" ], "title": "HQ location changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_status_changed" }, "entityType": { "type": "string", "const": "company" }, "toStatuses": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "operating", "acquired", "closed", "ipo", "subsidiary" ] }, "minItems": 1, "description": "Only alert if new status is one of these. Omit for any status change." } }, "required": [ "type", "entityType" ], "title": "Company status changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "technology_added" }, "entityType": { "type": "string", "const": "company" }, "technologies": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert for these technologies. Omit for any new technology." } }, "required": [ "type", "entityType" ], "title": "Technology added" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_posted" }, "entityType": { "type": "string", "const": "company" }, "minReactions": { "type": [ "integer", "null" ], "minimum": 0, "description": "Only alert for posts with at least this many reactions. Omit for any." } }, "required": [ "type", "entityType" ], "title": "Company posted" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_posted_with_keyword" }, "entityType": { "type": "string", "const": "company" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Alert for posts matching these keywords." }, "minReactions": { "type": [ "integer", "null" ], "minimum": 0, "description": "Only alert for posts with at least this many reactions. Omit for any." } }, "required": [ "type", "entityType" ], "title": "Company posted with keyword" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "follower_count_growth" }, "entityType": { "type": "string", "const": "company" }, "minAbsoluteGrowth": { "type": [ "integer", "null" ], "minimum": 0, "description": "Minimum absolute follower increase to trigger. Omit or set to 0 for any increase." }, "minPercentGrowth": { "type": [ "number", "null" ], "exclusiveMinimum": 0, "description": "Minimum percent follower increase to trigger. Omit for any increase." }, "minStartingFollowerCount": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Only alert if the company had at least this many followers before the growth. Omit for any starting count." } }, "required": [ "type", "entityType" ], "title": "Follower count growth" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_name_changed" }, "entityType": { "type": "string", "const": "company" } }, "required": [ "type", "entityType" ], "title": "Company name changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_description_changed" }, "entityType": { "type": "string", "const": "company" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if new description contains one of these keywords. Omit for any change." } }, "required": [ "type", "entityType" ], "title": "Company description changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_went_inactive" }, "entityType": { "type": "string", "const": "company" } }, "required": [ "type", "entityType" ], "description": "Fires when a company becomes inactive.", "title": "Company went inactive" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "employee_count_milestone" }, "entityType": { "type": "string", "const": "company" }, "milestone": { "type": "integer", "exclusiveMinimum": 0, "description": "The employee count threshold to watch for crossing. Any positive integer is accepted. Equivalent to 'threshold' in headcount_crossed_threshold." }, "direction": { "type": "string", "enum": [ "above", "below" ], "description": "Whether to alert when crossing above or below the milestone" } }, "required": [ "type", "entityType", "milestone", "direction" ], "description": "Fires when the employee count crosses the specified value. Supports any positive integer, not just round milestones. Functionally equivalent to headcount_crossed_threshold.", "title": "Employee count milestone" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "new_office_location" }, "entityType": { "type": "string", "const": "company" }, "countries": { "type": [ "array", "null" ], "items": { "type": "string", "pattern": "^[A-Z]{3}$", "minLength": 3, "maxLength": 3 }, "minItems": 1, "description": "ISO 3166-1 alpha-3 country codes (e.g. 'USA', 'GBR', 'DEU'). Only alert for offices in these countries. Omit for any new office." }, "cities": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "City names (e.g. 'San Francisco', 'London', 'Berlin'). Only alert for offices in these cities. Omit for any new office." }, "regions": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Region codes (e.g. 'X-EMEA', 'X-APAC', 'X-EUROPE'). Expands to constituent country codes. Omit for any." }, "states": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "State or province names (e.g. 'California', 'Ontario'). Omit for any." } }, "required": [ "type", "entityType" ], "title": "New office location" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_logo_changed" }, "entityType": { "type": "string", "const": "company" } }, "required": [ "type", "entityType" ], "title": "Company logo changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "acquired_company" }, "entityType": { "type": "string", "const": "company" }, "minPriceUsd": { "type": [ "number", "null" ], "minimum": 0, "description": "Only alert for acquisitions above this price. Omit for any acquisition." } }, "required": [ "type", "entityType" ], "title": "Acquired company" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "new_investor" }, "entityType": { "type": "string", "const": "company" }, "investorNames": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert when a new investor's name matches one of these (exact, case-insensitive). Omit for any new investor." } }, "required": [ "type", "entityType" ], "title": "New investor" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "recently_hired_with_title" }, "entityType": { "type": "string", "const": "company" }, "titleKeywords": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Title keywords to search for. Fires when the company hires someone whose title matches any keyword." }, "minNewHires": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Minimum number of NEW hires detected in a single check cycle to trigger the alert. Only counts employees who appeared since the last check. Omit for 1." } }, "required": [ "type", "entityType", "titleKeywords" ], "title": "Recently hired with title" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "department_size_threshold" }, "entityType": { "type": "string", "const": "company" }, "department": { "type": "string", "enum": [ "Accounting", "Administrative", "Advertising", "Analyst", "Art / Creative", "Business Development", "Community & Social Services", "Consulting", "Customer Service", "Design", "Distribution", "Education", "Engineering", "Entrepreneurship", "Finance", "General Business", "Health Care Provider", "Human Resources", "Information Technology", "Legal", "Management", "Manufacturing", "Marketing", "Military & Protective Services", "Other", "Product Management", "Production", "Program & Product Management", "Project Management", "Public Relations", "Purchasing", "Quality Assurance", "Real Estate", "Research", "Sales", "Science", "Strategy / Planning", "Supply Chain", "Training", "Writing / Editing" ], "description": "Department to track. Matched against the company's organizational structure." }, "threshold": { "type": "integer", "exclusiveMinimum": 0, "description": "The employee count threshold to watch for crossing" }, "direction": { "type": "string", "enum": [ "above", "below" ], "description": "Whether to alert when department size crosses above or below the threshold" } }, "required": [ "type", "entityType", "department", "threshold", "direction" ], "title": "Department size threshold" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "recent_layoffs" }, "entityType": { "type": "string", "const": "company" }, "minPeopleAffected": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Only alert if at least this many people were laid off. Omit for any layoff." }, "minPercentAffected": { "type": [ "number", "null" ], "exclusiveMinimum": 0, "maximum": 100, "description": "Only alert if at least this percentage of the workforce was laid off. Omit for any layoff." } }, "required": [ "type", "entityType" ], "title": "Recent layoffs" } ], "discriminator": { "propertyName": "type", "mapping": { "headcount_crossed_threshold": "#/components/schemas/HeadcountCrossedThreshold", "headcount_growth_percent": "#/components/schemas/HeadcountGrowthPercent", "new_funding_round": "#/components/schemas/NewFundingRound", "funding_stage_changed": "#/components/schemas/FundingStageChanged", "job_posting_with_keyword": "#/components/schemas/JobPostingWithKeyword", "job_posting_in_function": "#/components/schemas/JobPostingInFunction", "news_with_keyword": "#/components/schemas/NewsWithKeyword", "company_news": "#/components/schemas/CompanyNews", "hq_location_changed": "#/components/schemas/HqLocationChanged", "company_status_changed": "#/components/schemas/CompanyStatusChanged", "technology_added": "#/components/schemas/TechnologyAdded", "company_posted": "#/components/schemas/CompanyPosted", "company_posted_with_keyword": "#/components/schemas/CompanyPostedWithKeyword", "follower_count_growth": "#/components/schemas/FollowerCountGrowth", "company_name_changed": "#/components/schemas/CompanyNameChanged", "company_description_changed": "#/components/schemas/CompanyDescriptionChanged", "company_went_inactive": "#/components/schemas/CompanyWentInactive", "employee_count_milestone": "#/components/schemas/EmployeeCountMilestone", "new_office_location": "#/components/schemas/NewOfficeLocation", "company_logo_changed": "#/components/schemas/CompanyLogoChanged", "acquired_company": "#/components/schemas/AcquiredCompany", "new_investor": "#/components/schemas/NewInvestor", "recently_hired_with_title": "#/components/schemas/RecentlyHiredWithTitle", "department_size_threshold": "#/components/schemas/DepartmentSizeThreshold", "recent_layoffs": "#/components/schemas/RecentLayoffs" } } }, "minItems": 1, "maxItems": 25, "description": "Tracking rules to evaluate against this list's entities. Multiple rules can be active simultaneously." }, "companySearchParams": { "type": [ "object", "null" ], "properties": { "exactCompanyV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "domain": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$" } }, "required": [ "identifier", "domain" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/(www\\.)?linkedin\\.com\\/company\\/[a-zA-Z0-9-]+\\/?.*$" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-org-id" ] }, "org_id": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "identifier", "org_id" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "advanced" ] }, "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string", "minLength": 1 }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "identifier", "li_org_id" ] } ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "domain": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$" } }, "required": [ "identifier", "domain" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/(www\\.)?linkedin\\.com\\/company\\/[a-zA-Z0-9-]+\\/?.*$" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-org-id" ] }, "org_id": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "identifier", "org_id" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "advanced" ] }, "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string", "minLength": 1 }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "identifier", "li_org_id" ] } ] } } } }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "headquartersCountryCode": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", … _truncated to 65536 chars for ai-docs._ ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "id": { "type": "string", "description": "Tracker list ID." }, "name": { "type": "string", "description": "Name of the list." }, "refreshIntervalDays": { "type": "integer", "description": "Check interval in days." }, "trackingRules": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "headcount_crossed_threshold" }, "entityType": { "type": "string", "const": "company" }, "direction": { "type": "string", "enum": [ "above", "below" ], "description": "Whether to alert when headcount crosses the threshold going up or down" }, "threshold": { "type": "integer", "exclusiveMinimum": 0, "description": "The employee count threshold to watch for crossing. Any positive integer is accepted." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "direction", "threshold", "id" ], "title": "Headcount crossed threshold" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "headcount_growth_percent" }, "entityType": { "type": "string", "const": "company" }, "minPercentChange": { "type": "number", "exclusiveMinimum": 0, "maximum": 1000, "description": "Minimum percent change to trigger (e.g. 20 means 20% growth)" }, "direction": { "type": "string", "enum": [ "grew", "shrank", "either" ], "description": "Whether to alert on growth, shrinkage, or either" }, "minStartingHeadcount": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Only alert if the company had at least this many employees before the change. Omit for any starting size." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "minPercentChange", "direction", "id" ], "title": "Headcount growth percent" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "new_funding_round" }, "entityType": { "type": "string", "const": "company" }, "minAmountUsd": { "type": [ "number", "null" ], "minimum": 0, "description": "Only alert for rounds above this amount. Omit for any amount." }, "roundTypes": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "pre_seed", "seed", "angel", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "private_equity", "debt_financing", "grant", "convertible_note", "corporate_round", "undisclosed" ] }, "minItems": 1, "description": "Round types to alert on. Defaults to equity-focused types when omitted. Set explicitly to include debt/grant types." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "New funding round" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "funding_stage_changed" }, "entityType": { "type": "string", "const": "company" }, "toStages": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "private_equity", "public", "acquired" ] }, "minItems": 1, "description": "Only alert if new stage is one of these. Omit for any stage change." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Funding stage changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "job_posting_with_keyword" }, "entityType": { "type": "string", "const": "company" }, "keywords": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Alert when a job posting title contains any of these keywords" }, "seniorityLevels": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Internship", "Entry level", "Associate", "Mid-Senior level", "Director", "Executive" ] }, "minItems": 1, "description": "Only alert for these seniority levels. Omit for any level." }, "modalities": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "On-site", "Remote", "Hybrid" ] }, "minItems": 1, "description": "Only alert for these job modalities. Omit for any." }, "locationTypes": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "remote", "on_site", "hybrid" ] }, "minItems": 1, "description": "Deprecated. Use modalities instead.", "deprecated": true }, "minPostings": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Only alert if at least this many NEW matching postings are detected in a single check cycle. Omit for 1 (any new match)." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "keywords", "id" ], "title": "Job posting with keyword" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "job_posting_in_function" }, "entityType": { "type": "string", "const": "company" }, "jobFunctions": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Accounting", "Administrative", "Advertising", "Analyst", "Art / Creative", "Business Development", "Community & Social Services", "Consulting", "Customer Service", "Design", "Distribution", "Education", "Engineering", "Entrepreneurship", "Finance", "General Business", "Health Care Provider", "Human Resources", "Information Technology", "Legal", "Management", "Manufacturing", "Marketing", "Military & Protective Services", "Other", "Product Management", "Production", "Program & Product Management", "Project Management", "Public Relations", "Purchasing", "Quality Assurance", "Real Estate", "Research", "Sales", "Science", "Strategy / Planning", "Supply Chain", "Training", "Writing / Editing" ] }, "description": "Alert when a job posting is in any of these departments/functions." }, "minPostings": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Only alert if at least this many NEW matching postings are detected in a single check cycle. Omit for 1 (any new match)." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "jobFunctions", "id" ], "title": "Job posting in function" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "news_with_keyword" }, "entityType": { "type": "string", "const": "company" }, "keywords": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Alert when a news article title or summary matches any keyword" }, "sentiment": { "type": [ "string", "null" ], "enum": [ "positive", "negative", "neutral", null ], "description": "Only alert for news with this sentiment. Omit for any sentiment." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "keywords", "id" ], "title": "News with keyword" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_news" }, "entityType": { "type": "string", "const": "company" }, "sentiment": { "type": [ "string", "null" ], "enum": [ "positive", "negative", "neutral", null ], "description": "Only alert for news with this sentiment. Omit for any sentiment." }, "minArticles": { "type": [ "integer", "null" ], "minimum": 1, "description": "Only alert when at least this many articles are detected in a single check. Useful for filtering noise from single tangential mentions. Omit for any count." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Company news" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "hq_location_changed" }, "entityType": { "type": "string", "const": "company" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "HQ location changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_status_changed" }, "entityType": { "type": "string", "const": "company" }, "toStatuses": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "operating", "acquired", "closed", "ipo", "subsidiary" ] }, "minItems": 1, "description": "Only alert if new status is one of these. Omit for any status change." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Company status changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "technology_added" }, "entityType": { "type": "string", "const": "company" }, "technologies": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert for these technologies. Omit for any new technology." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Technology added" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_posted" }, "entityType": { "type": "string", "const": "company" }, "minReactions": { "type": [ "integer", "null" ], "minimum": 0, "description": "Only alert for posts with at least this many reactions. Omit for any." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Company posted" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_posted_with_keyword" }, "entityType": { "type": "string", "const": "company" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Alert for posts matching these keywords." }, "minReactions": { "type": [ "integer", "null" ], "minimum": 0, "description": "Only alert for posts with at least this many reactions. Omit for any." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Company posted with keyword" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "follower_count_growth" }, "entityType": { "type": "string", "const": "company" }, "minAbsoluteGrowth": { "type": [ "integer", "null" ], "minimum": 0, "description": "Minimum absolute follower increase to trigger. Omit or set to 0 for any increase." }, "minPercentGrowth": { "type": [ "number", "null" ], "exclusiveMinimum": 0, "description": "Minimum percent follower increase to trigger. Omit for any increase." }, "minStartingFollowerCount": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Only alert if the company had at least this many followers before the growth. Omit for any starting count." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Follower count growth" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_name_changed" }, "entityType": { "type": "string", "const": "company" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Company name changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_description_changed" }, "entityType": { "type": "string", "const": "company" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if new description contains one of these keywords. Omit for any change." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Company description changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_went_inactive" }, "entityType": { "type": "string", "const": "company" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "description": "Fires when a company becomes inactive.", "title": "Company went inactive" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "employee_count_milestone" }, "entityType": { "type": "string", "const": "company" }, "milestone": { "type": "integer", "exclusiveMinimum": 0, "description": "The employee count threshold to watch for crossing. Any positive integer is accepted. Equivalent to 'threshold' in headcount_crossed_threshold." }, "direction": { "type": "string", "enum": [ "above", "below" ], "description": "Whether to alert when crossing above or below the milestone" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "milestone", "direction", "id" ], "description": "Fires when the employee count crosses the specified value. Supports any positive integer, not just round milestones. Functionally equivalent to headcount_crossed_threshold.", "title": "Employee count milestone" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "new_office_location" }, "entityType": { "type": "string", "const": "company" }, "countries": { "type": [ "array", "null" ], "items": { "type": "string", "pattern": "^[A-Z]{3}$", "minLength": 3, "maxLength": 3 }, "minItems": 1, "description": "ISO 3166-1 alpha-3 country codes (e.g. 'USA', 'GBR', 'DEU'). Only alert for offices in these countries. Omit for any new office." }, "cities": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "City names (e.g. 'San Francisco', 'London', 'Berlin'). Only alert for offices in these cities. Omit for any new office." }, "regions": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Region codes (e.g. 'X-EMEA', 'X-APAC', 'X-EUROPE'). Expands to constituent country codes. Omit for any." }, "states": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "State or province names (e.g. 'California', 'Ontario'). Omit for any." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "New office location" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_logo_changed" }, "entityType": { "type": "string", "const": "company" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Company logo changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "acquired_company" }, "entityType": { "type": "string", "const": "company" }, "minPriceUsd": { "type": [ "number", "null" ], "minimum": 0, "description": "Only alert for acquisitions above this price. Omit for any acquisition." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Acquired company" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "new_investor" }, "entityType": { "type": "string", "const": "company" }, "investorNames": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert when a new investor's name matches one of these (exact, case-insensitive). Omit for any new investor." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "New investor" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "recently_hired_with_title" }, "entityType": { "type": "string", "const": "company" }, "titleKeywords": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Title keywords to search for. Fires when the company hires someone whose title matches any keyword." }, "minNewHires": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Minimum number of NEW hires detected in a single check cycle to trigger the alert. Only counts employees who appeared since the last check. Omit for 1." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "titleKeywords", "id" ], "title": "Recently hired with title" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "department_size_threshold" }, "entityType": { "type": "string", "const": "company" }, "department": { "type": "string", "enum": [ "Accounting", "Administrative", "Advertising", "Analyst", "Art / Creative", "Business Development", "Community & Social Services", "Consulting", "Customer Service", "Design", "Distribution", "Education", "Engineering", "Entrepreneurship", "Finance", "General Business", "Health Care Provider", "Human Resources", "Information Technology", "Legal", "Management", "Manufacturing", "Marketing", "Military & Protective Services", "Other", "Product Management", "Production", "Program & Product Management", "Project Management", "Public Relations", "Purchasing", "Quality Assurance", "Real Estate", "Research", "Sales", "Science", "Strategy / Planning", "Supply Chain", "Training", "Writing / Editing" ], "description": "Department to track. Matched against the company's organizational structure." }, "threshold": { "type": "integer", "exclusiveMinimum": 0, "description": "The employee count threshold to watch for crossing" }, "direction": { "type": "string", "enum": [ "above", "below" ], "description": "Whether to alert when department size crosses above or below the threshold" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "department", "threshold", "direction", "id" ], "title": "Department size threshold" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "recent_layoffs" }, "entityType": { "type": "string", "const": "company" }, "minPeopleAffected": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Only alert if at least this many people were laid off. Omit for any layoff." }, "minPercentAffected": { "type": [ "number", "null" ], "exclusiveMinimum": 0, "maximum": 100, "description": "Only alert if at least this percentage of the workforce was laid off. Omit for any layoff." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Recent layoffs" } ], "discriminator": { "propertyName": "type", "mapping": { "headcount_crossed_threshold": "#/components/schemas/HeadcountCrossedThresholdResponse", "headcount_growth_percent": "#/components/schemas/HeadcountGrowthPercentResponse", "new_funding_round": "#/components/schemas/NewFundingRoundResponse", "funding_stage_changed": "#/components/schemas/FundingStageChangedResponse", "job_posting_with_keyword": "#/components/schemas/JobPostingWithKeywordResponse", "job_posting_in_function": "#/components/schemas/JobPostingInFunctionResponse", "news_with_keyword": "#/components/schemas/NewsWithKeywordResponse", "company_news": "#/components/schemas/CompanyNewsResponse", "hq_location_changed": "#/components/schemas/HqLocationChangedResponse", "company_status_changed": "#/components/schemas/CompanyStatusChangedResponse", "technology_added": "#/components/schemas/TechnologyAddedResponse", "company_posted": "#/components/schemas/CompanyPostedResponse", "company_posted_with_keyword": "#/components/schemas/CompanyPostedWithKeywordResponse", "follower_count_growth": "#/components/schemas/FollowerCountGrowthResponse", "company_name_changed": "#/components/schemas/CompanyNameChangedResponse", "company_description_changed": "#/components/schemas/CompanyDescriptionChangedResponse", "company_went_inactive": "#/components/schemas/CompanyWentInactiveResponse", "employee_count_milestone": "#/components/schemas/EmployeeCountMilestoneResponse", "new_office_location": "#/components/schemas/NewOfficeLocationResponse", "company_logo_changed": "#/components/schemas/CompanyLogoChangedResponse", "acquired_company": "#/components/schemas/AcquiredCompanyResponse", "new_investor": "#/components/schemas/NewInvestorResponse", "recently_hired_with_title": "#/components/schemas/RecentlyHiredWithTitleResponse", "department_size_threshold": "#/components/schemas/DepartmentSizeThresholdResponse", "recent_layoffs": "#/components/schemas/RecentLayoffsResponse" } } }, "description": "Active tracking rules on this list, with IDs for granular management." }, "isActive": { "type": "boolean", "description": "Whether the list is actively being checked." }, "isArchived": { "type": "boolean", "description": "Whether the list is archived." }, "companyCount": { "type": "integer", "minimum": 0, "description": "Number of companies in this list." }, "createdAt": { "type": "string", "format": "date-time", "description": "When the list was created." }, "nextRefreshAt": { "type": [ "string", "null" ], "format": "date-time", "description": "When the entire list will next be refreshed. All entities in the list are checked together at this time. Null if the list has no active entities or is inactive." }, "isDynamic": { "type": "boolean", "description": "Whether this list's membership is query-driven and auto-refreshed (dynamic) rather than manually managed (static)." } }, "required": [ "id", "name", "refreshIntervalDays", "isActive", "isArchived", "companyCount", "createdAt", "isDynamic" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." … _truncated to 65536 chars for ai-docs._ ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # createTrackerPersonList `POST /v1/tracker/person-lists` **Tags:** `Tracker` Create person tracker list **Endpoint:** `https://api.fiber.ai/v1/tracker/person-lists` ## Description 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 (see your plan's pricing for exact rates). Creating the list itself is free. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "name": { "type": "string", "minLength": 1, "maxLength": 200, "description": "Human-readable name for the tracker list." }, "refreshIntervalDays": { "type": "integer", "minimum": 1, "maximum": 90, "description": "How often to check tracked people for changes, in days." }, "trackingRules": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_changed_company" }, "entityType": { "type": "string", "const": "person" }, "toCompanies": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if they moved TO one of these companies (domains or slugs). Omit for any." }, "fromCompanies": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if they moved FROM one of these companies. Omit for any." }, "toTitleKeywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if their title at the new company contains one of these keywords." }, "toSeniorityLevels": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Internship", "Entry level", "Associate", "Mid-Senior level", "Director", "Executive" ] }, "minItems": 1, "description": "Only alert if their seniority at the new company is one of these levels." }, "toEmploymentTypes": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Part-time", "Contract", "Internship", "Temporary", "Volunteer" ] }, "minItems": 1, "description": "Only alert for these employment types at the new company. Omit for any." } }, "required": [ "type", "entityType" ], "title": "Person changed company" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_title_changed" }, "entityType": { "type": "string", "const": "person" }, "titleKeywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if new title contains one of these keywords. Omit for any title change." }, "toSeniority": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Internship", "Entry level", "Associate", "Mid-Senior level", "Director", "Executive" ] }, "minItems": 1, "description": "Only alert if the new position's seniority level matches one of these. Omit for any seniority." } }, "required": [ "type", "entityType" ], "title": "Person title changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_stealth_changed" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "entered", "exited", "either" ], "description": "Whether to alert on entering stealth, exiting, or either" } }, "required": [ "type", "entityType", "direction" ], "title": "Person stealth changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_open_to_work" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "started", "stopped", "either" ], "description": "Whether to alert when they start or stop signaling open-to-work" } }, "required": [ "type", "entityType", "direction" ], "title": "Person open to work" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_is_hiring" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "started", "stopped", "either" ], "description": "Whether to alert when they start or stop signaling is-hiring" } }, "required": [ "type", "entityType", "direction" ], "title": "Person is hiring" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_headline_changed" }, "entityType": { "type": "string", "const": "person" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if new headline contains one of these keywords. Omit for any change." } }, "required": [ "type", "entityType" ], "title": "Person headline changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_location_changed" }, "entityType": { "type": "string", "const": "person" }, "toCountries": { "type": [ "array", "null" ], "items": { "type": "string", "pattern": "^[A-Z]{3}$", "minLength": 3, "maxLength": 3 }, "minItems": 1, "description": "ISO 3166-1 alpha-3 country codes (e.g. 'USA', 'GBR', 'DEU'). Only alert if moved to one of these countries. Omit for any relocation." }, "fromCountries": { "type": [ "array", "null" ], "items": { "type": "string", "pattern": "^[A-Z]{3}$", "minLength": 3, "maxLength": 3 }, "minItems": 1, "description": "Only alert if they moved FROM one of these countries. Omit for any." }, "regions": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Region codes (e.g. 'X-EMEA', 'X-APAC'). Only alert if destination country is in one of these regions. Omit for any." } }, "required": [ "type", "entityType" ], "title": "Person location changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_tag_gained" }, "entityType": { "type": "string", "const": "person" }, "tags": { "type": "array", "items": { "type": "string", "enum": [ "student", "attended-top-us-university", "attended-top-global-university", "second-time-founder", "deep-technical-background", "major-tech-company-experience", "fortune-500-executive", "recently-changed-companies", "recently-promoted", "decision-maker", "c-suite", "experienced-executive", "phd", "influencer", "board-member" ] }, "minItems": 1, "description": "Alert when the person gains any of these system-assigned tags." } }, "required": [ "type", "entityType", "tags" ], "title": "Person tag gained" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_posted" }, "entityType": { "type": "string", "const": "person" }, "minReactions": { "type": [ "integer", "null" ], "minimum": 0, "description": "Only alert for posts with at least this many reactions. Omit for any." } }, "required": [ "type", "entityType" ], "title": "Person posted" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_posted_with_keyword" }, "entityType": { "type": "string", "const": "person" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Alert for posts matching these keywords." }, "minReactions": { "type": [ "integer", "null" ], "minimum": 0, "description": "Only alert for posts with at least this many reactions. Omit for any." } }, "required": [ "type", "entityType" ], "title": "Person posted with keyword" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_reacted_to_post" }, "entityType": { "type": "string", "const": "person" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert for reactions on posts whose content or author name matches these keywords. Omit for any reaction." }, "reactionTypes": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "LIKE", "LOVE", "INSIGHTFUL", "CELEBRATE", "SUPPORT", "FUNNY" ] }, "minItems": 1, "description": "Only alert for these reaction types. Omit for any type." } }, "required": [ "type", "entityType" ], "title": "Person reacted to post" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_commented_on_post" }, "entityType": { "type": "string", "const": "person" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert for comments where the comment text, post content (when available from provider), or post author name matches these keywords. Omit for any comment." } }, "required": [ "type", "entityType" ], "title": "Person commented on post" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_skills_added" }, "entityType": { "type": "string", "const": "person" }, "skills": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert for these specific skills being added. Omit for any new skill." } }, "required": [ "type", "entityType" ], "title": "Person skills added" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_got_promoted" }, "entityType": { "type": "string", "const": "person" }, "seniorityKeywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if new title contains these seniority keywords (e.g. 'VP', 'Director'). Omit for any promotion." } }, "required": [ "type", "entityType" ], "title": "Person got promoted" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_started_company" }, "entityType": { "type": "string", "const": "person" } }, "required": [ "type", "entityType" ], "title": "Person started company" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_employment_type_changed" }, "entityType": { "type": "string", "const": "person" }, "toTypes": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Part-time", "Contract", "Internship", "Temporary", "Volunteer" ] }, "minItems": 1, "description": "Only alert if new employment type is one of these. Omit for any change." } }, "required": [ "type", "entityType" ], "title": "Person employment type changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_connections_milestone" }, "entityType": { "type": "string", "const": "person" }, "threshold": { "type": "integer", "exclusiveMinimum": 0, "description": "Connection count to watch for crossing" }, "direction": { "type": "string", "enum": [ "above", "below" ], "description": "Whether to alert when crossing above or below the threshold" } }, "required": [ "type", "entityType", "threshold", "direction" ], "title": "Person connections milestone" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_follower_milestone" }, "entityType": { "type": "string", "const": "person" }, "threshold": { "type": "integer", "exclusiveMinimum": 0, "description": "Follower count to watch for crossing" }, "direction": { "type": "string", "enum": [ "above", "below" ], "description": "Whether to alert when crossing above or below the threshold" } }, "required": [ "type", "entityType", "threshold", "direction" ], "title": "Person follower milestone" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_summary_changed" }, "entityType": { "type": "string", "const": "person" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if new summary contains one of these keywords. Omit for any change." } }, "required": [ "type", "entityType" ], "title": "Person summary changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_new_certification" }, "entityType": { "type": "string", "const": "person" }, "certificationKeywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert for certifications matching these keywords. Omit for any new cert." } }, "required": [ "type", "entityType" ], "title": "Person new certification" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_became_verified" }, "entityType": { "type": "string", "const": "person" } }, "required": [ "type", "entityType" ], "title": "Person became verified" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_became_premium" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "started", "stopped", "either" ], "description": "Whether to alert when they start or stop having premium status" } }, "required": [ "type", "entityType", "direction" ], "title": "Person became premium" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_became_influencer" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "started", "stopped", "either" ], "description": "Whether to alert when they join or leave the influencer program" } }, "required": [ "type", "entityType", "direction" ], "title": "Person became influencer" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_became_top_voice" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "started", "stopped", "either" ], "description": "Whether to alert when they earn or lose the top voice badge" } }, "required": [ "type", "entityType", "direction" ], "title": "Person became top voice" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_got_demoted" }, "entityType": { "type": "string", "const": "person" }, "seniorityKeywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if the previous title contained these seniority keywords (e.g. 'VP', 'Director'). Omit for any demotion." } }, "required": [ "type", "entityType" ], "title": "Person got demoted" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_stuck_in_role" }, "entityType": { "type": "string", "const": "person" }, "thresholdMonths": { "type": "integer", "minimum": 1, "description": "Alert when the person has been in their current role for at least this many months without a title change." } }, "required": [ "type", "entityType", "thresholdMonths" ], "title": "Person stuck in role" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_tenure_milestone" }, "entityType": { "type": "string", "const": "person" }, "thresholdMonths": { "type": "integer", "minimum": 1, "description": "Alert when the person has been at their current company for at least this many months, regardless of role changes or promotions." } }, "required": [ "type", "entityType", "thresholdMonths" ], "title": "Person tenure milestone" } ], "discriminator": { "propertyName": "type", "mapping": { "person_changed_company": "#/components/schemas/PersonChangedCompany", "person_title_changed": "#/components/schemas/PersonTitleChanged", "person_stealth_changed": "#/components/schemas/PersonStealthChanged", "person_open_to_work": "#/components/schemas/PersonOpenToWork", "person_is_hiring": "#/components/schemas/PersonIsHiring", "person_headline_changed": "#/components/schemas/PersonHeadlineChanged", "person_location_changed": "#/components/schemas/PersonLocationChanged", "person_tag_gained": "#/components/schemas/PersonTagGained", "person_posted": "#/components/schemas/PersonPosted", "person_posted_with_keyword": "#/components/schemas/PersonPostedWithKeyword", "person_reacted_to_post": "#/components/schemas/PersonReactedToPost", "person_commented_on_post": "#/components/schemas/PersonCommentedOnPost", "person_skills_added": "#/components/schemas/PersonSkillsAdded", "person_got_promoted": "#/components/schemas/PersonGotPromoted", "person_started_company": "#/components/schemas/PersonStartedCompany", "person_employment_type_changed": "#/components/schemas/PersonEmploymentTypeChanged", "person_connections_milestone": "#/components/schemas/PersonConnectionsMilestone", "person_follower_milestone": "#/components/schemas/PersonFollowerMilestone", "person_summary_changed": "#/components/schemas/PersonSummaryChanged", "person_new_certification": "#/components/schemas/PersonNewCertification", "person_became_verified": "#/components/schemas/PersonBecameVerified", "person_became_premium": "#/components/schemas/PersonBecamePremium", "person_became_influencer": "#/components/schemas/PersonBecameInfluencer", "person_became_top_voice": "#/components/schemas/PersonBecameTopVoice", "person_got_demoted": "#/components/schemas/PersonGotDemoted", "person_stuck_in_role": "#/components/schemas/PersonStuckInRole", "person_tenure_milestone": "#/components/schemas/PersonTenureMilestone" } } }, "minItems": 1, "maxItems": 25, "description": "Tracking rules to evaluate against this list's entities. Multiple rules can be active simultaneously." }, "prospectSearchParams": { "type": [ "object", "null" ], "properties": { "country3LetterCode": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } } } }, "numConnections": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "numFollowers": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "approxAge": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", … _truncated to 65536 chars for ai-docs._ ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "id": { "type": "string", "description": "Tracker list ID." }, "name": { "type": "string", "description": "Name of the list." }, "refreshIntervalDays": { "type": "integer", "description": "Check interval in days." }, "trackingRules": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_changed_company" }, "entityType": { "type": "string", "const": "person" }, "toCompanies": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if they moved TO one of these companies (domains or slugs). Omit for any." }, "fromCompanies": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if they moved FROM one of these companies. Omit for any." }, "toTitleKeywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if their title at the new company contains one of these keywords." }, "toSeniorityLevels": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Internship", "Entry level", "Associate", "Mid-Senior level", "Director", "Executive" ] }, "minItems": 1, "description": "Only alert if their seniority at the new company is one of these levels." }, "toEmploymentTypes": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Part-time", "Contract", "Internship", "Temporary", "Volunteer" ] }, "minItems": 1, "description": "Only alert for these employment types at the new company. Omit for any." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person changed company" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_title_changed" }, "entityType": { "type": "string", "const": "person" }, "titleKeywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if new title contains one of these keywords. Omit for any title change." }, "toSeniority": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Internship", "Entry level", "Associate", "Mid-Senior level", "Director", "Executive" ] }, "minItems": 1, "description": "Only alert if the new position's seniority level matches one of these. Omit for any seniority." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person title changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_stealth_changed" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "entered", "exited", "either" ], "description": "Whether to alert on entering stealth, exiting, or either" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "direction", "id" ], "title": "Person stealth changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_open_to_work" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "started", "stopped", "either" ], "description": "Whether to alert when they start or stop signaling open-to-work" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "direction", "id" ], "title": "Person open to work" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_is_hiring" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "started", "stopped", "either" ], "description": "Whether to alert when they start or stop signaling is-hiring" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "direction", "id" ], "title": "Person is hiring" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_headline_changed" }, "entityType": { "type": "string", "const": "person" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if new headline contains one of these keywords. Omit for any change." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person headline changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_location_changed" }, "entityType": { "type": "string", "const": "person" }, "toCountries": { "type": [ "array", "null" ], "items": { "type": "string", "pattern": "^[A-Z]{3}$", "minLength": 3, "maxLength": 3 }, "minItems": 1, "description": "ISO 3166-1 alpha-3 country codes (e.g. 'USA', 'GBR', 'DEU'). Only alert if moved to one of these countries. Omit for any relocation." }, "fromCountries": { "type": [ "array", "null" ], "items": { "type": "string", "pattern": "^[A-Z]{3}$", "minLength": 3, "maxLength": 3 }, "minItems": 1, "description": "Only alert if they moved FROM one of these countries. Omit for any." }, "regions": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Region codes (e.g. 'X-EMEA', 'X-APAC'). Only alert if destination country is in one of these regions. Omit for any." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person location changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_tag_gained" }, "entityType": { "type": "string", "const": "person" }, "tags": { "type": "array", "items": { "type": "string", "enum": [ "student", "attended-top-us-university", "attended-top-global-university", "second-time-founder", "deep-technical-background", "major-tech-company-experience", "fortune-500-executive", "recently-changed-companies", "recently-promoted", "decision-maker", "c-suite", "experienced-executive", "phd", "influencer", "board-member" ] }, "minItems": 1, "description": "Alert when the person gains any of these system-assigned tags." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "tags", "id" ], "title": "Person tag gained" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_posted" }, "entityType": { "type": "string", "const": "person" }, "minReactions": { "type": [ "integer", "null" ], "minimum": 0, "description": "Only alert for posts with at least this many reactions. Omit for any." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person posted" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_posted_with_keyword" }, "entityType": { "type": "string", "const": "person" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Alert for posts matching these keywords." }, "minReactions": { "type": [ "integer", "null" ], "minimum": 0, "description": "Only alert for posts with at least this many reactions. Omit for any." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person posted with keyword" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_reacted_to_post" }, "entityType": { "type": "string", "const": "person" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert for reactions on posts whose content or author name matches these keywords. Omit for any reaction." }, "reactionTypes": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "LIKE", "LOVE", "INSIGHTFUL", "CELEBRATE", "SUPPORT", "FUNNY" ] }, "minItems": 1, "description": "Only alert for these reaction types. Omit for any type." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person reacted to post" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_commented_on_post" }, "entityType": { "type": "string", "const": "person" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert for comments where the comment text, post content (when available from provider), or post author name matches these keywords. Omit for any comment." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person commented on post" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_skills_added" }, "entityType": { "type": "string", "const": "person" }, "skills": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert for these specific skills being added. Omit for any new skill." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person skills added" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_got_promoted" }, "entityType": { "type": "string", "const": "person" }, "seniorityKeywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if new title contains these seniority keywords (e.g. 'VP', 'Director'). Omit for any promotion." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person got promoted" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_started_company" }, "entityType": { "type": "string", "const": "person" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person started company" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_employment_type_changed" }, "entityType": { "type": "string", "const": "person" }, "toTypes": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Part-time", "Contract", "Internship", "Temporary", "Volunteer" ] }, "minItems": 1, "description": "Only alert if new employment type is one of these. Omit for any change." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person employment type changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_connections_milestone" }, "entityType": { "type": "string", "const": "person" }, "threshold": { "type": "integer", "exclusiveMinimum": 0, "description": "Connection count to watch for crossing" }, "direction": { "type": "string", "enum": [ "above", "below" ], "description": "Whether to alert when crossing above or below the threshold" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "threshold", "direction", "id" ], "title": "Person connections milestone" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_follower_milestone" }, "entityType": { "type": "string", "const": "person" }, "threshold": { "type": "integer", "exclusiveMinimum": 0, "description": "Follower count to watch for crossing" }, "direction": { "type": "string", "enum": [ "above", "below" ], "description": "Whether to alert when crossing above or below the threshold" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "threshold", "direction", "id" ], "title": "Person follower milestone" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_summary_changed" }, "entityType": { "type": "string", "const": "person" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if new summary contains one of these keywords. Omit for any change." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person summary changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_new_certification" }, "entityType": { "type": "string", "const": "person" }, "certificationKeywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert for certifications matching these keywords. Omit for any new cert." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person new certification" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_became_verified" }, "entityType": { "type": "string", "const": "person" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person became verified" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_became_premium" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "started", "stopped", "either" ], "description": "Whether to alert when they start or stop having premium status" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "direction", "id" ], "title": "Person became premium" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_became_influencer" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "started", "stopped", "either" ], "description": "Whether to alert when they join or leave the influencer program" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "direction", "id" ], "title": "Person became influencer" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_became_top_voice" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "started", "stopped", "either" ], "description": "Whether to alert when they earn or lose the top voice badge" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "direction", "id" ], "title": "Person became top voice" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_got_demoted" }, "entityType": { "type": "string", "const": "person" }, "seniorityKeywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if the previous title contained these seniority keywords (e.g. 'VP', 'Director'). Omit for any demotion." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person got demoted" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_stuck_in_role" }, "entityType": { "type": "string", "const": "person" }, "thresholdMonths": { "type": "integer", "minimum": 1, "description": "Alert when the person has been in their current role for at least this many months without a title change." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "thresholdMonths", "id" ], "title": "Person stuck in role" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_tenure_milestone" }, "entityType": { "type": "string", "const": "person" }, "thresholdMonths": { "type": "integer", "minimum": 1, "description": "Alert when the person has been at their current company for at least this many months, regardless of role changes or promotions." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "thresholdMonths", "id" ], "title": "Person tenure milestone" } ], "discriminator": { "propertyName": "type", "mapping": { "person_changed_company": "#/components/schemas/PersonChangedCompanyResponse", "person_title_changed": "#/components/schemas/PersonTitleChangedResponse", "person_stealth_changed": "#/components/schemas/PersonStealthChangedResponse", "person_open_to_work": "#/components/schemas/PersonOpenToWorkResponse", "person_is_hiring": "#/components/schemas/PersonIsHiringResponse", "person_headline_changed": "#/components/schemas/PersonHeadlineChangedResponse", "person_location_changed": "#/components/schemas/PersonLocationChangedResponse", "person_tag_gained": "#/components/schemas/PersonTagGainedResponse", "person_posted": "#/components/schemas/PersonPostedResponse", "person_posted_with_keyword": "#/components/schemas/PersonPostedWithKeywordResponse", "person_reacted_to_post": "#/components/schemas/PersonReactedToPostResponse", "person_commented_on_post": "#/components/schemas/PersonCommentedOnPostResponse", "person_skills_added": "#/components/schemas/PersonSkillsAddedResponse", "person_got_promoted": "#/components/schemas/PersonGotPromotedResponse", "person_started_company": "#/components/schemas/PersonStartedCompanyResponse", "person_employment_type_changed": "#/components/schemas/PersonEmploymentTypeChangedResponse", "person_connections_milestone": "#/components/schemas/PersonConnectionsMilestoneResponse", "person_follower_milestone": "#/components/schemas/PersonFollowerMilestoneResponse", "person_summary_changed": "#/components/schemas/PersonSummaryChangedResponse", "person_new_certification": "#/components/schemas/PersonNewCertificationResponse", "person_became_verified": "#/components/schemas/PersonBecameVerifiedResponse", "person_became_premium": "#/components/schemas/PersonBecamePremiumResponse", "person_became_influencer": "#/components/schemas/PersonBecameInfluencerResponse", "person_became_top_voice": "#/components/schemas/PersonBecameTopVoiceResponse", "person_got_demoted": "#/components/schemas/PersonGotDemotedResponse", "person_stuck_in_role": "#/components/schemas/PersonStuckInRoleResponse", "person_tenure_milestone": "#/components/schemas/PersonTenureMilestoneResponse" } } }, "description": "Active tracking rules on this list, with IDs for granular management." }, "isActive": { "type": "boolean", "description": "Whether the list is actively being checked." }, "isArchived": { "type": "boolean", "description": "Whether the list is archived." }, "personCount": { "type": "integer", "minimum": 0, "description": "Number of people in this list." }, "createdAt": { "type": "string", "format": "date-time", "description": "When the list was created." }, "nextRefreshAt": { "type": [ "string", "null" ], "format": "date-time", "description": "When the entire list will next be refreshed. All entities in the list are checked together at this time. Null if the list has no active entities or is inactive." }, "isDynamic": { "type": "boolean", "description": "Whether this list's membership is query-driven and auto-refreshed (dynamic) rather than manually managed (static)." } }, "required": [ "id", "name", "refreshIntervalDays", "isActive", "isArchived", "personCount", "createdAt", "isDynamic" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were char … _truncated to 65536 chars for ai-docs._ ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # createWebhookEndpoint `POST /v1/webhooks/endpoints` **Tags:** `Webhooks` Create webhook endpoint **Endpoint:** `https://api.fiber.ai/v1/webhooks/endpoints` ## Description 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. ⚡ Rate limit: 60 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "url": { "type": "string", "format": "uri", "pattern": "^https://", "description": "The HTTPS URL that will receive event payloads, e.g. 'https://api.example.com/webhooks/fiber'." }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "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" ] }, "minItems": 1, "description": "The event types to subscribe this endpoint to. Retrieve the full list of available event types from the webhook event types endpoint." }, "description": { "type": [ "string", "null" ], "minLength": 1, "description": "An optional human-readable label for this endpoint." } }, "required": [ "apiKey", "url", "eventTypes" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "endpointId": { "type": "string", "description": "The unique ID of this webhook endpoint." }, "url": { "type": "string", "description": "The HTTPS URL that receives event payloads." }, "eventTypes": { "type": "array", "items": { "type": "string" }, "description": "The event types this endpoint is subscribed to. An empty array means the endpoint receives every event type; endpoints created through this API are always subscribed to one or more specific event types." }, "description": { "type": [ "string", "null" ], "description": "An optional human-readable label for this endpoint." }, "disabled": { "type": "boolean", "description": "Whether delivery to this endpoint is currently paused." }, "createdAt": { "type": "string", "description": "When the endpoint was created (ISO 8601)." }, "updatedAt": { "type": "string", "description": "When the endpoint was last updated (ISO 8601)." }, "signingSecret": { "type": "string", "description": "The secret used to verify payload signatures. Store it securely — it is only returned when the endpoint is created or its secret is rotated." } }, "required": [ "endpointId", "url", "eventTypes", "disabled", "createdAt", "updatedAt", "signingSecret" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # deleteAudience `DELETE /v1/audiences/{audienceId}` **Tags:** `Audiences` Archive an audience **Endpoint:** `https://api.fiber.ai/v1/audiences/{audienceId}` ## Description 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. Pass your apiKey in the query string. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | | `audienceId` | path | yes | The unique ID of the audience. | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "audienceId": { "type": "string", "description": "The ID of the archived audience." }, "archived": { "type": "boolean", "description": "Whether the audience was successfully archived.", "enum": [ true ] } }, "required": [ "audienceId", "archived" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # deleteCompanyExclusionList `POST /v1/exclusions/companies/delete-list` **Tags:** `Exclusions` Delete company exclusion list **Endpoint:** `https://api.fiber.ai/v1/exclusions/companies/delete-list` ## Description Delete a company exclusion list ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "listIDs": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "The IDs of the company exclusion lists to delete." } }, "required": [ "apiKey", "listIDs" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "listIDs": { "type": "array", "items": { "type": "string" }, "description": "The IDs of the deleted company exclusion lists." } }, "required": [ "listIDs" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # deleteJobChangeList `POST /v1/job-changes/delete-list` **Tags:** `Job changes` Delete a job changes list **Endpoint:** `https://api.fiber.ai/v1/job-changes/delete-list` ## Description Deletes a job changes list. This will remove the list and stop tracking job changes for prospects in this list. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "jobChangeListId": { "type": "string", "description": "The ID of the job change list." } }, "required": [ "apiKey", "jobChangeListId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "jobChangeListId": { "type": "string", "description": "The ID of the deleted job change list." }, "deleted": { "type": "boolean", "description": "Whether the list was successfully deleted." } }, "required": [ "jobChangeListId", "deleted" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # deleteProfilesFromJobChangeList `POST /v1/job-changes/delete-profiles` **Tags:** `Job changes` Delete profiles from a job change list **Endpoint:** `https://api.fiber.ai/v1/job-changes/delete-profiles` ## Description Remove profiles from a job changes tracking list. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "profileIds": { "type": "array", "items": { "type": "string" }, "minItems": 1, "maxItems": 100, "description": "The IDs of the profiles to remove." }, "jobChangeListId": { "type": "string", "description": "The ID of the job change list to remove profiles from." } }, "required": [ "apiKey", "profileIds", "jobChangeListId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "numDeleted": { "type": "number", "description": "Number of profiles successfully deleted." } }, "required": [ "numDeleted" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # deleteProspectExclusionList `POST /v1/exclusions/prospects/delete-list` **Tags:** `Exclusions` Delete prospect exclusion list **Endpoint:** `https://api.fiber.ai/v1/exclusions/prospects/delete-list` ## Description Delete a prospect exclusion list ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "listIds": { "type": "array", "items": { "type": "string" }, "minItems": 1, "description": "The IDs of the prospect exclusion lists to delete." } }, "required": [ "apiKey", "listIds" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "listIds": { "type": "array", "items": { "type": "string" }, "description": "The IDs of the deleted prospect exclusion lists." } }, "required": [ "listIds" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # deleteTrackerCompanyList `DELETE /v1/tracker/company-lists/{listId}` **Tags:** `Tracker` Archive company tracker list **Endpoint:** `https://api.fiber.ai/v1/tracker/company-lists/{listId}` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | | `listId` | path | yes | The unique ID of the tracker list. | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the archived list." }, "name": { "type": "string", "description": "Name of the archived list." }, "isArchived": { "type": "boolean", "description": "List has been archived.", "enum": [ true ] }, "isActive": { "type": "boolean", "description": "Monitoring has been stopped.", "enum": [ false ] } }, "required": [ "id", "name", "isArchived", "isActive" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # deleteTrackerPersonList `DELETE /v1/tracker/person-lists/{listId}` **Tags:** `Tracker` Archive person tracker list **Endpoint:** `https://api.fiber.ai/v1/tracker/person-lists/{listId}` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | | `listId` | path | yes | The unique ID of the tracker list. | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the archived list." }, "name": { "type": "string", "description": "Name of the archived list." }, "isArchived": { "type": "boolean", "description": "List has been archived.", "enum": [ true ] }, "isActive": { "type": "boolean", "description": "Monitoring has been stopped.", "enum": [ false ] } }, "required": [ "id", "name", "isArchived", "isActive" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # deleteWebhookEndpoint `DELETE /v1/webhooks/endpoints/{endpointId}` **Tags:** `Webhooks` Delete webhook endpoint **Endpoint:** `https://api.fiber.ai/v1/webhooks/endpoints/{endpointId}` ## Description Delete a webhook endpoint. All future event deliveries to its URL stop immediately. Deleting webhooks is free. ⚡ Rate limit: 60 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | | `endpointId` | path | yes | The unique ID of the webhook endpoint. | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "endpointId": { "type": "string", "description": "The ID of the deleted webhook endpoint." }, "deleted": { "type": "boolean", "description": "Always true when the endpoint was deleted.", "enum": [ true ] } }, "required": [ "endpointId", "deleted" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # domainLookupPolling `POST /v1/domain-lookup/polling` **Tags:** `AI research` Poll Domain lookup **Endpoint:** `https://api.fiber.ai/v1/domain-lookup/polling` ## Description Poll for the results of a domain lookup task. ⚡ Rate limit: 120 requests per 1 minute ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "domainAgentRunId": { "type": "string", "description": "The ID of the domain agent run returned by the trigger endpoint." }, "cursor": { "type": [ "string", "null" ], "description": "The cursor from where to start fetching the next page of results. Provide the `nextCursor` from the previous response to continue from there." }, "pageSize": { "type": "number", "minimum": 1, "maximum": 100, "default": 10, "description": "The number of results to fetch per page." } }, "required": [ "apiKey", "domainAgentRunId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "NOT_STARTED", "STARTED", "DONE", "FAILED" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "companyName": { "type": "string", "description": "The name of the company." }, "bestDomain": { "type": [ "string", "null" ], "description": "The best matching domain for the company. Null if no domain was found." }, "emailDomains": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "emailDomain": { "type": [ "string", "null" ], "description": "The email domain found for the company. Personal email domains are excluded." }, "confidence": { "type": [ "number", "null" ], "minimum": 0, "maximum": 10, "description": "The confidence score for the email domain found (1-10, where 10 is most confident)." }, "rationale": { "type": [ "string", "null" ], "description": "The rationale for the email domain selection." } } }, "description": "The email domains of the company." }, "allDomains": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "All found domains for the company." }, "confidence": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 10, "description": "The confidence score between 0 and 10 denoting the match quality. Higher confidence score means the company has more matching parameters." }, "rationale": { "type": "string", "description": "The reasoning for why the agent chose the given company." } }, "required": [ "companyName", "rationale" ] }, "description": "The list of companies found along with their rationale and confidence scores." }, "nextCursor": { "type": [ "string", "null" ], "description": "The pagination cursor for the next page of results. Null if there are no more results." }, "hasMore": { "type": "boolean", "description": "Whether there are more results to fetch." } }, "required": [ "status", "data", "hasMore" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # domainLookupTrigger `POST /v1/domain-lookup/trigger` **Tags:** `AI research` Start Domain lookup **Endpoint:** `https://api.fiber.ai/v1/domain-lookup/trigger` ## Description 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. ⚡ Rate limit: 30 requests per 1 minute 💰 Cost: 3 credits per company ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "overAllContext": { "type": "string", "description": "A descriptor of what the companies have in common (e.g. \"British freight brokers\" or \"YC startups\"). Helps disambiguate companies with similar names." }, "companyInfo": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the company." }, "domain": { "type": [ "string", "null" ], "description": "The domain of the company if already known (e.g. 'example.com'). If provided and findEmailDomains is true, the agent will skip domain search and only find email domains. Else if not provided, the agent will search for the domain." }, "country": { "type": [ "string", "null" ], "description": "The country where the company is based. Provide full country name (e.g. United Kingdom) or ISO 3166-1 alpha-3 code (e.g. GBR)" }, "state": { "type": [ "string", "null" ], "description": "The state where the company is based. Provide full state name (e.g. California) or code (e.g. CA)." }, "city": { "type": [ "string", "null" ], "description": "The city where the company is located." }, "address": { "type": [ "string", "null" ], "description": "The street address of the company." }, "findEmailDomains": { "type": "boolean", "default": false, "description": "Whether to find the email domains of the company." }, "otherContext": { "type": [ "string", "null" ], "description": "Any other disambiguating information or identifiers for the company, such as \"YC startup\" or \"Italian airline\"" }, "description": { "type": [ "string", "null" ], "description": "A description of the company, such as what it does or its industry focus." } }, "required": [ "name" ] }, "minItems": 1, "maxItems": 400, "description": "List of companies to look up. Max 400 companies can be provided at a time." } }, "required": [ "apiKey", "overAllContext", "companyInfo" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "domainAgentRunId": { "type": "string", "description": "The ID of the domain agent run. Provide this to the polling endpoint to get the actual results back." } }, "required": [ "domainAgentRunId" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # emailBounceDetection `POST /v1/validate-email/single` **Tags:** `Validation` Validate a single email **Endpoint:** `https://api.fiber.ai/v1/validate-email/single` ## Description Checks if a given email is likely to bounce using a waterfall of strategies. Works for catch-all email addresses, which are increasingly common yet hard for other APIs to validate. ⚡ Rate limit: 300 requests per 1 minute 💰 Cost: 1 credit per email validation ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "email": { "type": "string", "format": "email", "description": "The email address to validate." } }, "required": [ "apiKey", "email" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "description": "The email address that was validated." }, "is_catch_all": { "type": "boolean", "description": "Whether the address is a catch-all email." }, "is_role_based": { "type": "boolean", "description": "Whether the address is role-based (e.g. 'sales@' or 'hello@') rather than a personal email." }, "is_disposable": { "type": "boolean", "description": "Whether the address uses a disposable email provider." }, "is_consumer": { "type": "boolean", "description": "Whether the address uses a consumer email service (e.g. Gmail, Outlook) rather than a commercial service." }, "email_provider": { "type": "string", "description": "The email provider." }, "verdict": { "type": "string", "enum": [ "ok", "undeliverable", "risky", "inconclusive" ], "description": "The final estimate of whether the email is likely to be correct and deliverable." }, "deliverability_score": { "type": "integer", "minimum": 0, "maximum": 100, "description": "The deliverability score out of 100. Higher scores are better." } }, "required": [ "email", "is_catch_all", "is_role_based", "is_disposable", "is_consumer", "email_provider", "verdict", "deliverability_score" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # estimateEnrichmentCost `POST /v1/audiences/{audienceId}/enrichment/estimate` **Tags:** `Audiences` Estimate enrichment cost **Endpoint:** `https://api.fiber.ai/v1/audiences/{audienceId}/enrichment/estimate` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `audienceId` | path | yes | The unique ID of the audience. | ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "maxProspectsToEnrich": { "type": "integer", "exclusiveMinimum": 0, "description": "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)." }, "enrichmentType": { "type": "object", "properties": { "getWorkEmails": { "type": "boolean", "default": true }, "getPersonalEmails": { "type": "boolean", "default": true }, "getPhoneNumbers": { "type": "boolean", "default": true } }, "description": "Enrichment types to estimate costs for" }, "runCompanyLiveEnrichment": { "type": "boolean", "default": true, "description": "Whether to include company live enrichment in estimate" }, "runProfileLiveEnrichment": { "type": "boolean", "default": true, "description": "Whether to include profile live enrichment in estimate" }, "runProfileSalesNav": { "type": "boolean", "default": true, "description": "Whether to include Sales Navigator enrichment in estimate" }, "runContactEnrichment": { "type": "boolean", "default": true, "description": "Whether to include contact enrichment in estimate" } }, "required": [ "apiKey", "maxProspectsToEnrich", "enrichmentType" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "totalCredits": { "type": "number", "description": "The total estimated credits required." }, "breakdown": { "type": "object", "properties": { "salesNav": { "type": "object", "properties": { "credits": { "type": "number" }, "isFree": { "type": "boolean" } }, "required": [ "credits", "isFree" ], "description": "Sales Navigator enrichment cost" }, "liveCompany": { "type": "object", "properties": { "credits": { "type": "number" }, "discounted": { "type": "boolean" } }, "required": [ "credits", "discounted" ], "description": "Company live enrichment cost" }, "liveProspect": { "type": "object", "properties": { "credits": { "type": "number" }, "discounted": { "type": "boolean" } }, "required": [ "credits", "discounted" ], "description": "Prospect live enrichment cost" }, "waterfall": { "type": "object", "properties": { "credits": { "type": "number" }, "originalCredits": { "type": "number" }, "discount": { "type": "number" }, "operations": { "type": "object", "properties": { "workEmail": { "type": "number" }, "personalEmail": { "type": "number" }, "phone": { "type": "number" } }, "required": [ "workEmail", "personalEmail", "phone" ] } }, "required": [ "credits", "originalCredits", "discount", "operations" ], "description": "Waterfall pricing for contact enrichment" }, "validation": { "type": "object", "properties": { "credits": { "type": "number" }, "isFree": { "type": "boolean" } }, "required": [ "credits", "isFree" ], "description": "Email validation cost" } }, "required": [ "salesNav", "liveCompany", "liveProspect", "waterfall", "validation" ], "description": "The detailed cost breakdown by operation type." }, "timeEstimate": { "type": "object", "properties": { "totalSeconds": { "type": "number" }, "formatted": { "type": "string" } }, "required": [ "totalSeconds", "formatted" ], "description": "The estimated time to complete enrichment." } }, "required": [ "totalCredits", "breakdown", "timeEstimate" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # exportCompanies `POST /v1/audiences/{audienceId}/export/companies` **Tags:** `Audiences` Export audience companies to CSV **Endpoint:** `https://api.fiber.ai/v1/audiences/{audienceId}/export/companies` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `audienceId` | path | yes | The unique ID of the audience. | ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "format": { "type": "string", "enum": [ "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" ], "description": "The format of the exported file." }, "maxRowsToExport": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Maximum number of rows to export. Defaults to remaining export quota." }, "excludeFields": { "type": "array", "items": { "type": "string", "enum": [ "fiber_id", "name", "all_names", "website", "domain", "linkedin_url", "linkedin_org_id", "logo_url", "headline", "description", "standard_industries", "linkedin_industries", "naics_codes", "hq_full_address", "hq_street_address", "hq_city", "hq_state", "hq_country", "hq_country_code", "hq_latitude", "hq_longitude", "num_offices", "all_office_addresses", "office_countries", "category", "employee_count_lower", "employee_count_upper", "founded_on", "num_followers", "office_locations", "office_locations_raw", "funding_stage", "last_funded_at", "last_funding_usd", "total_funding_usd", "market_cap_usd", "revenue_usd", "accelerators", "investors", "acquisitions", "funding_rounds", "stock_ticker", "num_exits", "tags", "job_posting_stats", "specialties", "phone_numbers", "facebook_urls", "x_urls", "github_usernames", "wellfound_urls", "blog_urls", "instagram_urls", "youtube_urls", "short_description", "long_description", "roles", "primary_role", "is_subsidiary", "parent", "matching_job_posting_urls", "matching_job_postings_json", "matching_job_postings_titles", "num_matching_job_postings", "num_role_matches", "custom" ] }, "default": [], "description": "The fields to exclude from the export." }, "userEmail": { "type": [ "string", "null" ], "format": "email", "description": "Optional email address to receive CSV export links. If not provided, no email will be sent." } }, "required": [ "apiKey", "format" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "message": { "type": "string", "description": "A human-readable message about the export status." }, "estimatedRows": { "type": "number", "description": "The estimated number of rows that will be exported." }, "maxRowsAllowed": { "type": "number", "description": "The maximum rows allowed based on the export quota." } }, "required": [ "message", "estimatedRows", "maxRowsAllowed" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # exportProspects `POST /v1/audiences/{audienceId}/export/prospects` **Tags:** `Audiences` Export audience prospects to CSV **Endpoint:** `https://api.fiber.ai/v1/audiences/{audienceId}/export/prospects` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `audienceId` | path | yes | The unique ID of the audience. | ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "format": { "type": "string", "enum": [ "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" ], "description": "The format of the exported file." }, "maxRowsToExport": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Maximum number of rows to export. Defaults to remaining export quota." }, "excludeFields": { "type": "array", "items": { "type": "string", "enum": [ "fiber_id", "first_name", "last_name", "full_name", "profile_url", "company", "company_domain", "company_description", "company_linkedin_url", "work_location", "employment_type", "job_title", "headline", "summary", "job_summary", "job_start_date", "months_in_current_job", "months_in_current_company", "city", "state", "country", "country_code", "timezone", "latitude", "longitude", "work_email_1", "work_email_2", "personal_email_1", "personal_email_2", "other_emails", "emails_verified", "phone_number_1", "phone_number_2", "other_phone_numbers", "profile_pic_url", "num_followers", "num_connections", "age", "education", "years_of_experience", "num_jobs", "past_jobs", "languages", "tags", "skills", "tenures", "industry", "past_jobs_raw", "job_academic_qualifications", "job_seniority", "job_function", "certifications", "certifications_raw", "patents", "patents_raw", "articles", "articles_raw", "num_recommendations_received", "volunteering", "volunteering_raw", "projects", "projects_raw", "tenures_raw", "courses", "courses_raw", "is_in_stealth", "publications", "publications_raw", "company_hq_city", "company_hq_state", "company_hq_country", "company_hq_country_code", "company_hq_latitude", "company_hq_longitude", "company_stock_ticker", "company_employee_trends", "company_founding_date", "company_employee_count_lower", "company_employee_count_upper", "company_industries", "company_num_followers", "company_naics_codes", "company_funding_rounds", "company_funding_stage", "company_total_funding_usd", "company_last_funded_at", "company_last_funding_usd", "company_revenue_usd", "company_investors", "company_tags", "company_market_cap_usd", "company_office_countries", "company_num_offices", "company_accelerators", "company_job_posting_stats", "custom" ] }, "default": [], "description": "The fields to exclude from the export." }, "onlyWithContacts": { "type": "boolean", "default": false, "description": "If true, only export prospects with verified emails or phones" }, "userEmail": { "type": [ "string", "null" ], "format": "email", "description": "Optional email address to receive CSV export links. If not provided, no email will be sent." } }, "required": [ "apiKey", "format" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "message": { "type": "string", "description": "A human-readable message about the export status." }, "estimatedRows": { "type": "number", "description": "The estimated number of rows that will be exported." }, "maxRowsAllowed": { "type": "number", "description": "The maximum rows allowed based on the export quota." } }, "required": [ "message", "estimatedRows", "maxRowsAllowed" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # fetchRealEstateListings `POST /v1/real-estate/listings` **Tags:** `Market intelligence` Fetch real estate listings **Endpoint:** `https://api.fiber.ai/v1/real-estate/listings` ## Description 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. ⚡ Rate limit: 300 requests per 1 minute 💰 Cost: 2 credits per page of results ⓘ ⏱ Recommended timeout: 30 seconds ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "location": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "raw" ] }, "rawQuery": { "type": "string", "minLength": 1, "description": "Free-form location text. Accepts city, city + state/province, ZIP/postal code, or full address (e.g., 'Toronto, ON', 'Brooklyn NY', '10001', 'Trois-Rivières, QC'). Resolved via geocoding to a city + state/province before searching." } }, "required": [ "type", "rawQuery" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "structured" ] }, "city": { "type": "string", "minLength": 1, "description": "City name (e.g., 'Toronto', 'Trois-Rivières')." }, "stateCode": { "type": "string", "pattern": "^[A-Za-z]{2}$", "description": "Two-letter US state code or Canadian province code (e.g., 'NY', 'CA', 'QC', 'ON')." } }, "required": [ "type", "city", "stateCode" ] } ], "description": "Location input for listing search. Use `raw` for user-provided text and `structured` for exact city/state precision." }, "nextPageToken": { "type": [ "string", "null" ], "minLength": 1, "description": "Pagination token from a previous response. Omit for the first page." }, "sortBy": { "type": [ "string", "null" ], "enum": [ "relevance", "newest", "priceAscending", "priceDescending", "paymentAscending", "paymentDescending", "bedroomCountDescending", "bathroomCountDescending", "floorAreaSqFtDescending", "lotAreaSqFtDescending", "estimatedPriceDescending", "estimatedPriceAscending", null ], "description": "Sort order for search results." }, "listingStatus": { "type": [ "string", "null" ], "enum": [ "forSale", "forRent", "sold", null ], "description": "Listing category to search." }, "homeTypes": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "house", "condo", "townhouse", "multi_family", "apartment", "land", "manufactured" ] }, "description": "Property types to include." }, "price": { "type": [ "object", "null" ], "properties": { "min": { "type": [ "number", "null" ], "minimum": 0 }, "max": { "type": [ "number", "null" ], "minimum": 0 } }, "description": "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)." }, "rent": { "type": [ "object", "null" ], "properties": { "min": { "type": [ "number", "null" ], "minimum": 0 }, "max": { "type": [ "number", "null" ], "minimum": 0 } }, "description": "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)." }, "bedrooms": { "type": [ "object", "null" ], "properties": { "min": { "type": "integer", "minimum": 1, "maximum": 5 } }, "required": [ "min" ], "description": "Bedroom count filter. Use `min` to set the lower bound." }, "bathrooms": { "type": [ "object", "null" ], "properties": { "min": { "type": "number", "minimum": 1, "maximum": 4 } }, "required": [ "min" ], "description": "Bathroom count filter. Use `min` to set the lower bound." }, "floorAreaSqFt": { "type": [ "object", "null" ], "properties": { "min": { "type": [ "number", "null" ], "minimum": 0 }, "max": { "type": [ "number", "null" ], "minimum": 0 } }, "description": "Interior living-area range in square feet." }, "lotAreaSqFt": { "type": [ "object", "null" ], "properties": { "min": { "type": [ "number", "null" ], "minimum": 0 }, "max": { "type": [ "number", "null" ], "minimum": 0 } }, "description": "Lot-size range in square feet." }, "yearBuilt": { "type": [ "object", "null" ], "properties": { "min": { "type": [ "integer", "null" ], "minimum": 1800 }, "max": { "type": [ "integer", "null" ], "minimum": 1800 } }, "description": "Year-built range." }, "parkingSpots": { "type": [ "object", "null" ], "properties": { "min": { "type": "integer", "minimum": 1, "description": "Minimum number of parking spots." } }, "required": [ "min" ], "description": "Parking spots filter." }, "keywords": { "type": [ "string", "null" ], "minLength": 1, "description": "Additional keyword terms to match in listing text. For broader matching, separate terms with commas (for example: 'pool,garage')." }, "features": { "type": [ "object", "null" ], "properties": { "hasPool": { "type": [ "boolean", "null" ] }, "hasGarage": { "type": [ "boolean", "null" ] }, "hasAirConditioning": { "type": [ "boolean", "null" ] }, "isWaterfront": { "type": [ "boolean", "null" ] }, "isSingleStory": { "type": [ "boolean", "null" ] }, "hasOpenHouse": { "type": [ "boolean", "null" ] }, "includeUnderContract": { "type": [ "boolean", "null" ] } }, "description": "Optional property feature filters." } }, "required": [ "apiKey", "location" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "runId": { "type": "string", "description": "Unique identifier for this search request." }, "totalResultCount": { "type": [ "integer", "null" ], "description": "Total number of matching listings." }, "regionName": { "type": [ "string", "null" ], "description": "Region name interpreted for this search query." }, "nextPageToken": { "type": [ "string", "null" ], "description": "Token for retrieving the next page. Pass this exact value as `nextPageToken` in the next request. Null if no more pages." }, "properties": { "type": "array", "items": { "type": "object", "properties": { "price": { "type": [ "object", "null" ], "properties": { "usd": { "type": "object", "properties": { "currency": { "type": [ "string", "null" ], "description": "ISO 4217 currency code for the listing price." }, "amount": { "type": [ "number", "null" ], "description": "Numeric listing price amount." } }, "description": "Listing price converted to USD when conversion data is available." }, "local": { "type": "object", "properties": { "currency": { "type": [ "string", "null" ], "description": "ISO 4217 currency code for the listing price." }, "amount": { "type": [ "number", "null" ], "description": "Numeric listing price amount." } }, "description": "Listing price in the local market currency." } }, "required": [ "usd", "local" ], "description": "Price represented in both USD and local listing currency." }, "position": { "type": [ "integer", "null" ], "description": "Result position on this page." }, "listingId": { "type": "string", "description": "Unique listing identifier." }, "address": { "type": [ "string", "null" ], "description": "Full property address." }, "street": { "type": [ "string", "null" ], "description": "Street address." }, "city": { "type": [ "string", "null" ], "description": "City name." }, "state": { "type": [ "string", "null" ], "description": "State or province code." }, "postalCode": { "type": [ "string", "null" ], "description": "Postal or ZIP code." }, "unitNumber": { "type": [ "string", "null" ], "description": "Unit or apartment number, when the listing is part of a multi-unit building." }, "bedroomCount": { "type": [ "integer", "null" ], "description": "Number of bedrooms." }, "bathroomCount": { "type": [ "number", "null" ], "description": "Number of bathrooms." }, "estimatedPrice": { "type": [ "object", "null" ], "properties": { "usd": { "type": "object", "properties": { "currency": { "type": [ "string", "null" ], "description": "ISO 4217 currency code for the listing price." }, "amount": { "type": [ "number", "null" ], "description": "Numeric listing price amount." } }, "description": "Listing price converted to USD when conversion data is available." }, "local": { "type": "object", "properties": { "currency": { "type": [ "string", "null" ], "description": "ISO 4217 currency code for the listing price." }, "amount": { "type": [ "number", "null" ], "description": "Numeric listing price amount." } }, "description": "Listing price in the local market currency." } }, "required": [ "usd", "local" ], "description": "Estimated property value in USD and local currency." }, "estimatedMonthlyRent": { "type": [ "object", "null" ], "properties": { "usd": { "type": "object", "properties": { "currency": { "type": [ "string", "null" ], "description": "ISO 4217 currency code for the listing price." }, "amount": { "type": [ "number", "null" ], "description": "Numeric listing price amount." } }, "description": "Listing price converted to USD when conversion data is available." }, "local": { "type": "object", "properties": { "currency": { "type": [ "string", "null" ], "description": "ISO 4217 currency code for the listing price." }, "amount": { "type": [ "number", "null" ], "description": "Numeric listing price amount." } }, "description": "Listing price in the local market currency." } }, "required": [ "usd", "local" ], "description": "Estimated monthly rent in USD and local currency." }, "priceChangeAmount": { "type": [ "object", "null" ], "properties": { "usd": { "type": "object", "properties": { "currency": { "type": [ "string", "null" ], "description": "ISO 4217 currency code for the listing price." }, "amount": { "type": [ "number", "null" ], "description": "Numeric listing price amount." } }, "description": "Listing price converted to USD when conversion data is available." }, "local": { "type": "object", "properties": { "currency": { "type": [ "string", "null" ], "description": "ISO 4217 currency code for the listing price." }, "amount": { "type": [ "number", "null" ], "description": "Numeric listing price amount." } }, "description": "Listing price in the local market currency." } }, "required": [ "usd", "local" ], "description": "Latest absolute price change in USD and local currency." }, "priceReductionNote": { "type": [ "string", "null" ], "description": "Formatted price-reduction note." }, "taxAssessedValue": { "type": [ "object", "null" ], "properties": { "usd": { "type": "object", "properties": { "currency": { "type": [ "string", "null" ], "description": "ISO 4217 currency code for the listing price." }, "amount": { "type": [ "number", "null" ], "description": "Numeric listing price amount." } }, "description": "Listing price converted to USD when conversion data is available." }, "local": { "type": "object", "properties": { "currency": { "type": [ "string", "null" ], "description": "ISO 4217 currency code for the listing price." }, "amount": { "type": [ "number", "null" ], "description": "Numeric listing price amount." } }, "description": "Listing price in the local market currency." } }, "required": [ "usd", "local" ], "description": "Tax-assessed property value in USD and local currency." }, "floorAreaSqFt": { "type": [ "integer", "null" ], "description": "Living area in square feet." }, "lotAreaSqFt": { "type": [ "number", "null" ], "description": "Lot size in square feet." }, "homeType": { "type": [ "string", "null" ], "description": "Property type label." }, "listingLifecycleStatus": { "type": [ "string", "null" ], "description": "Listing lifecycle status." }, "listingStatusLabel": { "type": [ "string", "null" ], "description": "Human-readable listing status label." }, "listingType": { "type": [ "string", "null" ], "description": "Listing type." }, "dateSold": { "type": [ "string", "null" ], "description": "Sold date." }, "datePriceChanged": { "type": [ "string", "null" ], "description": "Latest price-change date." }, "newConstructionType": { "type": [ "string", "null" ], "description": "New-construction type." }, "timeOnMarketDays": { "type": [ "integer", "null" ], "description": "Number of days this listing has been on market." }, "url": { "type": [ "string", "null" ], "description": "Listing URL." }, "thumbnailUrl": { "type": [ "string", "null" ], "description": "Listing thumbnail URL." }, "imageUrls": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Listing image URLs." }, "streetViewUrl": { "type": [ "string", "null" ], "description": "Street-view URL." }, "has3dModel": { "type": [ "boolean", "null" ], "description": "Whether a 3D model is available." }, "brokerName": { "type": [ "string", "null" ], "description": "Listing broker name." }, "builderName": { "type": [ "string", "null" ], "description": "Builder name." }, "isShowcaseListing": { "type": [ "boolean", "null" ], "description": "Whether the listing is marked as showcase." }, "isFeaturedListing": { "type": [ "boolean", "null" ], "description": "Whether the listing is marked as featured." }, "primaryTag": { "type": [ "object", "null" ], "properties": { "type": { "type": [ "string", "null" ] }, "text": { "type": [ "string", "null" ] } }, "description": "Primary listing tag." }, "listingTags": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "type": { "type": [ "string", "null" ] }, "text": { "type": [ "string", "null" ] } } }, "description": "Additional listing tags." }, "contactPhone": { "type": [ "string", "null" ], "description": "Listing contact phone number." }, "openHouse": { "type": [ "object", "null" ], "properties": { "description": { "type": [ "string", "null" ] }, "startDate": { "type": [ "string", "null" ] }, "endDate": { "type": [ "string", "null" ] } }, "description": "Open-house details." }, "buildingName": { "type": [ "string", "null" ], "description": "Building name." }, "rentalUnits": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "price": { "type": [ "object", "null" ], "properties": { "usd": { "type": "object", "properties": { "currency": { "type": [ "string", "null" ], "description": "ISO 4217 currency code for the listing price." }, "amount": { "type": [ "number", "null" ], "description": "Numeric listing price amount." } }, "description": "Listing price converted to USD when conversion data is available." }, "local": { "type": "object", "properties": { "currency": { "type": [ "string", "null" ], "description": "ISO 4217 currency code for the listing price." }, "amount": { "type": [ "number", "null" ], "description": "Numeric listing price amount." } }, "description": "Listing price in the local market currency." } }, "required": [ "usd", "local" ], "description": "Unit asking price in USD and local currency." }, "bedroomCount": { "type": [ "integer", "null" ], "description": "Number of bedrooms in the unit. 0 indicates a studio." }, "isRoomForRent": { "type": [ "boolean", "null" ], "description": "Whether the unit is a single room for rent." } } }, "description": "Individual rental units available in a multi-unit building." }, "availabilityCount": { "type": [ "integer", "null" ], "description": "Count of available units." }, "baseRent": { "type": [ "object", "null" ], "properties": { "min": { "type": [ "object", "null" ], "properties": { "usd": { "type": "object", "properties": { "currency": { "type": [ "string", "null" ], "description": "ISO 4217 currency code for the listing price." }, "amount": { "type": [ "number", "null" ], "description": "Numeric listing price amount." } }, "description": "Listing price converted to USD when conversion data is available." }, "local": { "type": "object", "properties": { "currency": { "type": [ "string", "null" ], "description": "ISO 4217 currency code for the listing price." }, "amount": { "type": [ "number", "null" ], "description": "Numeric listing price amount." } }, "description": "Listing price in the local market currency." } }, "required": [ "usd", "local" ], "description": "Minimum base rent in USD and local currency." }, "max": { "type": [ "object", "null" ], "properties": { "usd": { "type": "object", "properties": { "currency": { "type": [ "string", "null" ], "description": "ISO 4217 currency code for the listing price." }, "amount": { "type": [ "number", "null" ], "description": "Numeric listing price amount." } }, "description": "Listing price converted to USD when conversion data is available." }, "local": { "type": "object", "properties": { "currency": { "type": [ "string", "null" ], "description": "ISO 4217 currency code for the listing price." }, "amount": { "type": [ "number", "null" ], "description": "Numeric listing price amount." } }, "description": "Listing price in the local market currency." } }, "required": [ "usd", "local" ], "description": "Maximum base rent in USD and local currency." } }, "description": "Base-rent range in USD and local currency." }, "availabilityDate": { "type": [ "string", "null" ], "description": "Availability date." }, "isInstantTourEnabled": { "type": [ "boolean", "null" ], "description": "Whether instant tour is enabled." }, "factsAndFeatures": { "type": [ "object", "null" ], "additionalProperties": {}, "description": "Additional facts and features." }, "countryCode": { "type": [ "string", "null" ], "description": "ISO 3166-1 alpha-3 country code (for example: 'CAN')." }, "latitude": { "type": [ "number", "null" ], "description": "Latitude coordinate." }, "longitude": { "type": [ "number", "null" ], "description": "Longitude coordinate." } }, "required": [ "listingId" ] }, "description": "Properties returned for this page." }, "warnings": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Non-fatal advisories about how this page was served. For example, 'Sort \\'priceAscending\\' is applied from page 2 onwards.' when the requested sort cannot be honored on page 1. Omitted or null when there's nothing to flag." } }, "required": [ "runId", "properties" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # financialInstrumentLookup `POST /v1/finance/instrument` **Tags:** `Market intelligence` Look up a financial instrument **Endpoint:** `https://api.fiber.ai/v1/finance/instrument` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: 2 credits per financial instrument lookup ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "instrument": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "index" ] }, "index": { "type": "string", "enum": [ "SP_500", "DOW_JONES", "NASDAQ_100", "NASDAQ_COMPOSITE", "RUSSELL_1000", "RUSSELL_2000", "RUSSELL_3000", "FTSE_100" ], "description": "Named market index preset." } }, "required": [ "type", "index" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "mutualFund" ] }, "ticker": { "type": "string", "minLength": 1, "description": "Mutual fund ticker (e.g. `VTSAX`, `FXAIX`). This is for index funds and other mutual funds — NOT ETFs. ETFs like `SPY` or `QQQM` should use `stockOrEtf` instead." } }, "required": [ "type", "ticker" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "stockOrEtf" ] }, "ticker": { "type": "string", "minLength": 1, "description": "Ticker symbol for a stock or ETF (e.g. `AAPL`, `QQQM`, `BARC`)." }, "exchange": { "type": "string", "minLength": 1, "description": "Exchange code (e.g. `NASDAQ`, `NYSE`, `NYSEARCA`, `LON`, `TYO`)." } }, "required": [ "type", "ticker", "exchange" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "currencyPair" ] }, "base": { "type": "string", "minLength": 3, "description": "Base currency code. Fiat currencies are 3 letters (e.g. `USD`, `GBP`, `JPY`); crypto codes may be longer (e.g. `BTC`, `MATIC`, `USDC`)." }, "quote": { "type": "string", "minLength": 3, "description": "Quote currency code, using the same format as `base`." } }, "required": [ "type", "base", "quote" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "customSymbol" ] }, "symbol": { "type": "string", "minLength": 1, "maxLength": 64, "description": "Fully-qualified symbol using Google Finance's format. You are responsible for the correct syntax. Examples: `AAPL:NASDAQ` (stock), `SPY:NYSEARCA` (ETF), `VTSAX:MUTF` (mutual fund), `EUR-USD` (currency pair), `BTC-USD` (crypto), `NIFTY_50:INDEXNSE` (index)." } }, "required": [ "type", "symbol" ] } ], "description": "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." }, "window": { "type": [ "string", "null" ], "enum": [ "1D", "5D", "1M", "6M", "YTD", "1Y", "5Y", "MAX", null ], "description": "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." } }, "required": [ "apiKey", "instrument" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "instrument": { "type": [ "object", "null" ], "properties": { "name": { "type": [ "string", "null" ], "description": "Display name of the instrument (e.g. 'Alphabet Inc Class A')." }, "ticker": { "type": [ "string", "null" ], "description": "Ticker symbol without the exchange (e.g. 'GOOGL')." }, "exchange": { "type": [ "string", "null" ], "description": "Exchange code (e.g. 'NASDAQ')." }, "currency": { "type": [ "string", "null" ], "pattern": "^[A-Z]{3,6}$", "description": "Currency the quote is denominated in — fiat (e.g. 'USD', 'GBP') or crypto (e.g. 'BTC', 'USDC'). Minor-unit exchanges such as London in pence are converted to the major unit so every price matches this code." } }, "description": "Core identity of the looked-up instrument." }, "quote": { "type": [ "object", "null" ], "properties": { "price": { "type": [ "number", "null" ], "description": "Latest traded price as a number." }, "currency": { "type": [ "string", "null" ], "pattern": "^[A-Z]{3,6}$", "description": "Currency the price is denominated in — fiat (e.g. 'USD', 'GBP') or crypto (e.g. 'BTC', 'USDC')." }, "priceChange": { "type": [ "object", "null" ], "properties": { "percentage": { "type": [ "number", "null" ], "description": "Percent change versus the prior session." }, "amount": { "type": [ "number", "null" ], "description": "Absolute price change versus the prior session." }, "direction": { "type": [ "string", "null" ], "enum": [ "up", "down", null ], "description": "Whether the price moved up or down." }, "currency": { "type": [ "string", "null" ], "pattern": "^[A-Z]{3,6}$", "description": "Currency the price change amount and percentage are denominated in (e.g. 'USD', 'GBP')." } }, "description": "Magnitude and direction of the most recent price change." }, "quotedAt": { "type": [ "string", "null" ], "description": "ISO 8601 timestamp of when the quote was observed." } }, "description": "Latest regular-session quote." }, "extendedHoursQuote": { "type": [ "object", "null" ], "properties": { "price": { "type": [ "number", "null" ], "description": "Latest traded price as a number." }, "currency": { "type": [ "string", "null" ], "pattern": "^[A-Z]{3,6}$", "description": "Currency the price is denominated in — fiat (e.g. 'USD', 'GBP') or crypto (e.g. 'BTC', 'USDC')." }, "priceChange": { "type": [ "object", "null" ], "properties": { "percentage": { "type": [ "number", "null" ], "description": "Percent change versus the prior session." }, "amount": { "type": [ "number", "null" ], "description": "Absolute price change versus the prior session." }, "direction": { "type": [ "string", "null" ], "enum": [ "up", "down", null ], "description": "Whether the price moved up or down." }, "currency": { "type": [ "string", "null" ], "pattern": "^[A-Z]{3,6}$", "description": "Currency the price change amount and percentage are denominated in (e.g. 'USD', 'GBP')." } }, "description": "Magnitude and direction of the most recent price change." }, "quotedAt": { "type": [ "string", "null" ], "description": "ISO 8601 timestamp of when the quote was observed." } }, "description": "Extended-hours (pre/post-market) quote when reported separately." }, "keyStats": { "type": [ "object", "null" ], "properties": { "currency": { "type": [ "string", "null" ], "pattern": "^[A-Z]{3,6}$", "description": "Currency the price-denominated statistics are reported in (e.g. 'USD', 'BTC')." }, "open": { "type": [ "number", "null" ], "description": "Opening price for the current session." }, "high": { "type": [ "number", "null" ], "description": "Session high." }, "low": { "type": [ "number", "null" ], "description": "Session low." }, "marketCap": { "type": [ "number", "null" ], "description": "Market capitalization in the instrument's currency. Values from minor-unit exchanges are converted to major units." }, "averageVolume": { "type": [ "number", "null" ], "description": "Average trading volume." }, "volume": { "type": [ "number", "null" ], "description": "Current session volume." }, "dividendYieldPercentage": { "type": [ "number", "null" ], "description": "Dividend yield as a percentage (e.g. 0.26 for 0.26%)." }, "peRatio": { "type": [ "number", "null" ], "description": "Price-to-earnings ratio." }, "fiftyTwoWeekHigh": { "type": [ "number", "null" ], "description": "52-week high price." }, "fiftyTwoWeekLow": { "type": [ "number", "null" ], "description": "52-week low price." }, "earningsPerShare": { "type": [ "number", "null" ], "description": "Trailing earnings per share (EPS), denominated in the instrument's currency. EPS is the portion of a company's profit allocated to each outstanding share — higher values generally indicate stronger profitability." }, "beta": { "type": [ "number", "null" ], "description": "Beta relative to the market: a measure of how volatile the instrument is compared to the overall market. Beta > 1 means it tends to amplify market moves; beta < 1 means it tends to be more stable." }, "sharesOutstanding": { "type": [ "number", "null" ], "description": "Number of shares outstanding." } }, "description": "Typed key statistics when available." }, "companyInfo": { "type": [ "object", "null" ], "properties": { "description": { "type": [ "string", "null" ], "description": "Short company or fund description." }, "descriptionUrl": { "type": [ "string", "null" ], "description": "URL for the full company description." }, "ceoName": { "type": [ "string", "null" ], "description": "Chief executive officer name." }, "employeeCount": { "type": [ "integer", "null" ], "description": "Number of employees." }, "foundedDate": { "type": [ "string", "null" ], "description": "ISO 8601 founding date: full 'YYYY-MM-DD' when the day is known, otherwise just 'YYYY'." }, "headquarters": { "type": [ "string", "null" ], "description": "Headquarters location." }, "sector": { "type": [ "string", "null" ], "description": "Sector or industry classification." }, "websiteUrl": { "type": [ "string", "null" ], "description": "Company website URL." } }, "description": "Company information when available — description, leadership, sector, headquarters, etc." }, "financials": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "statement": { "type": "string", "enum": [ "incomeStatement", "balanceSheet", "cashFlow", "other" ], "description": "Which financial statement this group represents." }, "periods": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "periodEndDate": { "type": [ "string", "null" ], "description": "Calendar date the reporting period ended, as YYYY-MM-DD. Null when only a year or a quarter number is available, since the period's end depends on the company's fiscal calendar." }, "periodLabel": { "type": [ "string", "null" ], "description": "Period label such as 'Jun 2026', 'Q2 2026', or '2025'. Use periodEndDate to order or compare periods; a label may follow either the calendar year or the company's own fiscal year." }, "periodType": { "type": [ "string", "null" ], "enum": [ "quarterly", "annual", null ], "description": "Whether the period is quarterly or annual." }, "currency": { "type": [ "string", "null" ], "pattern": "^[A-Z]{3,6}$", "description": "Currency of the reported values." }, "lineItems": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ], "description": "Line-item name (e.g. 'Revenue')." }, "value": { "type": [ "number", "null" ], "description": "Reported value for the period." }, "changePercentage": { "type": [ "number", "null" ], "description": "Percent change versus the comparable prior period." } }, "description": "A single line item in a financial statement." }, "description": "Line items reported for this period." } }, "description": "One reporting period of statement data." }, "description": "Reporting periods included in this statement." } }, "required": [ "statement" ], "description": "A grouped financial statement with its reporting periods." }, "description": "Quarterly and annual financial statements when available." }, "news": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ], "description": "Article headline." }, "url": { "type": [ "string", "null" ], "description": "URL of the article." }, "source": { "type": [ "string", "null" ], "description": "Publisher name." }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time", "description": "ISO 8601 publication timestamp (e.g. '2026-07-28T14:30:00Z')." }, "isPublishedAtEstimated": { "type": [ "boolean", "null" ], "description": "Whether the publishedAt value is an estimate (true) or the exact publication timestamp (false). An estimate means only an approximate time like a date or hour was available from the source." }, "thumbnailUrl": { "type": [ "string", "null" ], "description": "Thumbnail image URL." } }, "description": "A news article related to the instrument." }, "description": "Recent news articles related to the instrument." }, "priceHistory": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "price": { "type": [ "number", "null" ], "description": "Price at this point." }, "currency": { "type": [ "string", "null" ], "pattern": "^[A-Z]{3,6}$", "description": "Currency of the price." }, "at": { "type": [ "string", "null" ], "description": "ISO 8601 timestamp of the price point." }, "volume": { "type": [ "integer", "null" ], "description": "Trading volume at this point, when available." } }, "description": "A single point on the price history series." }, "description": "Recent price history for the instrument." } } }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # fireTrackerDummy `POST /v1/tracker/fire-dummy/{listId}` **Tags:** `Tracker` Fire test signals **Endpoint:** `https://api.fiber.ai/v1/tracker/fire-dummy/{listId}` ## Description Send test signals to validate your integration end-to-end. Add rules with `isDummy: true` to your list, then call this endpoint. Each dummy rule produces a synthetic signal and persists it to your account. If the list has no entities, a well-known example (Google for company lists, Bill Gates for person lists) is added automatically. **Via webhooks** — If you have a webhook endpoint configured, test signals are delivered immediately with `isDummy: true` in the payload so you can distinguish them from real signals. **Via API polling** — If you consume signals by polling the API, retrieve your test signals with `GET /v1/tracker/signals/:listId?filter=dummy`. This returns the same response format as production signals, so you can validate your parsing logic without needing a webhook endpoint. Completely free, re-triggerable with no cooldown, and has no effect on real monitoring. Dummy rules are never evaluated during normal scheduled runs. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | | `listId` | path | yes | The unique ID of the tracker list. | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "signals": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the generated signal." }, "ruleId": { "type": "string", "description": "ID of the dummy rule that produced this signal." }, "ruleType": { "type": "string", "description": "Rule type slug (e.g. person_connections_milestone)." }, "entityId": { "type": [ "string", "null" ], "description": "Tracked entity ID the signal is attached to. Null if the list has no entities." }, "summary": { "type": "string", "description": "Human-readable description of what changed." }, "changeData": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "description": "Structured payload describing what changed." }, "isDummy": { "type": "boolean", "enum": [ true ] }, "webhookDispatched": { "type": "boolean", "description": "Whether a webhook was dispatched for this signal." } }, "required": [ "id", "ruleId", "ruleType", "summary", "changeData", "isDummy", "webhookDispatched" ] } } }, "required": [ "signals" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # flightBookingOptions `POST /v1/flights/booking-options` **Tags:** `Market intelligence` Get flight booking options **Endpoint:** `https://api.fiber.ai/v1/flights/booking-options` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: 2 credits per lookup ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "bookingToken": { "type": "string", "minLength": 1, "description": "Booking token from the `bookingToken` field of an itinerary returned by the flight search endpoint (`POST /v1/flights/search`)." }, "trip": { "oneOf": [ { "type": "object", "properties": { "flightType": { "type": "string", "enum": [ "one_way" ] }, "departureAirports": { "type": "string", "description": "Airport(s) to search. Accepts a 3-letter IATA airport code (e.g. 'JFK'), a comma-separated IATA list to search multiple airports (e.g. 'JFK,LGA,EWR'), 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 for a city or metro (e.g. '/m/02_286'). Case-insensitive except Freebase IDs." }, "arrivalAirports": { "type": "string", "description": "Airport(s) to search. Accepts a 3-letter IATA airport code (e.g. 'JFK'), a comma-separated IATA list to search multiple airports (e.g. 'JFK,LGA,EWR'), 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 for a city or metro (e.g. '/m/02_286'). Case-insensitive except Freebase IDs." }, "outboundDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "ISO date in YYYY-MM-DD format (e.g. '2026-06-10')." } }, "required": [ "flightType", "departureAirports", "arrivalAirports", "outboundDate" ] }, { "type": "object", "properties": { "flightType": { "type": "string", "enum": [ "round_trip" ] }, "departureAirports": { "type": "string", "description": "Airport(s) to search. Accepts a 3-letter IATA airport code (e.g. 'JFK'), a comma-separated IATA list to search multiple airports (e.g. 'JFK,LGA,EWR'), 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 for a city or metro (e.g. '/m/02_286'). Case-insensitive except Freebase IDs." }, "arrivalAirports": { "type": "string", "description": "Airport(s) to search. Accepts a 3-letter IATA airport code (e.g. 'JFK'), a comma-separated IATA list to search multiple airports (e.g. 'JFK,LGA,EWR'), 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 for a city or metro (e.g. '/m/02_286'). Case-insensitive except Freebase IDs." }, "outboundDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "ISO date in YYYY-MM-DD format (e.g. '2026-06-10')." }, "returnDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "ISO date in YYYY-MM-DD format (e.g. '2026-06-10')." } }, "required": [ "flightType", "departureAirports", "arrivalAirports", "outboundDate", "returnDate" ] }, { "type": "object", "properties": { "flightType": { "type": "string", "enum": [ "multi_city" ] }, "segments": { "type": "array", "items": { "type": "object", "properties": { "departureAirports": { "type": "string", "description": "Airport(s) to search. Accepts a 3-letter IATA airport code (e.g. 'JFK'), a comma-separated IATA list to search multiple airports (e.g. 'JFK,LGA,EWR'), 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 for a city or metro (e.g. '/m/02_286'). Case-insensitive except Freebase IDs." }, "arrivalAirports": { "type": "string", "description": "Airport(s) to search. Accepts a 3-letter IATA airport code (e.g. 'JFK'), a comma-separated IATA list to search multiple airports (e.g. 'JFK,LGA,EWR'), 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 for a city or metro (e.g. '/m/02_286'). Case-insensitive except Freebase IDs." }, "outboundDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "ISO date in YYYY-MM-DD format (e.g. '2026-06-10')." } }, "required": [ "departureAirports", "arrivalAirports", "outboundDate" ] }, "minItems": 2, "maxItems": 5, "description": "Provide between 2 and 5 segments." } }, "required": [ "flightType", "segments" ] } ], "description": "Trip configuration. The shape is determined by flightType — see each variant for its required fields." }, "currencyCode": { "type": "string", "pattern": "^[A-Za-z]{3}$", "default": "USD", "description": "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." }, "searchMarketCountryCode": { "type": "string", "pattern": "^[A-Za-z]{3}$", "default": "USA", "description": "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." }, "languageCode": { "type": "string", "pattern": "^[a-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "default": "en", "description": "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'." } }, "required": [ "apiKey", "bookingToken", "trip" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "bookingOptions": { "type": "array", "items": { "type": "object", "properties": { "providerName": { "type": "string", "description": "Name of the airline or booking site selling this ticket (e.g. 'United', 'American')." }, "airlineLogoUrls": { "type": "array", "items": { "type": "string" }, "description": "Logos for the airline(s) or booking site(s) on this option. Multiple entries indicate a split booking across providers." }, "flightNumbers": { "type": "array", "items": { "type": "string" }, "description": "Flight numbers covered by this option (e.g. 'UA 2175')." }, "price": { "type": [ "integer", "null" ], "description": "Total price in whole currency units." }, "fareType": { "type": [ "string", "null" ], "description": "Fare class label (e.g. 'Basic Economy', 'Business')." }, "isSplitBooking": { "type": [ "boolean", "null" ], "description": "True when this option consists of separately-issued tickets across different providers (e.g. booking two separate one-way tickets on different airlines rather than a single connection). Split bookings carry higher disruption risk." }, "bookingLink": { "type": [ "object", "null" ], "properties": { "url": { "type": "string", "description": "URL to begin booking this option." }, "postData": { "type": [ "string", "null" ], "description": "Form-encoded body to POST to `url` to start the booking flow, when a POST request is required." } }, "required": [ "url" ], "description": "Link to book this option. When present, both `url` and optionally `postData` are available." }, "bookingPhone": { "type": [ "string", "null" ], "pattern": "^\\+[1-9]\\d{1,14}$", "description": "Phone number to book through this provider, in E.164 format (e.g. '+18005551212')." }, "estimatedPhoneServiceFee": { "type": [ "integer", "null" ], "description": "Estimated phone booking service fee in whole currency units, when phone booking is offered." }, "fareConditions": { "type": "array", "items": { "type": "string" }, "description": "Amenities and fare rules included or excluded (e.g. seat selection policy, change rules)." }, "baggageDetails": { "type": "array", "items": { "type": "string" }, "description": "Baggage allowances and fees as display strings (e.g. '1st checked bag: 75', '1 free carry-on')." } }, "required": [ "providerName", "airlineLogoUrls", "flightNumbers", "fareConditions", "baggageDetails" ] }, "description": "Purchasing options for the selected itinerary, each representing a specific provider × fare type combination (e.g. United Economy). Ordered best first. Empty when the itinerary is no longer bookable." }, "currencyCode": { "type": [ "string", "null" ], "pattern": "^[A-Z]{3}$", "description": "ISO 4217 currency code for prices in this response (e.g. 'USD', 'EUR', 'GBP')." } }, "required": [ "bookingOptions" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # flightSearch `POST /v1/flights/search` **Tags:** `Market intelligence` Search flights **Endpoint:** `https://api.fiber.ai/v1/flights/search` ## Description Searches flight itineraries between cities of interest and returns trips, fares, timing, etc. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: 2 credits per search ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "travelClass": { "type": [ "string", "null" ], "enum": [ "economy", "premiumEconomy", "business", "first", null ], "description": "Preferred cabin class. Omit to consider flights across all cabin classes." }, "adults": { "type": "integer", "minimum": 1, "maximum": 9, "default": 1, "description": "Number of adult passengers (ages 12+)." }, "children": { "type": "integer", "minimum": 0, "maximum": 8, "default": 0, "description": "Number of child passengers (ages 2-11)." }, "infantsInSeat": { "type": "integer", "minimum": 0, "maximum": 8, "default": 0, "description": "Number of infants (under 2) with their own seat." }, "infantsOnLap": { "type": "integer", "minimum": 0, "maximum": 8, "default": 0, "description": "Number of infants (under 2) on an adult's lap." }, "maxStops": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2, "description": "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." }, "sortBy": { "type": [ "string", "null" ], "enum": [ "top", "price", "departureTime", "arrivalTime", "duration", "emissions", null ], "description": "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": { "type": [ "object", "null" ], "properties": { "include": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Only return flights operated or marketed by these airlines. Pass 2-letter IATA airline codes (e.g. 'UA' for United, 'AA' for American, 'DL' for Delta, 'B6' for JetBlue). Case-insensitive." }, "exclude": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Exclude flights operated or marketed by these airlines. Pass 2-letter IATA airline codes (e.g. 'UA' for United, 'AA' for American, 'DL' for Delta, 'B6' for JetBlue). Case-insensitive." } }, "description": "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." }, "minCarryOnBags": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 5, "description": "Minimum carry-on bags the itinerary must include. Omit for no requirement." }, "minCheckedBags": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 5, "description": "Minimum checked bags the itinerary must include. Omit for no requirement. Honored on a best-effort basis: not every itinerary exposes checked-bag inclusion." }, "maxPrice": { "type": [ "integer", "null" ], "minimum": 1, "description": "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." }, "outboundTimeWindow": { "type": [ "object", "null" ], "properties": { "departure": { "type": [ "object", "null" ], "properties": { "startHour": { "type": "integer", "minimum": 0, "maximum": 23, "description": "Start of the hour range (inclusive), in 24-hour format." }, "endHour": { "type": "integer", "minimum": 0, "maximum": 23, "description": "End of the hour range (inclusive), in 24-hour format." } }, "required": [ "startHour", "endHour" ], "description": "Restrict departure times to this hour range." }, "arrival": { "type": [ "object", "null" ], "properties": { "startHour": { "type": "integer", "minimum": 0, "maximum": 23, "description": "Start of the hour range (inclusive), in 24-hour format." }, "endHour": { "type": "integer", "minimum": 0, "maximum": 23, "description": "End of the hour range (inclusive), in 24-hour format." } }, "required": [ "startHour", "endHour" ], "description": "Restrict arrival times to this hour range." } }, "description": "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." }, "returnTimeWindow": { "type": [ "object", "null" ], "properties": { "departure": { "type": [ "object", "null" ], "properties": { "startHour": { "type": "integer", "minimum": 0, "maximum": 23, "description": "Start of the hour range (inclusive), in 24-hour format." }, "endHour": { "type": "integer", "minimum": 0, "maximum": 23, "description": "End of the hour range (inclusive), in 24-hour format." } }, "required": [ "startHour", "endHour" ], "description": "Restrict departure times to this hour range." }, "arrival": { "type": [ "object", "null" ], "properties": { "startHour": { "type": "integer", "minimum": 0, "maximum": 23, "description": "Start of the hour range (inclusive), in 24-hour format." }, "endHour": { "type": "integer", "minimum": 0, "maximum": 23, "description": "End of the hour range (inclusive), in 24-hour format." } }, "required": [ "startHour", "endHour" ], "description": "Restrict arrival times to this hour range." } }, "description": "Time-of-day window for return flights (round-trip only). Both startHour and endHour must be provided together per sub-window." }, "layoverDuration": { "type": [ "object", "null" ], "properties": { "minMinutes": { "type": [ "integer", "null" ], "minimum": 30, "maximum": 1440, "description": "Minimum layover duration in minutes. Omit for no minimum." }, "maxMinutes": { "type": [ "integer", "null" ], "minimum": 30, "maximum": 1440, "description": "Maximum layover duration in minutes. Omit for no maximum." } }, "description": "Constrain layover duration. Omit to allow any layover length." }, "maxFlightDurationMinutes": { "type": [ "integer", "null" ], "minimum": 30, "maximum": 4320, "description": "Maximum total flight duration in minutes. Omit for no limit." }, "connectingAirports": { "type": [ "object", "null" ], "properties": { "include": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Only allow itineraries connecting through at least one of these IATA airports (e.g. 'DFW', 'SFO'). Nonstop flights and itineraries that don't match are filtered out. Narrow allowlists may return zero results. Case-insensitive." }, "exclude": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Drop itineraries connecting through any of these IATA airports (e.g. 'ORD', 'ATL'). Case-insensitive." } }, "description": "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." }, "onlyShowLowEmissionFlights": { "type": "boolean", "default": false, "description": "When true, only return flights with lower-than-typical carbon emissions. When false (default), return all flights." }, "showHidden": { "type": "boolean", "default": true, "description": "When true, include itineraries that would normally be hidden (e.g. very late or undesirable schedules)." }, "hideSeparateTickets": { "type": "boolean", "default": false, "description": "When true, drop itineraries that combine separately-issued tickets (which carry higher disruption risk)." }, "currencyCode": { "type": "string", "pattern": "^[A-Za-z]{3}$", "default": "USD", "description": "ISO 4217 currency code for prices in the response (e.g. 'EUR', 'GBP', 'CAD'). Case-insensitive. Defaults to USD." }, "searchMarketCountryCode": { "type": "string", "pattern": "^[A-Za-z]{3}$", "default": "USA", "description": "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." }, "languageCode": { "type": "string", "pattern": "^[a-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "default": "en", "description": "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'." }, "nextPageToken": { "type": [ "string", "null" ], "description": "Token to retrieve the next page. Pass as nextPageToken in the next request. Null if no more pages." }, "trip": { "oneOf": [ { "type": "object", "properties": { "flightType": { "type": "string", "enum": [ "one_way" ] }, "departureAirports": { "type": "string", "description": "Airport(s) to search. Accepts a 3-letter IATA airport code (e.g. 'JFK'), a comma-separated IATA list to search multiple airports (e.g. 'JFK,LGA,EWR'), 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 for a city or metro (e.g. '/m/02_286'). Case-insensitive except Freebase IDs." }, "arrivalAirports": { "type": "string", "description": "Airport(s) to search. Accepts a 3-letter IATA airport code (e.g. 'JFK'), a comma-separated IATA list to search multiple airports (e.g. 'JFK,LGA,EWR'), 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 for a city or metro (e.g. '/m/02_286'). Case-insensitive except Freebase IDs." }, "outboundDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "ISO date in YYYY-MM-DD format (e.g. '2026-06-10')." } }, "required": [ "flightType", "departureAirports", "arrivalAirports", "outboundDate" ] }, { "type": "object", "properties": { "flightType": { "type": "string", "enum": [ "round_trip" ] }, "departureAirports": { "type": "string", "description": "Airport(s) to search. Accepts a 3-letter IATA airport code (e.g. 'JFK'), a comma-separated IATA list to search multiple airports (e.g. 'JFK,LGA,EWR'), 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 for a city or metro (e.g. '/m/02_286'). Case-insensitive except Freebase IDs." }, "arrivalAirports": { "type": "string", "description": "Airport(s) to search. Accepts a 3-letter IATA airport code (e.g. 'JFK'), a comma-separated IATA list to search multiple airports (e.g. 'JFK,LGA,EWR'), 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 for a city or metro (e.g. '/m/02_286'). Case-insensitive except Freebase IDs." }, "outboundDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "ISO date in YYYY-MM-DD format (e.g. '2026-06-10')." }, "returnDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "ISO date in YYYY-MM-DD format (e.g. '2026-06-10')." } }, "required": [ "flightType", "departureAirports", "arrivalAirports", "outboundDate", "returnDate" ] }, { "type": "object", "properties": { "flightType": { "type": "string", "enum": [ "multi_city" ] }, "segments": { "type": "array", "items": { "type": "object", "properties": { "departureAirports": { "type": "string", "description": "Airport(s) to search. Accepts a 3-letter IATA airport code (e.g. 'JFK'), a comma-separated IATA list to search multiple airports (e.g. 'JFK,LGA,EWR'), 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 for a city or metro (e.g. '/m/02_286'). Case-insensitive except Freebase IDs." }, "arrivalAirports": { "type": "string", "description": "Airport(s) to search. Accepts a 3-letter IATA airport code (e.g. 'JFK'), a comma-separated IATA list to search multiple airports (e.g. 'JFK,LGA,EWR'), 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 for a city or metro (e.g. '/m/02_286'). Case-insensitive except Freebase IDs." }, "outboundDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "ISO date in YYYY-MM-DD format (e.g. '2026-06-10')." } }, "required": [ "departureAirports", "arrivalAirports", "outboundDate" ] }, "minItems": 2, "maxItems": 5, "description": "Provide between 2 and 5 segments." } }, "required": [ "flightType", "segments" ] } ], "description": "Trip configuration. The shape is determined by flightType — see each variant for its required fields." } }, "required": [ "apiKey", "trip" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "bestFlights": { "type": "array", "items": { "type": "object", "properties": { "segments": { "type": "array", "items": { "type": "object", "properties": { "departureAirport": { "type": "object", "properties": { "iataCode": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 3, "description": "3-letter IATA airport code (e.g. 'JFK', 'LAX', 'LHR')." }, "name": { "type": [ "string", "null" ], "description": "Airport display name." }, "localDateTime": { "type": [ "string", "null" ], "description": "Local departure or arrival datetime without timezone offset (format: YYYY-MM-DDTHH:mm:ss)." } }, "description": "Departure airport." }, "arrivalAirport": { "type": "object", "properties": { "iataCode": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 3, "description": "3-letter IATA airport code (e.g. 'JFK', 'LAX', 'LHR')." }, "name": { "type": [ "string", "null" ], "description": "Airport display name." }, "localDateTime": { "type": [ "string", "null" ], "description": "Local departure or arrival datetime without timezone offset (format: YYYY-MM-DDTHH:mm:ss)." } }, "description": "Arrival airport." }, "durationMinutes": { "type": [ "integer", "null" ], "description": "Segment duration in minutes." }, "airlineName": { "type": [ "string", "null" ], "description": "Operating airline name." }, "airlineLogoUrl": { "type": [ "string", "null" ], "description": "Operating airline logo URL." }, "travelClass": { "type": [ "string", "null" ], "description": "Cabin class as labeled in the search results (e.g. 'Economy', 'Premium Economy', 'Business', 'First')." }, "flightNumber": { "type": [ "string", "null" ], "description": "Flight number including airline code (e.g. 'UA 2175', 'DL 1384')." }, "aircraftModel": { "type": [ "string", "null" ], "description": "Aircraft model." }, "legroom": { "type": [ "string", "null" ], "description": "Legroom distance as reported by the airline (e.g. '32 in')." }, "isOvernight": { "type": [ "boolean", "null" ], "description": "True when this segment is overnight." }, "isOftenDelayed": { "type": [ "boolean", "null" ], "description": "True when this segment is frequently delayed." }, "carbonEmissionKg": { "type": [ "number", "null" ], "description": "Estimated carbon emissions in kilograms." } }, "required": [ "departureAirport", "arrivalAirport" ] }, "description": "Flight segments for this itinerary." }, "layovers": { "type": "array", "items": { "type": "object", "properties": { "iataCode": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 3, "description": "3-letter IATA code of the layover airport (e.g. 'DFW', 'ORD')." }, "airportName": { "type": [ "string", "null" ], "description": "Layover airport name." }, "durationMinutes": { "type": [ "integer", "null" ], "description": "Layover duration in minutes." }, "isOvernight": { "type": [ "boolean", "null" ], "description": "True when layover spans overnight." } } }, "description": "Layovers for this itinerary." }, "totalDurationMinutes": { "type": [ "integer", "null" ], "description": "Total itinerary duration in minutes." }, "price": { "type": [ "integer", "null" ], "description": "Total itinerary price in whole currency units." }, "bookingToken": { "type": [ "string", "null" ], "description": "Opaque booking token. Pass as `bookingToken` in POST /v1/flights/booking-options to retrieve booking options for this itinerary." }, "flightType": { "type": [ "string", "null" ], "enum": [ "one_way", "round_trip", "multi_city", null ], "description": "Trip type for this itinerary." }, "mainAirlineLogoUrl": { "type": [ "string", "null" ], "description": "Logo URL for the primary airline on this itinerary. For multi-airline itineraries this may be a generic multi-carrier logo." }, "carbonEmissions": { "type": [ "object", "null" ], "properties": { "thisFlightKg": { "type": [ "integer", "null" ], "description": "Estimated emissions for this itinerary in kilograms." }, "typicalForRouteKg": { "type": [ "integer", "null" ], "description": "Typical route emissions in kilograms." }, "differencePercent": { "type": [ "number", "null" ], "description": "Percent difference versus typical route emissions. Negative means lower than typical, positive means higher." } }, "description": "Carbon emissions summary for this itinerary." }, "alsoSoldBy": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Full names of other airlines that also sell this itinerary (e.g. 'United', 'Korean Air')." }, "operatingCarrier": { "type": [ "string", "null" ], "description": "Full name of the airline operating the aircraft and crew, when it differs from the marketing airline (e.g. 'Envoy Air' operating on behalf of American Airlines)." } }, "required": [ "segments", "layovers" ] }, "description": "Best flight itineraries for this query." }, "otherFlights": { "type": "array", "items": { "type": "object", "properties": { "segments": { "type": "array", "items": { "type": "object", "properties": { "departureAirport": { "type": "object", "properties": { "iataCode": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 3, "description": "3-letter IATA airport code (e.g. 'JFK', 'LAX', 'LHR')." }, "name": { "type": [ "string", "null" ], "description": "Airport display name." }, "localDateTime": { "type": [ "string", "null" ], "description": "Local departure or arrival datetime without timezone offset (format: YYYY-MM-DDTHH:mm:ss)." } }, "description": "Departure airport." }, "arrivalAirport": { "type": "object", "properties": { "iataCode": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 3, "description": "3-letter IATA airport code (e.g. 'JFK', 'LAX', 'LHR')." }, "name": { "type": [ "string", "null" ], "description": "Airport display name." }, "localDateTime": { "type": [ "string", "null" ], "description": "Local departure or arrival datetime without timezone offset (format: YYYY-MM-DDTHH:mm:ss)." } }, "description": "Arrival airport." }, "durationMinutes": { "type": [ "integer", "null" ], "description": "Segment duration in minutes." }, "airlineName": { "type": [ "string", "null" ], "description": "Operating airline name." }, "airlineLogoUrl": { "type": [ "string", "null" ], "description": "Operating airline logo URL." }, "travelClass": { "type": [ "string", "null" ], "description": "Cabin class as labeled in the search results (e.g. 'Economy', 'Premium Economy', 'Business', 'First')." }, "flightNumber": { "type": [ "string", "null" ], "description": "Flight number including airline code (e.g. 'UA 2175', 'DL 1384')." }, "aircraftModel": { "type": [ "string", "null" ], "description": "Aircraft model." }, "legroom": { "type": [ "string", "null" ], "description": "Legroom distance as reported by the airline (e.g. '32 in')." }, "isOvernight": { "type": [ "boolean", "null" ], "description": "True when this segment is overnight." }, "isOftenDelayed": { "type": [ "boolean", "null" ], "description": "True when this segment is frequently delayed." }, "carbonEmissionKg": { "type": [ "number", "null" ], "description": "Estimated carbon emissions in kilograms." } }, "required": [ "departureAirport", "arrivalAirport" ] }, "description": "Flight segments for this itinerary." }, "layovers": { "type": "array", "items": { "type": "object", "properties": { "iataCode": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 3, "description": "3-letter IATA code of the layover airport (e.g. 'DFW', 'ORD')." }, "airportName": { "type": [ "string", "null" ], "description": "Layover airport name." }, "durationMinutes": { "type": [ "integer", "null" ], "description": "Layover duration in minutes." }, "isOvernight": { "type": [ "boolean", "null" ], "description": "True when layover spans overnight." } } }, "description": "Layovers for this itinerary." }, "totalDurationMinutes": { "type": [ "integer", "null" ], "description": "Total itinerary duration in minutes." }, "price": { "type": [ "integer", "null" ], "description": "Total itinerary price in whole currency units." }, "bookingToken": { "type": [ "string", "null" ], "description": "Opaque booking token. Pass as `bookingToken` in POST /v1/flights/booking-options to retrieve booking options for this itinerary." }, "flightType": { "type": [ "string", "null" ], "enum": [ "one_way", "round_trip", "multi_city", null ], "description": "Trip type for this itinerary." }, "mainAirlineLogoUrl": { "type": [ "string", "null" ], "description": "Logo URL for the primary airline on this itinerary. For multi-airline itineraries this may be a generic multi-carrier logo." }, "carbonEmissions": { "type": [ "object", "null" ], "properties": { "thisFlightKg": { "type": [ "integer", "null" ], "description": "Estimated emissions for this itinerary in kilograms." }, "typicalForRouteKg": { "type": [ "integer", "null" ], "description": "Typical route emissions in kilograms." }, "differencePercent": { "type": [ "number", "null" ], "description": "Percent difference versus typical route emissions. Negative means lower than typical, positive means higher." } }, "description": "Carbon emissions summary for this itinerary." }, "alsoSoldBy": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Full names of other airlines that also sell this itinerary (e.g. 'United', 'Korean Air')." }, "operatingCarrier": { "type": [ "string", "null" ], "description": "Full name of the airline operating the aircraft and crew, when it differs from the marketing airline (e.g. 'Envoy Air' operating on behalf of American Airlines)." } }, "required": [ "segments", "layovers" ] }, "description": "Additional flight itineraries for this query." }, "nextPageToken": { "type": [ "string", "null" ], "description": "Token to retrieve the next page. Pass as `nextPageToken` in the next request. Null if no more pages." }, "currencyCode": { "type": [ "string", "null" ], "pattern": "^[A-Z]{3}$", "description": "ISO 4217 currency code for prices in this response (e.g. 'USD', 'EUR', 'GBP')." }, "priceInsights": { "type": [ "object", "null" ], "properties": { "lowestPrice": { "type": [ "integer", "null" ], "description": "Lowest observed price for this query." }, "priceLevel": { "type": [ "string", "null" ], "enum": [ "low", "typical", "high", null ], "description": "How the current price compares to historical prices for this route." }, "typicalPriceRange": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "integer", "null" ], "description": "Lower bound of the typical price range." }, "upperBound": { "type": [ "integer", "null" ], "description": "Upper bound of the typical price range." } }, "description": "Typical price range for this route in whole currency units." }, "history": { "type": "array", "items": { "type": "object", "properties": { "snapshotDate": { "type": [ "string", "null" ], "description": "Date this price was observed (e.g. '2024-09-19')." }, "price": { "type": "integer", "description": "Observed price in whole currency units." } }, "required": [ "price" ] }, "description": "Historical prices for this route." } }, "required": [ "history" ], "description": "Price-insight summary for this route query." }, "airports": { "type": "array", "items": { "type": "object", "properties": { "departure": { "type": "array", "items": { "type": "object", "properties": { "iataCode": { "type": [ "string", "null" ], "description": "IATA airport code (e.g. 'JFK'). When the search targeted a metro area via an X- alias or Freebase ID input, this will be a Freebase ID (e.g. '/m/02_286') representing the metro rather than a single airport." }, "name": { "type": [ "string", "null" ], "description": "Airport name." }, "city": { "type": [ "string", "null" ], "description": "City name." }, "countryCode": { "type": [ "string", "null" ], "description": "ISO 3166-1 alpha-3 country code (e.g. 'USA', 'GBR')." } } }, "description": "Departure airport options matched for this query." }, "arrival": { "type": "array", "items": { "type": "object", "properties": { "iataCode": { "type": [ "string", "null" ], "description": "IATA airport code (e.g. 'JFK'). When the search targeted a metro area via an X- alias or Freebase ID input, this will be a Freebase ID (e.g. '/m/02_286') representing the metro rather than a single airport." }, "name": { "type": [ "string", "null" ], "description": "Airport name." }, "city": { "type": [ "string", "null" ], "description": "City name." }, "countryCode": { "type": [ "string", "null" ], "description": "ISO 3166-1 alpha-3 country code (e.g. 'USA', 'GBR')." } } }, "description": "Arrival airport options matched for this query." } }, "required": [ "departure", "arrival" ] }, "description": "Airports recognized for departure and arrival in this query." } }, "required": [ "bestFlights", "otherFlights", "airports" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getAccelerators `GET /v1/enums/accelerators` **Tags:** `Enums` List accelerators **Endpoint:** `https://api.fiber.ai/v1/enums/accelerators` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "array", "items": { "type": "object", "properties": { "acceleratorSlug": { "type": "string", "description": "The accelerator identifier (e.g., 'y_combinator')" }, "acceleratorName": { "type": "string", "description": "The human-readable accelerator name (e.g., 'Y Combinator')" }, "numCompanies": { "type": "integer", "minimum": 0, "description": "Total number of companies in this accelerator" }, "batches": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "batch": { "type": "string", "description": "The batch name (e.g., 'Winter 2023', 'Spring 2025')" }, "numCompanies": { "type": "integer", "minimum": 0, "description": "Number of companies in this batch for this accelerator" } }, "required": [ "batch", "numCompanies" ] }, "description": "List of batches with company counts for this accelerator. Null if the accelerator doesn't use batches." }, "years": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "year": { "type": "integer", "minimum": 2000, "maximum": 2027, "description": "The year the companies participated in the accelerator" }, "numCompanies": { "type": "integer", "minimum": 0, "description": "Number of companies in this year for this accelerator" } }, "required": [ "year", "numCompanies" ] }, "description": "List of years with company counts for this accelerator. Null if the accelerator doesn't track years." }, "logoUrl": { "type": [ "string", "null" ], "description": "URL to the accelerator's logo image" }, "website": { "type": [ "string", "null" ], "description": "The accelerator's website URL (includes https:// and www. if applicable)" }, "otherNames": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Alternate names for the accelerator (e.g., 'YC' for 'Y Combinator')" } }, "required": [ "acceleratorSlug", "acceleratorName", "numCompanies" ] }, "description": "List of all accelerators with their metadata and company statistics" }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getAllApiKeys `POST /v1/api-keys` **Tags:** `API key` List API keys **Endpoint:** `https://api.fiber.ai/v1/api-keys` ## Description 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. ⚡ Rate limit: 30 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "includeRevoked": { "type": "boolean", "default": false, "description": "Include revoked keys in the results. Defaults to false, returning only active keys." } }, "required": [ "apiKey" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "apiKeys": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "id of your api key. This or prefix can be used to identify the key." }, "name": { "type": "string", "description": "Name of your api key." }, "prefix": { "type": "string", "description": "Non secret prefix of your api key. Used for identification." }, "expiresAt": { "type": [ "string", "null" ], "format": "date-time", "description": "When the key expires. Null implies key never expires." }, "maxCredits": { "type": [ "number", "null" ], "minimum": 0, "description": "The lifetime credit ceiling for this key. Null implies key has no per-key credit limit." }, "creditsUsed": { "type": "number", "minimum": 0, "description": "Credits consumed by this key so far over its lifetime." }, "createdAt": { "type": "string", "format": "date-time", "description": "When the key was created, as an ISO 8601 timestamp." }, "isRevoked": { "type": "boolean", "description": "Whether the key has been revoked. Revoked keys can no longer authenticate. Only ever true in listings that include revoked keys." } }, "required": [ "id", "name", "prefix", "expiresAt", "maxCredits", "creditsUsed", "createdAt", "isRevoked" ] }, "description": "Every API key belonging to your organization." } }, "required": [ "apiKeys" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getAudienceCompanies `GET /v1/audiences/{audienceId}/companies` **Tags:** `Audiences` Get companies in an audience **Endpoint:** `https://api.fiber.ai/v1/audiences/{audienceId}/companies` ## Description Gets the companies in an audience with pagination. Use the nextCursor from the response to fetch the next page. Pass your apiKey in the query string. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | | `pageSize` | query | no | The number of companies to return per page (max 500). | | `cursor` | query | no | The pagination cursor from the previous page. | | `audienceId` | path | yes | The unique ID of the audience. | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "audienceId": { "type": "string", "description": "The ID of the audience." }, "companies": { "type": "array", "items": { "type": "object", "properties": { "companyId": { "type": "string", "description": "The unique ID of the company." }, "name": { "type": [ "string", "null" ], "description": "The company name." }, "linkedinUrl": { "type": [ "string", "null" ], "description": "The company LinkedIn URL." }, "domain": { "type": [ "string", "null" ], "description": "The company domain." }, "industry": { "type": [ "string", "null" ], "description": "The company industry." }, "headcount": { "type": [ "number", "null" ], "description": "The employee count." } }, "required": [ "companyId" ] }, "description": "The list of companies." }, "totalCount": { "type": "number", "description": "The total number of companies in the audience." }, "nextCursor": { "type": [ "string", "null" ], "description": "The pagination cursor for the next page." }, "hasMore": { "type": "boolean", "description": "Whether there are more results available." } }, "required": [ "audienceId", "companies", "totalCount", "hasMore" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getAudienceProspects `GET /v1/audiences/{audienceId}/prospects` **Tags:** `Audiences` Get prospects in an audience **Endpoint:** `https://api.fiber.ai/v1/audiences/{audienceId}/prospects` ## Description Gets the prospects (people) in an audience with pagination. Use the nextCursor from the response to fetch the next page. Pass your apiKey in the query string. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | | `pageSize` | query | no | The number of prospects to return per page (max 500). | | `cursor` | query | no | The pagination cursor from the previous page. | | `audienceId` | path | yes | The unique ID of the audience. | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "audienceId": { "type": "string", "description": "The ID of the audience." }, "prospects": { "type": "array", "items": { "type": "object", "properties": { "prospectId": { "type": "string", "description": "The unique ID of the prospect." }, "firstName": { "type": [ "string", "null" ], "description": "The prospect's first name." }, "lastName": { "type": [ "string", "null" ], "description": "The prospect's last name." }, "linkedinUrl": { "type": [ "string", "null" ], "description": "The prospect's LinkedIn URL." }, "jobTitle": { "type": [ "string", "null" ], "description": "The prospect's job title." }, "companyName": { "type": [ "string", "null" ], "description": "The prospect's current company name." }, "location": { "type": [ "string", "null" ], "description": "The prospect's location." } }, "required": [ "prospectId" ] }, "description": "The list of prospects." }, "totalCount": { "type": "number", "description": "The total number of prospects in the audience." }, "nextCursor": { "type": [ "string", "null" ], "description": "The pagination cursor for the next page." }, "hasMore": { "type": "boolean", "description": "Whether there are more results available." } }, "required": [ "audienceId", "prospects", "totalCount", "hasMore" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getAudienceStatus `GET /v1/audiences/{audienceId}/status` **Tags:** `Audiences` Get audience status **Endpoint:** `https://api.fiber.ai/v1/audiences/{audienceId}/status` ## Description 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). Pass your apiKey in the query string. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | | `audienceId` | path | yes | The unique ID of the audience. | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "audienceId": { "type": "string", "description": "The unique ID of the audience." }, "name": { "type": "string", "description": "The name of the audience." }, "status": { "type": "string", "enum": [ "NORMAL", "HEALING_COMPANIES", "DRAFT", "BUILDING", "SAVING_COMPANIES", "SAVING_PROSPECTS", "LINKING_PROSPECTS_WITH_COMPANIES", "FAILED" ], "description": "The current status of the audience." }, "creationMethod": { "type": "string", "enum": [ "NORMAL", "COMPANY_UPLOAD", "PROSPECT_UPLOAD", "START_FROM_PROSPECTS", "FOLLOW_ME", "INDIVIDUAL_SALES_NAV_SCRAPE", "MERGE_AUDIENCES", "BATCH_ENRICHMENT", "CLONED", "SALES_NAV_COMPANIES", "SALES_NAV_PROFILES" ], "description": "The method used to create the audience." }, "createdAt": { "type": "string", "description": "The timestamp when the audience was created." }, "buildingStartedAt": { "type": [ "string", "null" ], "description": "The timestamp when the audience build started." }, "buildingFinishedAt": { "type": [ "string", "null" ], "description": "The timestamp when the audience build finished." }, "companiesCount": { "type": [ "number", "null" ], "description": "The number of companies in the audience." }, "prospectsCount": { "type": [ "number", "null" ], "description": "The number of prospects in the audience." } }, "required": [ "audienceId", "name", "status", "creationMethod", "createdAt" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getAutoTopupSettings `GET /v1/auto-topup/settings` **Tags:** `Account` Get auto top-up settings **Endpoint:** `https://api.fiber.ai/v1/auto-topup/settings` ## Description Get the organization's auto top-up configuration. When configured is false, no auto top-up settings exist yet. ⚡ Rate limit: 10 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "settings": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "configured": { "type": "boolean", "enum": [ true ] }, "subscriptionId": { "type": "string", "description": "The subscription these auto top-up settings belong to" }, "isEnabled": { "type": "boolean", "description": "Whether auto top-up is currently enabled for this organization" }, "creditThreshold": { "type": "integer", "exclusiveMinimum": 0, "description": "Credit balance threshold below which auto top-up triggers" }, "creditsToBuy": { "type": "integer", "minimum": 1000, "maximum": 1000000, "description": "Number of credits purchased when auto top-up triggers" }, "maxPerDay": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Maximum number of auto top-ups allowed in a rolling 24-hour window. When reached, auto top-up pauses until the window passes. Leave as null to not enforce daily limit." }, "maxPerMonth": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Maximum number of auto top-ups allowed per calendar month (UTC). When reached, auto top-up pauses until the next calendar month. Leave as null to not enforce monthly limit." } }, "required": [ "configured", "subscriptionId", "isEnabled", "creditThreshold", "creditsToBuy" ] }, { "type": "object", "properties": { "configured": { "type": "boolean", "enum": [ false ] }, "subscriptionId": { "type": "string", "description": "The subscription these auto top-up settings belong to" } }, "required": [ "configured", "subscriptionId" ] } ] }, "description": "Auto top-up settings per subscription" } }, "required": [ "settings" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getCompanyExclusionLists `POST /v1/exclusions/companies/get-lists` **Tags:** `Exclusions` Get company exclusion list **Endpoint:** `https://api.fiber.ai/v1/exclusions/companies/get-lists` ## Description Get company exclusion list ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" } }, "required": [ "apiKey" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "array", "items": { "type": "object", "properties": { "listID": { "type": "string", "description": "The ID of the company exclusion list." }, "name": { "type": "string", "description": "The name of the company exclusion list." } }, "required": [ "listID", "name" ] } }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getCompanyRevenue `POST /v1/company-revenue` **Tags:** `Company info` Get company revenue estimate **Endpoint:** `https://api.fiber.ai/v1/company-revenue` ## Description Fetches the most recent annual revenue estimate for a company. Pass a LinkedIn company URL, domain, and/or company name. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: 4 credits per company lookup ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "companyMetadata": { "type": "object", "properties": { "name": { "type": [ "string", "null" ], "minLength": 1, "description": "Company display name (optional, helps disambiguate)" }, "domain": { "type": [ "string", "null" ], "minLength": 1, "description": "Company website domain (e.g. 'openai.com'), optional" }, "linkedinUrl": { "type": [ "string", "null" ], "minLength": 1, "description": "LinkedIn company URL or slug (e.g. 'https://www.linkedin.com/company/openai' or 'openai')" }, "linkedinOrgId": { "type": [ "string", "null" ], "minLength": 1, "description": "LinkedIn numeric organization ID (e.g. '1441'), optional" } } } }, "required": [ "apiKey", "companyMetadata" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "company": { "type": "object", "properties": { "linkedinUrl": { "type": "string", "minLength": 1, "description": "LinkedIn company URL (e.g. 'https://www.linkedin.com/company/openai')" }, "linkedinOrgId": { "type": "string", "minLength": 1, "description": "LinkedIn organization ID, if known" }, "name": { "type": [ "string", "null" ], "minLength": 1, "description": "Company display name, if known" }, "domain": { "type": [ "string", "null" ], "minLength": 1, "description": "Company website domain, if known" } }, "required": [ "linkedinUrl", "linkedinOrgId" ] }, "revenueInfo": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": "number", "description": "Lower bound of the annual revenue estimate in USD" }, "upperBound": { "type": "number", "description": "Upper bound of the annual revenue estimate in USD" }, "fiscalYear": { "type": "number", "description": "Fiscal year the revenue figure corresponds to. Often (but not always) the most recent completed calendar year (e.g. 2025 as of 2026)." }, "citations": { "type": "array", "items": { "type": "string" }, "description": "Source URLs used to derive the revenue estimate. May be empty when the revenue figure is common knowledge to the AI model and no web sources were needed." }, "comments": { "type": [ "string", "null" ], "description": "Additional context about the revenue data" } }, "required": [ "lowerBound", "upperBound", "fiscalYear", "citations" ], "description": "Revenue information. Null means the company was found but no public revenue data is available." } }, "required": [ "company" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getCurrentApiKey `POST /v1/api-keys/current` **Tags:** `API key` Get API key **Endpoint:** `https://api.fiber.ai/v1/api-keys/current` ## Description 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. ⚡ Rate limit: 30 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "target": { "type": "string", "enum": [ "SELF", "OTHER" ], "default": "SELF", "description": "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." }, "targetApiKey": { "type": [ "string", "null" ], "minLength": 1, "description": "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." } }, "required": [ "apiKey" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "id": { "type": "string", "description": "id of your api key. This or prefix can be used to identify the key." }, "name": { "type": "string", "description": "Name of your api key." }, "prefix": { "type": "string", "description": "Non secret prefix of your api key. Used for identification." }, "expiresAt": { "type": [ "string", "null" ], "format": "date-time", "description": "When the key expires. Null implies key never expires." }, "maxCredits": { "type": [ "number", "null" ], "minimum": 0, "description": "The lifetime credit ceiling for this key. Null implies key has no per-key credit limit." }, "creditsUsed": { "type": "number", "minimum": 0, "description": "Credits consumed by this key so far over its lifetime." }, "createdAt": { "type": "string", "format": "date-time", "description": "When the key was created, as an ISO 8601 timestamp." }, "isRevoked": { "type": "boolean", "description": "Whether the key has been revoked. Revoked keys can no longer authenticate. Only ever true in listings that include revoked keys." } }, "required": [ "id", "name", "prefix", "expiresAt", "maxCredits", "creditsUsed", "createdAt", "isRevoked" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getCurrentCompaniesInSavedSearch `POST /v1/saved-search/current/companies` **Tags:** `Saved search` Get current companies in saved search **Endpoint:** `https://api.fiber.ai/v1/saved-search/current/companies` ## Description Get current companies found for a specific saved search ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "savedSearchId": { "type": "string", "description": "The ID of the saved search" }, "statuses": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "joined", "returned", "departed", "stayed" ] }, "minItems": 1, "description": "The statuses of the companies. This is optional and if not provided, all current companies will be returned." }, "cursor": { "type": [ "string", "null" ], "description": "The cursor to start from" }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25, "description": "The number of companies to return" } }, "required": [ "apiKey", "savedSearchId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "companies": { "type": "array", "items": { "type": "object", "properties": { "linkedin_id": { "type": [ "string", "null" ] }, "accelerator_statuses": { "type": [ "array", "null" ], "items": { "type": "string" } }, "accelerators": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "slug": { "type": [ "string", "null" ] }, "tags": { "type": [ "array", "null" ], "items": { "type": "string" } }, "year": { "type": [ "number", "null" ] }, "batch": { "type": [ "string", "null" ] }, "founders": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "full_name": { "type": [ "string", "null" ] }, "bio": { "type": [ "string", "null" ] }, "job_title": { "type": [ "string", "null" ] }, "is_active": { "type": [ "boolean", "null" ] }, "email_address": { "type": [ "string", "null" ] }, "facebook_url": { "type": [ "string", "null" ] }, "twitter_handle": { "type": [ "string", "null" ] }, "linkedin_slug": { "type": [ "string", "null" ] }, "github_username": { "type": [ "string", "null" ] } } } }, "description": { "type": [ "string", "null" ] }, "one_liner": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "company_domain": { "type": [ "string", "null" ] }, "accelerator_name": { "type": [ "string", "null" ] }, "accelerator_domain": { "type": [ "string", "null" ] } } } }, "blog_urls": { "type": [ "array", "null" ], "items": { "type": "string" } }, "custom_data": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "emails": { "type": [ "array", "null" ], "items": { "type": "string" } }, "phone_numbers": { "type": [ "array", "null" ], "items": { "type": "string" } }, "employee_count_consensus": { "type": [ "object", "null" ], "properties": { "gte": { "type": [ "number", "null" ] }, "lte": { "type": [ "number", "null" ] } } }, "facebook_urls": { "type": [ "array", "null" ], "items": { "type": "string" } }, "fortune_rankings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "list": { "type": "string", "enum": [ "fortune-500-usa", "forbes-global-2000" ] }, "year": { "type": "number" }, "rank": { "type": "number" } }, "required": [ "list", "year", "rank" ] } }, "founded_on_consensus": { "type": [ "string", "null" ] }, "github_usernames": { "type": [ "array", "null" ], "items": { "type": "string" } }, "instagram_handles": { "type": [ "array", "null" ], "items": { "type": "string" } }, "latest_funding_consensus": { "type": [ "number", "null" ] }, "linkedin_slugs": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "li_org_id": { "type": [ "string", "null" ] }, "li_category": { "type": [ "string", "null" ], "enum": [ "W", "S", "C", null ] }, "li_job_posts_stats": { "type": [ "object", "null" ], "properties": { "total_count": { "type": "number" }, "seniority_stats": { "type": [ "object", "null" ], "properties": { "Entry level": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Director": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Associate": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Mid-Senior level": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Internship": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Executive": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Not Applicable": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] } }, "additionalProperties": false }, "employment_type_stats": { "type": [ "object", "null" ], "properties": { "Full-time": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Temporary": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Internship": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Contract": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Part-time": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Volunteer": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Other": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] } }, "additionalProperties": false }, "country_location_stats": { "type": [ "object", "null" ], "properties": { "USA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GBR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "FRA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IND": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BRA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "DEU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ESP": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CAN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "AUS": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NLD": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ITA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ZAF": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BEL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CHN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "TUR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MEX": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CHE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NOR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ARE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SWE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "POL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IDN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ARG": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PRT": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "COL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CHL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PAK": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "DNK": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "JPN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NGA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SGP": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PER": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NZL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "AUT": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IRL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MYS": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BGD": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "EGY": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ISR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SAU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PHL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "FIN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IRN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ROU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CZE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GRC": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "HKG": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "HUN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "KEN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MAR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "VNM": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "RUS": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "UKR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ECU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "THA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LKA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "KOR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BGR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GHA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SRB": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "TWN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "HRV": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LTU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PRI": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SVK": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "TUN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "EST": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "VEN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CRI": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PAN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "URY": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LBN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LUX": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CYP": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NPL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "JOR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SVN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MTQ": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "QAT": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GLP": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "UGA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "DZA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GTM": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CMR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LVA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "DOM": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "AZE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GEO": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SEN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "TZA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ZWE": { "type": "object", "properties": { "count": { "type": "number" }, "fr … _truncated to 65536 chars for ai-docs._ ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getCurrentProfilesInSavedSearch `POST /v1/saved-search/current/profiles` **Tags:** `Saved search` Get current profiles in saved search **Endpoint:** `https://api.fiber.ai/v1/saved-search/current/profiles` ## Description Get current profiles found for a specific saved search ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "savedSearchId": { "type": "string", "description": "The ID of the saved search" }, "statuses": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "joined", "returned", "departed", "stayed" ] }, "minItems": 1, "description": "The statuses of the profiles. This is optional and if not provided, all current profiles will be returned." }, "cursor": { "type": [ "string", "null" ], "description": "The cursor to start from" }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25, "description": "The number of profiles to return" } }, "required": [ "apiKey", "savedSearchId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "profiles": { "type": "array", "items": { "type": "object", "properties": { "articles": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "date_published": { "type": [ "string", "null" ] } } } }, "certifications": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "credential_id": { "type": [ "string", "null" ] }, "verify_url": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "date": { "type": [ "string", "null" ] } } } }, "connection_count": { "type": [ "number", "null" ] }, "courses": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "course_number": { "type": [ "string", "null" ] }, "association": { "type": "null" } } } }, "dob": { "type": [ "string", "null" ] }, "education": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "school_id": { "type": [ "string", "null" ] }, "school_name": { "type": [ "string", "null" ] }, "field_of_study_id": { "type": [ "string", "null" ] }, "field_of_study_name": { "type": [ "string", "null" ] }, "degree": { "type": [ "string", "null" ] }, "grade": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "activities": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } } } }, "experiences": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } } }, "first_name": { "type": [ "string", "null" ] }, "follower_count": { "type": [ "number", "null" ] }, "headline": { "type": [ "string", "null" ] }, "inferred_location": { "type": [ "object", "null" ], "properties": { "street_address": { "type": [ "string", "null" ] }, "neighborhood": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "state_name": { "type": [ "string", "null" ] }, "state_code": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] }, "country_code": { "type": [ "string", "null" ] }, "country_name": { "type": [ "string", "null" ] }, "coordinates": { "type": [ "object", "null" ], "properties": { "lat": { "type": "number" }, "lon": { "type": "number" } }, "required": [ "lat", "lon" ] }, "timezone": { "type": [ "string", "null" ] }, "full_address": { "type": [ "string", "null" ] }, "formatted_address": { "type": [ "string", "null" ] } } }, "interests": { "type": [ "array", "null" ], "items": { "type": "string" } }, "last_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "patents": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "number": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "date": { "type": [ "string", "null" ] } } } }, "profile_pic": { "type": [ "string", "null" ] }, "projects": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "project_id": { "type": [ "string", "null" ] }, "project_title": { "type": [ "string", "null" ] }, "project_url": { "type": [ "string", "null" ] }, "project_summary": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] } } } }, "publications": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "collaborators": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } } } }, "date": { "type": [ "string", "null" ] }, "id": { "type": [ "string", "null" ] }, "publisher": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } } } }, "skills": { "type": [ "array", "null" ], "items": { "type": "string" } }, "primary_slug": { "type": "string" }, "slugs": { "type": [ "array", "null" ], "items": { "type": "string" } }, "summary": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "user_id": { "type": [ "string", "null" ] }, "volunteering": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "role": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "cause": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] } } } }, "tenures": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "date_range": { "type": "object", "properties": { "gte": { "type": [ "string", "null" ] }, "lte": { "type": [ "string", "null" ] } } }, "range_length_days": { "type": [ "number", "null" ] }, "titles": { "type": "array", "items": { "type": "string" } }, "localities": { "type": "array", "items": { "type": "string" } } }, "required": [ "date_range", "titles", "localities" ] } }, "career_began_at": { "type": [ "string", "null" ] }, "tags": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "student", "attended-top-us-university", "attended-top-global-university", "second-time-founder", "deep-technical-background", "major-tech-company-experience", "fortune-500-executive", "recently-changed-companies", "recently-promoted", "decision-maker", "c-suite", "experienced-executive", "phd", "influencer", "board-member" ] } }, "entity_urn": { "type": [ "string", "null" ] }, "open_to_work": { "type": [ "boolean", "null" ] }, "premium": { "type": [ "boolean", "null" ] }, "influencer": { "type": [ "boolean", "null" ] }, "organizations": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] } } } }, "entity_urns": { "type": [ "array", "null" ], "items": { "type": "string" } }, "is_hiring": { "type": [ "boolean", "null" ] }, "websites": { "type": [ "array", "null" ], "items": { "type": "string" } }, "is_verified": { "type": [ "boolean", "null" ] }, "verifications": { "type": [ "object", "null" ], "properties": { "is_verified": { "type": [ "boolean", "null" ] }, "joined_date": { "type": [ "string", "null" ] }, "verification_types": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "subtitle": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] } } } } } }, "is_top_voice": { "type": [ "boolean", "null" ] }, "current_job": { "type": [ "object", "null" ], "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } }, "custom_data": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "relevance_score": { "type": [ "number", "null" ] }, "last_sort_key": { "type": [ "string", "null" ] }, "industry_name": { "type": [ "string", "null" ] }, "last_updated_at": { "type": [ "string", "null" ] }, "languages": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "proficiency_id": { "type": [ "string", "null" ] }, "proficiency_name": { "type": [ "string", "null" ] } } } }, "detailed_education": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "school_details": { "type": [ "object", "null" ], "properties": { "linkedin_ids": { "type": [ "array", "null" ], "items": { "type": "string" } }, "li_org_id": { "type": [ "string", "null" ] }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "preferred_name": { "type": [ "string", "null" ] } } }, "school_id": { "type": [ "string", "null" ] }, "school_name": { "type": [ "string", "null" ] }, "field_of_study_id": { "type": [ "string", "null" ] }, "field_of_study_name": { "type": [ "string", "null" ] }, "degree": { "type": [ "string", "null" ] }, "grade": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "activities": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } } } }, "detailed_work_experiences": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "company_details": { "type": [ "object", "null" ], "properties": { "linkedin_ids": { "type": [ "array", "null" ], "items": { "type": "string" } }, "li_org_id": { "type": [ "string", "null" ] }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "preferred_name": { "type": [ "string", "null" ] }, "crunchbase_slug": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "standard_industries": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "li_industries": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } } } }, "required": [ "primary_slug" ] }, "description": "The profiles found for the saved search by movement type" }, "nextCursor": { "type": [ "string", "null" ], "description": "The next cursor" }, "lastRunCompletedAt": { "type": [ "string", "null" ], "description": "The date and time the last run completed" } }, "required": [ "profiles" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getDepartmentSize `POST /v1/department-size` **Tags:** `Company info` Count employees per department **Endpoint:** `https://api.fiber.ai/v1/department-size` ## Description 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. ⚡ Rate limit: 60 requests per 1 minute 💰 Cost: 2 credits per company ⓘ ⏱ Recommended timeout: 1 minute ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "company": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinUrl" ] }, "value": { "type": "string", "minLength": 1, "description": "LinkedIn company URL (e.g. 'https://www.linkedin.com/company/openai')." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinSlug" ] }, "value": { "type": "string", "minLength": 1, "description": "LinkedIn company slug (e.g. 'openai')." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinOrgId" ] }, "value": { "type": "string", "pattern": "^\\d+$", "minLength": 1, "description": "LinkedIn numeric organization ID (e.g. '11130470')." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "value": { "type": "string", "minLength": 1, "description": "Company website domain (e.g. 'openai.com')." } }, "required": [ "identifier", "value" ] } ], "description": "Company identifier. Set identifier to 'linkedinUrl', 'linkedinSlug', 'linkedinOrgId', or 'domain' and provide the corresponding value." }, "departments": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "description": "Your label for this department (e.g. 'Engineering')." }, "titles": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "description": "Match employees against a job-title list you provide.", "enum": [ "manual" ] }, "include": { "type": "object", "properties": { "titles": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "maxItems": 400, "description": "Job-title strings that qualify an employee for this department." } }, "required": [ "titles" ], "description": "Title filter for including employees in this department." }, "exclude": { "type": "object", "properties": { "titles": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 400, "default": [], "description": "Job-title strings that disqualify an employee even if they matched include.titles. Omit this object or pass an empty list to exclude nobody." } }, "default": { "titles": [] }, "description": "Optional title filter for excluding employees from this department." } }, "required": [ "type", "include" ] } ], "description": "How to decide which employees belong to this department." } }, "required": [ "name", "titles" ] }, "minItems": 1, "maxItems": 20, "description": "Departments to size. Each is counted independently against ALL current employees, so overlapping definitions may count the same person in more than one department." } }, "required": [ "apiKey", "company", "departments" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "company": { "type": "object", "properties": { "name": { "type": [ "string", "null" ], "description": "Company name" }, "linkedinUrl": { "type": [ "string", "null" ], "description": "Full LinkedIn company profile URL" }, "linkedinOrgId": { "type": [ "string", "null" ], "description": "LinkedIn organization ID for the company" }, "domain": { "type": [ "string", "null" ], "description": "Company primary domain" } }, "description": "Company identification details" }, "headcount": { "type": "number", "minimum": 0, "description": "Public sources reported total employees at the company (the percentage denominator). Per-department counts come from profile matching and may not sum to this value." }, "departments": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The department label you supplied" }, "count": { "type": "number", "minimum": 0, "description": "Number of current employees matching this department" }, "percentOfHeadcount": { "type": "number", "minimum": 0, "description": "Department count as a percentage of total company headcount (0–100, rounded to 2 decimal places). Because departments are counted independently, values across departments need not sum to 100. Due to approximation above 40K employees, this can slightly exceed 100." } }, "required": [ "name", "count", "percentOfHeadcount" ] }, "description": "One entry per input department, in the same order" } }, "required": [ "company", "headcount", "departments" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getEnrichmentStatus `GET /v1/audiences/{audienceId}/enrichment/status` **Tags:** `Audiences` Get enrichment status **Endpoint:** `https://api.fiber.ai/v1/audiences/{audienceId}/enrichment/status` ## Description 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. Pass your apiKey in the query string. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | | `audienceId` | path | yes | The unique ID of the audience. | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "enrichmentId": { "type": "string", "description": "The unique ID of the enrichment run." }, "currentStage": { "type": "string", "enum": [ "NOT_STARTED", "STARTED", "RUNNING_SALES_NAV", "RUNNING_LIVE_ENRICH", "RESUBMITTING_AUDIENCE", "CLEANING_NAMES", "FETCHING_CONTACT_DETAILS", "VALIDATING_CONTACT_DETAILS", "EXPORTING_CSV", "DONE", "FAILED" ], "description": "The current stage of the enrichment process." }, "progressPercent": { "type": "number", "minimum": 0, "maximum": 100, "description": "The progress percentage (0-100)." }, "stepsCompleted": { "type": "array", "items": { "type": "string" }, "description": "The list of completed step names." }, "currentStep": { "type": [ "string", "null" ], "description": "The name of the current step being executed." }, "stepsRemaining": { "type": "array", "items": { "type": "string" }, "description": "The list of remaining step names." }, "createdAt": { "type": "string", "description": "The timestamp when the enrichment was created." }, "completedAt": { "type": [ "string", "null" ], "description": "The timestamp when the enrichment completed." } }, "required": [ "enrichmentId", "currentStage", "progressPercent", "stepsCompleted", "stepsRemaining", "createdAt" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getExcludedCompaniesForExclusionList `POST /v1/exclusions/companies/read-from-list` **Tags:** `Exclusions` Get excluded companies for exclusion list **Endpoint:** `https://api.fiber.ai/v1/exclusions/companies/read-from-list` ## Description Get excluded companies for a specific exclusion list with pagination ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "exclusionListId": { "type": "string", "minLength": 1, "description": "ID of the company exclusion list" }, "cursor": { "type": [ "string", "null" ], "description": "Pagination cursor" }, "pageSize": { "type": "integer", "exclusiveMinimum": 0, "maximum": 1000, "default": 25, "description": "Number of companies to return per page" } }, "required": [ "apiKey", "exclusionListId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "size": { "type": "number", "description": "Total number of excluded companies in the list" }, "companies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the excluded company" }, "domain": { "type": [ "string", "null" ], "description": "Domain of the excluded company" }, "linkedInUrl": { "type": [ "string", "null" ], "description": "LinkedIn URL of the excluded company" }, "name": { "type": [ "string", "null" ], "description": "Name of the excluded company" } }, "required": [ "id", "domain", "linkedInUrl", "name" ] }, "description": "List of excluded companies" }, "nextCursor": { "type": [ "string", "null" ], "description": "Cursor for the next page of results" }, "hasMore": { "type": "boolean", "description": "Whether there are more results available" } }, "required": [ "size", "companies", "nextCursor", "hasMore" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getExcludedProspectsForExclusionList `POST /v1/exclusions/prospects/read-from-list` **Tags:** `Exclusions` Get excluded prospects for exclusion list **Endpoint:** `https://api.fiber.ai/v1/exclusions/prospects/read-from-list` ## Description Get excluded prospects for a specific exclusion list with pagination ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "exclusionListId": { "type": "string", "minLength": 1, "description": "ID of the prospect exclusion list" }, "cursor": { "type": [ "string", "null" ], "description": "Pagination cursor" }, "pageSize": { "type": "integer", "exclusiveMinimum": 0, "maximum": 1000, "default": 25, "description": "Number of prospects to return per page" } }, "required": [ "apiKey", "exclusionListId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "size": { "type": "number", "description": "Total number of excluded profiles in the list" }, "prospects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the excluded prospect" }, "linkedInUrl": { "type": [ "string", "null" ], "description": "LinkedIn URL of the excluded prospect" }, "name": { "type": [ "string", "null" ], "description": "Name of the excluded prospect" } }, "required": [ "id", "linkedInUrl", "name" ] }, "description": "List of excluded prospects" }, "nextCursor": { "type": [ "string", "null" ], "description": "Cursor for the next page of results" }, "hasMore": { "type": "boolean", "description": "Whether there are more results available" } }, "required": [ "size", "prospects", "nextCursor", "hasMore" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getFlightRegions `GET /v1/enums/flight-regions` **Tags:** `Enums` List flight region aliases **Endpoint:** `https://api.fiber.ai/v1/enums/flight-regions` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "regions": { "type": "array", "items": { "type": "object", "properties": { "apiCode": { "type": "string", "description": "Alias to use as `departureAirports` / `arrivalAirports` to target this entire metro (e.g. 'X-NYC')." }, "name": { "type": "string", "description": "Human-readable metro name (e.g. 'New York City')." }, "airportIataCodes": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{3}$" }, "minItems": 1, "description": "IATA codes covered by this metro alias (e.g. 'JFK', 'LGA', 'EWR')." }, "freebaseId": { "type": "string", "pattern": "^\\/(?:m|g)\\/[A-Za-z0-9_]+$", "description": "Stable identifier for this metro. Also accepted as `departureAirports` / `arrivalAirports`." } }, "required": [ "apiCode", "name", "airportIataCodes", "freebaseId" ], "description": "A flight region alias covering one metropolitan area's airports." }, "minItems": 1, "description": "All supported flight region aliases." } }, "required": [ "regions" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getHotelAmenities `GET /v1/enums/hotels/amenities` **Tags:** `Enums` List hotel amenity filters **Endpoint:** `https://api.fiber.ai/v1/enums/hotels/amenities` ## Description List supported hotel amenity filter identifiers for use in `amenities` on POST /v1/hotels/search. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "amenities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Amenity identifier for use in search filters." }, "name": { "type": "string", "description": "Amenity display name." } }, "required": [ "id", "name" ], "description": "A supported hotel amenity filter value." }, "minItems": 1, "description": "All supported hotel amenity filter values." } }, "required": [ "amenities" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getHotelBrands `GET /v1/enums/hotels/brands` **Tags:** `Enums` List hotel brand filters **Endpoint:** `https://api.fiber.ai/v1/enums/hotels/brands` ## Description List supported hotel brand filter identifiers for use in `brands` on POST /v1/hotels/search. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "brands": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Brand group identifier for search filters." }, "name": { "type": "string", "description": "Brand group display name." }, "children": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Brand identifier." }, "name": { "type": "string", "description": "Brand display name." } }, "required": [ "id", "name" ] }, "description": "Sub-brands within this group." } }, "required": [ "id", "name", "children" ], "description": "A supported hotel brand filter value." }, "minItems": 1, "description": "All supported hotel brand filter values." } }, "required": [ "brands" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getHotelPropertyTypes `GET /v1/enums/hotels/property-types` **Tags:** `Enums` List hotel property type filters **Endpoint:** `https://api.fiber.ai/v1/enums/hotels/property-types` ## Description List supported hotel property type filter identifiers for use in `propertyTypes` on POST /v1/hotels/search. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "propertyTypes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Property type identifier for search filters." }, "name": { "type": "string", "description": "Property type display name." } }, "required": [ "id", "name" ], "description": "A supported hotel property type filter value." }, "minItems": 1, "description": "All supported hotel property type filter values." } }, "required": [ "propertyTypes" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getIndustries `GET /v1/enums/industries` **Tags:** `Enums` List industries **Endpoint:** `https://api.fiber.ai/v1/enums/industries` ## Description Get lists of various industry categorizations. Useful for our company search API. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "fiberIndustries": { "type": "array", "items": { "type": "string" }, "description": "Fiber's standardized list of industries." }, "linkedinIndustries": { "type": "array", "items": { "type": "string" }, "description": "LinkedIn's list of industries." }, "crunchbaseIndustries": { "type": "array", "items": { "type": "string" }, "description": "Crunchbase's list of industries (a.k.a. Crunchbase categories). Use these values to populate the `crunchbaseCategories` filter on the company-search API." }, "crunchbaseIndustryGroups": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "description": "Crunchbase's industry groups mapped to their constituent industries. Keys are industry group names, values are arrays of industry names belonging to that group. Use the keys to populate the `crunchbaseCategoryGroups` filter on the company-search API." }, "companyCounts": { "type": [ "object", "null" ], "properties": { "fiberIndustries": { "type": "object", "additionalProperties": { "type": "number" } }, "linkedinIndustries": { "type": "object", "additionalProperties": { "type": "number" } }, "crunchbaseIndustries": { "type": "object", "additionalProperties": { "type": "number" } }, "crunchbaseIndustryGroups": { "type": "object", "additionalProperties": { "type": "number" } } }, "required": [ "fiberIndustries", "linkedinIndustries", "crunchbaseIndustries", "crunchbaseIndustryGroups" ], "description": "Shows the number of companies in each industry." } }, "required": [ "fiberIndustries", "linkedinIndustries", "crunchbaseIndustries", "crunchbaseIndustryGroups" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getJobChangeList `POST /v1/job-changes/get-list` **Tags:** `Job changes` Get a job changes list **Endpoint:** `https://api.fiber.ai/v1/job-changes/get-list` ## Description Get a job changes list. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "jobChangeListId": { "type": "string", "description": "The ID of the job change list." } }, "required": [ "apiKey", "jobChangeListId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the job change list." }, "name": { "type": "string", "description": "The name of the job change list." }, "createdAt": { "type": "string", "description": "When the list was created." }, "status": { "type": "string", "enum": [ "NORMAL", "DRAFT", "BUILDING", "ERROR" ], "description": "Status of the job changes list. 'NORMAL' = list has profiles and is ready to use. 'DRAFT' = list is empty, no profiles added yet. 'BUILDING' = profiles are currently being added to the list. 'ERROR' = an error occurred while processing the list; contact support." }, "isActive": { "type": "boolean", "description": "Whether the list is currently active." } }, "required": [ "id", "name", "createdAt", "status", "isActive" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getLanguages `GET /v1/enums/languages` **Tags:** `Enums` List languages **Endpoint:** `https://api.fiber.ai/v1/enums/languages` ## Description Get a list of all languages that you can pass to our API ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "array", "items": { "type": "string" }, "description": "List of all languages supported by Fiber; uses their full English names." }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getLatestSavedSearchRun `POST /v1/saved-search/run/get-latest` **Tags:** `Saved search` Get latest saved search run **Endpoint:** `https://api.fiber.ai/v1/saved-search/run/get-latest` ## Description Get the latest saved search run for a specific saved search ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "savedSearchId": { "type": "string", "description": "The ID of the saved search" } }, "required": [ "apiKey", "savedSearchId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "run": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the saved search run" }, "status": { "type": "string", "enum": [ "NOT_STARTED", "PROCESSING", "COMPLETED", "FAILED", "REJECTED_NO_FUNDS" ], "description": "The current status of the saved search run" }, "startedAt": { "type": [ "string", "null" ], "description": "The date and time the run started" }, "completedAt": { "type": [ "string", "null" ], "description": "The date and time the run completed (if completed)" }, "executionMode": { "type": "string", "enum": [ "manually_triggered", "automatically_triggered" ], "description": "The execution mode of the saved search run. How the saved search run was triggered (\"spawned\"): automatically via the saved search's frequency, or manually through your team's actions" }, "companiesStats": { "type": "object", "properties": { "numCompaniesJoined": { "type": "number", "description": "The number of companies joined which means companies who appeared in the search results for the first time" }, "numCompaniesDeparted": { "type": "number", "description": "The number of companies departed which means companies who appeared in the search results previously and then disappeared in the latest search results" }, "numCompaniesStayed": { "type": "number", "description": "The number of companies stayed which means companies who appeared in the search results previously and then stayed in the latest search results" }, "numCompaniesReturned": { "type": "number", "description": "The number of companies returned which means companies who appeared in the search results previously but departed and then appeared again in the latest search results" } }, "required": [ "numCompaniesJoined", "numCompaniesDeparted", "numCompaniesStayed", "numCompaniesReturned" ], "description": "The companies stats" }, "peopleStats": { "type": "object", "properties": { "numPeopleJoined": { "type": "number", "description": "The number of people joined which means people who appeared in the search results for the first time" }, "numPeopleDeparted": { "type": "number", "description": "The number of people departed which means people who appeared in the search results previously and then disappeared in the latest search results" }, "numPeopleReturned": { "type": "number", "description": "The number of people returned which means people who appeared in the search results previously but departed and then appeared again in the latest search results" }, "numPeopleStayed": { "type": "number", "description": "The number of people stayed which means people who appeared in the search results previously and then stayed in the latest search results" } }, "required": [ "numPeopleJoined", "numPeopleDeparted", "numPeopleReturned", "numPeopleStayed" ], "description": "The people stats" }, "savedSearchId": { "type": "string", "description": "The ID of the saved search" }, "companySearchParams": { "type": [ "object", "null" ], "properties": { "exactCompanyV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "domain": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$" } }, "required": [ "identifier", "domain" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/(www\\.)?linkedin\\.com\\/company\\/[a-zA-Z0-9-]+\\/?.*$" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-org-id" ] }, "org_id": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "identifier", "org_id" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "advanced" ] }, "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string", "minLength": 1 }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "identifier", "li_org_id" ] } ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "domain": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$" } }, "required": [ "identifier", "domain" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/(www\\.)?linkedin\\.com\\/company\\/[a-zA-Z0-9-]+\\/?.*$" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-org-id" ] }, "org_id": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "identifier", "org_id" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "advanced" ] }, "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string", "minLength": 1 }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "identifier", "li_org_id" ] } ] } } } }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "headquartersCountryCode": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } } } }, "headquartersStateName": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string" } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "employeeCountV2": { "type": [ "object", "null" ], "properties": { "lowerBoundExclusive": { "type": [ "integer", "null" ], "minimum": 0 }, "upperBoundInclusive": { "type": [ "integer", "null" ], "minimum": 0 } } }, "keywords": { "type": [ "object", "null" ], "properties": { "containsAll": { "type": [ "array", "null" ], "items": { "type": "string" } }, "containsAny": { "type": [ "array", "null" ], "items": { "type": "string" } }, "containsNone": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "industriesV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "allOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } } } }, "stage": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "acquired", "public", "closed", "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "series_i", "series_j", "venture_other", "private_equity", "unknown", "no_funding_yet" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "acquired", "public", "closed", "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "series_i", "series_j", "venture_other", "private_equity", "unknown", "no_funding_yet" ] } } } }, "totalFundingUSD": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "lastFundingUSD": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "lastFundedOn": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ] }, "foundedOn": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ] }, "nameLike": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string" } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "exactCompany": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string" }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ " … _truncated to 65536 chars for ai-docs._ ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getMetroAreas `GET /v1/enums/metro-areas` **Tags:** `Enums` List preset metro areas **Endpoint:** `https://api.fiber.ai/v1/enums/metro-areas` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "metroAreas": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "circle" ] }, "slug": { "type": "string", "enum": [ "sf-bay-area", "sf-north-bay", "sf-east-bay", "sf-south-bay", "sf-peninsula", "greater-new-york", "chicagoland", "washington-dmv", "greater-los-angeles", "inland-empire", "greater-philadelphia", "boston-route-128", "greater-austin", "toronto-golden-horseshoe", "greater-london", "greater-tokyo", "research-triangle", "seattle-puget-sound", "dallas-fort-worth", "miami-south-florida", "slc-silicon-slopes", "denver-front-range" ] }, "name": { "type": "string" }, "emoji": { "type": "string" }, "countryCode": { "type": "string", "minLength": 3, "maxLength": 3 }, "cities": { "type": "array", "items": { "type": "string" }, "maxItems": 5 }, "synonyms": { "type": "array", "items": { "type": "string" } }, "latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "longitude": { "type": "number", "minimum": -180, "maximum": 180 }, "radiusMiles": { "type": "number", "minimum": 0, "maximum": 12500 } }, "required": [ "type", "slug", "name", "emoji", "countryCode", "cities", "synonyms", "latitude", "longitude", "radiusMiles" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "polygon" ] }, "slug": { "type": "string", "enum": [ "sf-bay-area", "sf-north-bay", "sf-east-bay", "sf-south-bay", "sf-peninsula", "greater-new-york", "chicagoland", "washington-dmv", "greater-los-angeles", "inland-empire", "greater-philadelphia", "boston-route-128", "greater-austin", "toronto-golden-horseshoe", "greater-london", "greater-tokyo", "research-triangle", "seattle-puget-sound", "dallas-fort-worth", "miami-south-florida", "slc-silicon-slopes", "denver-front-range" ] }, "name": { "type": "string" }, "emoji": { "type": "string" }, "countryCode": { "type": "string", "minLength": 3, "maxLength": 3 }, "cities": { "type": "array", "items": { "type": "string" }, "maxItems": 5 }, "synonyms": { "type": "array", "items": { "type": "string" } }, "vertices": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "longitude": { "type": "number", "minimum": -180, "maximum": 180 } }, "required": [ "latitude", "longitude" ] }, "minItems": 4, "maxItems": 1000 } }, "required": [ "type", "slug", "name", "emoji", "countryCode", "cities", "synonyms", "vertices" ] } ] }, "description": "All available preset metro area regions. Use the slug with the preset-region strategy in location-based search endpoints." } }, "required": [ "metroAreas" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getNaicsCodes `GET /v1/enums/naics-codes` **Tags:** `Enums` List NAICS codes **Endpoint:** `https://api.fiber.ai/v1/enums/naics-codes` ## Description Get all NAICS (North American Industry Classification System) codes from the 2022 version. Returns each code and its corresponding title. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "naicsCodes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "The NAICS code identifier." }, "title": { "type": "string", "description": "The title of the NAICS code." } }, "required": [ "code", "title" ] }, "description": "The list of all NAICS 2022 codes with their titles." } }, "required": [ "naicsCodes" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getOpenApi `GET /openapi.json` **Tags:** `Utility` Get OpenAPI schema **Endpoint:** `https://api.fiber.ai/openapi.json` ## Description Get the comprehensive, auto-generated OpenAPI spec for all Fiber APIs. **Note**: This file is very large, so we don't recommend feeding it into LLMs directly. Agents should instead fetch `/llms.txt` for routing instructions and `/ai-docs/.md` for per-operation context. If you'd like to work with Fiber from Claude, ChatGPT, or another LLM, you can also use our MCP server, explained at . --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getOrgCredits `GET /v1/get-org-credits` **Tags:** `Account` Get organization credits **Endpoint:** `https://api.fiber.ai/v1/get-org-credits` ## Description Get credits for an organization ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "array", "items": { "type": "object", "properties": { "organizationId": { "type": "string" }, "subscriptionId": { "type": "string" }, "max": { "type": "number" }, "used": { "type": "number" }, "available": { "type": "number" }, "usagePeriodResetsOn": { "type": "string" }, "creditsPerOperation": { "type": [ "object", "null" ], "properties": { "getCompanyFromDb": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 100 } ] } }, "getPersonFromDb": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 100 } ] } }, "getCompanyCountFromDb": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 100 } ] } }, "getJobPostingCountFromDb": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 100 } ] } }, "getPersonCountFromDb": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 100 } ] } }, "getInvestorFromDb": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 300 } ] } }, "getInvestmentFromDb": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 200 } ] } }, "getJobPostingFromDb": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 100 } ] } }, "textToCompanySearchParams": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 200 } ] } }, "textToPersonSearchParams": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 200 } ] } }, "textToSearchParams": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 200 } ] } }, "liveEnrichCompany": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 200 } ] } }, "liveEnrichPerson": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 200 } ] } }, "liveEnrichPersonForContactReveal": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 100 } ] } }, "standardizeCompanySlug": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 100 } ] } }, "standardizePersonSlug": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 100 } ] } }, "workEmailReveal": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 200 } ] } }, "personalEmailReveal": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 200 } ] } }, "liteEmailReveal": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 100 } ] } }, "litePhoneReveal": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 200 } ] } }, "liteReverseEmailLookup": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 100 } ] } }, "instantEmailReveal": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 100 } ] } }, "instantPhoneReveal": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 100 } ] } }, "allEmailReveal": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 300 } ] } }, "phoneReveal": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 300 } ] } }, "combinedReveal": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 500 } ] } }, "validateEmail": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 100 } ] } }, "validatePhone": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 300 } ] } }, "emailToLinkedinUrl": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 200 } ] } }, "kitchenSinkPerson": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 200 } ] } }, "kitchenSinkCompany": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 200 } ] } }, "salesNavCompanyScrape": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 200 } ] } }, "salesNavPersonScrape": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 200 } ] } }, "salesNavPersonScrapeWithoutLiveFetch": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 100 } ] } }, "googleMapsScrape": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 300 } ] } }, "geolocation": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 100 } ] } }, "jobTitleRewrite": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 100 } ] } }, "combinedEnrichment": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 600 } ] } }, "domainLookupAgent": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 300 } ] } }, "localBusinessResearchAgent": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 400 } ] } }, "githubLookupAgent": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 300 } ] } }, "getLiProfileFromGithubUsername": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 500 } ] } }, "getEmailFromGithubUsername": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 300 } ] } }, "socialMediaFinderAgent": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 300 } ] } }, "bulkCompanyLogoLookup": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 30 } ] } }, "bulkProfilePicLookup": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 30 } ] } }, "getLiProfilePosts": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 200 } ] } }, "getLiCompanyPosts": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 200 } ] } }, "getLiPostComments": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 200 } ] } }, "getLiPostReactions": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 200 } ] } }, "getLiProfileComments": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 200 } ] } }, "getLiProfileReactions": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 200 } ] } }, "getLiProfileLatestActivities": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "object", "properties": { "limit": { "type": [ "number", "null" ], "exclusiveMinimum": 0 }, "centiCreditCost": { "type": "number", "minimum": 0 } }, "required": [ "centiCreditCost" ] }, "minItems": 1 } }, "required": [ "levels" ], "default": { "levels": [ { "limit": null, "centiCreditCost": 300 } ] } }, "getLiProfileLastActiveDate": { … _truncated to 65536 chars for ai-docs._ ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getProspectExclusionLists `POST /v1/exclusions/prospects/get-lists` **Tags:** `Exclusions` Get prospect exclusion lists **Endpoint:** `https://api.fiber.ai/v1/exclusions/prospects/get-lists` ## Description Get prospect exclusion lists ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" } }, "required": [ "apiKey" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "array", "items": { "type": "object", "properties": { "listId": { "type": "string", "description": "The ID of the prospect exclusion list." }, "name": { "type": "string", "description": "The name of the prospect exclusion list." } }, "required": [ "listId", "name" ] } }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getQuickstartScript `GET /quickstart` **Tags:** `Quickstart` Get quickstart install script **Endpoint:** `https://api.fiber.ai/quickstart` ## Description Returns a bash script that signs up for a Fiber API trial and prints your API key. The one-liner is: ```bash curl -fsSL https://api.fiber.ai/quickstart | bash ``` The script handles the full flow end to end: 1. Prompts for a work email and OTP (agents run non-interactively with `--json`). 2. Calls `POST /v1/account/send-otp` and `POST /v1/account/verify-otp`. 3. Stores the returned live API key at `$HOME/.config/fiber/credentials` (mode 0600). 4. Verifies the key with `GET /v1/get-org-credits` and prints the balance. No authentication is required to fetch the script. The response is `text/x-shellscript`, not JSON — pipe it to `bash`. --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getRateLimits `GET /v1/rate-limits` **Tags:** `Account` Get organization rate limits **Endpoint:** `https://api.fiber.ai/v1/rate-limits` ## Description 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. ⚡ Rate limit: 20 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "rateLimits": { "type": "array", "items": { "type": "object", "properties": { "method": { "type": "string", "minLength": 1, "description": "HTTP method (e.g. GET, POST)" }, "path": { "type": "string", "minLength": 1, "description": "Route path (e.g. /v1/search/people)" }, "max": { "type": "number", "description": "Maximum number of requests allowed in the window" }, "windowSeconds": { "type": [ "number", "null" ], "description": "Time window duration in seconds (e.g. 60), or null if unavailable" }, "isCustom": { "type": "boolean", "description": "Whether this rate limit is a custom override for your organization" } }, "required": [ "method", "path", "max", "windowSeconds", "isCustom" ] }, "description": "Rate limits for all available API endpoints" } }, "required": [ "rateLimits" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getRegions `GET /v1/enums/regions` **Tags:** `Enums` List countries and regions **Endpoint:** `https://api.fiber.ai/v1/enums/regions` ## Description Get a list of all countries and regions supported by the API, along with their names, codes, and additional metadata. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "countries": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The common name of the country." }, "apiCode": { "type": "string", "description": "The code to use when filtering by this country in the API." }, "isoCodeAlpha3": { "type": "string", "description": "The ISO 3166-1 alpha-3 country code (e.g. 'USA', 'CAN')." }, "isoCodeAlpha2": { "type": "string", "description": "The ISO 3166-1 alpha-2 country code (e.g. 'US', 'CA')." }, "flag": { "type": "string", "description": "The Unicode flag emoji for the country." } }, "required": [ "name", "apiCode", "isoCodeAlpha3", "isoCodeAlpha2", "flag" ] } }, "regions": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The common name of the region." }, "apiCode": { "type": "string", "description": "The code to use when filtering by this region in the API." }, "acronym": { "type": [ "string", "null" ], "description": "The short form of the region name, if applicable." }, "flag": { "type": "string", "description": "The Unicode flag emoji for the region." }, "countries": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The common name of the country." }, "apiCode": { "type": "string", "description": "The code to use when filtering by this country in the API." }, "isoCodeAlpha3": { "type": "string", "description": "The ISO 3166-1 alpha-3 country code (e.g. 'USA', 'CAN')." }, "isoCodeAlpha2": { "type": "string", "description": "The ISO 3166-1 alpha-2 country code (e.g. 'US', 'CA')." }, "flag": { "type": "string", "description": "The Unicode flag emoji for the country." } }, "required": [ "name", "apiCode", "isoCodeAlpha3", "isoCodeAlpha2", "flag" ] }, "description": "The countries included in this region." } }, "required": [ "name", "apiCode", "countries" ], "description": "A multi-country region, as defined by Fiber AI." } } }, "required": [ "countries", "regions" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getSavedSearch `POST /v1/saved-search/get` **Tags:** `Saved search` Get saved search **Endpoint:** `https://api.fiber.ai/v1/saved-search/get` ## Description Get all details for a specific saved search ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "savedSearchId": { "type": "string", "description": "The ID of the saved search" } }, "required": [ "apiKey", "savedSearchId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the saved search" }, "name": { "type": "string", "description": "The name of the saved search" }, "type": { "type": "string", "enum": [ "combined", "company_only", "prospect_only" ], "description": "The type of the saved search" }, "spawnFrequencyDays": { "type": "integer", "exclusiveMinimum": 0, "description": "The frequency of the saved search in days." }, "estimatedDateOfNextSpawn": { "type": [ "string", "null" ], "description": "The estimated date of the next spawn of the saved search" }, "lastSpawnedAt": { "type": [ "string", "null" ], "description": "The date and time the last spawn of the saved search" }, "pastSpawnsDates": { "type": [ "array", "null" ], "items": { "type": "string" }, "maxItems": 100, "description": "The dates of the past spawns (max 100) of the saved search" }, "isActive": { "type": "boolean", "description": "Whether the saved search is active i.e whether to auto spawn it or not." }, "companySearchParams": { "type": [ "object", "null" ], "properties": { "exactCompanyV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "domain": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$" } }, "required": [ "identifier", "domain" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/(www\\.)?linkedin\\.com\\/company\\/[a-zA-Z0-9-]+\\/?.*$" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-org-id" ] }, "org_id": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "identifier", "org_id" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "advanced" ] }, "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string", "minLength": 1 }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "identifier", "li_org_id" ] } ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "domain": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$" } }, "required": [ "identifier", "domain" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/(www\\.)?linkedin\\.com\\/company\\/[a-zA-Z0-9-]+\\/?.*$" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-org-id" ] }, "org_id": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "identifier", "org_id" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "advanced" ] }, "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string", "minLength": 1 }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "identifier", "li_org_id" ] } ] } } } }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "headquartersCountryCode": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } } } }, "headquartersStateName": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string" } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "employeeCountV2": { "type": [ "object", "null" ], "properties": { "lowerBoundExclusive": { "type": [ "integer", "null" ], "minimum": 0 }, "upperBoundInclusive": { "type": [ "integer", "null" ], "minimum": 0 } } }, "keywords": { "type": [ "object", "null" ], "properties": { "containsAll": { "type": [ "array", "null" ], "items": { "type": "string" } }, "containsAny": { "type": [ "array", "null" ], "items": { "type": "string" } }, "containsNone": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "industriesV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "allOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } } } }, "stage": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "acquired", "public", "closed", "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "series_i", "series_j", "venture_other", "private_equity", "unknown", "no_funding_yet" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "acquired", "public", "closed", "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "series_i", "series_j", "venture_other", "private_equity", "unknown", "no_funding_yet" ] } } } }, "totalFundingUSD": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "lastFundingUSD": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "lastFundedOn": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ] }, "foundedOn": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ] }, "nameLike": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string" } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "exactCompany": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string" }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "li_org_id" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string" }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "li_org_id" ] } } } }, "acceleratorsV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "acceleratorName": { "type": "string", "enum": [ "a16z_speedrun", "accel_atoms", "ai2_incubator", "alchemist_accelerator", "alliance", "antler", "berkeley_skydeck", "founders_inc", "google_startups", "launch_accelerator", "neo", "pear_x", "plug_and_play", "sosv", "south_park_commons", "startx", "techstars", "the_mint", "ycombinator" ] }, "batchSelection": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "all-batches" ] } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "only-these-batches" ] }, "batches": { "type": "array", "items": { "type": "string" }, "minItems": 0 } }, "required": [ "strategy", "batches" ] }, { "type": "null" } ] }, "years": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } } }, "required": [ "acceleratorName" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "acceleratorName": { "type": "string", "enum": [ "a16z_speedrun", "accel_atoms", "ai2_incubator", "alchemist_accelerator", "alliance", "antler", "berkeley_skydeck", "founders_inc", "google_startups", "launch_accelerator", "neo", "pear_x", "plug_and_play", "sosv", "south_park_commons", "startx", "techstars", "the_mint", "ycombinator" ] }, "batchSelection": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "all-batches" ] } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "only-these-batches" ] }, "batches": { "type": "array", … _truncated to 65536 chars for ai-docs._ ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getSavedSearchRun `POST /v1/saved-search/run/get` **Tags:** `Saved search` Get saved search run **Endpoint:** `https://api.fiber.ai/v1/saved-search/run/get` ## Description Get all details for a specific saved search run ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "savedSearchRunId": { "type": "string", "description": "The ID of the saved search run" } }, "required": [ "apiKey", "savedSearchRunId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "run": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the saved search run" }, "status": { "type": "string", "enum": [ "NOT_STARTED", "PROCESSING", "COMPLETED", "FAILED", "REJECTED_NO_FUNDS" ], "description": "The current status of the saved search run" }, "startedAt": { "type": [ "string", "null" ], "description": "The date and time the run started" }, "completedAt": { "type": [ "string", "null" ], "description": "The date and time the run completed (if completed)" }, "executionMode": { "type": "string", "enum": [ "manually_triggered", "automatically_triggered" ], "description": "The execution mode of the saved search run. How the saved search run was triggered (\"spawned\"): automatically via the saved search's frequency, or manually through your team's actions" }, "companiesStats": { "type": "object", "properties": { "numCompaniesJoined": { "type": "number", "description": "The number of companies joined which means companies who appeared in the search results for the first time" }, "numCompaniesDeparted": { "type": "number", "description": "The number of companies departed which means companies who appeared in the search results previously and then disappeared in the latest search results" }, "numCompaniesStayed": { "type": "number", "description": "The number of companies stayed which means companies who appeared in the search results previously and then stayed in the latest search results" }, "numCompaniesReturned": { "type": "number", "description": "The number of companies returned which means companies who appeared in the search results previously but departed and then appeared again in the latest search results" } }, "required": [ "numCompaniesJoined", "numCompaniesDeparted", "numCompaniesStayed", "numCompaniesReturned" ], "description": "The companies stats" }, "peopleStats": { "type": "object", "properties": { "numPeopleJoined": { "type": "number", "description": "The number of people joined which means people who appeared in the search results for the first time" }, "numPeopleDeparted": { "type": "number", "description": "The number of people departed which means people who appeared in the search results previously and then disappeared in the latest search results" }, "numPeopleReturned": { "type": "number", "description": "The number of people returned which means people who appeared in the search results previously but departed and then appeared again in the latest search results" }, "numPeopleStayed": { "type": "number", "description": "The number of people stayed which means people who appeared in the search results previously and then stayed in the latest search results" } }, "required": [ "numPeopleJoined", "numPeopleDeparted", "numPeopleReturned", "numPeopleStayed" ], "description": "The people stats" }, "savedSearchId": { "type": "string", "description": "The ID of the saved search" }, "companySearchParams": { "type": [ "object", "null" ], "properties": { "exactCompanyV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "domain": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$" } }, "required": [ "identifier", "domain" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/(www\\.)?linkedin\\.com\\/company\\/[a-zA-Z0-9-]+\\/?.*$" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-org-id" ] }, "org_id": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "identifier", "org_id" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "advanced" ] }, "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string", "minLength": 1 }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "identifier", "li_org_id" ] } ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "domain": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$" } }, "required": [ "identifier", "domain" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/(www\\.)?linkedin\\.com\\/company\\/[a-zA-Z0-9-]+\\/?.*$" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-org-id" ] }, "org_id": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "identifier", "org_id" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "advanced" ] }, "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string", "minLength": 1 }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "identifier", "li_org_id" ] } ] } } } }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "headquartersCountryCode": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } } } }, "headquartersStateName": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string" } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "employeeCountV2": { "type": [ "object", "null" ], "properties": { "lowerBoundExclusive": { "type": [ "integer", "null" ], "minimum": 0 }, "upperBoundInclusive": { "type": [ "integer", "null" ], "minimum": 0 } } }, "keywords": { "type": [ "object", "null" ], "properties": { "containsAll": { "type": [ "array", "null" ], "items": { "type": "string" } }, "containsAny": { "type": [ "array", "null" ], "items": { "type": "string" } }, "containsNone": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "industriesV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "allOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } } } }, "stage": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "acquired", "public", "closed", "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "series_i", "series_j", "venture_other", "private_equity", "unknown", "no_funding_yet" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "acquired", "public", "closed", "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "series_i", "series_j", "venture_other", "private_equity", "unknown", "no_funding_yet" ] } } } }, "totalFundingUSD": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "lastFundingUSD": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "lastFundedOn": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ] }, "foundedOn": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ] }, "nameLike": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string" } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "exactCompany": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string" }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ " … _truncated to 65536 chars for ai-docs._ ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getSavedSearchRunCompanies `POST /v1/saved-search/run/companies` **Tags:** `Saved search` Get saved search run companies **Endpoint:** `https://api.fiber.ai/v1/saved-search/run/companies` ## Description Get the companies found for a specific saved search run ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "savedSearchRunId": { "type": "string", "description": "The ID of the saved search run" }, "statuses": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "joined", "returned", "departed", "stayed" ] }, "minItems": 1, "description": "The statuses of the companies. This is optional and if not provided, all companies will be returned." }, "cursor": { "type": [ "string", "null" ], "description": "The cursor to start from" }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25, "description": "The number of companies to return" } }, "required": [ "apiKey", "savedSearchRunId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "companies": { "type": "array", "items": { "type": "object", "properties": { "company": { "type": "object", "properties": { "linkedin_id": { "type": [ "string", "null" ] }, "accelerator_statuses": { "type": [ "array", "null" ], "items": { "type": "string" } }, "accelerators": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "slug": { "type": [ "string", "null" ] }, "tags": { "type": [ "array", "null" ], "items": { "type": "string" } }, "year": { "type": [ "number", "null" ] }, "batch": { "type": [ "string", "null" ] }, "founders": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "full_name": { "type": [ "string", "null" ] }, "bio": { "type": [ "string", "null" ] }, "job_title": { "type": [ "string", "null" ] }, "is_active": { "type": [ "boolean", "null" ] }, "email_address": { "type": [ "string", "null" ] }, "facebook_url": { "type": [ "string", "null" ] }, "twitter_handle": { "type": [ "string", "null" ] }, "linkedin_slug": { "type": [ "string", "null" ] }, "github_username": { "type": [ "string", "null" ] } } } }, "description": { "type": [ "string", "null" ] }, "one_liner": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "company_domain": { "type": [ "string", "null" ] }, "accelerator_name": { "type": [ "string", "null" ] }, "accelerator_domain": { "type": [ "string", "null" ] } } } }, "blog_urls": { "type": [ "array", "null" ], "items": { "type": "string" } }, "custom_data": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "emails": { "type": [ "array", "null" ], "items": { "type": "string" } }, "phone_numbers": { "type": [ "array", "null" ], "items": { "type": "string" } }, "employee_count_consensus": { "type": [ "object", "null" ], "properties": { "gte": { "type": [ "number", "null" ] }, "lte": { "type": [ "number", "null" ] } } }, "facebook_urls": { "type": [ "array", "null" ], "items": { "type": "string" } }, "fortune_rankings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "list": { "type": "string", "enum": [ "fortune-500-usa", "forbes-global-2000" ] }, "year": { "type": "number" }, "rank": { "type": "number" } }, "required": [ "list", "year", "rank" ] } }, "founded_on_consensus": { "type": [ "string", "null" ] }, "github_usernames": { "type": [ "array", "null" ], "items": { "type": "string" } }, "instagram_handles": { "type": [ "array", "null" ], "items": { "type": "string" } }, "latest_funding_consensus": { "type": [ "number", "null" ] }, "linkedin_slugs": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "li_org_id": { "type": [ "string", "null" ] }, "li_category": { "type": [ "string", "null" ], "enum": [ "W", "S", "C", null ] }, "li_job_posts_stats": { "type": [ "object", "null" ], "properties": { "total_count": { "type": "number" }, "seniority_stats": { "type": [ "object", "null" ], "properties": { "Entry level": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Director": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Associate": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Mid-Senior level": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Internship": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Executive": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Not Applicable": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] } }, "additionalProperties": false }, "employment_type_stats": { "type": [ "object", "null" ], "properties": { "Full-time": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Temporary": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Internship": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Contract": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Part-time": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Volunteer": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Other": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] } }, "additionalProperties": false }, "country_location_stats": { "type": [ "object", "null" ], "properties": { "USA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GBR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "FRA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IND": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BRA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "DEU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ESP": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CAN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "AUS": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NLD": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ITA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ZAF": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BEL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CHN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "TUR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MEX": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CHE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NOR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ARE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SWE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "POL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IDN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ARG": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PRT": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "COL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CHL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PAK": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "DNK": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "JPN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NGA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SGP": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PER": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NZL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "AUT": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IRL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MYS": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BGD": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "EGY": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ISR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SAU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PHL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "FIN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IRN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ROU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CZE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GRC": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "HKG": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "HUN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "KEN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MAR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "VNM": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "RUS": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "UKR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ECU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "THA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LKA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "KOR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BGR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GHA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SRB": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "TWN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "HRV": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LTU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PRI": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SVK": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "TUN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "EST": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "VEN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CRI": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PAN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "URY": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LBN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LUX": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CYP": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NPL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "JOR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SVN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MTQ": { "type": "object", … _truncated to 65536 chars for ai-docs._ ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getSavedSearchRunProfiles `POST /v1/saved-search/run/profiles` **Tags:** `Saved search` Get saved search run profiles **Endpoint:** `https://api.fiber.ai/v1/saved-search/run/profiles` ## Description Get the profiles found for a specific saved search run ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "savedSearchRunId": { "type": "string", "description": "The ID of the saved search run" }, "statuses": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "joined", "returned", "departed", "stayed" ] }, "minItems": 1, "description": "The statuses of the profiles. This is optional and if not provided, all profiles will be returned." }, "cursor": { "type": [ "string", "null" ], "description": "The cursor to start from" }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25, "description": "The number of profiles to return" } }, "required": [ "apiKey", "savedSearchRunId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "profiles": { "type": "array", "items": { "type": "object", "properties": { "profile": { "type": "object", "properties": { "articles": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "date_published": { "type": [ "string", "null" ] } } } }, "certifications": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "credential_id": { "type": [ "string", "null" ] }, "verify_url": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "date": { "type": [ "string", "null" ] } } } }, "connection_count": { "type": [ "number", "null" ] }, "courses": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "course_number": { "type": [ "string", "null" ] }, "association": { "type": "null" } } } }, "dob": { "type": [ "string", "null" ] }, "education": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "school_id": { "type": [ "string", "null" ] }, "school_name": { "type": [ "string", "null" ] }, "field_of_study_id": { "type": [ "string", "null" ] }, "field_of_study_name": { "type": [ "string", "null" ] }, "degree": { "type": [ "string", "null" ] }, "grade": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "activities": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } } } }, "experiences": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } } }, "first_name": { "type": [ "string", "null" ] }, "follower_count": { "type": [ "number", "null" ] }, "headline": { "type": [ "string", "null" ] }, "inferred_location": { "type": [ "object", "null" ], "properties": { "street_address": { "type": [ "string", "null" ] }, "neighborhood": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "state_name": { "type": [ "string", "null" ] }, "state_code": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] }, "country_code": { "type": [ "string", "null" ] }, "country_name": { "type": [ "string", "null" ] }, "coordinates": { "type": [ "object", "null" ], "properties": { "lat": { "type": "number" }, "lon": { "type": "number" } }, "required": [ "lat", "lon" ] }, "timezone": { "type": [ "string", "null" ] }, "full_address": { "type": [ "string", "null" ] }, "formatted_address": { "type": [ "string", "null" ] } } }, "interests": { "type": [ "array", "null" ], "items": { "type": "string" } }, "last_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "patents": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "number": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "date": { "type": [ "string", "null" ] } } } }, "profile_pic": { "type": [ "string", "null" ] }, "projects": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "project_id": { "type": [ "string", "null" ] }, "project_title": { "type": [ "string", "null" ] }, "project_url": { "type": [ "string", "null" ] }, "project_summary": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] } } } }, "publications": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "collaborators": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } } } }, "date": { "type": [ "string", "null" ] }, "id": { "type": [ "string", "null" ] }, "publisher": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } } } }, "skills": { "type": [ "array", "null" ], "items": { "type": "string" } }, "primary_slug": { "type": "string" }, "slugs": { "type": [ "array", "null" ], "items": { "type": "string" } }, "summary": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "user_id": { "type": [ "string", "null" ] }, "volunteering": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "role": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "cause": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] } } } }, "tenures": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "date_range": { "type": "object", "properties": { "gte": { "type": [ "string", "null" ] }, "lte": { "type": [ "string", "null" ] } } }, "range_length_days": { "type": [ "number", "null" ] }, "titles": { "type": "array", "items": { "type": "string" } }, "localities": { "type": "array", "items": { "type": "string" } } }, "required": [ "date_range", "titles", "localities" ] } }, "career_began_at": { "type": [ "string", "null" ] }, "tags": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "student", "attended-top-us-university", "attended-top-global-university", "second-time-founder", "deep-technical-background", "major-tech-company-experience", "fortune-500-executive", "recently-changed-companies", "recently-promoted", "decision-maker", "c-suite", "experienced-executive", "phd", "influencer", "board-member" ] } }, "entity_urn": { "type": [ "string", "null" ] }, "open_to_work": { "type": [ "boolean", "null" ] }, "premium": { "type": [ "boolean", "null" ] }, "influencer": { "type": [ "boolean", "null" ] }, "organizations": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] } } } }, "entity_urns": { "type": [ "array", "null" ], "items": { "type": "string" } }, "is_hiring": { "type": [ "boolean", "null" ] }, "websites": { "type": [ "array", "null" ], "items": { "type": "string" } }, "is_verified": { "type": [ "boolean", "null" ] }, "verifications": { "type": [ "object", "null" ], "properties": { "is_verified": { "type": [ "boolean", "null" ] }, "joined_date": { "type": [ "string", "null" ] }, "verification_types": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "subtitle": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] } } } } } }, "is_top_voice": { "type": [ "boolean", "null" ] }, "current_job": { "type": [ "object", "null" ], "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } }, "custom_data": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "relevance_score": { "type": [ "number", "null" ] }, "last_sort_key": { "type": [ "string", "null" ] }, "industry_name": { "type": [ "string", "null" ] }, "last_updated_at": { "type": [ "string", "null" ] }, "languages": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "proficiency_id": { "type": [ "string", "null" ] }, "proficiency_name": { "type": [ "string", "null" ] } } } }, "detailed_education": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "school_details": { "type": [ "object", "null" ], "properties": { "linkedin_ids": { "type": [ "array", "null" ], "items": { "type": "string" } }, "li_org_id": { "type": [ "string", "null" ] }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "preferred_name": { "type": [ "string", "null" ] } } }, "school_id": { "type": [ "string", "null" ] }, "school_name": { "type": [ "string", "null" ] }, "field_of_study_id": { "type": [ "string", "null" ] }, "field_of_study_name": { "type": [ "string", "null" ] }, "degree": { "type": [ "string", "null" ] }, "grade": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "activities": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } } } }, "detailed_work_experiences": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "company_details": { "type": [ "object", "null" ], "properties": { "linkedin_ids": { "type": [ "array", "null" ], "items": { "type": "string" } }, "li_org_id": { "type": [ "string", "null" ] }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "preferred_name": { "type": [ "string", "null" ] }, "crunchbase_slug": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "standard_industries": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "li_industries": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } } } }, "required": [ "primary_slug" ] }, "movementType": { "type": "string", "enum": [ "joined", "returned", "departed", "stayed" ] } }, "required": [ "profile", "movementType" ] }, "description": "The profiles found for the saved search run" }, "nextCursor": { "type": [ "string", "null" ], "description": "The next cursor" } }, "required": [ "profiles" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { … _truncated to 65536 chars for ai-docs._ ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getSavedSearchRunStatus `POST /v1/saved-search/run/status` **Tags:** `Saved search` Get saved search run status **Endpoint:** `https://api.fiber.ai/v1/saved-search/run/status` ## Description 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) ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "savedSearchRunId": { "type": "string", "description": "The ID of the saved search run" } }, "required": [ "apiKey", "savedSearchRunId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "run": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the saved search run" }, "startedAt": { "type": [ "string", "null" ], "description": "The date and time the run started (if started)" }, "completedAt": { "type": [ "string", "null" ], "description": "The date and time the run completed (if completed)" }, "status": { "type": "string", "enum": [ "NOT_STARTED", "PROCESSING", "COMPLETED", "FAILED", "REJECTED_NO_FUNDS" ], "description": "The status of the saved search run" }, "companiesStats": { "type": "object", "properties": { "numCompaniesJoined": { "type": "number", "description": "The number of companies joined which means companies who appeared in the search results for the first time" }, "numCompaniesDeparted": { "type": "number", "description": "The number of companies departed which means companies who appeared in the search results previously and then disappeared in the latest search results" }, "numCompaniesStayed": { "type": "number", "description": "The number of companies stayed which means companies who appeared in the search results previously and then stayed in the latest search results" }, "numCompaniesReturned": { "type": "number", "description": "The number of companies returned which means companies who appeared in the search results previously but departed and then appeared again in the latest search results" } }, "required": [ "numCompaniesJoined", "numCompaniesDeparted", "numCompaniesStayed", "numCompaniesReturned" ], "description": "The companies stats. This includes the number of companies joined, departed, stayed, and returned so far." }, "peopleStats": { "type": "object", "properties": { "numPeopleJoined": { "type": "number", "description": "The number of people joined which means people who appeared in the search results for the first time" }, "numPeopleDeparted": { "type": "number", "description": "The number of people departed which means people who appeared in the search results previously and then disappeared in the latest search results" }, "numPeopleReturned": { "type": "number", "description": "The number of people returned which means people who appeared in the search results previously but departed and then appeared again in the latest search results" }, "numPeopleStayed": { "type": "number", "description": "The number of people stayed which means people who appeared in the search results previously and then stayed in the latest search results" } }, "required": [ "numPeopleJoined", "numPeopleDeparted", "numPeopleReturned", "numPeopleStayed" ], "description": "The people stats. This includes the number of people joined, departed, stayed, and returned so far." } }, "required": [ "id", "status", "companiesStats", "peopleStats" ], "description": "The saved search run details" } }, "required": [ "run" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getScoutingReport `POST /v1/scouting-report` **Tags:** `Company info` Get company scouting report **Endpoint:** `https://api.fiber.ai/v1/scouting-report` ## Description 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). ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: 6 credits per scouting report ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "company": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinUrl" ] }, "value": { "type": "string", "minLength": 1, "description": "LinkedIn company URL (e.g. 'https://www.linkedin.com/company/openai')." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinSlug" ] }, "value": { "type": "string", "minLength": 1, "description": "LinkedIn company slug (e.g. 'openai')." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinOrgId" ] }, "value": { "type": "string", "pattern": "^\\d+$", "minLength": 1, "description": "LinkedIn numeric organization ID (e.g. '11130470')." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "value": { "type": "string", "minLength": 1, "description": "Company website domain (e.g. 'openai.com')." } }, "required": [ "identifier", "value" ] } ], "description": "Company identifier. Set identifier to 'linkedinUrl', 'linkedinSlug', 'linkedinOrgId', or 'domain' and provide the corresponding value." } }, "required": [ "apiKey", "company" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "company": { "type": "object", "properties": { "linkedinUrl": { "type": [ "string", "null" ], "minLength": 1, "description": "LinkedIn company URL. Null when no validated LinkedIn URL could be resolved." }, "linkedinOrgId": { "type": [ "string", "null" ], "minLength": 1, "description": "LinkedIn numeric organization ID. Null when the company has no known org ID." }, "name": { "type": [ "string", "null" ], "minLength": 1, "description": "Company display name. Null when the name is not available in our data." }, "domain": { "type": [ "string", "null" ], "minLength": 1, "description": "Company website domain. Null when the domain is not available in our data." } }, "required": [ "linkedinUrl", "linkedinOrgId", "name", "domain" ] }, "report": { "type": "object", "properties": { "news": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "description": "Article headline" }, "url": { "type": "string", "description": "Article URL" }, "date": { "type": [ "string", "null" ], "description": "Publication date (ISO format) or null" }, "summary": { "type": [ "string", "null" ], "description": "Brief summary of the article" }, "sentiment": { "type": [ "string", "null" ], "enum": [ "positive", "negative", "neutral", null ], "description": "Article tone toward the company. Use null if unclear." } }, "required": [ "title", "url" ] }, "default": [] }, "mediaLinks": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "youtube", "podcast" ] }, "title": { "type": "string" }, "url": { "type": "string" }, "description": { "type": [ "string", "null" ] } }, "required": [ "type", "title", "url" ] }, "default": [] }, "blogPosts": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "url": { "type": "string" }, "date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] } }, "required": [ "title", "url" ] }, "default": [] }, "aboutDescription": { "type": [ "string", "null" ] }, "companyPhotos": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "caption": { "type": [ "string", "null" ] } }, "required": [ "url" ] }, "default": [] }, "milestones": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "description": { "type": "string" }, "date": { "type": [ "string", "null" ] } }, "required": [ "type", "description" ] }, "default": [] }, "fundingInfo": { "type": [ "object", "null" ], "properties": { "stage": { "type": [ "string", "null" ] }, "totalFundingUsd": { "type": [ "number", "null" ] }, "lastRoundUsd": { "type": [ "number", "null" ] }, "lastRoundDate": { "type": [ "string", "null" ] }, "investors": { "type": "array", "items": { "type": "string" }, "default": [] }, "description": { "type": [ "string", "null" ] } }, "required": [ "investors" ] }, "jobPosts": { "type": "array", "items": { "type": "object", "properties": { "jobId": { "type": "string" }, "title": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "postedAt": { "type": [ "string", "null" ] }, "jobUrl": { "type": [ "string", "null" ] }, "locationType": { "type": [ "string", "null" ] } }, "required": [ "jobId", "title", "location", "postedAt", "jobUrl", "locationType" ] }, "default": [] }, "founders": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "role": { "type": [ "string", "null" ] }, "linkedinUrl": { "type": [ "string", "null" ] }, "profilePicUrl": { "type": [ "string", "null" ] } }, "required": [ "name" ] }, "default": [] }, "historicalHeadcount": { "type": [ "object", "null" ], "properties": { "latest_snapshot_date": { "type": "string", "format": "date" }, "snapshots": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "employees": { "type": "integer" } }, "required": [ "date", "employees" ] } }, "growth": { "type": "object", "properties": { "1m": { "type": [ "object", "null" ], "properties": { "percent": { "type": "number" }, "quantity": { "type": "integer" } }, "required": [ "percent", "quantity" ] }, "2m": { "type": [ "object", "null" ], "properties": { "percent": { "type": "number" }, "quantity": { "type": "integer" } }, "required": [ "percent", "quantity" ] }, "3m": { "type": [ "object", "null" ], "properties": { "percent": { "type": "number" }, "quantity": { "type": "integer" } }, "required": [ "percent", "quantity" ] }, "6m": { "type": [ "object", "null" ], "properties": { "percent": { "type": "number" }, "quantity": { "type": "integer" } }, "required": [ "percent", "quantity" ] }, "12m": { "type": [ "object", "null" ], "properties": { "percent": { "type": "number" }, "quantity": { "type": "integer" } }, "required": [ "percent", "quantity" ] }, "18m": { "type": [ "object", "null" ], "properties": { "percent": { "type": "number" }, "quantity": { "type": "integer" } }, "required": [ "percent", "quantity" ] }, "24m": { "type": [ "object", "null" ], "properties": { "percent": { "type": "number" }, "quantity": { "type": "integer" } }, "required": [ "percent", "quantity" ] }, "36m": { "type": [ "object", "null" ], "properties": { "percent": { "type": "number" }, "quantity": { "type": "integer" } }, "required": [ "percent", "quantity" ] } } } }, "required": [ "latest_snapshot_date", "snapshots", "growth" ], "default": null }, "companySummary": { "type": [ "string", "null" ], "default": null }, "companyProfile": { "type": [ "object", "null" ], "properties": { "name": { "type": [ "string", "null" ] }, "headline": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "logoUrl": { "type": [ "string", "null" ] }, "website": { "type": [ "string", "null" ] }, "linkedinUrl": { "type": [ "string", "null" ] }, "followerCount": { "type": [ "number", "null" ] }, "employeeCount": { "type": [ "number", "null" ] }, "foundedYear": { "type": [ "number", "null" ] }, "streetAddress": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "countryName": { "type": [ "string", "null" ] }, "stateCode": { "type": [ "string", "null" ] }, "industries": { "type": [ "array", "null" ], "items": { "type": "string" } }, "specialties": { "type": [ "array", "null" ], "items": { "type": "string" } }, "twitterHandle": { "type": [ "string", "null" ] }, "facebookUrl": { "type": [ "string", "null" ] }, "wellfoundSlug": { "type": [ "string", "null" ] } }, "required": [ "name", "headline", "description", "logoUrl", "website", "linkedinUrl", "followerCount", "employeeCount", "foundedYear", "streetAddress", "locality", "countryName", "stateCode", "industries", "specialties", "twitterHandle", "facebookUrl", "wellfoundSlug" ], "default": null }, "officeLocations": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": [ "string", "null" ] }, "is_primary": { "type": [ "boolean", "null" ] }, "location": { "type": [ "object", "null" ], "properties": { "street_address": { "type": [ "string", "null" ] }, "neighborhood": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "state_name": { "type": [ "string", "null" ] }, "state_code": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] }, "country_code": { "type": [ "string", "null" ] }, "country_name": { "type": [ "string", "null" ] }, "coordinates": { "type": [ "object", "null" ], "properties": { "lat": { "type": "number" }, "lon": { "type": "number" } }, "required": [ "lat", "lon" ] }, "timezone": { "type": [ "string", "null" ] }, "full_address": { "type": [ "string", "null" ] }, "formatted_address": { "type": [ "string", "null" ] } } } } }, "default": [], "description": "Company office locations with structured address details and coordinates. Empty when no office data is available." } }, "required": [ "news", "mediaLinks", "blogPosts", "companyPhotos", "milestones", "jobPosts", "founders", "historicalHeadcount", "companySummary", "companyProfile", "officeLocations" ], "description": "The generated scouting report" } }, "required": [ "company", "report" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getSkills `GET /v1/enums/skills` **Tags:** `Enums` List skills **Endpoint:** `https://api.fiber.ai/v1/enums/skills` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "array", "items": { "type": "string", "minLength": 1, "description": "A professional skill name" } }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getSubdivisions `GET /v1/enums/subdivisions` **Tags:** `Enums` List subdivisions by country **Endpoint:** `https://api.fiber.ai/v1/enums/subdivisions` ## Description Get a list of subdivisions (states, provinces, Länder, etc.) for a given country, identified by ISO 3166-1 alpha-2 or alpha-3 code. ⚡ Rate limit: 250 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | | `countryCode` | query | 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. | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "countryCode": { "type": "string", "description": "The alpha-3 country code that was queried." }, "subdivisions": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "The subdivision code without the country prefix (e.g. 'CA' for California, 'MH' for Maharashtra)." }, "name": { "type": "string", "description": "The official name of the subdivision." }, "type": { "type": "string", "description": "The type of subdivision (e.g. 'State', 'Province', 'Land')." }, "alternateNames": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The alternate name." }, "languageCode": { "type": "string", "description": "The ISO 639 language code (e.g. 'eng', 'hin', 'deu')." } }, "required": [ "name", "languageCode" ] }, "description": "The alternate or local names for the subdivision." } }, "required": [ "code", "name", "type", "alternateNames" ] } } }, "required": [ "countryCode", "subdivisions" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getTags `GET /v1/enums/tags` **Tags:** `Enums` List profile and company tags **Endpoint:** `https://api.fiber.ai/v1/enums/tags` ## Description Get a list of all profile and company tags that you can use to filter searches in our API, along with their descriptions. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "profileTags": { "type": "array", "items": { "type": "object", "properties": { "slug": { "type": "string", "enum": [ "student", "attended-top-us-university", "attended-top-global-university", "second-time-founder", "deep-technical-background", "major-tech-company-experience", "fortune-500-executive", "recently-changed-companies", "recently-promoted", "decision-maker", "c-suite", "experienced-executive", "phd", "influencer", "board-member" ] }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "emoji": { "type": "string" } }, "required": [ "slug", "name", "emoji" ] }, "description": "List of all available profile tags" }, "companyTags": { "type": "array", "items": { "type": "object", "properties": { "slug": { "type": "string", "enum": [ "raised-from-top-vc", "is-government", "is-school", "venture-backed-startup" ] }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "emoji": { "type": "string" } }, "required": [ "slug", "name", "emoji" ] }, "description": "List of all available company tags" } }, "required": [ "profileTags", "companyTags" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getTalentFlow `POST /v1/talent-flow` **Tags:** `Company info` Get talent flow analysis for a company **Endpoint:** `https://api.fiber.ai/v1/talent-flow` ## Description 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. ⚡ Rate limit: 30 requests per 1 minute 💰 Cost: 5 credits per talent flow report ⓘ ⏱ Recommended timeout: 2 minutes ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "company": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinUrl" ] }, "value": { "type": "string", "minLength": 1, "description": "LinkedIn company URL (e.g. 'https://www.linkedin.com/company/openai')." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinSlug" ] }, "value": { "type": "string", "minLength": 1, "description": "LinkedIn company slug (e.g. 'openai')." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinOrgId" ] }, "value": { "type": "string", "pattern": "^\\d+$", "minLength": 1, "description": "LinkedIn numeric organization ID (e.g. '11130470')." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "value": { "type": "string", "minLength": 1, "description": "Company website domain (e.g. 'openai.com')." } }, "required": [ "identifier", "value" ] } ], "description": "Company to analyze. Set identifier to 'linkedinUrl', 'linkedinSlug', 'linkedinOrgId', or 'domain' and provide the corresponding value." }, "direction": { "type": "string", "enum": [ "joiners", "leavers" ], "description": "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." }, "dateRange": { "type": "object", "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "apiKey", "company", "direction", "dateRange" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "direction": { "type": "string", "enum": [ "joiners", "leavers" ], "description": "Direction of the analysis." }, "company": { "type": "object", "properties": { "name": { "type": "string", "description": "Company name." }, "linkedinOrgId": { "type": "string", "description": "LinkedIn organization ID (e.g. '1441' for Google)." }, "domains": { "type": "array", "items": { "type": "string" }, "description": "Company website domains." }, "linkedinSlug": { "type": [ "string", "null" ], "description": "LinkedIn company slug (e.g. 'anthropic')." } }, "required": [ "name", "linkedinOrgId", "domains" ], "description": "Company that was analyzed." }, "window": { "type": "object", "properties": { "after": { "type": [ "string", "null" ], "description": "Start of the analysis window (YYYY-MM-DD). Null means no lower bound." }, "before": { "type": [ "string", "null" ], "description": "End of the analysis window (YYYY-MM-DD). Null means no upper bound." } }, "description": "Time window for the analysis." }, "peopleCount": { "type": "integer", "minimum": 0, "description": "Number of people who joined (joiners) or left (leavers) the company within the analysis window." }, "companyBuckets": { "type": "array", "items": { "type": "object", "properties": { "companyName": { "type": "string", "description": "Company name." }, "domain": { "type": [ "string", "null" ], "description": "Company website domain (e.g. 'amazon.com')." }, "linkedinUrl": { "type": [ "string", "null" ], "description": "LinkedIn company URL." }, "linkedinOrgId": { "type": [ "string", "null" ], "description": "LinkedIn organization ID." }, "count": { "type": "integer", "minimum": 0, "description": "Number of people who came from this company (joiners) or went to this company (leavers)." }, "percent": { "type": "number", "minimum": 0, "maximum": 100, "description": "Percentage of total people (0-100, one decimal place)." }, "stage": { "type": [ "string", "null" ], "description": "Funding stage (e.g. 'Series A', 'Acquired', 'IPO')." }, "totalFundingUsd": { "type": [ "number", "null" ], "description": "Total funding raised in USD, if available." }, "valuationUsd": { "type": [ "number", "null" ], "description": "Latest known valuation in USD, if available." } }, "required": [ "companyName", "count", "percent" ] }, "description": "Where people came from (joiners) or went to (leavers), sorted by count descending." }, "yearsOfExperience": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "description": "Number of data points." }, "median": { "type": [ "number", "null" ], "description": "Median value." }, "mean": { "type": [ "number", "null" ], "description": "Mean (average) value." }, "stdDev": { "type": [ "number", "null" ], "description": "Standard deviation." }, "p25": { "type": [ "number", "null" ], "description": "25th percentile." }, "p75": { "type": [ "number", "null" ], "description": "75th percentile." }, "min": { "type": [ "number", "null" ], "description": "Minimum value." }, "max": { "type": [ "number", "null" ], "description": "Maximum value." } }, "required": [ "count" ], "description": "Years of experience at the time of the join or leave event." }, "tenureMonths": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "description": "Number of data points." }, "median": { "type": [ "number", "null" ], "description": "Median value." }, "mean": { "type": [ "number", "null" ], "description": "Mean (average) value." }, "stdDev": { "type": [ "number", "null" ], "description": "Standard deviation." }, "p25": { "type": [ "number", "null" ], "description": "25th percentile." }, "p75": { "type": [ "number", "null" ], "description": "75th percentile." }, "min": { "type": [ "number", "null" ], "description": "Minimum value." }, "max": { "type": [ "number", "null" ], "description": "Maximum value." } }, "required": [ "count" ], "description": "Tenure at the analyzed company, in months." }, "breakdowns": { "type": "object", "properties": { "bySeniority": { "type": "array", "items": { "type": "object", "properties": { "seniority": { "type": "string", "description": "Seniority level label." }, "count": { "type": "integer", "minimum": 0, "description": "Number of people at this seniority." }, "percent": { "type": "number", "minimum": 0, "maximum": 100, "description": "Percentage of total people (0-100)." } }, "required": [ "seniority", "count", "percent" ] }, "description": "Breakdown by seniority level." }, "byJobFunction": { "type": "array", "items": { "type": "object", "properties": { "jobFunction": { "type": "string", "description": "Job function label." }, "count": { "type": "integer", "minimum": 0, "description": "Number of people in this function." }, "percent": { "type": "number", "minimum": 0, "maximum": 100, "description": "Percentage of total people (0-100)." } }, "required": [ "jobFunction", "count", "percent" ] }, "description": "Breakdown by job function." }, "byCountry": { "type": "array", "items": { "type": "object", "properties": { "countryCode": { "type": "string", "description": "ISO 3166-1 alpha-3 country code (e.g. 'USA', 'GBR', 'IND')." }, "countryName": { "type": "string", "description": "Full English country name." }, "count": { "type": "integer", "minimum": 0, "description": "Number of people in this country." }, "percent": { "type": "number", "minimum": 0, "maximum": 100, "description": "Percentage of total people (0-100)." } }, "required": [ "countryCode", "countryName", "count", "percent" ] }, "description": "Breakdown by country." }, "byMetro": { "type": "array", "items": { "type": "object", "properties": { "slug": { "type": "string", "description": "Region identifier. Preset metros use slugs like 'sf-bay-area'; non-preset metros are clustered and use 'unknown-metro' with centroid coordinates; profiles with no location use 'no-location'." }, "name": { "type": "string", "description": "Metro area display name." }, "count": { "type": "integer", "minimum": 0, "description": "Number of people in this metro area." }, "percent": { "type": "number", "minimum": 0, "maximum": 100, "description": "Percentage of total people (0-100)." }, "centroid": { "type": [ "object", "null" ], "properties": { "lat": { "type": "number", "description": "Centroid latitude." }, "lon": { "type": "number", "description": "Centroid longitude." } }, "required": [ "lat", "lon" ], "description": "Centroid coordinates for clustered metros. Null for preset regions and no-location." } }, "required": [ "slug", "name", "count", "percent" ] }, "description": "Breakdown by metro area." }, "bySchool": { "type": "array", "items": { "type": "object", "properties": { "school": { "type": "string", "description": "School or university name." }, "count": { "type": "integer", "minimum": 0, "description": "Number of people from this school." }, "percent": { "type": "number", "minimum": 0, "maximum": 100, "description": "Percentage of total people (0-100)." } }, "required": [ "school", "count", "percent" ] }, "description": "Breakdown by school or university." }, "byYearsOfExperience": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "Years of experience range label." }, "count": { "type": "integer", "minimum": 0, "description": "Number of people in this range." }, "percent": { "type": "number", "minimum": 0, "maximum": 100, "description": "Percentage of total people (0-100)." } }, "required": [ "label", "count", "percent" ] }, "description": "Years of experience distribution histogram." } }, "required": [ "bySeniority", "byJobFunction", "byCountry", "byMetro", "bySchool", "byYearsOfExperience" ], "description": "Categorical breakdowns of the analyzed population." }, "generatedAt": { "type": "string", "description": "ISO 8601 timestamp when the report was generated." }, "markdownSummary": { "type": "string", "description": "Human-readable markdown summary of the report, including tables and charts." } }, "required": [ "direction", "company", "window", "peopleCount", "companyBuckets", "yearsOfExperience", "tenureMonths", "breakdowns", "generatedAt", "markdownSummary" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getTalentFlowRivals `POST /v1/talent-flow/rivals` **Tags:** `Company info` Get top talent sources/destinations for a company **Endpoint:** `https://api.fiber.ai/v1/talent-flow/rivals` ## Description 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. ⚡ Rate limit: 30 requests per 1 minute 💰 Cost: 5 credits per talent flow report ⓘ ⏱ Recommended timeout: 4 minutes ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "company": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinUrl" ] }, "value": { "type": "string", "minLength": 1, "description": "LinkedIn company URL (e.g. 'https://www.linkedin.com/company/openai')." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinSlug" ] }, "value": { "type": "string", "minLength": 1, "description": "LinkedIn company slug (e.g. 'openai')." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinOrgId" ] }, "value": { "type": "string", "pattern": "^\\d+$", "minLength": 1, "description": "LinkedIn numeric organization ID (e.g. '11130470')." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "value": { "type": "string", "minLength": 1, "description": "Company website domain (e.g. 'openai.com')." } }, "required": [ "identifier", "value" ] } ], "description": "Company to analyze. Set identifier to 'linkedinUrl', 'linkedinSlug', 'linkedinOrgId', or 'domain' and provide the corresponding value." }, "dateRange": { "type": "object", "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } }, "numCompaniesPerSide": { "type": "integer", "minimum": 1, "maximum": 50, "default": 10, "description": "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." } }, "required": [ "apiKey", "company", "dateRange" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "company": { "type": "object", "properties": { "name": { "type": "string", "description": "Company name." }, "linkedinOrgId": { "type": "string", "description": "LinkedIn organization ID (e.g. '1441' for Google)." }, "domains": { "type": "array", "items": { "type": "string" }, "description": "Company website domains." }, "linkedinSlug": { "type": [ "string", "null" ], "description": "LinkedIn company slug (e.g. 'anthropic')." } }, "required": [ "name", "linkedinOrgId", "domains" ], "description": "Company that was analyzed." }, "window": { "type": "object", "properties": { "after": { "type": [ "string", "null" ], "description": "Start of the analysis window (YYYY-MM-DD). Null means no lower bound." }, "before": { "type": [ "string", "null" ], "description": "End of the analysis window (YYYY-MM-DD). Null means no upper bound." } }, "description": "Time window for the analysis." }, "numCompaniesPerSide": { "type": "integer", "minimum": 1, "description": "Requested number of donor and acceptor companies per side." }, "joinersCount": { "type": "integer", "minimum": 0, "description": "Number of people who joined the analyzed company within the window." }, "leaversCount": { "type": "integer", "minimum": 0, "description": "Number of people who left the analyzed company within the window." }, "rivals": { "type": "array", "items": { "type": "object", "properties": { "companyName": { "type": "string", "description": "Rival company name." }, "domain": { "type": [ "string", "null" ], "description": "Rival company website domain (e.g. 'stripe.com')." }, "linkedinUrl": { "type": [ "string", "null" ], "description": "Rival company LinkedIn URL." }, "linkedinOrgId": { "type": [ "string", "null" ], "description": "Rival company LinkedIn organization ID." }, "gainedCount": { "type": "integer", "minimum": 0, "description": "People who left this company to join the analyzed company within the window." }, "lostCount": { "type": "integer", "minimum": 0, "description": "People who left the analyzed company to join this company within the window." }, "netCount": { "type": "integer", "description": "gainedCount minus lostCount. Positive means the analyzed company gained more talent from this company than it lost to it." }, "totalMovesCount": { "type": "integer", "minimum": 0, "description": "Total two-way moves with this company (gainedCount plus lostCount)." }, "stage": { "type": [ "string", "null" ], "description": "Rival company funding stage (e.g. 'Series A', 'IPO')." }, "totalFundingUsd": { "type": [ "number", "null" ], "description": "Rival company total funding raised in USD, if available." }, "valuationUsd": { "type": [ "number", "null" ], "description": "Rival company latest known valuation in USD, if available." } }, "required": [ "companyName", "gainedCount", "lostCount", "netCount", "totalMovesCount" ] }, "description": "Companies trading the most talent with the analyzed company, sorted by total two-way moves (gained plus lost) descending. Includes up to `numCompaniesPerSide` top donors (companies it hires from most) and up to `numCompaniesPerSide` top acceptors (companies its alumni join most); overlapping companies are combined into one entry." }, "generatedAt": { "type": "string", "description": "ISO 8601 timestamp when the report was generated." }, "markdownSummary": { "type": "string", "description": "Human-readable markdown summary of the report, including a rival table." } }, "required": [ "company", "window", "numCompaniesPerSide", "joinersCount", "leaversCount", "rivals", "generatedAt", "markdownSummary" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getTechnologies `GET /v1/enums/technologies` **Tags:** `Enums` List technologies **Endpoint:** `https://api.fiber.ai/v1/enums/technologies` ## Description Get all searchable technologies and platforms with their synonyms. Useful for the technology search API. ⚡ Rate limit: 50 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "array", "items": { "type": "object", "properties": { "technology": { "type": "string", "minLength": 1, "description": "Canonical slug for this technology or platform" }, "synonyms": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Human-readable names and variants" }, "category": { "type": [ "string", "null" ], "description": "Technology category (e.g. CMS, CRM, Analytics)" }, "type": { "type": "string", "enum": [ "technology", "platform" ], "description": "Whether this is a technology or a platform" } }, "required": [ "technology", "synonyms", "type" ] } }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getTimeZones `GET /v1/enums/time-zones` **Tags:** `Enums` List time zones **Endpoint:** `https://api.fiber.ai/v1/enums/time-zones` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "array", "items": { "type": "object", "properties": { "timeZoneName": { "type": "string", "description": "The IANA timezone identifier (e.g., 'America/New_York')" }, "minUtcOffsetMinutes": { "type": "integer", "minimum": -840, "maximum": 840, "description": "The minimum (most negative) offset from UTC at any point in the year, in minutes. Time zones that observe daylight saving time will have a max offset 60 minutes greater than their min offset." }, "maxUtcOffsetMinutes": { "type": "integer", "minimum": -840, "maximum": 840, "description": "The maximum (most positive) offset from UTC at any point in the year, in minutes. Time zones that observe daylight saving time will have a max offset 60 minutes greater than their min offset." }, "continentCode": { "type": [ "string", "null" ], "description": "Continent code (e.g., 'NA' for North America)" }, "continentName": { "type": [ "string", "null" ], "description": "Continent name (e.g., 'North America')" }, "countryName": { "type": [ "string", "null" ], "description": "Country name (e.g., 'United States')" }, "countryCodeAlpha2": { "type": [ "string", "null" ], "description": "The ISO 3166-1 alpha-2 country code (e.g. 'US')." }, "mainCities": { "type": "array", "items": { "type": "string" }, "description": "Major cities in this timezone" }, "alternativeName": { "type": "string", "description": "Alternative/common name for the timezone" }, "subZones": { "type": "array", "items": { "type": "string" }, "description": "Related timezone variants that share geographic proximity or similar time offset behaviors (e.g., Mountain Time zones in British Columbia: 'America/Creston', 'America/Dawson_Creek', 'America/Fort_Nelson')" }, "currentUtcOffsetMinutes": { "type": "integer", "minimum": -840, "maximum": 840, "description": "Current UTC offset in minutes" }, "currentLocalTime": { "type": "string", "description": "Current time in this timezone, formatted as an ISO 8601 string." }, "abbreviation": { "type": "string", "description": "Current timezone abbreviation (e.g., 'EST', 'PDT')" }, "displayName": { "type": "string", "description": "Human-friendly display name" }, "isDaylightSaving": { "type": "boolean", "description": "Whether the time zone is currently observing daylight saving time." } }, "required": [ "timeZoneName", "minUtcOffsetMinutes", "maxUtcOffsetMinutes", "mainCities", "alternativeName", "subZones", "currentUtcOffsetMinutes", "currentLocalTime", "abbreviation", "displayName", "isDaylightSaving" ] }, "description": "The list of all available time zones with comprehensive information." }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getTrackerCompanyList `GET /v1/tracker/company-lists/{listId}` **Tags:** `Tracker` Get company tracker list **Endpoint:** `https://api.fiber.ai/v1/tracker/company-lists/{listId}` ## Description Get a single company tracker list by ID. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | | `listId` | path | yes | The unique ID of the tracker list. | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "id": { "type": "string", "description": "Tracker list ID." }, "name": { "type": "string", "description": "Name of the list." }, "refreshIntervalDays": { "type": "integer", "description": "Check interval in days." }, "trackingRules": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "headcount_crossed_threshold" }, "entityType": { "type": "string", "const": "company" }, "direction": { "type": "string", "enum": [ "above", "below" ], "description": "Whether to alert when headcount crosses the threshold going up or down" }, "threshold": { "type": "integer", "exclusiveMinimum": 0, "description": "The employee count threshold to watch for crossing. Any positive integer is accepted." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "direction", "threshold", "id" ], "title": "Headcount crossed threshold" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "headcount_growth_percent" }, "entityType": { "type": "string", "const": "company" }, "minPercentChange": { "type": "number", "exclusiveMinimum": 0, "maximum": 1000, "description": "Minimum percent change to trigger (e.g. 20 means 20% growth)" }, "direction": { "type": "string", "enum": [ "grew", "shrank", "either" ], "description": "Whether to alert on growth, shrinkage, or either" }, "minStartingHeadcount": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Only alert if the company had at least this many employees before the change. Omit for any starting size." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "minPercentChange", "direction", "id" ], "title": "Headcount growth percent" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "new_funding_round" }, "entityType": { "type": "string", "const": "company" }, "minAmountUsd": { "type": [ "number", "null" ], "minimum": 0, "description": "Only alert for rounds above this amount. Omit for any amount." }, "roundTypes": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "pre_seed", "seed", "angel", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "private_equity", "debt_financing", "grant", "convertible_note", "corporate_round", "undisclosed" ] }, "minItems": 1, "description": "Round types to alert on. Defaults to equity-focused types when omitted. Set explicitly to include debt/grant types." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "New funding round" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "funding_stage_changed" }, "entityType": { "type": "string", "const": "company" }, "toStages": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "private_equity", "public", "acquired" ] }, "minItems": 1, "description": "Only alert if new stage is one of these. Omit for any stage change." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Funding stage changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "job_posting_with_keyword" }, "entityType": { "type": "string", "const": "company" }, "keywords": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Alert when a job posting title contains any of these keywords" }, "seniorityLevels": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Internship", "Entry level", "Associate", "Mid-Senior level", "Director", "Executive" ] }, "minItems": 1, "description": "Only alert for these seniority levels. Omit for any level." }, "modalities": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "On-site", "Remote", "Hybrid" ] }, "minItems": 1, "description": "Only alert for these job modalities. Omit for any." }, "locationTypes": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "remote", "on_site", "hybrid" ] }, "minItems": 1, "description": "Deprecated. Use modalities instead.", "deprecated": true }, "minPostings": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Only alert if at least this many NEW matching postings are detected in a single check cycle. Omit for 1 (any new match)." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "keywords", "id" ], "title": "Job posting with keyword" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "job_posting_in_function" }, "entityType": { "type": "string", "const": "company" }, "jobFunctions": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Accounting", "Administrative", "Advertising", "Analyst", "Art / Creative", "Business Development", "Community & Social Services", "Consulting", "Customer Service", "Design", "Distribution", "Education", "Engineering", "Entrepreneurship", "Finance", "General Business", "Health Care Provider", "Human Resources", "Information Technology", "Legal", "Management", "Manufacturing", "Marketing", "Military & Protective Services", "Other", "Product Management", "Production", "Program & Product Management", "Project Management", "Public Relations", "Purchasing", "Quality Assurance", "Real Estate", "Research", "Sales", "Science", "Strategy / Planning", "Supply Chain", "Training", "Writing / Editing" ] }, "description": "Alert when a job posting is in any of these departments/functions." }, "minPostings": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Only alert if at least this many NEW matching postings are detected in a single check cycle. Omit for 1 (any new match)." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "jobFunctions", "id" ], "title": "Job posting in function" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "news_with_keyword" }, "entityType": { "type": "string", "const": "company" }, "keywords": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Alert when a news article title or summary matches any keyword" }, "sentiment": { "type": [ "string", "null" ], "enum": [ "positive", "negative", "neutral", null ], "description": "Only alert for news with this sentiment. Omit for any sentiment." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "keywords", "id" ], "title": "News with keyword" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_news" }, "entityType": { "type": "string", "const": "company" }, "sentiment": { "type": [ "string", "null" ], "enum": [ "positive", "negative", "neutral", null ], "description": "Only alert for news with this sentiment. Omit for any sentiment." }, "minArticles": { "type": [ "integer", "null" ], "minimum": 1, "description": "Only alert when at least this many articles are detected in a single check. Useful for filtering noise from single tangential mentions. Omit for any count." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Company news" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "hq_location_changed" }, "entityType": { "type": "string", "const": "company" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "HQ location changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_status_changed" }, "entityType": { "type": "string", "const": "company" }, "toStatuses": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "operating", "acquired", "closed", "ipo", "subsidiary" ] }, "minItems": 1, "description": "Only alert if new status is one of these. Omit for any status change." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Company status changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "technology_added" }, "entityType": { "type": "string", "const": "company" }, "technologies": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert for these technologies. Omit for any new technology." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Technology added" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_posted" }, "entityType": { "type": "string", "const": "company" }, "minReactions": { "type": [ "integer", "null" ], "minimum": 0, "description": "Only alert for posts with at least this many reactions. Omit for any." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Company posted" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_posted_with_keyword" }, "entityType": { "type": "string", "const": "company" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Alert for posts matching these keywords." }, "minReactions": { "type": [ "integer", "null" ], "minimum": 0, "description": "Only alert for posts with at least this many reactions. Omit for any." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Company posted with keyword" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "follower_count_growth" }, "entityType": { "type": "string", "const": "company" }, "minAbsoluteGrowth": { "type": [ "integer", "null" ], "minimum": 0, "description": "Minimum absolute follower increase to trigger. Omit or set to 0 for any increase." }, "minPercentGrowth": { "type": [ "number", "null" ], "exclusiveMinimum": 0, "description": "Minimum percent follower increase to trigger. Omit for any increase." }, "minStartingFollowerCount": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Only alert if the company had at least this many followers before the growth. Omit for any starting count." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Follower count growth" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_name_changed" }, "entityType": { "type": "string", "const": "company" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Company name changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_description_changed" }, "entityType": { "type": "string", "const": "company" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if new description contains one of these keywords. Omit for any change." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Company description changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_went_inactive" }, "entityType": { "type": "string", "const": "company" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "description": "Fires when a company becomes inactive.", "title": "Company went inactive" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "employee_count_milestone" }, "entityType": { "type": "string", "const": "company" }, "milestone": { "type": "integer", "exclusiveMinimum": 0, "description": "The employee count threshold to watch for crossing. Any positive integer is accepted. Equivalent to 'threshold' in headcount_crossed_threshold." }, "direction": { "type": "string", "enum": [ "above", "below" ], "description": "Whether to alert when crossing above or below the milestone" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "milestone", "direction", "id" ], "description": "Fires when the employee count crosses the specified value. Supports any positive integer, not just round milestones. Functionally equivalent to headcount_crossed_threshold.", "title": "Employee count milestone" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "new_office_location" }, "entityType": { "type": "string", "const": "company" }, "countries": { "type": [ "array", "null" ], "items": { "type": "string", "pattern": "^[A-Z]{3}$", "minLength": 3, "maxLength": 3 }, "minItems": 1, "description": "ISO 3166-1 alpha-3 country codes (e.g. 'USA', 'GBR', 'DEU'). Only alert for offices in these countries. Omit for any new office." }, "cities": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "City names (e.g. 'San Francisco', 'London', 'Berlin'). Only alert for offices in these cities. Omit for any new office." }, "regions": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Region codes (e.g. 'X-EMEA', 'X-APAC', 'X-EUROPE'). Expands to constituent country codes. Omit for any." }, "states": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "State or province names (e.g. 'California', 'Ontario'). Omit for any." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "New office location" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_logo_changed" }, "entityType": { "type": "string", "const": "company" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Company logo changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "acquired_company" }, "entityType": { "type": "string", "const": "company" }, "minPriceUsd": { "type": [ "number", "null" ], "minimum": 0, "description": "Only alert for acquisitions above this price. Omit for any acquisition." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Acquired company" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "new_investor" }, "entityType": { "type": "string", "const": "company" }, "investorNames": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert when a new investor's name matches one of these (exact, case-insensitive). Omit for any new investor." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "New investor" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "recently_hired_with_title" }, "entityType": { "type": "string", "const": "company" }, "titleKeywords": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Title keywords to search for. Fires when the company hires someone whose title matches any keyword." }, "minNewHires": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Minimum number of NEW hires detected in a single check cycle to trigger the alert. Only counts employees who appeared since the last check. Omit for 1." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "titleKeywords", "id" ], "title": "Recently hired with title" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "department_size_threshold" }, "entityType": { "type": "string", "const": "company" }, "department": { "type": "string", "enum": [ "Accounting", "Administrative", "Advertising", "Analyst", "Art / Creative", "Business Development", "Community & Social Services", "Consulting", "Customer Service", "Design", "Distribution", "Education", "Engineering", "Entrepreneurship", "Finance", "General Business", "Health Care Provider", "Human Resources", "Information Technology", "Legal", "Management", "Manufacturing", "Marketing", "Military & Protective Services", "Other", "Product Management", "Production", "Program & Product Management", "Project Management", "Public Relations", "Purchasing", "Quality Assurance", "Real Estate", "Research", "Sales", "Science", "Strategy / Planning", "Supply Chain", "Training", "Writing / Editing" ], "description": "Department to track. Matched against the company's organizational structure." }, "threshold": { "type": "integer", "exclusiveMinimum": 0, "description": "The employee count threshold to watch for crossing" }, "direction": { "type": "string", "enum": [ "above", "below" ], "description": "Whether to alert when department size crosses above or below the threshold" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "department", "threshold", "direction", "id" ], "title": "Department size threshold" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "recent_layoffs" }, "entityType": { "type": "string", "const": "company" }, "minPeopleAffected": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Only alert if at least this many people were laid off. Omit for any layoff." }, "minPercentAffected": { "type": [ "number", "null" ], "exclusiveMinimum": 0, "maximum": 100, "description": "Only alert if at least this percentage of the workforce was laid off. Omit for any layoff." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Recent layoffs" } ], "discriminator": { "propertyName": "type", "mapping": { "headcount_crossed_threshold": "#/components/schemas/HeadcountCrossedThresholdResponse", "headcount_growth_percent": "#/components/schemas/HeadcountGrowthPercentResponse", "new_funding_round": "#/components/schemas/NewFundingRoundResponse", "funding_stage_changed": "#/components/schemas/FundingStageChangedResponse", "job_posting_with_keyword": "#/components/schemas/JobPostingWithKeywordResponse", "job_posting_in_function": "#/components/schemas/JobPostingInFunctionResponse", "news_with_keyword": "#/components/schemas/NewsWithKeywordResponse", "company_news": "#/components/schemas/CompanyNewsResponse", "hq_location_changed": "#/components/schemas/HqLocationChangedResponse", "company_status_changed": "#/components/schemas/CompanyStatusChangedResponse", "technology_added": "#/components/schemas/TechnologyAddedResponse", "company_posted": "#/components/schemas/CompanyPostedResponse", "company_posted_with_keyword": "#/components/schemas/CompanyPostedWithKeywordResponse", "follower_count_growth": "#/components/schemas/FollowerCountGrowthResponse", "company_name_changed": "#/components/schemas/CompanyNameChangedResponse", "company_description_changed": "#/components/schemas/CompanyDescriptionChangedResponse", "company_went_inactive": "#/components/schemas/CompanyWentInactiveResponse", "employee_count_milestone": "#/components/schemas/EmployeeCountMilestoneResponse", "new_office_location": "#/components/schemas/NewOfficeLocationResponse", "company_logo_changed": "#/components/schemas/CompanyLogoChangedResponse", "acquired_company": "#/components/schemas/AcquiredCompanyResponse", "new_investor": "#/components/schemas/NewInvestorResponse", "recently_hired_with_title": "#/components/schemas/RecentlyHiredWithTitleResponse", "department_size_threshold": "#/components/schemas/DepartmentSizeThresholdResponse", "recent_layoffs": "#/components/schemas/RecentLayoffsResponse" } } }, "description": "Active tracking rules on this list, with IDs for granular management." }, "isActive": { "type": "boolean", "description": "Whether the list is actively being checked." }, "isArchived": { "type": "boolean", "description": "Whether the list is archived." }, "companyCount": { "type": "integer", "minimum": 0, "description": "Number of companies in this list." }, "createdAt": { "type": "string", "format": "date-time", "description": "When the list was created." }, "nextRefreshAt": { "type": [ "string", "null" ], "format": "date-time", "description": "When the entire list will next be refreshed. All entities in the list are checked together at this time. Null if the list has no active entities or is inactive." }, "isDynamic": { "type": "boolean", "description": "Whether this list's membership is query-driven and auto-refreshed (dynamic) rather than manually managed (static)." } }, "required": [ "id", "name", "refreshIntervalDays", "isActive", "isArchived", "companyCount", "createdAt", "isDynamic" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." … _truncated to 65536 chars for ai-docs._ ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getTrackerOverview `GET /v1/tracker/overview` **Tags:** `Tracker` Summarize all tracker lists **Endpoint:** `https://api.fiber.ai/v1/tracker/overview` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "summary": { "type": "object", "properties": { "totalCompanyLists": { "type": "integer", "minimum": 0, "description": "Active, non-archived company tracker lists for the organization." }, "totalPersonLists": { "type": "integer", "minimum": 0, "description": "Active, non-archived person tracker lists for the organization." }, "totalCompaniesTracked": { "type": "integer", "minimum": 0, "description": "Total active companies across all company lists." }, "totalPeopleTracked": { "type": "integer", "minimum": 0, "description": "Total active people across all person lists." }, "totalActiveRules": { "type": "integer", "minimum": 0, "description": "Active tracking rules across all lists." }, "estimatedDailyCredits": { "type": "number", "minimum": 0, "description": "Amortized daily credit burn across all lists at the current entity counts and refresh cadences." }, "estimatedMonthlyCredits": { "type": "number", "minimum": 0, "description": "Estimated 30-day credit burn at the current entity counts and refresh cadences." } }, "required": [ "totalCompanyLists", "totalPersonLists", "totalCompaniesTracked", "totalPeopleTracked", "totalActiveRules", "estimatedDailyCredits", "estimatedMonthlyCredits" ] }, "companyLists": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Tracker list ID." }, "name": { "type": "string", "description": "List name." }, "entityType": { "type": "string", "enum": [ "company", "person" ], "description": "Entity type tracked by this list." }, "refreshIntervalDays": { "type": "integer", "description": "How often the list is checked, in days." }, "isActive": { "type": "boolean", "description": "Whether the list is actively being checked." }, "entityCount": { "type": "integer", "minimum": 0, "description": "Number of active entities currently tracked in this list." }, "ruleCount": { "type": "integer", "minimum": 0, "description": "Number of active tracking rules on this list. Use the GET endpoint for the full rule details." }, "nextRefreshAt": { "type": [ "string", "null" ], "format": "date-time", "description": "ISO timestamp when at least one entity in this list becomes due for its next check. Null if the list has no active entities." }, "estimatedCreditsPerRefresh": { "type": "number", "minimum": 0, "description": "Credits charged for a full refresh of this list at the org's current pricing (entityCount × per-entity cost)." } }, "required": [ "id", "name", "entityType", "refreshIntervalDays", "isActive", "entityCount", "ruleCount", "nextRefreshAt", "estimatedCreditsPerRefresh" ] }, "description": "All non-archived company tracker lists with refresh estimates. May include inactive lists." }, "personLists": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Tracker list ID." }, "name": { "type": "string", "description": "List name." }, "entityType": { "type": "string", "enum": [ "company", "person" ], "description": "Entity type tracked by this list." }, "refreshIntervalDays": { "type": "integer", "description": "How often the list is checked, in days." }, "isActive": { "type": "boolean", "description": "Whether the list is actively being checked." }, "entityCount": { "type": "integer", "minimum": 0, "description": "Number of active entities currently tracked in this list." }, "ruleCount": { "type": "integer", "minimum": 0, "description": "Number of active tracking rules on this list. Use the GET endpoint for the full rule details." }, "nextRefreshAt": { "type": [ "string", "null" ], "format": "date-time", "description": "ISO timestamp when at least one entity in this list becomes due for its next check. Null if the list has no active entities." }, "estimatedCreditsPerRefresh": { "type": "number", "minimum": 0, "description": "Credits charged for a full refresh of this list at the org's current pricing (entityCount × per-entity cost)." } }, "required": [ "id", "name", "entityType", "refreshIntervalDays", "isActive", "entityCount", "ruleCount", "nextRefreshAt", "estimatedCreditsPerRefresh" ] }, "description": "All non-archived person tracker lists with refresh estimates. May include inactive lists." }, "upcomingRefreshes": { "type": "array", "items": { "type": "object", "properties": { "listId": { "type": "string", "description": "Tracker list ID." }, "listName": { "type": "string", "description": "List name." }, "entityType": { "type": "string", "enum": [ "company", "person" ], "description": "Entity type tracked by this list." }, "refreshAt": { "type": "string", "format": "date-time", "description": "ISO timestamp when the next refresh of this list will run." }, "entityCount": { "type": "integer", "minimum": 0, "description": "Number of entities in the list that will be refreshed." }, "estimatedCredits": { "type": "number", "minimum": 0, "description": "Credits that will be charged for this refresh." } }, "required": [ "listId", "listName", "entityType", "refreshAt", "entityCount", "estimatedCredits" ] }, "description": "Next refreshes across all lists, sorted earliest first. Use this to forecast upcoming charges." } }, "required": [ "summary", "companyLists", "personLists", "upcomingRefreshes" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getTrackerPersonList `GET /v1/tracker/person-lists/{listId}` **Tags:** `Tracker` Get person tracker list **Endpoint:** `https://api.fiber.ai/v1/tracker/person-lists/{listId}` ## Description Get a single person tracker list by ID. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | | `listId` | path | yes | The unique ID of the tracker list. | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "id": { "type": "string", "description": "Tracker list ID." }, "name": { "type": "string", "description": "Name of the list." }, "refreshIntervalDays": { "type": "integer", "description": "Check interval in days." }, "trackingRules": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_changed_company" }, "entityType": { "type": "string", "const": "person" }, "toCompanies": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if they moved TO one of these companies (domains or slugs). Omit for any." }, "fromCompanies": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if they moved FROM one of these companies. Omit for any." }, "toTitleKeywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if their title at the new company contains one of these keywords." }, "toSeniorityLevels": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Internship", "Entry level", "Associate", "Mid-Senior level", "Director", "Executive" ] }, "minItems": 1, "description": "Only alert if their seniority at the new company is one of these levels." }, "toEmploymentTypes": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Part-time", "Contract", "Internship", "Temporary", "Volunteer" ] }, "minItems": 1, "description": "Only alert for these employment types at the new company. Omit for any." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person changed company" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_title_changed" }, "entityType": { "type": "string", "const": "person" }, "titleKeywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if new title contains one of these keywords. Omit for any title change." }, "toSeniority": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Internship", "Entry level", "Associate", "Mid-Senior level", "Director", "Executive" ] }, "minItems": 1, "description": "Only alert if the new position's seniority level matches one of these. Omit for any seniority." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person title changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_stealth_changed" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "entered", "exited", "either" ], "description": "Whether to alert on entering stealth, exiting, or either" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "direction", "id" ], "title": "Person stealth changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_open_to_work" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "started", "stopped", "either" ], "description": "Whether to alert when they start or stop signaling open-to-work" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "direction", "id" ], "title": "Person open to work" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_is_hiring" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "started", "stopped", "either" ], "description": "Whether to alert when they start or stop signaling is-hiring" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "direction", "id" ], "title": "Person is hiring" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_headline_changed" }, "entityType": { "type": "string", "const": "person" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if new headline contains one of these keywords. Omit for any change." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person headline changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_location_changed" }, "entityType": { "type": "string", "const": "person" }, "toCountries": { "type": [ "array", "null" ], "items": { "type": "string", "pattern": "^[A-Z]{3}$", "minLength": 3, "maxLength": 3 }, "minItems": 1, "description": "ISO 3166-1 alpha-3 country codes (e.g. 'USA', 'GBR', 'DEU'). Only alert if moved to one of these countries. Omit for any relocation." }, "fromCountries": { "type": [ "array", "null" ], "items": { "type": "string", "pattern": "^[A-Z]{3}$", "minLength": 3, "maxLength": 3 }, "minItems": 1, "description": "Only alert if they moved FROM one of these countries. Omit for any." }, "regions": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Region codes (e.g. 'X-EMEA', 'X-APAC'). Only alert if destination country is in one of these regions. Omit for any." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person location changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_tag_gained" }, "entityType": { "type": "string", "const": "person" }, "tags": { "type": "array", "items": { "type": "string", "enum": [ "student", "attended-top-us-university", "attended-top-global-university", "second-time-founder", "deep-technical-background", "major-tech-company-experience", "fortune-500-executive", "recently-changed-companies", "recently-promoted", "decision-maker", "c-suite", "experienced-executive", "phd", "influencer", "board-member" ] }, "minItems": 1, "description": "Alert when the person gains any of these system-assigned tags." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "tags", "id" ], "title": "Person tag gained" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_posted" }, "entityType": { "type": "string", "const": "person" }, "minReactions": { "type": [ "integer", "null" ], "minimum": 0, "description": "Only alert for posts with at least this many reactions. Omit for any." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person posted" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_posted_with_keyword" }, "entityType": { "type": "string", "const": "person" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Alert for posts matching these keywords." }, "minReactions": { "type": [ "integer", "null" ], "minimum": 0, "description": "Only alert for posts with at least this many reactions. Omit for any." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person posted with keyword" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_reacted_to_post" }, "entityType": { "type": "string", "const": "person" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert for reactions on posts whose content or author name matches these keywords. Omit for any reaction." }, "reactionTypes": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "LIKE", "LOVE", "INSIGHTFUL", "CELEBRATE", "SUPPORT", "FUNNY" ] }, "minItems": 1, "description": "Only alert for these reaction types. Omit for any type." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person reacted to post" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_commented_on_post" }, "entityType": { "type": "string", "const": "person" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert for comments where the comment text, post content (when available from provider), or post author name matches these keywords. Omit for any comment." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person commented on post" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_skills_added" }, "entityType": { "type": "string", "const": "person" }, "skills": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert for these specific skills being added. Omit for any new skill." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person skills added" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_got_promoted" }, "entityType": { "type": "string", "const": "person" }, "seniorityKeywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if new title contains these seniority keywords (e.g. 'VP', 'Director'). Omit for any promotion." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person got promoted" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_started_company" }, "entityType": { "type": "string", "const": "person" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person started company" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_employment_type_changed" }, "entityType": { "type": "string", "const": "person" }, "toTypes": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Part-time", "Contract", "Internship", "Temporary", "Volunteer" ] }, "minItems": 1, "description": "Only alert if new employment type is one of these. Omit for any change." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person employment type changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_connections_milestone" }, "entityType": { "type": "string", "const": "person" }, "threshold": { "type": "integer", "exclusiveMinimum": 0, "description": "Connection count to watch for crossing" }, "direction": { "type": "string", "enum": [ "above", "below" ], "description": "Whether to alert when crossing above or below the threshold" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "threshold", "direction", "id" ], "title": "Person connections milestone" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_follower_milestone" }, "entityType": { "type": "string", "const": "person" }, "threshold": { "type": "integer", "exclusiveMinimum": 0, "description": "Follower count to watch for crossing" }, "direction": { "type": "string", "enum": [ "above", "below" ], "description": "Whether to alert when crossing above or below the threshold" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "threshold", "direction", "id" ], "title": "Person follower milestone" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_summary_changed" }, "entityType": { "type": "string", "const": "person" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if new summary contains one of these keywords. Omit for any change." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person summary changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_new_certification" }, "entityType": { "type": "string", "const": "person" }, "certificationKeywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert for certifications matching these keywords. Omit for any new cert." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person new certification" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_became_verified" }, "entityType": { "type": "string", "const": "person" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person became verified" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_became_premium" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "started", "stopped", "either" ], "description": "Whether to alert when they start or stop having premium status" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "direction", "id" ], "title": "Person became premium" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_became_influencer" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "started", "stopped", "either" ], "description": "Whether to alert when they join or leave the influencer program" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "direction", "id" ], "title": "Person became influencer" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_became_top_voice" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "started", "stopped", "either" ], "description": "Whether to alert when they earn or lose the top voice badge" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "direction", "id" ], "title": "Person became top voice" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_got_demoted" }, "entityType": { "type": "string", "const": "person" }, "seniorityKeywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if the previous title contained these seniority keywords (e.g. 'VP', 'Director'). Omit for any demotion." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person got demoted" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_stuck_in_role" }, "entityType": { "type": "string", "const": "person" }, "thresholdMonths": { "type": "integer", "minimum": 1, "description": "Alert when the person has been in their current role for at least this many months without a title change." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "thresholdMonths", "id" ], "title": "Person stuck in role" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_tenure_milestone" }, "entityType": { "type": "string", "const": "person" }, "thresholdMonths": { "type": "integer", "minimum": 1, "description": "Alert when the person has been at their current company for at least this many months, regardless of role changes or promotions." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "thresholdMonths", "id" ], "title": "Person tenure milestone" } ], "discriminator": { "propertyName": "type", "mapping": { "person_changed_company": "#/components/schemas/PersonChangedCompanyResponse", "person_title_changed": "#/components/schemas/PersonTitleChangedResponse", "person_stealth_changed": "#/components/schemas/PersonStealthChangedResponse", "person_open_to_work": "#/components/schemas/PersonOpenToWorkResponse", "person_is_hiring": "#/components/schemas/PersonIsHiringResponse", "person_headline_changed": "#/components/schemas/PersonHeadlineChangedResponse", "person_location_changed": "#/components/schemas/PersonLocationChangedResponse", "person_tag_gained": "#/components/schemas/PersonTagGainedResponse", "person_posted": "#/components/schemas/PersonPostedResponse", "person_posted_with_keyword": "#/components/schemas/PersonPostedWithKeywordResponse", "person_reacted_to_post": "#/components/schemas/PersonReactedToPostResponse", "person_commented_on_post": "#/components/schemas/PersonCommentedOnPostResponse", "person_skills_added": "#/components/schemas/PersonSkillsAddedResponse", "person_got_promoted": "#/components/schemas/PersonGotPromotedResponse", "person_started_company": "#/components/schemas/PersonStartedCompanyResponse", "person_employment_type_changed": "#/components/schemas/PersonEmploymentTypeChangedResponse", "person_connections_milestone": "#/components/schemas/PersonConnectionsMilestoneResponse", "person_follower_milestone": "#/components/schemas/PersonFollowerMilestoneResponse", "person_summary_changed": "#/components/schemas/PersonSummaryChangedResponse", "person_new_certification": "#/components/schemas/PersonNewCertificationResponse", "person_became_verified": "#/components/schemas/PersonBecameVerifiedResponse", "person_became_premium": "#/components/schemas/PersonBecamePremiumResponse", "person_became_influencer": "#/components/schemas/PersonBecameInfluencerResponse", "person_became_top_voice": "#/components/schemas/PersonBecameTopVoiceResponse", "person_got_demoted": "#/components/schemas/PersonGotDemotedResponse", "person_stuck_in_role": "#/components/schemas/PersonStuckInRoleResponse", "person_tenure_milestone": "#/components/schemas/PersonTenureMilestoneResponse" } } }, "description": "Active tracking rules on this list, with IDs for granular management." }, "isActive": { "type": "boolean", "description": "Whether the list is actively being checked." }, "isArchived": { "type": "boolean", "description": "Whether the list is archived." }, "personCount": { "type": "integer", "minimum": 0, "description": "Number of people in this list." }, "createdAt": { "type": "string", "format": "date-time", "description": "When the list was created." }, "nextRefreshAt": { "type": [ "string", "null" ], "format": "date-time", "description": "When the entire list will next be refreshed. All entities in the list are checked together at this time. Null if the list has no active entities or is inactive." }, "isDynamic": { "type": "boolean", "description": "Whether this list's membership is query-driven and auto-refreshed (dynamic) rather than manually managed (static)." } }, "required": [ "id", "name", "refreshIntervalDays", "isActive", "isArchived", "personCount", "createdAt", "isDynamic" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were char … _truncated to 65536 chars for ai-docs._ ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # getWebhookEndpoint `GET /v1/webhooks/endpoints/{endpointId}` **Tags:** `Webhooks` Get webhook endpoint **Endpoint:** `https://api.fiber.ai/v1/webhooks/endpoints/{endpointId}` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | | `endpointId` | path | yes | The unique ID of the webhook endpoint. | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "endpointId": { "type": "string", "description": "The unique ID of this webhook endpoint." }, "url": { "type": "string", "description": "The HTTPS URL that receives event payloads." }, "eventTypes": { "type": "array", "items": { "type": "string" }, "description": "The event types this endpoint is subscribed to. An empty array means the endpoint receives every event type; endpoints created through this API are always subscribed to one or more specific event types." }, "description": { "type": [ "string", "null" ], "description": "An optional human-readable label for this endpoint." }, "disabled": { "type": "boolean", "description": "Whether delivery to this endpoint is currently paused." }, "createdAt": { "type": "string", "description": "When the endpoint was created (ISO 8601)." }, "updatedAt": { "type": "string", "description": "When the endpoint was last updated (ISO 8601)." } }, "required": [ "endpointId", "url", "eventTypes", "disabled", "createdAt", "updatedAt" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # githubLookupPoll `POST /v1/github-lookup/poll` **Tags:** `GitHub` Poll GitHub lookup results **Endpoint:** `https://api.fiber.ai/v1/github-lookup/poll` ## Description Poll for the results of a GitHub lookup task. Returns progress breakdown and all completed results in a single response (no pagination). ⚡ Rate limit: 120 requests per 1 minute ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "githubAgentRunId": { "type": "string", "description": "The ID of the GitHub lookup agent run which you got back from the trigger endpoint." } }, "required": [ "apiKey", "githubAgentRunId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "githubAgentRunId": { "type": "string", "description": "The ID of the GitHub lookup run these results belong to." }, "overallStatus": { "type": "string", "enum": [ "NOT_STARTED", "STARTED", "DONE", "FAILED" ], "description": "The overall status of the lookup run." }, "counts": { "type": "object", "properties": { "total": { "type": "integer", "description": "Total number of people submitted in this run." }, "found": { "type": "integer", "description": "Number of people for whom a GitHub profile was found." }, "notFound": { "type": "integer", "description": "Number of people for whom no GitHub profile could be found after searching." }, "invalidInput": { "type": "integer", "description": "Number of people whose input could not be resolved (e.g. unresolvable LinkedIn URL, insufficient information)." }, "failed": { "type": "integer", "description": "Number of people whose lookup failed due to a system error." }, "pending": { "type": "integer", "description": "Number of people still waiting to be processed." } }, "required": [ "total", "found", "notFound", "invalidInput", "failed", "pending" ], "description": "Breakdown of lookup progress. All fields sum to the total number of people in the run." }, "people": { "type": "array", "items": { "type": "object", "properties": { "person": { "type": "object", "properties": { "fullName": { "type": "string", "description": "The full name of the person." }, "company": { "type": [ "string", "null" ], "description": "Company provided in the original input." }, "jobTitle": { "type": [ "string", "null" ], "description": "Job title provided in the original input." }, "workEmail": { "type": [ "string", "null" ], "description": "Work email provided in the original input." }, "linkedInUrl": { "type": [ "string", "null" ], "description": "LinkedIn URL provided or resolved from the original input." }, "linkedinUserId": { "type": [ "string", "null" ], "description": "LinkedIn numeric user ID if provided in the original input." }, "customerProvidedId": { "type": [ "string", "null" ], "description": "The external ID echoed back from the input for joining results to the original dataset." } }, "required": [ "fullName" ], "description": "The original input person." }, "githubProfile": { "oneOf": [ { "type": "object", "properties": { "outcome": { "type": "string", "enum": [ "found" ] }, "username": { "type": "string", "description": "The GitHub username (login) for the matched profile." }, "githubUrl": { "type": "string", "format": "uri", "description": "The GitHub profile URL." }, "displayName": { "type": [ "string", "null" ], "description": "The user's display name on GitHub." }, "profilePictureUrl": { "type": [ "string", "null" ], "format": "uri", "description": "URL to the user's GitHub profile picture." }, "bio": { "type": [ "string", "null" ], "description": "One-line summary below the person's name on GitHub." }, "location": { "type": [ "string", "null" ], "description": "Location as displayed on the GitHub profile." }, "numRepositories": { "type": [ "integer", "null" ], "description": "Number of public repositories." }, "numFollowers": { "type": [ "integer", "null" ], "description": "Number of followers on GitHub." }, "confidenceOutOf10": { "type": "integer", "minimum": 1, "maximum": 10, "description": "Confidence score between 1 and 10 denoting the match quality." }, "rationale": { "type": [ "string", "null" ], "description": "Short explanation of why this GitHub profile was matched to the person, referencing details like name, company, or location." } }, "required": [ "outcome", "username", "githubUrl", "confidenceOutOf10" ] }, { "type": "object", "properties": { "outcome": { "type": "string", "enum": [ "notFound" ] }, "message": { "type": "string", "description": "A user-facing explanation of why no profile was found." } }, "required": [ "outcome", "message" ] }, { "type": "object", "properties": { "outcome": { "type": "string", "enum": [ "invalidInput" ] }, "message": { "type": "string", "description": "A user-facing explanation of why the lookup could not proceed." } }, "required": [ "outcome", "message" ] }, { "type": "object", "properties": { "outcome": { "type": "string", "enum": [ "failed" ] }, "message": { "type": "string", "description": "A user-facing explanation of the failure." } }, "required": [ "outcome", "message" ] } ], "description": "The GitHub lookup result for this person." } }, "required": [ "person", "githubProfile" ] }, "description": "All processed people sorted by outcome (found first). Pending people are not included." } }, "required": [ "githubAgentRunId", "overallStatus", "counts", "people" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # githubLookupTrigger `POST /v1/github-lookup/trigger` **Tags:** `GitHub` Start GitHub lookup **Endpoint:** `https://api.fiber.ai/v1/github-lookup/trigger` ## Description 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. ⚡ Rate limit: 30 requests per 1 minute 💰 Cost: 3 credits per person ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "overallContext": { "type": "string", "description": "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." }, "people": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "externalId": { "type": [ "string", "null" ], "description": "An external ID for joining results back to the original dataset." }, "inputType": { "type": "string", "enum": [ "linkedinUrl" ] }, "linkedinUrl": { "type": "string", "description": "LinkedIn URL, slug, or entity URN" } }, "required": [ "inputType", "linkedinUrl" ] }, { "type": "object", "properties": { "externalId": { "type": [ "string", "null" ], "description": "An external ID for joining results back to the original dataset." }, "inputType": { "type": "string", "enum": [ "linkedinUserId" ] }, "linkedinUserId": { "type": "string", "description": "LinkedIn numeric user ID" } }, "required": [ "inputType", "linkedinUserId" ] }, { "type": "object", "properties": { "externalId": { "type": [ "string", "null" ], "description": "An external ID for joining results back to the original dataset." }, "inputType": { "type": "string", "enum": [ "manual" ] }, "fullName": { "type": "string", "maxLength": 256, "description": "The full name of the person whose GitHub profile you want to find." }, "company": { "type": [ "string", "null" ] }, "jobTitle": { "type": [ "string", "null" ] }, "schoolName": { "type": [ "string", "null" ], "description": "School or university name" }, "workEmail": { "type": [ "string", "null" ], "format": "email" }, "linkedinUrl": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "inputType", "fullName" ] } ] }, "minItems": 1, "maxItems": 1000, "description": "List of people to look up. Maximum 1000 people can be provided at a time." } }, "required": [ "apiKey", "overallContext", "people" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "githubAgentRunId": { "type": "string", "description": "The ID of the GitHub lookup agent run. Provide this to the polling endpoint to get the actual results back." } }, "required": [ "githubAgentRunId" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # githubToLinkedInPolling `POST /v1/github-to-linkedin/polling` **Tags:** `GitHub` Poll GitHub to LinkedIn lookup **Endpoint:** `https://api.fiber.ai/v1/github-to-linkedin/polling` ## Description Poll for the results of a GitHub to LinkedIn lookup task. ⚡ Rate limit: 60 requests per 1 minute ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "githubAgentRunId": { "type": "string", "description": "The ID of the GitHub to LinkedIn lookup run which you got back from the trigger endpoint." }, "cursor": { "type": [ "string", "null" ], "description": "The cursor from where to start fetching the next page of results. Provide `nextCursor` from the previous response to continue from there." }, "pageSize": { "type": "number", "minimum": 1, "maximum": 100, "default": 10, "description": "The number of results to fetch per page." } }, "required": [ "apiKey", "githubAgentRunId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "NOT_STARTED", "STARTED", "DONE", "FAILED" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "githubUsername": { "type": "string" }, "customerProvidedId": { "type": [ "string", "null" ] }, "status": { "type": "string", "enum": [ "NOT_STARTED", "STARTED", "DONE", "FAILED" ] }, "linkedInUrl": { "type": [ "string", "null" ], "format": "uri" }, "linkedInSlug": { "type": [ "string", "null" ] }, "confidenceOutOf10": { "type": "integer", "minimum": 0, "maximum": 10 }, "rationale": { "type": [ "string", "null" ] }, "extractedEmails": { "type": "array", "items": { "type": "string" } }, "githubProfile": { "type": [ "object", "null" ], "properties": { "name": { "type": [ "string", "null" ] }, "company": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "bio": { "type": [ "string", "null" ] }, "blog": { "type": [ "string", "null" ] }, "avatarUrl": { "type": [ "string", "null" ] }, "followers": { "type": [ "integer", "null" ] }, "publicRepos": { "type": [ "integer", "null" ] } } }, "errorMessage": { "type": [ "string", "null" ] } }, "required": [ "githubUsername", "status", "confidenceOutOf10", "extractedEmails" ] }, "description": "The list of GitHub to LinkedIn lookup results along with their rationale and confidence scores." }, "nextCursor": { "type": [ "string", "null" ], "description": "The cursor from where to start fetching the next page of results. Provide `nextCursor` from the previous response to continue from there." }, "hasMore": { "type": "boolean", "description": "Whether there are more results to fetch for this run." } }, "required": [ "status", "data", "hasMore" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # githubToLinkedInTrigger `POST /v1/github-to-linkedin/trigger` **Tags:** `GitHub` Start GitHub to LinkedIn lookup **Endpoint:** `https://api.fiber.ai/v1/github-to-linkedin/trigger` ## Description Convert GitHub usernames to LinkedIn profiles or get emailIds. Use outputType flag to specify what to retrieve. ⚡ Rate limit: 30 requests per 1 minute 💰 Cost: 1 credit per person for LinkedIn lookup OR email extraction. 2 credits per person if outputType='both'. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "overallContext": { "type": [ "string", "null" ], "description": "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." }, "people": { "type": "array", "items": { "type": "object", "properties": { "githubUsername": { "type": "string", "minLength": 1 }, "customerProvidedId": { "type": [ "string", "null" ] } }, "required": [ "githubUsername" ] }, "minItems": 1, "maxItems": 1000, "description": "List of GitHub usernames to look up. Maximum 1000 people can be provided at a time." }, "outputType": { "type": "string", "enum": [ "linkedin", "email", "both" ], "default": "linkedin", "description": "What to extract from GitHub profile. 'linkedin' finds LinkedIn profile, 'email' extracts work emails from commits, 'both' returns both." } }, "required": [ "apiKey", "people" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "githubAgentRunId": { "type": "string", "description": "The ID of the GitHub to LinkedIn lookup run. Provide this to the polling endpoint to get actual results back." } }, "required": [ "githubAgentRunId" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # githubToLinkedinSingle `POST /v1/github-to-linkedin/single` **Tags:** `GitHub` Find person by GitHub username (single) **Endpoint:** `https://api.fiber.ai/v1/github-to-linkedin/single` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: 5 credits per person (LinkedIn lookup) + 3 credits per person (email extraction) ⓘ ⏱ Recommended timeout: 2 minutes ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "githubUsername": { "type": "string", "minLength": 1, "description": "The GitHub username to look up." }, "context": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 1000, "description": "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." }, "outputType": { "type": "string", "enum": [ "linkedin", "email", "both" ], "default": "both", "description": "What to extract from GitHub profile. 'linkedin' finds LinkedIn profile, 'email' extracts work emails from commits, 'both' returns both." }, "customerProvidedId": { "type": [ "string", "null" ], "minLength": 1, "description": "Optional customer-provided ID to tie results back to original input." } }, "required": [ "apiKey", "githubUsername" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "githubUsername": { "type": "string", "description": "The GitHub username that was resolved." }, "customerProvidedId": { "type": [ "string", "null" ], "description": "Echoes the optional customer-provided ID from the request." }, "linkedInUrl": { "type": [ "string", "null" ], "format": "uri", "description": "Resolved LinkedIn profile URL when available." }, "linkedInSlug": { "type": [ "string", "null" ], "description": "Resolved LinkedIn profile slug when available." }, "confidenceOutOf10": { "type": "integer", "minimum": 0, "maximum": 10, "description": "Confidence score (0-10) for this resolution." }, "rationale": { "type": [ "string", "null" ], "description": "Optional explanation for the selected match." }, "extractedEmails": { "type": "array", "items": { "type": "string" }, "default": [], "description": "Extracted work email addresses from GitHub commits/cache." }, "githubProfile": { "type": [ "object", "null" ], "properties": { "name": { "type": [ "string", "null" ] }, "company": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "bio": { "type": [ "string", "null" ] }, "blog": { "type": [ "string", "null" ] }, "avatarUrl": { "type": [ "string", "null" ] }, "followers": { "type": [ "integer", "null" ] }, "publicRepos": { "type": [ "integer", "null" ] } }, "description": "Basic GitHub profile fields used by the resolver." } }, "required": [ "githubUsername", "confidenceOutOf10", "extractedEmails" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # google-maps-search `POST /v1/google-maps-search/start` **Tags:** `Google maps` Start a search on Google Maps **Endpoint:** `https://api.fiber.ai/v1/google-maps-search/start` ## Description Start a search for local businesses or other places of interest on Google Maps ⚡ Rate limit: 30 requests per 1 minute 💰 Cost: 3 credits per business found ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "name": { "type": [ "string", "null" ], "description": "An optional name for the project for reference purposes." }, "query": { "type": "string", "minLength": 1, "description": "The search query to run on Google Maps. Do not include a location info here. Examples: 'dominos pizza', 'real estate agent'." }, "maxResults": { "type": "integer", "exclusiveMinimum": 0, "maximum": 10000, "default": 100, "description": "The maximum number of Google Maps results to return." }, "strategy": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "description": "Does a broad search across all cities in the United States. Not as exhaustive as, for example, a city-specific search.", "enum": [ "whole-usa" ] } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "description": "Use 'specific-areas' to search for places in specific areas", "enum": [ "specific-areas" ] }, "unionAll": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "regionType": { "type": "string", "description": "Use 'circle' to search for places in a circle", "enum": [ "circle" ] }, "center": { "type": "object", "properties": { "latitude": { "type": "number", "minimum": -90, "maximum": 90, "description": "The latitude of the point." }, "longitude": { "type": "number", "minimum": -180, "maximum": 180, "description": "The longitude of the point." } }, "required": [ "latitude", "longitude" ] }, "radiusMiles": { "type": "number", "exclusiveMinimum": 0, "maximum": 250, "default": 25, "description": "The radius of the circle in miles." } }, "required": [ "regionType", "center" ] }, { "type": "object", "properties": { "regionType": { "type": "string", "description": "Use 'rectangle' to search for places in a rectangle", "enum": [ "rectangle" ] }, "northwestCorner": { "type": "object", "properties": { "latitude": { "type": "number", "minimum": -90, "maximum": 90, "description": "The latitude of the point." }, "longitude": { "type": "number", "minimum": -180, "maximum": 180, "description": "The longitude of the point." } }, "required": [ "latitude", "longitude" ], "description": "The coordinates of the north west corner of the rectangle" }, "southeastCorner": { "type": "object", "properties": { "latitude": { "type": "number", "minimum": -90, "maximum": 90, "description": "The latitude of the point." }, "longitude": { "type": "number", "minimum": -180, "maximum": 180, "description": "The longitude of the point." } }, "required": [ "latitude", "longitude" ], "description": "The coordinates of the south east corner of the rectangle" } }, "required": [ "regionType", "northwestCorner", "southeastCorner" ] } ] }, "description": "An array of region definitions (rectangles and/or circles). All regions in this array will be unioned together to form the total search area." } }, "required": [ "strategy", "unionAll" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "world-cities" ] }, "countriesAndRegions": { "type": "object", "properties": { "unionAll": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } }, "subtractAll": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } } } }, "smallestCityTierID": { "type": [ "string", "null" ], "enum": [ "mega", "major", "large", "medium", "minor", "small", "tiny", null ] }, "largestCityTierID": { "type": [ "string", "null" ], "enum": [ "mega", "major", "large", "medium", "minor", "small", "tiny", null ] } }, "required": [ "strategy", "countriesAndRegions" ] } ], "description": "The strategy for searching places." } }, "required": [ "apiKey", "query", "strategy" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "searchID": { "type": "string", "description": "The ID of the Google Maps search. Use this to poll for the search results." } }, "required": [ "searchID" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # healthCheck `GET /health` **Tags:** `Utility` Health check **Endpoint:** `https://api.fiber.ai/health` ## Description Health check endpoint to check if the server is running ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "status": { "type": "string", "enum": [ "healthy" ] }, "timestamp": { "type": "string" } }, "required": [ "status", "timestamp" ] } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # hotelProperty `POST /v1/hotels/property` **Tags:** `Market intelligence` Get hotel property details **Endpoint:** `https://api.fiber.ai/v1/hotels/property` ## Description Retrieves full details for a single hotel or vacation rental, including amenities, images, and booking offers. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: 2 credits per property lookup ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "propertyToken": { "type": "string", "minLength": 1, "description": "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`)." }, "checkInDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "Check-in date for the stay." }, "checkOutDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "Check-out date for the stay." }, "adults": { "type": "integer", "minimum": 1, "maximum": 10, "default": 2, "description": "Number of adult guests (at least 1). Total guests (`adults` + `children`) must not exceed 6 for hotels or 10 for vacation rentals." }, "children": { "type": "integer", "minimum": 0, "maximum": 9, "default": 0, "description": "Number of child guests. Total guests (`adults` + `children`) must not exceed 6 for hotels or 10 for vacation rentals." }, "childrenAges": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 17 }, "default": [], "description": "Ages of each child guest. Must contain exactly `children` entries when `children` is greater than zero." }, "currencyCode": { "type": "string", "pattern": "^[A-Za-z]{3}$", "default": "USD", "description": "ISO 4217 currency code for prices in the response (e.g. 'EUR', 'GBP', 'CAD'). Case-insensitive. Defaults to USD." }, "searchMarketCountryCode": { "type": "string", "pattern": "^[A-Za-z]{3}$", "default": "USA", "description": "ISO 3166-1 alpha-3 country code that sets the search market (e.g. 'GBR', 'BRA'). This affects regional pricing and availability. Case-insensitive." }, "languageCode": { "type": "string", "pattern": "^[a-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "default": "en", "description": "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." } }, "required": [ "apiKey", "propertyToken", "checkInDate", "checkOutDate" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "property": { "type": "object", "properties": { "type": { "type": [ "string", "null" ], "enum": [ "hotel", "vacationRental", null ], "description": "Property category." }, "propertyToken": { "type": "string", "description": "Opaque token identifying this property. Pass as `propertyToken` in POST /v1/hotels/property to retrieve full details. Always present on returned properties." }, "name": { "type": "string", "description": "Property display name." }, "description": { "type": [ "string", "null" ], "description": "Property description." }, "url": { "type": [ "string", "null" ], "description": "Property website URL." }, "coordinates": { "type": [ "object", "null" ], "properties": { "latitude": { "type": "number", "description": "Latitude in decimal degrees." }, "longitude": { "type": "number", "description": "Longitude in decimal degrees." } }, "required": [ "latitude", "longitude" ], "description": "Geographic coordinates of the property in decimal degrees." }, "city": { "type": [ "string", "null" ], "description": "City name." }, "countryCode": { "type": [ "string", "null" ], "description": "ISO 3166-1 alpha-3 country code (e.g. 'USA')." }, "checkInTime": { "type": [ "string", "null" ], "description": "Check-in time in 24-hour `HH:mm` format, where `HH` is 00 through 23 (e.g. '15:00'). Null when unavailable." }, "checkOutTime": { "type": [ "string", "null" ], "description": "Check-out time in 24-hour `HH:mm` format, where `HH` is 00 through 23 (e.g. '11:00'). Null when unavailable." }, "ratePerNight": { "type": [ "object", "null" ], "properties": { "currencyCode": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "ISO 4217 currency code for the amounts in this rate." }, "allInCost": { "type": [ "integer", "null" ], "description": "All-in cost in whole currency units, including taxes and fees. Null when only a pre-tax rate is available, in which case only `baseCost` is populated." }, "baseCost": { "type": [ "integer", "null" ], "description": "Base cost before taxes and fees in whole currency units; this is not the final amount charged." } }, "required": [ "currencyCode" ], "description": "Nightly rate summary for one night." }, "totalRate": { "type": [ "object", "null" ], "properties": { "currencyCode": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "ISO 4217 currency code for the amounts in this rate." }, "allInCost": { "type": [ "integer", "null" ], "description": "All-in cost in whole currency units, including taxes and fees. Null when only a pre-tax rate is available, in which case only `baseCost` is populated." }, "baseCost": { "type": [ "integer", "null" ], "description": "Base cost before taxes and fees in whole currency units; this is not the final amount charged." } }, "required": [ "currencyCode" ], "description": "Total rate summary for the entire requested stay, from check-in through check-out. The all-in amount includes taxes and fees when supplied; otherwise `baseCost` is provided." }, "rating": { "type": [ "number", "null" ], "minimum": 0, "maximum": 5, "description": "Guest rating from 0 to 5." }, "reviewCount": { "type": [ "integer", "null" ], "description": "Total number of guest reviews." }, "reviewsBreakdown": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ], "description": "Review category name." }, "description": { "type": [ "string", "null" ], "description": "Review category description." }, "totalCount": { "type": [ "integer", "null" ], "description": "Total reviews mentioning this category." }, "positiveCount": { "type": [ "integer", "null" ], "description": "Positive mentions for this category." }, "neutralCount": { "type": [ "integer", "null" ], "description": "Neutral mentions for this category." }, "negativeCount": { "type": [ "integer", "null" ], "description": "Negative mentions for this category." } } }, "description": "Breakdown of reviews by category." }, "hotelStarClass": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 5, "description": "Observed hotel star class indicating how upscale the property is, from 1 to 5 whole stars. This is a property classification, not a guest review rating." }, "amenities": { "type": "array", "items": { "type": "string" }, "description": "Amenities offered by this property." }, "excludedAmenities": { "type": "array", "items": { "type": "string" }, "description": "Amenities explicitly not offered." }, "images": { "type": "array", "items": { "type": "object", "properties": { "thumbnailUrl": { "type": [ "string", "null" ], "description": "Thumbnail image URL." }, "originalUrl": { "type": [ "string", "null" ], "description": "Full-size image URL." } } }, "description": "Property images." }, "nearbyPlaces": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ], "description": "Nearby place name." }, "transportations": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": [ "string", "null" ], "description": "Transportation mode (e.g. 'Walking')." }, "durationMinutes": { "type": [ "integer", "null" ], "description": "Travel duration in minutes." } } }, "description": "Transportation options to reach this place." } }, "required": [ "transportations" ] }, "description": "Notable nearby places and transit options." }, "locationRating": { "type": [ "number", "null" ], "description": "Location quality rating from 0 to 5." }, "deal": { "type": [ "string", "null" ], "description": "Deal label when the booking provider marks a promotion; may be present without `dealDescription`." }, "dealDescription": { "type": [ "string", "null" ], "description": "Short deal description when supplied by the booking provider; may be absent even when `deal` is present." }, "essentialInfo": { "type": "array", "items": { "type": "string" }, "description": "Key facts for vacation rentals (e.g. 'Entire apartment', 'Sleeps 4')." }, "address": { "type": [ "string", "null" ], "description": "Street address." }, "phone": { "type": [ "string", "null" ], "description": "Contact phone number normalized to E.164 format." }, "directionsUrl": { "type": [ "string", "null" ], "description": "URL with directions to the property." }, "amenitiesDetailed": { "type": "array", "items": { "type": "string" }, "description": "Detailed amenity list for the property." }, "offers": { "type": "array", "items": { "type": "object", "properties": { "sourceName": { "type": [ "string", "null" ], "description": "Booking source name." }, "logoUrl": { "type": [ "string", "null" ], "description": "Booking source logo URL." }, "url": { "type": [ "string", "null" ], "description": "Booking URL." }, "isOfficial": { "type": [ "boolean", "null" ], "description": "True when this is the property's official booking channel." }, "ratePerNight": { "type": [ "object", "null" ], "properties": { "currencyCode": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "ISO 4217 currency code for the amounts in this rate." }, "allInCost": { "type": [ "integer", "null" ], "description": "All-in cost in whole currency units, including taxes and fees. Null when only a pre-tax rate is available, in which case only `baseCost` is populated." }, "baseCost": { "type": [ "integer", "null" ], "description": "Base cost before taxes and fees in whole currency units; this is not the final amount charged." } }, "required": [ "currencyCode" ], "description": "Nightly rate from this source." }, "totalRate": { "type": [ "object", "null" ], "properties": { "currencyCode": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "ISO 4217 currency code for the amounts in this rate." }, "allInCost": { "type": [ "integer", "null" ], "description": "All-in cost in whole currency units, including taxes and fees. Null when only a pre-tax rate is available, in which case only `baseCost` is populated." }, "baseCost": { "type": [ "integer", "null" ], "description": "Base cost before taxes and fees in whole currency units; this is not the final amount charged." } }, "required": [ "currencyCode" ], "description": "Total rate for the entire requested stay from this source. The all-in amount includes taxes and fees when supplied; otherwise `baseCost` is provided." } } }, "description": "Booking offers from online travel agencies." }, "typicalPriceRange": { "type": [ "object", "null" ], "properties": { "currencyCode": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "ISO 4217 currency code for the amounts in this range." }, "lowerBound": { "type": [ "integer", "null" ], "description": "Lower bound of the typical price range in the specified currency." }, "upperBound": { "type": [ "integer", "null" ], "description": "Upper bound of the typical price range in the specified currency." } }, "required": [ "currencyCode" ], "description": "Typical price range for this property in whole currency units." }, "ratingsBreakdown": { "type": [ "object", "null" ], "properties": { "oneStarCount": { "type": [ "integer", "null" ], "description": "Count of 1-star reviews." }, "twoStarCount": { "type": [ "integer", "null" ], "description": "Count of 2-star reviews." }, "threeStarCount": { "type": [ "integer", "null" ], "description": "Count of 3-star reviews." }, "fourStarCount": { "type": [ "integer", "null" ], "description": "Count of 4-star reviews." }, "fiveStarCount": { "type": [ "integer", "null" ], "description": "Count of 5-star reviews." } }, "description": "Guest review counts grouped by one- through five-star rating." } }, "required": [ "propertyToken", "name", "reviewsBreakdown", "amenities", "excludedAmenities", "images", "nearbyPlaces", "essentialInfo", "amenitiesDetailed", "offers" ], "description": "Full property details including offers and amenities." }, "currencyCode": { "type": [ "string", "null" ], "pattern": "^[A-Z]{3}$", "description": "ISO 4217 currency code for prices in this response (e.g. 'USD', 'EUR', 'GBP')." } }, "required": [ "property" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # hotelSearch `POST /v1/hotels/search` **Tags:** `Market intelligence` Search hotels **Endpoint:** `https://api.fiber.ai/v1/hotels/search` ## Description Searches hotels and vacation rentals for a destination and returns matching properties with rates, ratings, and amenities. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: 2 credits per search ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "query": { "type": "string", "minLength": 1, "description": "Destination or hotel search query (e.g. 'Hotels in Manhattan New York')." }, "checkInDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "Check-in date for the stay." }, "checkOutDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "Check-out date for the stay." }, "adults": { "type": "integer", "minimum": 1, "maximum": 10, "default": 2, "description": "Number of adult guests (at least 1). Total guests (`adults` + `children`) must not exceed 6 for hotels or 10 for vacation rentals." }, "children": { "type": "integer", "minimum": 0, "maximum": 9, "default": 0, "description": "Number of child guests. Total guests (`adults` + `children`) must not exceed 6 for hotels or 10 for vacation rentals." }, "childrenAges": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 17, "description": "Child age from 1 to 17." }, "default": [], "description": "Ages of each child guest. Must contain exactly `children` entries when `children` is greater than zero." }, "sortBy": { "type": [ "string", "null" ], "enum": [ "relevance", "lowestPrice", "highestRating", "mostReviewed", null ], "description": "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." }, "minRating": { "type": [ "string", "null" ], "enum": [ "3.5", "4.0", "4.5", null ], "description": "Minimum guest rating filter. Omit to include all ratings." }, "priceRange": { "type": [ "object", "null" ], "properties": { "minPerNight": { "type": [ "integer", "null" ], "minimum": 0, "description": "Minimum nightly rate in whole currency units." }, "maxPerNight": { "type": [ "integer", "null" ], "minimum": 1, "description": "Maximum nightly rate in whole currency units." } }, "description": "Filter by nightly price range in whole currency units." }, "category": { "oneOf": [ { "type": "object", "properties": { "propertyCategory": { "type": "string", "description": "Search hotels (the default property category).", "enum": [ "hotel" ] }, "hotelStarClasses": { "type": [ "array", "null" ], "items": { "type": "integer", "minimum": 2, "maximum": 5, "description": "Hotel star class indicating how upscale the property is. This filter supports 2 to 5 whole stars; 2 stars generally indicates a basic property, while 5 stars indicates a luxury property. This is not a guest review rating. Returned properties may report an observed class from 1 to 5 stars." }, "description": "Filter to specific hotel star classes based on how upscale the property is (e.g. [4, 5] for 4- and 5-star hotels). This is not a guest review rating." }, "propertyTypes": { "type": [ "array", "null" ], "items": { "type": "integer", "minimum": 1, "description": "Property type identifier. Call GET /v1/enums/hotels/property-types for the full list (e.g. 17 for resorts)." }, "description": "Filter to specific property types by ID. Call GET /v1/enums/hotels/property-types for valid values." }, "amenities": { "type": [ "array", "null" ], "items": { "type": "integer", "minimum": 1, "description": "Amenity identifier. Call GET /v1/enums/hotels/amenities for the full list (e.g. 35 for free Wi-Fi)." }, "description": "Require properties that offer all of these amenities by ID. Call GET /v1/enums/hotels/amenities for valid values." }, "brands": { "type": [ "array", "null" ], "items": { "type": "integer", "minimum": 1, "description": "Hotel brand identifier. Call GET /v1/enums/hotels/brands for the full list (e.g. 28 for Hilton Honors)." }, "description": "Filter to specific hotel brands by ID. Call GET /v1/enums/hotels/brands for valid values." }, "freeCancellation": { "type": "boolean", "default": false, "description": "When true, only return properties with a booking option that can be cancelled without a cancellation fee." }, "specialOffers": { "type": "boolean", "default": false, "description": "When true, only return properties marked by the booking provider as having a special offer or promotion." }, "ecoCertified": { "type": "boolean", "default": false, "description": "When true, only return properties marked by the booking provider as having an environmental or sustainability certification." } }, "required": [ "propertyCategory" ] }, { "type": "object", "properties": { "propertyCategory": { "type": "string", "description": "Search vacation rentals instead of hotels.", "enum": [ "vacationRental" ] }, "minBedrooms": { "type": [ "integer", "null" ], "minimum": 0, "description": "Minimum number of bedrooms." }, "minBathrooms": { "type": [ "integer", "null" ], "minimum": 0, "description": "Minimum number of bathrooms." } }, "required": [ "propertyCategory" ] } ], "description": "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.", "default": { "propertyCategory": "hotel" } }, "nextPageToken": { "type": [ "string", "null" ], "description": "Opaque pagination token from a prior search response's `nextPageToken`. Omit (or pass null) to fetch the first page." }, "currencyCode": { "type": "string", "pattern": "^[A-Za-z]{3}$", "default": "USD", "description": "ISO 4217 currency code for prices in the response (e.g. 'EUR', 'GBP', 'CAD'). Case-insensitive. Defaults to USD." }, "searchMarketCountryCode": { "type": "string", "pattern": "^[A-Za-z]{3}$", "default": "USA", "description": "ISO 3166-1 alpha-3 country code that sets the search market (e.g. 'GBR', 'BRA'). This affects regional pricing and availability. Case-insensitive." }, "languageCode": { "type": "string", "pattern": "^[a-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "default": "en", "description": "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." } }, "required": [ "apiKey", "query", "checkInDate", "checkOutDate" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "properties": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": [ "string", "null" ], "enum": [ "hotel", "vacationRental", null ], "description": "Property category." }, "propertyToken": { "type": "string", "description": "Opaque token identifying this property. Pass as `propertyToken` in POST /v1/hotels/property to retrieve full details. Always present on returned properties." }, "name": { "type": "string", "description": "Property display name." }, "description": { "type": [ "string", "null" ], "description": "Property description." }, "url": { "type": [ "string", "null" ], "description": "Property website URL." }, "coordinates": { "type": [ "object", "null" ], "properties": { "latitude": { "type": "number", "description": "Latitude in decimal degrees." }, "longitude": { "type": "number", "description": "Longitude in decimal degrees." } }, "required": [ "latitude", "longitude" ], "description": "Geographic coordinates of the property in decimal degrees." }, "city": { "type": [ "string", "null" ], "description": "City name." }, "countryCode": { "type": [ "string", "null" ], "description": "ISO 3166-1 alpha-3 country code (e.g. 'USA')." }, "checkInTime": { "type": [ "string", "null" ], "description": "Check-in time in 24-hour `HH:mm` format, where `HH` is 00 through 23 (e.g. '15:00'). Null when unavailable." }, "checkOutTime": { "type": [ "string", "null" ], "description": "Check-out time in 24-hour `HH:mm` format, where `HH` is 00 through 23 (e.g. '11:00'). Null when unavailable." }, "ratePerNight": { "type": [ "object", "null" ], "properties": { "currencyCode": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "ISO 4217 currency code for the amounts in this rate." }, "allInCost": { "type": [ "integer", "null" ], "description": "All-in cost in whole currency units, including taxes and fees. Null when only a pre-tax rate is available, in which case only `baseCost` is populated." }, "baseCost": { "type": [ "integer", "null" ], "description": "Base cost before taxes and fees in whole currency units; this is not the final amount charged." } }, "required": [ "currencyCode" ], "description": "Nightly rate summary for one night." }, "totalRate": { "type": [ "object", "null" ], "properties": { "currencyCode": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "ISO 4217 currency code for the amounts in this rate." }, "allInCost": { "type": [ "integer", "null" ], "description": "All-in cost in whole currency units, including taxes and fees. Null when only a pre-tax rate is available, in which case only `baseCost` is populated." }, "baseCost": { "type": [ "integer", "null" ], "description": "Base cost before taxes and fees in whole currency units; this is not the final amount charged." } }, "required": [ "currencyCode" ], "description": "Total rate summary for the entire requested stay, from check-in through check-out. The all-in amount includes taxes and fees when supplied; otherwise `baseCost` is provided." }, "rating": { "type": [ "number", "null" ], "minimum": 0, "maximum": 5, "description": "Guest rating from 0 to 5." }, "reviewCount": { "type": [ "integer", "null" ], "description": "Total number of guest reviews." }, "reviewsBreakdown": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ], "description": "Review category name." }, "description": { "type": [ "string", "null" ], "description": "Review category description." }, "totalCount": { "type": [ "integer", "null" ], "description": "Total reviews mentioning this category." }, "positiveCount": { "type": [ "integer", "null" ], "description": "Positive mentions for this category." }, "neutralCount": { "type": [ "integer", "null" ], "description": "Neutral mentions for this category." }, "negativeCount": { "type": [ "integer", "null" ], "description": "Negative mentions for this category." } } }, "description": "Breakdown of reviews by category." }, "hotelStarClass": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 5, "description": "Observed hotel star class indicating how upscale the property is, from 1 to 5 whole stars. This is a property classification, not a guest review rating." }, "amenities": { "type": "array", "items": { "type": "string" }, "description": "Amenities offered by this property." }, "excludedAmenities": { "type": "array", "items": { "type": "string" }, "description": "Amenities explicitly not offered." }, "images": { "type": "array", "items": { "type": "object", "properties": { "thumbnailUrl": { "type": [ "string", "null" ], "description": "Thumbnail image URL." }, "originalUrl": { "type": [ "string", "null" ], "description": "Full-size image URL." } } }, "description": "Property images." }, "nearbyPlaces": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ], "description": "Nearby place name." }, "transportations": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": [ "string", "null" ], "description": "Transportation mode (e.g. 'Walking')." }, "durationMinutes": { "type": [ "integer", "null" ], "description": "Travel duration in minutes." } } }, "description": "Transportation options to reach this place." } }, "required": [ "transportations" ] }, "description": "Notable nearby places and transit options." }, "locationRating": { "type": [ "number", "null" ], "description": "Location quality rating from 0 to 5." }, "deal": { "type": [ "string", "null" ], "description": "Deal label when the booking provider marks a promotion; may be present without `dealDescription`." }, "dealDescription": { "type": [ "string", "null" ], "description": "Short deal description when supplied by the booking provider; may be absent even when `deal` is present." }, "essentialInfo": { "type": "array", "items": { "type": "string" }, "description": "Key facts for vacation rentals (e.g. 'Entire apartment', 'Sleeps 4')." } }, "required": [ "propertyToken", "name", "reviewsBreakdown", "amenities", "excludedAmenities", "images", "nearbyPlaces", "essentialInfo" ] }, "description": "Matching hotel and vacation rental properties." }, "brands": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Brand group identifier." }, "name": { "type": "string", "description": "Brand group display name." }, "children": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Brand identifier." }, "name": { "type": "string", "description": "Brand display name." } }, "required": [ "id", "name" ] }, "description": "Sub-brands within this group." } }, "required": [ "id", "name", "children" ] }, "description": "Hotel brand groups available for filtering in this market. Empty when searching vacation rentals only." }, "nextPageToken": { "type": [ "string", "null" ], "description": "Token to retrieve the next page. Pass as `nextPageToken` in the next request. Null if no more pages." }, "currencyCode": { "type": [ "string", "null" ], "pattern": "^[A-Z]{3}$", "description": "ISO 4217 currency code for prices in this response (e.g. 'USD', 'EUR', 'GBP')." }, "searchInformation": { "type": [ "object", "null" ], "properties": { "totalResultCount": { "type": [ "integer", "null" ], "description": "Approximate total number of matching properties." } }, "description": "Summary information about the search results." } }, "required": [ "properties", "brands" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # instagramPostComments `POST /v1/instagram/post-comments` **Tags:** `Instagram` Fetch Instagram post comments **Endpoint:** `https://api.fiber.ai/v1/instagram/post-comments` ## Description 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'). ⚡ Rate limit: 300 requests per 1 minute 💰 Cost: 2 credits per page of results ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "postUrl": { "type": "string", "minLength": 1, "description": "Full Instagram post URL (e.g. 'https://www.instagram.com/p/DVoDVg5DkXM/') or shortcode (e.g. 'DVoDVg5DkXM')." }, "nextPageToken": { "type": [ "string", "null" ], "minLength": 1, "description": "Pagination token from a previous response to retrieve the next page. Omit for the first page." } }, "required": [ "apiKey", "postUrl" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "comments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique comment identifier." }, "text": { "type": [ "string", "null" ], "description": "Comment text." }, "publishedAt": { "type": [ "string", "null" ], "description": "ISO 8601 timestamp of when the comment was posted." }, "user": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "description": "Unique user identifier." }, "handle": { "type": [ "string", "null" ], "description": "Instagram handle (without '@')." }, "displayName": { "type": [ "string", "null" ], "description": "Display name." }, "profileImageUrl": { "type": [ "string", "null" ], "description": "URL of the profile picture." }, "isVerified": { "type": [ "boolean", "null" ], "description": "Whether the account is verified." } }, "required": [ "id" ], "description": "The user who posted the comment." } }, "required": [ "id" ] }, "description": "List of comments for this page." }, "nextPageToken": { "type": [ "string", "null" ], "description": "Token to retrieve the next page. Pass as `nextPageToken` in the next request. Null if there are no more pages." } }, "required": [ "comments" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # instagramPostDetails `POST /v1/instagram/post-details` **Tags:** `Instagram` Fetch Instagram post details **Endpoint:** `https://api.fiber.ai/v1/instagram/post-details` ## Description 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'). ⚡ Rate limit: 300 requests per 1 minute 💰 Cost: 2 credits per request ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "postUrl": { "type": "string", "minLength": 1, "description": "Full Instagram post URL (e.g. 'https://www.instagram.com/p/DVoDVg5DkXM/') or shortcode (e.g. 'DVoDVg5DkXM')." } }, "required": [ "apiKey", "postUrl" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique post identifier." }, "shortcode": { "type": [ "string", "null" ], "description": "Post shortcode — the unique identifier from the URL. For example, in 'https://www.instagram.com/p/DVoDVg5DkXM/', the shortcode is 'DVoDVg5DkXM'." }, "caption": { "type": [ "string", "null" ], "description": "Post caption text." }, "likeCount": { "type": [ "number", "null" ], "description": "Number of likes." }, "commentCount": { "type": [ "number", "null" ], "description": "Number of comments." }, "playCount": { "type": [ "number", "null" ], "description": "Number of plays or views (video/reel only)." }, "isVideo": { "type": "boolean", "description": "True if the post is a video or reel. False if it is an image." }, "thumbnailUrl": { "type": [ "string", "null" ], "description": "URL of the post image or video thumbnail." }, "publishedAt": { "type": [ "string", "null" ], "description": "ISO 8601 timestamp of when the post was published." } }, "required": [ "id", "isVideo" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # instagramProfile `POST /v1/instagram/profile` **Tags:** `Instagram` Fetch Instagram user profile **Endpoint:** `https://api.fiber.ai/v1/instagram/profile` ## Description Fetches profile information for an Instagram user including follower counts, bio, and account type. ⚡ Rate limit: 300 requests per 1 minute 💰 Cost: 2 credits per request ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "handle": { "type": "string", "minLength": 1, "description": "Instagram handle to look up. Accepts with or without a leading '@' (e.g. 'natgeo' or '@natgeo')." } }, "required": [ "apiKey", "handle" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique user identifier." }, "handle": { "type": [ "string", "null" ], "description": "Instagram handle (without '@')." }, "displayName": { "type": [ "string", "null" ], "description": "Display name." }, "bio": { "type": [ "string", "null" ], "description": "Profile bio." }, "followerCount": { "type": [ "number", "null" ], "description": "Number of followers." }, "followingCount": { "type": [ "number", "null" ], "description": "Number of accounts followed." }, "postCount": { "type": [ "number", "null" ], "description": "Total number of posts." }, "isVerified": { "type": [ "boolean", "null" ], "description": "Whether the account is verified." }, "isPrivate": { "type": [ "boolean", "null" ], "description": "Whether the account is private." }, "isBusinessAccount": { "type": [ "boolean", "null" ], "description": "Whether this is a business account." }, "businessCategory": { "type": [ "string", "null" ], "description": "Business category (e.g. 'Media/News Company'). Null for personal accounts." }, "profileImageUrl": { "type": [ "string", "null" ], "description": "URL of the profile picture." }, "externalUrl": { "type": [ "string", "null" ], "description": "Website URL from the profile (the 'link in bio')." } }, "required": [ "id" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # instagramUserPosts `POST /v1/instagram/user-posts` **Tags:** `Instagram` Fetch Instagram user posts **Endpoint:** `https://api.fiber.ai/v1/instagram/user-posts` ## Description 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. ⚡ Rate limit: 300 requests per 1 minute 💰 Cost: 2 credits per page of results ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "handle": { "type": "string", "minLength": 1, "description": "Instagram handle (with or without leading '@')." }, "nextPageToken": { "type": [ "string", "null" ], "minLength": 1, "description": "Pagination token from a previous response to retrieve the next page. Omit for the first page." } }, "required": [ "apiKey", "handle" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "posts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique post identifier." }, "shortcode": { "type": [ "string", "null" ], "description": "Post shortcode — the unique identifier from the URL. For example, in 'https://www.instagram.com/p/DVoDVg5DkXM/', the shortcode is 'DVoDVg5DkXM'." }, "caption": { "type": [ "string", "null" ], "description": "Post caption text." }, "likeCount": { "type": [ "number", "null" ], "description": "Number of likes." }, "commentCount": { "type": [ "number", "null" ], "description": "Number of comments." }, "playCount": { "type": [ "number", "null" ], "description": "Number of plays or views (video/reel only)." }, "isVideo": { "type": "boolean", "description": "True if the post is a video or reel. False if it is an image." }, "thumbnailUrl": { "type": [ "string", "null" ], "description": "URL of the post image or video thumbnail." }, "publishedAt": { "type": [ "string", "null" ], "description": "ISO 8601 timestamp of when the post was published." } }, "required": [ "id", "isVideo" ] }, "description": "List of posts for this page." }, "nextPageToken": { "type": [ "string", "null" ], "description": "Token to retrieve the next page. Pass as `nextPageToken` in the next request. Null if there are no more pages." } }, "required": [ "posts" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # instagramUserReels `POST /v1/instagram/user-reels` **Tags:** `Instagram` Fetch Instagram user reels **Endpoint:** `https://api.fiber.ai/v1/instagram/user-reels` ## Description 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. ⚡ Rate limit: 300 requests per 1 minute 💰 Cost: 2 credits per page of results ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "handle": { "type": "string", "minLength": 1, "description": "Instagram handle (with or without leading '@')." }, "nextPageToken": { "type": [ "string", "null" ], "minLength": 1, "description": "Pagination token from a previous response to retrieve the next page. Omit for the first page." } }, "required": [ "apiKey", "handle" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "reels": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique post identifier." }, "shortcode": { "type": [ "string", "null" ], "description": "Post shortcode — the unique identifier from the URL. For example, in 'https://www.instagram.com/p/DVoDVg5DkXM/', the shortcode is 'DVoDVg5DkXM'." }, "caption": { "type": [ "string", "null" ], "description": "Post caption text." }, "likeCount": { "type": [ "number", "null" ], "description": "Number of likes." }, "commentCount": { "type": [ "number", "null" ], "description": "Number of comments." }, "playCount": { "type": [ "number", "null" ], "description": "Number of plays or views (video/reel only)." }, "isVideo": { "type": "boolean", "description": "True if the post is a video or reel. False if it is an image." }, "thumbnailUrl": { "type": [ "string", "null" ], "description": "URL of the post image or video thumbnail." }, "publishedAt": { "type": [ "string", "null" ], "description": "ISO 8601 timestamp of when the post was published." } }, "required": [ "id", "isVideo" ] }, "description": "List of reels for this page." }, "nextPageToken": { "type": [ "string", "null" ], "description": "Token to retrieve the next page. Pass as `nextPageToken` in the next request. Null if there are no more pages." } }, "required": [ "reels" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # instantContactReveal `POST /v1/contact-details/instant` **Tags:** `Contact details` Reveal contact details (instant) **Endpoint:** `https://api.fiber.ai/v1/contact-details/instant` ## Description Fast contact lookup that returns emails and phone numbers already on file for the person. Does not perform additional discovery or re-verify addresses at request time, so yield is lower than other contact-reveal endpoints and validationStatus may be unknown. Accepts a LinkedIn profile identifier or a name plus company domain. ⚡ Rate limit: 500 requests per 1 minute 💰 Cost: 1 credit per instant email reveal + 1 credit per instant phone reveal ⓘ ⏱ Recommended timeout: 15 seconds ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "input": { "oneOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "linkedin" ] }, "linkedinIdentifier": { "type": "string", "minLength": 1, "description": "LinkedIn profile identifier — a full URL, bare slug, or URN (e.g. 'williamhgates', 'https://www.linkedin.com/in/williamhgates')." }, "fullName": { "type": [ "string", "null" ], "minLength": 1, "description": "Full name of the person. Optional — improves match accuracy." } }, "required": [ "mode", "linkedinIdentifier" ] }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "name-domain" ] }, "fullName": { "type": "string", "minLength": 1, "description": "Full name of the person." }, "companyDomain": { "type": "string", "minLength": 1, "description": "Company domain (e.g. 'gatesfoundation.org')." } }, "required": [ "mode", "fullName", "companyDomain" ] } ], "description": "Person lookup parameters. Use mode 'linkedin' or 'name-domain'." }, "enrichmentType": { "type": "object", "properties": { "getWorkEmails": { "type": "boolean", "default": true }, "getPersonalEmails": { "type": "boolean", "default": false }, "getPhoneNumbers": { "type": "boolean", "default": false } }, "description": "Which email and phone types to look for.", "default": { "getWorkEmails": true, "getPersonalEmails": false, "getPhoneNumbers": false } } }, "required": [ "apiKey", "input" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "profile": { "type": "object", "properties": { "emails": { "type": "array", "items": { "type": "object", "properties": { "emailAddress": { "type": [ "string", "null" ], "minLength": 1, "description": "Email address for the person." }, "type": { "type": [ "string", "null" ], "enum": [ "work", "personal", null ], "description": "Classification of the email address." }, "validationStatus": { "type": [ "string", "null" ], "enum": [ "valid", "risky", "unknown", "invalid", null ], "description": "Email verification result." }, "deliverabilityScore": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100, "description": "Confidence score ranking deliverability for this email. Higher values indicate higher likelihood of delivery." }, "isCatchAll": { "type": [ "boolean", "null" ], "description": "Whether the domain accepts email to any address (catch-all). Catch-all domains make individual address verification unreliable — the address may appear valid but not actually be monitored." } } }, "default": [], "description": "All emails found for this profile, ordered by priority." }, "phoneNumbers": { "type": "array", "items": { "type": "object", "properties": { "phoneNumber": { "type": [ "string", "null" ], "minLength": 1, "description": "Phone number for the person." }, "type": { "type": [ "string", "null" ], "enum": [ "mobile", "other", "unknown", null ], "description": "Classification of the phone number." } } }, "default": [], "description": "All phone numbers found for this profile." } }, "required": [ "emails", "phoneNumbers" ] } }, "required": [ "profile" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # jobPostingSearch `POST /v1/job-search` **Tags:** `Search` Job postings search **Endpoint:** `https://api.fiber.ai/v1/job-search` ## Description Search for job postings with flexible filtering capabilities ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: 1 credit per job posting found ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "searchParams": { "type": "object", "properties": { "companies": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinSlug" ] }, "value": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Array of LinkedIn company slugs (e.g., ['microsoft'])" } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "value": { "type": "array", "items": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$", "description": "A domain, like 'example.com' or 'https://example.com'" }, "description": "Array of company domains (e.g., ['microsoft.com'])" } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinUrl" ] }, "value": { "type": "array", "items": { "type": "string", "format": "uri", "pattern": "^(https?:\\/\\/)?(\\w+\\.)?linkedin\\.\\w+(\\.\\w+)?\\/(company|company-beta|showcase|organization|school|companies)\\/(?:[^\\/\\?#]+)\\/?(\\?.*)?(#.*)?$", "description": "A LinkedIn company URL, like 'https://www.linkedin.com/company/google'" }, "description": "Array of LinkedIn company URLs, e.g., https://www.linkedin.com/company/microsoft/" } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinOrgID" ] }, "value": { "type": "array", "items": { "type": "string", "pattern": "^\\d+$", "description": "A LinkedIn organization ID (numeric string), e.g., '1035' for Microsoft" }, "description": "Array of LinkedIn organization IDs (numeric strings), e.g., '1035' for Microsoft" } }, "required": [ "identifier", "value" ] }, { "type": "null" } ], "description": "Filter jobs by one type of company identifier with array values" }, "title": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "description": "Array of job titles for partial match (e.g., 'Software Engineer', 'Manager')" }, "isActive": { "type": [ "string", "null" ], "enum": [ "true", "false", "no_preference", null ], "description": "Filter by job status: true=active, false=closed, no_preference=both" }, "postedAt": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ], "description": "Filter by job posting date (supports relative and absolute dates)" }, "numApplicants": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "integer", "null" ] }, "upperBound": { "type": [ "integer", "null" ] } }, "description": "Filter by number of applicants (range)" }, "jobFunctions": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] }, "description": "Array of job functions" }, "industries": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] }, "description": "Array of industries" }, "annualSalaryUsd": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "integer", "null" ] }, "upperBound": { "type": [ "integer", "null" ] } }, "description": "Filter by annual salary range in USD" }, "yearsOfExperience": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "integer", "null" ] }, "upperBound": { "type": [ "integer", "null" ] } }, "description": "Filter by years of experience required" }, "jobModality": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "On-site", "Remote", "Hybrid" ] }, "description": "Lets you find jobs that are on-site, remote, or hybrid. Pass several values to match any of them." }, "jobLocationType": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "On-site", "Remote", "Hybrid" ] }, "description": "Deprecated. Use jobModality instead.", "deprecated": true }, "employmentType": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] }, "description": "Array of employment types (e.g., Full-time, Part-time, Contract, Internship)" }, "seniorityLevel": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive" ] }, "description": "Array of seniority levels (e.g., Entry level, Mid-Senior level, Director)" }, "countryOrRegionCode": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] }, "description": "Array of country or region codes (e.g., USA, IND, X-ANGLOSPHERE)" } }, "additionalProperties": false, "description": "Job search filter parameters" }, "pageSize": { "type": "integer", "exclusiveMinimum": 0, "maximum": 1000, "default": 25, "description": "Number of jobs to return per page (max 1000)" }, "cursor": { "type": [ "string", "null" ], "description": "Pagination cursor for fetching next page of results" } }, "required": [ "apiKey", "searchParams" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "job_id": { "type": "string", "description": "Unique job identifier" }, "title": { "type": [ "string", "null" ], "description": "Job title/position" }, "company_name": { "type": [ "string", "null" ], "description": "Company name" }, "company_logo_url": { "type": [ "string", "null" ], "format": "uri", "description": "Company logo URL" }, "posted_at": { "type": [ "string", "null" ], "description": "When the job was posted" }, "job_url": { "type": [ "string", "null" ], "format": "uri", "description": "LinkedIn job URL" }, "applicant_range": { "type": [ "object", "null" ], "properties": { "gte": { "type": [ "number", "null" ] }, "lte": { "type": [ "number", "null" ] } }, "description": "Applicant count range" }, "description": { "type": [ "string", "null" ], "description": "Job description text" }, "seniority_level": { "type": [ "string", "null" ], "description": "Seniority level (e.g., 'Entry level', 'Senior level')" }, "employment_type": { "type": [ "string", "null" ], "description": "Employment type (e.g., 'Full-time', 'Part-time')" }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] }, "description": "Job function categories" }, "raw_industries": { "type": [ "string", "null" ], "description": "Raw industries string from LinkedIn" }, "standard_industries": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] }, "description": "Standardized industry categories" }, "compensation_range": { "type": [ "object", "null" ], "properties": { "lte": { "type": [ "object", "null" ], "properties": { "currencyUnit": { "type": "string", "description": "These are just currency symbols, like CA$ or £" }, "number": { "type": "number" }, "period": { "type": "string", "enum": [ "hr", "m", "yr", "daily" ] } }, "required": [ "currencyUnit", "number", "period" ] }, "gte": { "type": [ "object", "null" ], "properties": { "currencyUnit": { "type": "string", "description": "These are just currency symbols, like CA$ or £" }, "number": { "type": "number" }, "period": { "type": "string", "enum": [ "hr", "m", "yr", "daily" ] } }, "required": [ "currencyUnit", "number", "period" ] } }, "description": "Structured compensation range with currency and period" }, "annual_salary_usd": { "type": [ "object", "null" ], "properties": { "gte": { "type": [ "number", "null" ] }, "lte": { "type": [ "number", "null" ] } }, "description": "Annual salary approximation in USD" }, "years_of_experience": { "type": [ "object", "null" ], "properties": { "gte": { "type": [ "number", "null" ] }, "lte": { "type": [ "number", "null" ] } }, "description": "Years of experience required" }, "standardized_location": { "type": [ "object", "null" ], "properties": { "street_address": { "type": [ "string", "null" ] }, "neighborhood": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "state_name": { "type": [ "string", "null" ] }, "state_code": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] }, "country_code": { "type": [ "string", "null" ] }, "country_name": { "type": [ "string", "null" ] }, "coordinates": { "type": [ "object", "null" ], "properties": { "lat": { "type": "number" }, "lon": { "type": "number" } }, "required": [ "lat", "lon" ] }, "timezone": { "type": [ "string", "null" ] }, "full_address": { "type": [ "string", "null" ] }, "formatted_address": { "type": [ "string", "null" ] } }, "description": "Standardized location with geo data including lat/lon" }, "job_location_type": { "type": [ "string", "null" ], "enum": [ "On-site", "Remote", "Hybrid", null ], "description": "Deprecated. Use modality instead.", "deprecated": true }, "modality": { "type": [ "string", "null" ], "enum": [ "On-site", "Remote", "Hybrid", null ], "description": "Whether the job is on-site, remote, or hybrid." }, "status": { "type": "string", "enum": [ "active", "closed" ], "description": "Job status" } }, "required": [ "job_id", "status" ] }, "description": "Array of job postings matching the search criteria" }, "nextCursor": { "type": [ "string", "null" ], "description": "Cursor for fetching the next page of results. Null if no more results available" } }, "required": [ "data" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # jobPostingSearchCount `POST /v1/job-search/count` **Tags:** `Search` Job postings count **Endpoint:** `https://api.fiber.ai/v1/job-search/count` ## Description Get count of job postings matching search filters ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: 1 credit per request ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "searchParams": { "type": "object", "properties": { "companies": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinSlug" ] }, "value": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Array of LinkedIn company slugs (e.g., ['microsoft'])" } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "value": { "type": "array", "items": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$", "description": "A domain, like 'example.com' or 'https://example.com'" }, "description": "Array of company domains (e.g., ['microsoft.com'])" } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinUrl" ] }, "value": { "type": "array", "items": { "type": "string", "format": "uri", "pattern": "^(https?:\\/\\/)?(\\w+\\.)?linkedin\\.\\w+(\\.\\w+)?\\/(company|company-beta|showcase|organization|school|companies)\\/(?:[^\\/\\?#]+)\\/?(\\?.*)?(#.*)?$", "description": "A LinkedIn company URL, like 'https://www.linkedin.com/company/google'" }, "description": "Array of LinkedIn company URLs, e.g., https://www.linkedin.com/company/microsoft/" } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinOrgID" ] }, "value": { "type": "array", "items": { "type": "string", "pattern": "^\\d+$", "description": "A LinkedIn organization ID (numeric string), e.g., '1035' for Microsoft" }, "description": "Array of LinkedIn organization IDs (numeric strings), e.g., '1035' for Microsoft" } }, "required": [ "identifier", "value" ] }, { "type": "null" } ], "description": "Filter jobs by one type of company identifier with array values" }, "title": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "description": "Array of job titles for partial match (e.g., 'Software Engineer', 'Manager')" }, "isActive": { "type": [ "string", "null" ], "enum": [ "true", "false", "no_preference", null ], "description": "Filter by job status: true=active, false=closed, no_preference=both" }, "postedAt": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ], "description": "Filter by job posting date (supports relative and absolute dates)" }, "numApplicants": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "integer", "null" ] }, "upperBound": { "type": [ "integer", "null" ] } }, "description": "Filter by number of applicants (range)" }, "jobFunctions": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] }, "description": "Array of job functions" }, "industries": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] }, "description": "Array of industries" }, "annualSalaryUsd": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "integer", "null" ] }, "upperBound": { "type": [ "integer", "null" ] } }, "description": "Filter by annual salary range in USD" }, "yearsOfExperience": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "integer", "null" ] }, "upperBound": { "type": [ "integer", "null" ] } }, "description": "Filter by years of experience required" }, "jobModality": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "On-site", "Remote", "Hybrid" ] }, "description": "Lets you find jobs that are on-site, remote, or hybrid. Pass several values to match any of them." }, "jobLocationType": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "On-site", "Remote", "Hybrid" ] }, "description": "Deprecated. Use jobModality instead.", "deprecated": true }, "employmentType": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] }, "description": "Array of employment types (e.g., Full-time, Part-time, Contract, Internship)" }, "seniorityLevel": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive" ] }, "description": "Array of seniority levels (e.g., Entry level, Mid-Senior level, Director)" }, "countryOrRegionCode": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] }, "description": "Array of country or region codes (e.g., USA, IND, X-ANGLOSPHERE)" } }, "additionalProperties": false, "description": "Job search filter parameters" } }, "required": [ "apiKey", "searchParams" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "totalJobsFound": { "type": "integer", "minimum": 0, "description": "Total number of jobs matching the search criteria" } }, "required": [ "totalJobsFound" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # jobTitleRewrite `POST /v1/typeahead/job-title` **Tags:** `Typeaheads` Job Title Synonym Expansion **Endpoint:** `https://api.fiber.ai/v1/typeahead/job-title` ## Description Expand a job title into synonyms and related variations. Useful for broadening job title searches to improve yield. ⚡ Rate limit: 240 requests per 1 minute 💰 Cost: 1 credit per request ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "query": { "type": "string", "minLength": 1, "maxLength": 200, "description": "The job title to expand into synonyms and variations." }, "limit": { "type": "integer", "minimum": 1, "maximum": 50, "default": 10, "description": "Maximum number of suggestions to return." } }, "required": [ "apiKey", "query" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "suggestions": { "type": "array", "items": { "type": "string" } } }, "required": [ "suggestions" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # kitchenSinkBulkCompany `POST /v1/kitchen-sink/bulk/company` **Tags:** `Kitchen sink` Kitchen sink bulk company lookup **Endpoint:** `https://api.fiber.ai/v1/kitchen-sink/bulk/company` ## Description Search for many companies using a variety of parameters such as LinkedIn slug, LinkedIn URL, name, etc. Returns complete company data if found. ⚡ Rate limit: 60 requests per 1 minute 💰 Cost: 2 credits per company lookup ⓘ ⏱ Recommended timeout: 3 minutes ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "companies": { "type": "array", "items": { "type": "object", "properties": { "companyIdentifier": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinSlug" ] }, "value": { "type": "string", "description": "The LinkedIn slug of the person's current company." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinUrl" ] }, "value": { "type": "string", "description": "The LinkedIn URL of the person's current company." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinOrgID" ] }, "value": { "type": "string", "description": "The LinkedIn organization ID of the person's current company." } }, "required": [ "identifier", "value" ] }, { "type": "null" } ], "description": "A unique identifier for the company. Accepts one of: linkedinSlug, linkedinUrl, or linkedinOrgID. Providing this increases the accuracy and speed of the lookup. If this is provided, you do not need to supply companyName or companyDomain." }, "companyName": { "type": [ "object", "null" ], "properties": { "value": { "type": [ "string", "null" ], "description": "The name of the company. All input words must match." } } }, "companyDomain": { "type": [ "object", "null" ], "properties": { "value": { "type": [ "string", "null" ], "description": "The domain of the company. URL prefixes (https, www) are automatically stripped. Subdomains and path segments are preserved to support domains like 'instagram.com/company' or 'my_company.netlify.app'." } } }, "companyLocation": { "type": [ "object", "null" ], "properties": { "countryCode": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 3, "description": "ISO 3166-1 alpha-3 country code (e.g. 'USA', 'GBR')." }, "stateName": { "type": [ "string", "null" ], "description": "State or region name in plain text (e.g. 'California', 'New York')." }, "locality": { "type": [ "string", "null" ], "description": "Free-text location string. Use this when the location data does not clearly separate into country, state, or city." } }, "description": "Company headquarters location. Helps disambiguate companies with similar names or domains by boosting matches in the specified location." }, "numCompanies": { "type": "integer", "minimum": 1, "maximum": 10, "default": 1, "description": "Maximum number of company results to return. Sorted by best match. Defaults to 1." } }, "description": "Parameters for searching for a company. Provide at least one parameter. More parameters improve match accuracy." }, "minItems": 1, "maxItems": 50 } }, "required": [ "apiKey", "companies" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "array", "items": { "type": "object", "properties": { "linkedin_id": { "type": [ "string", "null" ] }, "accelerator_statuses": { "type": [ "array", "null" ], "items": { "type": "string" } }, "accelerators": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "slug": { "type": [ "string", "null" ] }, "tags": { "type": [ "array", "null" ], "items": { "type": "string" } }, "year": { "type": [ "number", "null" ] }, "batch": { "type": [ "string", "null" ] }, "founders": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "full_name": { "type": [ "string", "null" ] }, "bio": { "type": [ "string", "null" ] }, "job_title": { "type": [ "string", "null" ] }, "is_active": { "type": [ "boolean", "null" ] }, "email_address": { "type": [ "string", "null" ] }, "facebook_url": { "type": [ "string", "null" ] }, "twitter_handle": { "type": [ "string", "null" ] }, "linkedin_slug": { "type": [ "string", "null" ] }, "github_username": { "type": [ "string", "null" ] } } } }, "description": { "type": [ "string", "null" ] }, "one_liner": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "company_domain": { "type": [ "string", "null" ] }, "accelerator_name": { "type": [ "string", "null" ] }, "accelerator_domain": { "type": [ "string", "null" ] } } } }, "blog_urls": { "type": [ "array", "null" ], "items": { "type": "string" } }, "custom_data": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "emails": { "type": [ "array", "null" ], "items": { "type": "string" } }, "phone_numbers": { "type": [ "array", "null" ], "items": { "type": "string" } }, "employee_count_consensus": { "type": [ "object", "null" ], "properties": { "gte": { "type": [ "number", "null" ] }, "lte": { "type": [ "number", "null" ] } } }, "facebook_urls": { "type": [ "array", "null" ], "items": { "type": "string" } }, "fortune_rankings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "list": { "type": "string", "enum": [ "fortune-500-usa", "forbes-global-2000" ] }, "year": { "type": "number" }, "rank": { "type": "number" } }, "required": [ "list", "year", "rank" ] } }, "founded_on_consensus": { "type": [ "string", "null" ] }, "github_usernames": { "type": [ "array", "null" ], "items": { "type": "string" } }, "instagram_handles": { "type": [ "array", "null" ], "items": { "type": "string" } }, "latest_funding_consensus": { "type": [ "number", "null" ] }, "linkedin_slugs": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "li_org_id": { "type": [ "string", "null" ] }, "li_category": { "type": [ "string", "null" ], "enum": [ "W", "S", "C", null ] }, "li_job_posts_stats": { "type": [ "object", "null" ], "properties": { "total_count": { "type": "number" }, "seniority_stats": { "type": [ "object", "null" ], "properties": { "Entry level": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Director": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Associate": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Mid-Senior level": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Internship": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Executive": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Not Applicable": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] } }, "additionalProperties": false }, "employment_type_stats": { "type": [ "object", "null" ], "properties": { "Full-time": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Temporary": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Internship": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Contract": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Part-time": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Volunteer": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Other": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] } }, "additionalProperties": false }, "country_location_stats": { "type": [ "object", "null" ], "properties": { "USA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GBR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "FRA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IND": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BRA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "DEU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ESP": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CAN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "AUS": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NLD": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ITA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ZAF": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BEL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CHN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "TUR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MEX": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CHE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NOR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ARE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SWE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "POL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IDN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ARG": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PRT": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "COL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CHL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PAK": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "DNK": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "JPN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NGA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SGP": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PER": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NZL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "AUT": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IRL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MYS": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BGD": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "EGY": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ISR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SAU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PHL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "FIN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IRN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ROU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CZE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GRC": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "HKG": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "HUN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "KEN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MAR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "VNM": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "RUS": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "UKR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ECU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "THA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LKA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "KOR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BGR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GHA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SRB": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "TWN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "HRV": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LTU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PRI": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SVK": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "TUN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "EST": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "VEN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CRI": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PAN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "URY": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LBN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LUX": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CYP": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NPL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "JOR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SVN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MTQ": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "QAT": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GLP": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "UGA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "DZA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GTM": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CMR": { "type": "object", "properties": { "count": { "type": "number" }, … _truncated to 65536 chars for ai-docs._ ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # kitchenSinkCompany `POST /v1/kitchen-sink/company` **Tags:** `Kitchen sink` Kitchen sink company lookup **Endpoint:** `https://api.fiber.ai/v1/kitchen-sink/company` ## Description Search for a company using a variety of parameters such as LinkedIn slug, LinkedIn URL, name, etc. Returns complete company data if found. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: 2 credits per company lookup ⓘ ⏱ Recommended timeout: 30 seconds ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "companyIdentifier": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinSlug" ] }, "value": { "type": "string", "description": "The LinkedIn slug of the person's current company." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinUrl" ] }, "value": { "type": "string", "description": "The LinkedIn URL of the person's current company." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinOrgID" ] }, "value": { "type": "string", "description": "The LinkedIn organization ID of the person's current company." } }, "required": [ "identifier", "value" ] }, { "type": "null" } ], "description": "A unique identifier for the company. Accepts one of: linkedinSlug, linkedinUrl, or linkedinOrgID. Providing this increases the accuracy and speed of the lookup. If this is provided, you do not need to supply companyName or companyDomain." }, "companyName": { "type": [ "object", "null" ], "properties": { "value": { "type": [ "string", "null" ], "description": "The name of the company. All input words must match." } } }, "companyDomain": { "type": [ "object", "null" ], "properties": { "value": { "type": [ "string", "null" ], "description": "The domain of the company. URL prefixes (https, www) are automatically stripped. Subdomains and path segments are preserved to support domains like 'instagram.com/company' or 'my_company.netlify.app'." } } }, "companyLocation": { "type": [ "object", "null" ], "properties": { "countryCode": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 3, "description": "ISO 3166-1 alpha-3 country code (e.g. 'USA', 'GBR')." }, "stateName": { "type": [ "string", "null" ], "description": "State or region name in plain text (e.g. 'California', 'New York')." }, "locality": { "type": [ "string", "null" ], "description": "Free-text location string. Use this when the location data does not clearly separate into country, state, or city." } }, "description": "Company headquarters location. Helps disambiguate companies with similar names or domains by boosting matches in the specified location." }, "numCompanies": { "type": "integer", "minimum": 1, "maximum": 10, "default": 1, "description": "Maximum number of company results to return. Sorted by best match. Defaults to 1." } }, "required": [ "apiKey" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "linkedin_id": { "type": [ "string", "null" ] }, "accelerator_statuses": { "type": [ "array", "null" ], "items": { "type": "string" } }, "accelerators": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "slug": { "type": [ "string", "null" ] }, "tags": { "type": [ "array", "null" ], "items": { "type": "string" } }, "year": { "type": [ "number", "null" ] }, "batch": { "type": [ "string", "null" ] }, "founders": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "full_name": { "type": [ "string", "null" ] }, "bio": { "type": [ "string", "null" ] }, "job_title": { "type": [ "string", "null" ] }, "is_active": { "type": [ "boolean", "null" ] }, "email_address": { "type": [ "string", "null" ] }, "facebook_url": { "type": [ "string", "null" ] }, "twitter_handle": { "type": [ "string", "null" ] }, "linkedin_slug": { "type": [ "string", "null" ] }, "github_username": { "type": [ "string", "null" ] } } } }, "description": { "type": [ "string", "null" ] }, "one_liner": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "company_domain": { "type": [ "string", "null" ] }, "accelerator_name": { "type": [ "string", "null" ] }, "accelerator_domain": { "type": [ "string", "null" ] } } } }, "blog_urls": { "type": [ "array", "null" ], "items": { "type": "string" } }, "custom_data": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "emails": { "type": [ "array", "null" ], "items": { "type": "string" } }, "phone_numbers": { "type": [ "array", "null" ], "items": { "type": "string" } }, "employee_count_consensus": { "type": [ "object", "null" ], "properties": { "gte": { "type": [ "number", "null" ] }, "lte": { "type": [ "number", "null" ] } } }, "facebook_urls": { "type": [ "array", "null" ], "items": { "type": "string" } }, "fortune_rankings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "list": { "type": "string", "enum": [ "fortune-500-usa", "forbes-global-2000" ] }, "year": { "type": "number" }, "rank": { "type": "number" } }, "required": [ "list", "year", "rank" ] } }, "founded_on_consensus": { "type": [ "string", "null" ] }, "github_usernames": { "type": [ "array", "null" ], "items": { "type": "string" } }, "instagram_handles": { "type": [ "array", "null" ], "items": { "type": "string" } }, "latest_funding_consensus": { "type": [ "number", "null" ] }, "linkedin_slugs": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "li_org_id": { "type": [ "string", "null" ] }, "li_category": { "type": [ "string", "null" ], "enum": [ "W", "S", "C", null ] }, "li_job_posts_stats": { "type": [ "object", "null" ], "properties": { "total_count": { "type": "number" }, "seniority_stats": { "type": [ "object", "null" ], "properties": { "Entry level": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Director": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Associate": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Mid-Senior level": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Internship": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Executive": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Not Applicable": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] } }, "additionalProperties": false }, "employment_type_stats": { "type": [ "object", "null" ], "properties": { "Full-time": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Temporary": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Internship": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Contract": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Part-time": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Volunteer": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Other": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] } }, "additionalProperties": false }, "country_location_stats": { "type": [ "object", "null" ], "properties": { "USA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GBR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "FRA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IND": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BRA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "DEU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ESP": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CAN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "AUS": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NLD": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ITA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ZAF": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BEL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CHN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "TUR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MEX": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CHE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NOR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ARE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SWE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "POL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IDN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ARG": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PRT": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "COL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CHL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PAK": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "DNK": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "JPN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NGA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SGP": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PER": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NZL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "AUT": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IRL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MYS": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BGD": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "EGY": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ISR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SAU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PHL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "FIN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IRN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ROU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CZE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GRC": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "HKG": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "HUN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "KEN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MAR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "VNM": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "RUS": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "UKR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ECU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "THA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LKA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "KOR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BGR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GHA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SRB": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "TWN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "HRV": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LTU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PRI": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SVK": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "TUN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "EST": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "VEN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CRI": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PAN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "URY": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LBN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LUX": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CYP": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NPL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "JOR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SVN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MTQ": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "QAT": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GLP": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "UGA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "DZA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GTM": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CMR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LVA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "DOM": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "AZE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GEO": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SEN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "TZA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ZWE": { "type": "object", "properties": { "count": { "type": "number" }, "fractio … _truncated to 65536 chars for ai-docs._ ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # listAllJobChangeLists `POST /v1/job-changes/list-all` **Tags:** `Job changes` List all job changes lists **Endpoint:** `https://api.fiber.ai/v1/job-changes/list-all` ## Description Lists all job changes lists for your organization. Returns basic info for each list. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "cursor": { "type": [ "string", "null" ], "description": "The pagination cursor to continue from a previous response." }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100, "description": "The number of job changes lists to return per page." } }, "required": [ "apiKey" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "jobChangesLists": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the job change list." }, "name": { "type": "string", "description": "The name of the job change list." }, "createdAt": { "type": "string", "description": "When the list was created." }, "status": { "type": "string", "enum": [ "NORMAL", "DRAFT", "BUILDING", "ERROR" ], "description": "Status of the job changes list. 'NORMAL' = list has profiles and is ready to use. 'DRAFT' = list is empty, no profiles added yet. 'BUILDING' = profiles are currently being added to the list. 'ERROR' = an error occurred while processing the list; contact support." }, "isActive": { "type": "boolean", "description": "Whether the list is currently active." } }, "required": [ "id", "name", "createdAt", "status", "isActive" ] } }, "totalCount": { "type": "number", "description": "Total number of job changes lists." }, "nextCursor": { "type": [ "string", "null" ], "description": "The pagination cursor for the next page. Null if there are no more results." } }, "required": [ "jobChangesLists", "totalCount" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # listAllProfilesFromJobChangeList `POST /v1/job-changes/list-all-profiles` **Tags:** `Job changes` Lists all profiles from a job change list **Endpoint:** `https://api.fiber.ai/v1/job-changes/list-all-profiles` ## Description Get current state of all profiles from the list. Returns basic info for each profile. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "jobChangeListId": { "type": "string", "description": "The job change list id." }, "movements": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "promoted", "lateral-move", "new-role", "changed", "no-change" ] } }, "cursor": { "type": [ "string", "null" ], "description": "The pagination cursor to continue from a previous response." }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100, "description": "The number of profiles to return per page." } }, "required": [ "apiKey", "jobChangeListId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "profiles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the profile." }, "linkedinUrl": { "type": "string", "description": "The LinkedIn URL of the profile." }, "allMovements": { "type": "array", "items": { "type": "object", "properties": { "discoveredAt": { "type": "string" }, "newCompanyName": { "type": [ "string", "null" ] }, "newCompanyLogoUrl": { "type": [ "string", "null" ] }, "newCompanyOrgId": { "type": [ "string", "null" ] }, "newCompanyLiSlug": { "type": [ "string", "null" ] }, "newCompanyDomain": { "type": [ "string", "null" ] }, "newJobTitle": { "type": [ "string", "null" ] }, "oldCompanyName": { "type": [ "string", "null" ] }, "oldCompanyLogoUrl": { "type": [ "string", "null" ] }, "oldCompanyOrgId": { "type": [ "string", "null" ] }, "oldCompanyLiSlug": { "type": [ "string", "null" ] }, "oldCompanyDomain": { "type": [ "string", "null" ] }, "oldJobTitle": { "type": [ "string", "null" ] }, "startedInRoleAt": { "type": [ "string", "null" ] }, "startedAtCompanyAt": { "type": [ "string", "null" ] }, "movement": { "type": "string", "enum": [ "promoted", "lateral-move", "new-role", "changed", "no-change" ] } }, "required": [ "discoveredAt", "movement" ] }, "description": "All job change movements for this profile, sorted most recent first." } }, "required": [ "id", "linkedinUrl", "allMovements" ] } }, "totalCount": { "type": "number", "description": "Total number of profiles in the job change list." }, "nextCursor": { "type": [ "string", "null" ], "description": "The pagination cursor for the next page. Null if there are no more results." } }, "required": [ "profiles", "totalCount" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # listApiRequests `POST /v1/api-requests` **Tags:** `API requests` List your past API requests **Endpoint:** `https://api.fiber.ai/v1/api-requests` ## Description 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 7 days; anything older has been purged. Response bodies are not returned — only the request side of each call. ⚡ Rate limit: 30 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "from": { "type": [ "string", "null" ], "format": "date-time", "description": "Only return requests received at or after this ISO 8601 timestamp. Logs are retained for 7 days, so earlier timestamps simply return nothing." }, "to": { "type": [ "string", "null" ], "format": "date-time", "description": "Only return requests received strictly before this ISO 8601 timestamp." }, "routePath": { "type": [ "string", "null" ], "description": "Only return requests to this exact route template, e.g. \"/v1/person/search\"." }, "method": { "type": [ "string", "null" ], "description": "Only return requests using this HTTP method, e.g. \"POST\"." }, "statusCode": { "type": [ "integer", "null" ], "description": "Only return requests that returned this exact status code." }, "errorCode": { "type": [ "string", "null" ], "description": "Only return the request carrying this error correlation code." }, "cursor": { "type": [ "string", "null" ], "description": "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." }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25, "description": "The number of results to fetch per page." } }, "required": [ "apiKey" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "apiRequests": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique id of this logged request. Quote it in support requests to identify a specific call." }, "organizationId": { "type": "string", "description": "Your organization's id." }, "createdAt": { "type": "string", "format": "date-time", "description": "When the request was received, as an ISO 8601 timestamp." }, "method": { "type": "string", "description": "HTTP method, e.g. \"POST\"." }, "routePath": { "type": "string", "description": "The route template that handled the request, e.g. \"/v1/person/search\"" }, "statusCode": { "type": "integer", "description": "HTTP status code returned to you." }, "durationMs": { "type": [ "integer", "null" ], "description": "How long the request took to process, in milliseconds, measured from receipt to just before the response was written." }, "errorCode": { "type": [ "string", "null" ], "description": "Correlation code included in the response body when a request fails. Quote it in support requests." }, "request": { "description": "The input you sent with this call." } }, "required": [ "id", "organizationId", "createdAt", "method", "routePath", "statusCode" ] }, "description": "Your past API requests, newest first." }, "nextCursor": { "type": [ "string", "null" ], "description": "The pagination cursor for the next page of results. Null if there are no more results." }, "hasMore": { "type": "boolean", "description": "Whether there are more results to fetch." }, "retentionDays": { "type": "integer", "description": "How many days of request history are retained. Requests older than this have been purged and cannot be returned." } }, "required": [ "apiRequests", "hasMore", "retentionDays" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # listAudiences `GET /v1/audiences` **Tags:** `Audiences` List all audiences **Endpoint:** `https://api.fiber.ai/v1/audiences` ## Description Lists all audiences for your organization. Returns basic info and counts for each audience. Only visible audiences are returned (hidden system audiences are excluded). Pass your apiKey in the query string. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "audiences": { "type": "array", "items": { "type": "object", "properties": { "audienceId": { "type": "string", "description": "The unique ID of the audience." }, "name": { "type": "string", "description": "The name of the audience." }, "status": { "type": "string", "enum": [ "NORMAL", "HEALING_COMPANIES", "DRAFT", "BUILDING", "SAVING_COMPANIES", "SAVING_PROSPECTS", "LINKING_PROSPECTS_WITH_COMPANIES", "FAILED" ], "description": "The current status of the audience." }, "creationMethod": { "type": "string", "enum": [ "NORMAL", "COMPANY_UPLOAD", "PROSPECT_UPLOAD", "START_FROM_PROSPECTS", "FOLLOW_ME", "INDIVIDUAL_SALES_NAV_SCRAPE", "MERGE_AUDIENCES", "BATCH_ENRICHMENT", "CLONED", "SALES_NAV_COMPANIES", "SALES_NAV_PROFILES" ], "description": "The method used to create the audience." }, "createdAt": { "type": "string", "description": "The timestamp when the audience was created." }, "companiesCount": { "type": "number", "description": "The number of companies in the audience." }, "prospectsCount": { "type": "number", "description": "The number of prospects in the audience." } }, "required": [ "audienceId", "name", "status", "creationMethod", "createdAt", "companiesCount", "prospectsCount" ] } }, "totalCount": { "type": "number", "description": "The total number of audiences." } }, "required": [ "audiences", "totalCount" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # listAvailableTrackerRules `GET /v1/tracker/rules` **Tags:** `Tracker` List available tracker rules **Endpoint:** `https://api.fiber.ai/v1/tracker/rules` ## Description Returns all available tracker rule types with descriptions, configuration schemas, example configs, and example signal payloads. Use this to discover what rules exist before creating tracker lists. The response is deterministic — same output on every call. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "companyRules": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Rule type slug used in config objects (e.g. headcount_crossed_threshold)." }, "readableName": { "type": "string", "description": "Human-readable name for this rule type." }, "entityType": { "type": "string", "enum": [ "company", "person" ], "description": "Whether this rule applies to company or person lists." }, "description": { "type": "string", "description": "What change this rule detects and when it fires." }, "useCase": { "type": "string", "description": "Sales-oriented example of why you would use this rule." }, "supportsInitialSignals": { "type": "boolean", "description": "Whether this rule supports immediate initial signals on entity addition." }, "config": { "type": "object", "properties": { "schema": { "type": "object", "additionalProperties": {}, "description": "JSON Schema for the rule config object. Pass a config conforming to this schema when creating a tracker list rule." }, "example": { "type": "object", "additionalProperties": {}, "description": "A valid example config you can pass directly to create a rule." } }, "required": [ "schema", "example" ], "description": "Config schema and example for creating this rule type." }, "signal": { "type": "object", "properties": { "schema": { "type": "object", "additionalProperties": {}, "description": "JSON Schema for each item in the changeData array. When this rule fires, the signal contains one or more changeData items conforming to this schema." }, "example": { "type": "object", "additionalProperties": {}, "description": "A concrete changeData item example matching the schema above." } }, "required": [ "schema", "example" ], "description": "Signal output schema and example for this rule type." } }, "required": [ "name", "readableName", "entityType", "description", "useCase", "supportsInitialSignals", "config", "signal" ] }, "description": "All available company tracking rule types." }, "personRules": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Rule type slug used in config objects (e.g. headcount_crossed_threshold)." }, "readableName": { "type": "string", "description": "Human-readable name for this rule type." }, "entityType": { "type": "string", "enum": [ "company", "person" ], "description": "Whether this rule applies to company or person lists." }, "description": { "type": "string", "description": "What change this rule detects and when it fires." }, "useCase": { "type": "string", "description": "Sales-oriented example of why you would use this rule." }, "supportsInitialSignals": { "type": "boolean", "description": "Whether this rule supports immediate initial signals on entity addition." }, "config": { "type": "object", "properties": { "schema": { "type": "object", "additionalProperties": {}, "description": "JSON Schema for the rule config object. Pass a config conforming to this schema when creating a tracker list rule." }, "example": { "type": "object", "additionalProperties": {}, "description": "A valid example config you can pass directly to create a rule." } }, "required": [ "schema", "example" ], "description": "Config schema and example for creating this rule type." }, "signal": { "type": "object", "properties": { "schema": { "type": "object", "additionalProperties": {}, "description": "JSON Schema for each item in the changeData array. When this rule fires, the signal contains one or more changeData items conforming to this schema." }, "example": { "type": "object", "additionalProperties": {}, "description": "A concrete changeData item example matching the schema above." } }, "required": [ "schema", "example" ], "description": "Signal output schema and example for this rule type." } }, "required": [ "name", "readableName", "entityType", "description", "useCase", "supportsInitialSignals", "config", "signal" ] }, "description": "All available person tracking rule types." }, "totalRuleCount": { "type": "integer", "minimum": 0, "description": "Total number of available rule types across both entity types." } }, "required": [ "companyRules", "personRules", "totalRuleCount" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # listCompanyRankings `POST /v1/company-rankings` **Tags:** `Company info` Download a ranked company list **Endpoint:** `https://api.fiber.ai/v1/company-rankings` ## Description 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. ⚡ Rate limit: 600 requests per 1 minute 💰 Cost: 1 credit per company returned ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "rankings": { "type": "object", "properties": { "list": { "type": "string", "enum": [ "fortune-500-usa", "forbes-global-2000" ] }, "year": { "type": [ "integer", "null" ], "minimum": 2024, "maximum": 2026, "description": "Edition year of the list. Omit to get the most recent year available." }, "rankRange": { "type": "object", "properties": { "low": { "type": "integer", "minimum": 1, "description": "First rank to include, where 1 is the top-ranked company." }, "high": { "type": "integer", "minimum": 1, "description": "Last rank to include." } }, "required": [ "low", "high" ], "description": "Inclusive rank range of companies to download. Note: the Fortune 500 edition actually holds the top 1000 companies, so you can request ranks past 500 (e.g. up to 1000)." } }, "required": [ "list", "rankRange" ] } }, "required": [ "apiKey", "rankings" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "list": { "type": "string", "enum": [ "fortune-500-usa", "forbes-global-2000" ] }, "year": { "type": "integer", "description": "Edition year of the returned list." }, "companies": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "description": "Company name as published on the list." }, "rank": { "type": "integer", "minimum": 1, "description": "Position on the list for this edition (1 = top ranked)." }, "domain": { "type": [ "string", "null" ], "description": "Primary company domain, e.g. 'example.com'." }, "ticker": { "type": [ "string", "null" ], "description": "Stock ticker symbol (e.g. 'AAPL'), when the company is publicly traded." }, "headquarters": { "type": [ "string", "null" ], "description": "Where the company is based. The exact format varies by list." }, "countryCode": { "type": [ "string", "null" ], "description": "ISO 3166-1 alpha-3 country code of the headquarters country (e.g. 'USA')." }, "revenueUsd": { "type": [ "number", "null" ], "description": "Annual revenue in US dollars." }, "profitsUsd": { "type": [ "number", "null" ], "description": "Annual profits in US dollars." }, "marketCapUsd": { "type": [ "number", "null" ], "description": "Market capitalization in US dollars." }, "employeeCount": { "type": [ "number", "null" ], "description": "Number of employees." } }, "required": [ "name", "rank" ] }, "description": "Companies in rank order (rank 1 first)." } }, "required": [ "list", "year", "companies" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # listSavedSearch `POST /v1/saved-search/list` **Tags:** `Saved search` List saved searches **Endpoint:** `https://api.fiber.ai/v1/saved-search/list` ## Description List saved searches ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "cursor": { "type": [ "string", "null" ], "description": "The pagination cursor to continue from a previous response." }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100, "description": "The number of saved searches to return per page." } }, "required": [ "apiKey" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "savedSearches": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the saved search." }, "name": { "type": "string", "description": "The name of the saved search." } }, "required": [ "id", "name" ] }, "description": "The list of saved searches." }, "nextCursor": { "type": [ "string", "null" ], "description": "The pagination cursor for the next page. Null if there are no more results." } }, "required": [ "savedSearches" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # listSavedSearchRuns `POST /v1/saved-search/run/list` **Tags:** `Saved search` List saved search runs **Endpoint:** `https://api.fiber.ai/v1/saved-search/run/list` ## Description List saved search runs ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "savedSearchId": { "type": "string", "description": "The ID of the saved search. Use /saved-search/list to get the ID of a saved search." }, "cursor": { "type": [ "string", "null" ], "description": "The cursor to start from. You can pass null to get the first page of results." }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100, "description": "The number of runs to return" } }, "required": [ "apiKey", "savedSearchId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "runs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the saved search run" }, "status": { "type": "string", "description": "The status of the saved search run" }, "startedAt": { "type": [ "string", "null" ], "description": "The date and time the saved search run started" }, "completedAt": { "type": [ "string", "null" ], "description": "The date and time the saved search run completed (if completed)" }, "executionMode": { "type": "string", "enum": [ "manually_triggered", "automatically_triggered" ], "description": "The execution mode of the saved search run. How the saved search run was triggered (\"spawned\"): automatically via the saved search's frequency, or manually through your team's actions" } }, "required": [ "id", "status", "executionMode" ] }, "description": "The runs of the saved search" }, "nextCursor": { "type": [ "string", "null" ], "description": "The next cursor. You can call this endpoint again with this cursor to get the next page of results. If null, there are no more results." } }, "required": [ "runs" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # listTrackerCompanyLists `GET /v1/tracker/company-lists` **Tags:** `Tracker` List company tracker lists **Endpoint:** `https://api.fiber.ai/v1/tracker/company-lists` ## Description List all company tracker lists for your organization. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "lists": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Tracker list ID." }, "name": { "type": "string", "description": "Name of the list." }, "refreshIntervalDays": { "type": "integer", "description": "Check interval in days." }, "trackingRules": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "headcount_crossed_threshold" }, "entityType": { "type": "string", "const": "company" }, "direction": { "type": "string", "enum": [ "above", "below" ], "description": "Whether to alert when headcount crosses the threshold going up or down" }, "threshold": { "type": "integer", "exclusiveMinimum": 0, "description": "The employee count threshold to watch for crossing. Any positive integer is accepted." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "direction", "threshold", "id" ], "title": "Headcount crossed threshold" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "headcount_growth_percent" }, "entityType": { "type": "string", "const": "company" }, "minPercentChange": { "type": "number", "exclusiveMinimum": 0, "maximum": 1000, "description": "Minimum percent change to trigger (e.g. 20 means 20% growth)" }, "direction": { "type": "string", "enum": [ "grew", "shrank", "either" ], "description": "Whether to alert on growth, shrinkage, or either" }, "minStartingHeadcount": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Only alert if the company had at least this many employees before the change. Omit for any starting size." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "minPercentChange", "direction", "id" ], "title": "Headcount growth percent" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "new_funding_round" }, "entityType": { "type": "string", "const": "company" }, "minAmountUsd": { "type": [ "number", "null" ], "minimum": 0, "description": "Only alert for rounds above this amount. Omit for any amount." }, "roundTypes": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "pre_seed", "seed", "angel", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "private_equity", "debt_financing", "grant", "convertible_note", "corporate_round", "undisclosed" ] }, "minItems": 1, "description": "Round types to alert on. Defaults to equity-focused types when omitted. Set explicitly to include debt/grant types." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "New funding round" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "funding_stage_changed" }, "entityType": { "type": "string", "const": "company" }, "toStages": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "private_equity", "public", "acquired" ] }, "minItems": 1, "description": "Only alert if new stage is one of these. Omit for any stage change." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Funding stage changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "job_posting_with_keyword" }, "entityType": { "type": "string", "const": "company" }, "keywords": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Alert when a job posting title contains any of these keywords" }, "seniorityLevels": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Internship", "Entry level", "Associate", "Mid-Senior level", "Director", "Executive" ] }, "minItems": 1, "description": "Only alert for these seniority levels. Omit for any level." }, "modalities": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "On-site", "Remote", "Hybrid" ] }, "minItems": 1, "description": "Only alert for these job modalities. Omit for any." }, "locationTypes": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "remote", "on_site", "hybrid" ] }, "minItems": 1, "description": "Deprecated. Use modalities instead.", "deprecated": true }, "minPostings": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Only alert if at least this many NEW matching postings are detected in a single check cycle. Omit for 1 (any new match)." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "keywords", "id" ], "title": "Job posting with keyword" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "job_posting_in_function" }, "entityType": { "type": "string", "const": "company" }, "jobFunctions": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Accounting", "Administrative", "Advertising", "Analyst", "Art / Creative", "Business Development", "Community & Social Services", "Consulting", "Customer Service", "Design", "Distribution", "Education", "Engineering", "Entrepreneurship", "Finance", "General Business", "Health Care Provider", "Human Resources", "Information Technology", "Legal", "Management", "Manufacturing", "Marketing", "Military & Protective Services", "Other", "Product Management", "Production", "Program & Product Management", "Project Management", "Public Relations", "Purchasing", "Quality Assurance", "Real Estate", "Research", "Sales", "Science", "Strategy / Planning", "Supply Chain", "Training", "Writing / Editing" ] }, "description": "Alert when a job posting is in any of these departments/functions." }, "minPostings": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Only alert if at least this many NEW matching postings are detected in a single check cycle. Omit for 1 (any new match)." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "jobFunctions", "id" ], "title": "Job posting in function" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "news_with_keyword" }, "entityType": { "type": "string", "const": "company" }, "keywords": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Alert when a news article title or summary matches any keyword" }, "sentiment": { "type": [ "string", "null" ], "enum": [ "positive", "negative", "neutral", null ], "description": "Only alert for news with this sentiment. Omit for any sentiment." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "keywords", "id" ], "title": "News with keyword" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_news" }, "entityType": { "type": "string", "const": "company" }, "sentiment": { "type": [ "string", "null" ], "enum": [ "positive", "negative", "neutral", null ], "description": "Only alert for news with this sentiment. Omit for any sentiment." }, "minArticles": { "type": [ "integer", "null" ], "minimum": 1, "description": "Only alert when at least this many articles are detected in a single check. Useful for filtering noise from single tangential mentions. Omit for any count." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Company news" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "hq_location_changed" }, "entityType": { "type": "string", "const": "company" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "HQ location changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_status_changed" }, "entityType": { "type": "string", "const": "company" }, "toStatuses": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "operating", "acquired", "closed", "ipo", "subsidiary" ] }, "minItems": 1, "description": "Only alert if new status is one of these. Omit for any status change." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Company status changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "technology_added" }, "entityType": { "type": "string", "const": "company" }, "technologies": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert for these technologies. Omit for any new technology." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Technology added" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_posted" }, "entityType": { "type": "string", "const": "company" }, "minReactions": { "type": [ "integer", "null" ], "minimum": 0, "description": "Only alert for posts with at least this many reactions. Omit for any." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Company posted" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_posted_with_keyword" }, "entityType": { "type": "string", "const": "company" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Alert for posts matching these keywords." }, "minReactions": { "type": [ "integer", "null" ], "minimum": 0, "description": "Only alert for posts with at least this many reactions. Omit for any." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Company posted with keyword" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "follower_count_growth" }, "entityType": { "type": "string", "const": "company" }, "minAbsoluteGrowth": { "type": [ "integer", "null" ], "minimum": 0, "description": "Minimum absolute follower increase to trigger. Omit or set to 0 for any increase." }, "minPercentGrowth": { "type": [ "number", "null" ], "exclusiveMinimum": 0, "description": "Minimum percent follower increase to trigger. Omit for any increase." }, "minStartingFollowerCount": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Only alert if the company had at least this many followers before the growth. Omit for any starting count." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Follower count growth" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_name_changed" }, "entityType": { "type": "string", "const": "company" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Company name changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_description_changed" }, "entityType": { "type": "string", "const": "company" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if new description contains one of these keywords. Omit for any change." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Company description changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_went_inactive" }, "entityType": { "type": "string", "const": "company" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "description": "Fires when a company becomes inactive.", "title": "Company went inactive" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "employee_count_milestone" }, "entityType": { "type": "string", "const": "company" }, "milestone": { "type": "integer", "exclusiveMinimum": 0, "description": "The employee count threshold to watch for crossing. Any positive integer is accepted. Equivalent to 'threshold' in headcount_crossed_threshold." }, "direction": { "type": "string", "enum": [ "above", "below" ], "description": "Whether to alert when crossing above or below the milestone" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "milestone", "direction", "id" ], "description": "Fires when the employee count crosses the specified value. Supports any positive integer, not just round milestones. Functionally equivalent to headcount_crossed_threshold.", "title": "Employee count milestone" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "new_office_location" }, "entityType": { "type": "string", "const": "company" }, "countries": { "type": [ "array", "null" ], "items": { "type": "string", "pattern": "^[A-Z]{3}$", "minLength": 3, "maxLength": 3 }, "minItems": 1, "description": "ISO 3166-1 alpha-3 country codes (e.g. 'USA', 'GBR', 'DEU'). Only alert for offices in these countries. Omit for any new office." }, "cities": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "City names (e.g. 'San Francisco', 'London', 'Berlin'). Only alert for offices in these cities. Omit for any new office." }, "regions": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Region codes (e.g. 'X-EMEA', 'X-APAC', 'X-EUROPE'). Expands to constituent country codes. Omit for any." }, "states": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "State or province names (e.g. 'California', 'Ontario'). Omit for any." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "New office location" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_logo_changed" }, "entityType": { "type": "string", "const": "company" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Company logo changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "acquired_company" }, "entityType": { "type": "string", "const": "company" }, "minPriceUsd": { "type": [ "number", "null" ], "minimum": 0, "description": "Only alert for acquisitions above this price. Omit for any acquisition." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Acquired company" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "new_investor" }, "entityType": { "type": "string", "const": "company" }, "investorNames": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert when a new investor's name matches one of these (exact, case-insensitive). Omit for any new investor." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "New investor" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "recently_hired_with_title" }, "entityType": { "type": "string", "const": "company" }, "titleKeywords": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Title keywords to search for. Fires when the company hires someone whose title matches any keyword." }, "minNewHires": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Minimum number of NEW hires detected in a single check cycle to trigger the alert. Only counts employees who appeared since the last check. Omit for 1." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "titleKeywords", "id" ], "title": "Recently hired with title" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "department_size_threshold" }, "entityType": { "type": "string", "const": "company" }, "department": { "type": "string", "enum": [ "Accounting", "Administrative", "Advertising", "Analyst", "Art / Creative", "Business Development", "Community & Social Services", "Consulting", "Customer Service", "Design", "Distribution", "Education", "Engineering", "Entrepreneurship", "Finance", "General Business", "Health Care Provider", "Human Resources", "Information Technology", "Legal", "Management", "Manufacturing", "Marketing", "Military & Protective Services", "Other", "Product Management", "Production", "Program & Product Management", "Project Management", "Public Relations", "Purchasing", "Quality Assurance", "Real Estate", "Research", "Sales", "Science", "Strategy / Planning", "Supply Chain", "Training", "Writing / Editing" ], "description": "Department to track. Matched against the company's organizational structure." }, "threshold": { "type": "integer", "exclusiveMinimum": 0, "description": "The employee count threshold to watch for crossing" }, "direction": { "type": "string", "enum": [ "above", "below" ], "description": "Whether to alert when department size crosses above or below the threshold" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", … _truncated to 65536 chars for ai-docs._ ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # listTrackerPersonLists `GET /v1/tracker/person-lists` **Tags:** `Tracker` List person tracker lists **Endpoint:** `https://api.fiber.ai/v1/tracker/person-lists` ## Description List all person tracker lists for your organization. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "lists": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Tracker list ID." }, "name": { "type": "string", "description": "Name of the list." }, "refreshIntervalDays": { "type": "integer", "description": "Check interval in days." }, "trackingRules": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_changed_company" }, "entityType": { "type": "string", "const": "person" }, "toCompanies": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if they moved TO one of these companies (domains or slugs). Omit for any." }, "fromCompanies": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if they moved FROM one of these companies. Omit for any." }, "toTitleKeywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if their title at the new company contains one of these keywords." }, "toSeniorityLevels": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Internship", "Entry level", "Associate", "Mid-Senior level", "Director", "Executive" ] }, "minItems": 1, "description": "Only alert if their seniority at the new company is one of these levels." }, "toEmploymentTypes": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Part-time", "Contract", "Internship", "Temporary", "Volunteer" ] }, "minItems": 1, "description": "Only alert for these employment types at the new company. Omit for any." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person changed company" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_title_changed" }, "entityType": { "type": "string", "const": "person" }, "titleKeywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if new title contains one of these keywords. Omit for any title change." }, "toSeniority": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Internship", "Entry level", "Associate", "Mid-Senior level", "Director", "Executive" ] }, "minItems": 1, "description": "Only alert if the new position's seniority level matches one of these. Omit for any seniority." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person title changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_stealth_changed" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "entered", "exited", "either" ], "description": "Whether to alert on entering stealth, exiting, or either" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "direction", "id" ], "title": "Person stealth changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_open_to_work" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "started", "stopped", "either" ], "description": "Whether to alert when they start or stop signaling open-to-work" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "direction", "id" ], "title": "Person open to work" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_is_hiring" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "started", "stopped", "either" ], "description": "Whether to alert when they start or stop signaling is-hiring" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "direction", "id" ], "title": "Person is hiring" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_headline_changed" }, "entityType": { "type": "string", "const": "person" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if new headline contains one of these keywords. Omit for any change." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person headline changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_location_changed" }, "entityType": { "type": "string", "const": "person" }, "toCountries": { "type": [ "array", "null" ], "items": { "type": "string", "pattern": "^[A-Z]{3}$", "minLength": 3, "maxLength": 3 }, "minItems": 1, "description": "ISO 3166-1 alpha-3 country codes (e.g. 'USA', 'GBR', 'DEU'). Only alert if moved to one of these countries. Omit for any relocation." }, "fromCountries": { "type": [ "array", "null" ], "items": { "type": "string", "pattern": "^[A-Z]{3}$", "minLength": 3, "maxLength": 3 }, "minItems": 1, "description": "Only alert if they moved FROM one of these countries. Omit for any." }, "regions": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Region codes (e.g. 'X-EMEA', 'X-APAC'). Only alert if destination country is in one of these regions. Omit for any." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person location changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_tag_gained" }, "entityType": { "type": "string", "const": "person" }, "tags": { "type": "array", "items": { "type": "string", "enum": [ "student", "attended-top-us-university", "attended-top-global-university", "second-time-founder", "deep-technical-background", "major-tech-company-experience", "fortune-500-executive", "recently-changed-companies", "recently-promoted", "decision-maker", "c-suite", "experienced-executive", "phd", "influencer", "board-member" ] }, "minItems": 1, "description": "Alert when the person gains any of these system-assigned tags." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "tags", "id" ], "title": "Person tag gained" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_posted" }, "entityType": { "type": "string", "const": "person" }, "minReactions": { "type": [ "integer", "null" ], "minimum": 0, "description": "Only alert for posts with at least this many reactions. Omit for any." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person posted" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_posted_with_keyword" }, "entityType": { "type": "string", "const": "person" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Alert for posts matching these keywords." }, "minReactions": { "type": [ "integer", "null" ], "minimum": 0, "description": "Only alert for posts with at least this many reactions. Omit for any." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person posted with keyword" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_reacted_to_post" }, "entityType": { "type": "string", "const": "person" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert for reactions on posts whose content or author name matches these keywords. Omit for any reaction." }, "reactionTypes": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "LIKE", "LOVE", "INSIGHTFUL", "CELEBRATE", "SUPPORT", "FUNNY" ] }, "minItems": 1, "description": "Only alert for these reaction types. Omit for any type." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person reacted to post" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_commented_on_post" }, "entityType": { "type": "string", "const": "person" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert for comments where the comment text, post content (when available from provider), or post author name matches these keywords. Omit for any comment." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person commented on post" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_skills_added" }, "entityType": { "type": "string", "const": "person" }, "skills": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert for these specific skills being added. Omit for any new skill." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person skills added" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_got_promoted" }, "entityType": { "type": "string", "const": "person" }, "seniorityKeywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if new title contains these seniority keywords (e.g. 'VP', 'Director'). Omit for any promotion." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person got promoted" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_started_company" }, "entityType": { "type": "string", "const": "person" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person started company" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_employment_type_changed" }, "entityType": { "type": "string", "const": "person" }, "toTypes": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Part-time", "Contract", "Internship", "Temporary", "Volunteer" ] }, "minItems": 1, "description": "Only alert if new employment type is one of these. Omit for any change." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person employment type changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_connections_milestone" }, "entityType": { "type": "string", "const": "person" }, "threshold": { "type": "integer", "exclusiveMinimum": 0, "description": "Connection count to watch for crossing" }, "direction": { "type": "string", "enum": [ "above", "below" ], "description": "Whether to alert when crossing above or below the threshold" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "threshold", "direction", "id" ], "title": "Person connections milestone" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_follower_milestone" }, "entityType": { "type": "string", "const": "person" }, "threshold": { "type": "integer", "exclusiveMinimum": 0, "description": "Follower count to watch for crossing" }, "direction": { "type": "string", "enum": [ "above", "below" ], "description": "Whether to alert when crossing above or below the threshold" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "threshold", "direction", "id" ], "title": "Person follower milestone" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_summary_changed" }, "entityType": { "type": "string", "const": "person" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if new summary contains one of these keywords. Omit for any change." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person summary changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_new_certification" }, "entityType": { "type": "string", "const": "person" }, "certificationKeywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert for certifications matching these keywords. Omit for any new cert." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person new certification" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_became_verified" }, "entityType": { "type": "string", "const": "person" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person became verified" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_became_premium" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "started", "stopped", "either" ], "description": "Whether to alert when they start or stop having premium status" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "direction", "id" ], "title": "Person became premium" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_became_influencer" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "started", "stopped", "either" ], "description": "Whether to alert when they join or leave the influencer program" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "direction", "id" ], "title": "Person became influencer" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_became_top_voice" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "started", "stopped", "either" ], "description": "Whether to alert when they earn or lose the top voice badge" }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "direction", "id" ], "title": "Person became top voice" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_got_demoted" }, "entityType": { "type": "string", "const": "person" }, "seniorityKeywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if the previous title contained these seniority keywords (e.g. 'VP', 'Director'). Omit for any demotion." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "id" ], "title": "Person got demoted" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_stuck_in_role" }, "entityType": { "type": "string", "const": "person" }, "thresholdMonths": { "type": "integer", "minimum": 1, "description": "Alert when the person has been in their current role for at least this many months without a title change." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", "thresholdMonths", "id" ], "title": "Person stuck in role" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_tenure_milestone" }, "entityType": { "type": "string", "const": "person" }, "thresholdMonths": { "type": "integer", "minimum": 1, "description": "Alert when the person has been at their current company for at least this many months, regardless of role changes or promotions." }, "id": { "type": "string", "description": "Unique rule ID. Use with removeRuleIds to delete a specific rule." } }, "required": [ "isDummy", "type", "entityType", … _truncated to 65536 chars for ai-docs._ ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # listTrackerSignals `GET /v1/tracker/signals/{listId}` **Tags:** `Tracker` List signals **Endpoint:** `https://api.fiber.ai/v1/tracker/signals/{listId}` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | | `since` | query | no | Only return signals observed after this date. Example: '2024-06-01T00:00:00Z'. | | `cursor` | query | no | Pass the nextCursor value from the previous response to fetch the next page. Omit or pass null to start from the beginning. | | `pageSize` | query | no | Number of results per page. | | `filter` | query | 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. | | `listId` | path | yes | The unique ID of the tracker list. | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "signals": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Signal ID." }, "entityId": { "type": "string", "description": "Tracked entity ID." }, "entityType": { "type": "string", "enum": [ "company", "person" ], "description": "Entity type." }, "linkedinIdentifier": { "type": "string", "description": "LinkedIn org ID or user ID." }, "linkedinSlug": { "type": [ "string", "null" ], "description": "The identifying part of a person or company's LinkedIn URL, such as `williamhgates` for `https://www.linkedin.com/in/williamhgates/` or `google` for `https://www.linkedin.com/company/google`." }, "linkedinUrl": { "type": [ "string", "null" ], "description": "Full LinkedIn URL for the tracked entity, like `https://www.linkedin.com/company/google` for companies or `https://www.linkedin.com/in/williamhgates` for people." }, "type": { "type": "string", "description": "Signal type (e.g. headcount_crossed_threshold)." }, "summary": { "type": [ "string", "null" ], "description": "Human-readable description of what changed." }, "changeData": { "type": "array", "items": { "anyOf": [ { "allOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "scalar" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "null" } ], "description": "Previous funding stage" }, "current": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "null" } ], "description": "Current funding stage" }, "currentRoundDetails": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "description": "Funding round type" }, "amountUsd": { "type": [ "number", "null" ], "description": "Amount raised in USD" }, "date": { "type": [ "string", "null" ], "description": "ISO date of the round" }, "investors": { "type": "array", "items": { "type": "string" }, "description": "Investor names" }, "crunchbaseUrl": { "type": [ "string", "null" ], "description": "URL to the funding round page on Crunchbase, when available" } }, "required": [ "type", "investors" ] }, { "type": "null" } ], "description": "Details of the funding round that drove the new stage, when available" } }, "required": [ "kind" ] } ], "additionalProperties": true }, { "allOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "location" }, "previous": { "oneOf": [ { "type": "object", "properties": { "city": { "type": [ "string", "null" ], "description": "City name" }, "state": { "type": [ "string", "null" ], "description": "State or province" }, "country": { "type": [ "string", "null" ], "description": "Country name" }, "countryCode": { "type": [ "string", "null" ], "description": "ISO country code" }, "coordinates": { "type": [ "object", "null" ], "properties": { "latitude": { "type": "number", "description": "Latitude" }, "longitude": { "type": "number", "description": "Longitude" } }, "required": [ "latitude", "longitude" ], "description": "Geocoded coordinates, when known" }, "streetAddress": { "type": [ "string", "null" ], "description": "Street address of the office" }, "postalCode": { "type": [ "string", "null" ], "description": "Postal or ZIP code" }, "changeType": { "type": [ "string", "null" ], "enum": [ "added", null ], "description": "Marks a location as newly added. New office alerts report only net-new locations, so this is always 'added'; the field is unset in other location signals." }, "officeMapUrl": { "type": [ "string", "null" ], "description": "Map link for this specific office location, when there is enough address data to build one." } } }, { "type": "null" } ] }, "current": { "oneOf": [ { "type": "object", "properties": { "city": { "type": [ "string", "null" ], "description": "City name" }, "state": { "type": [ "string", "null" ], "description": "State or province" }, "country": { "type": [ "string", "null" ], "description": "Country name" }, "countryCode": { "type": [ "string", "null" ], "description": "ISO country code" }, "coordinates": { "type": [ "object", "null" ], "properties": { "latitude": { "type": "number", "description": "Latitude" }, "longitude": { "type": "number", "description": "Longitude" } }, "required": [ "latitude", "longitude" ], "description": "Geocoded coordinates, when known" }, "streetAddress": { "type": [ "string", "null" ], "description": "Street address of the office" }, "postalCode": { "type": [ "string", "null" ], "description": "Postal or ZIP code" }, "changeType": { "type": [ "string", "null" ], "enum": [ "added", null ], "description": "Marks a location as newly added. New office alerts report only net-new locations, so this is always 'added'; the field is unset in other location signals." }, "officeMapUrl": { "type": [ "string", "null" ], "description": "Map link for this specific office location, when there is enough address data to build one." } } }, { "type": "null" } ] }, "countryChanged": { "type": "boolean" }, "stateChanged": { "type": "boolean" }, "cityChanged": { "type": "boolean" }, "distanceMiles": { "type": [ "number", "null" ], "description": "Distance moved in miles, when both locations are geocoded" } }, "required": [ "kind", "previous", "current", "countryChanged", "stateChanged", "cityChanged" ] } ], "additionalProperties": true }, { "allOf": [ { "type": "object", "properties": { "city": { "type": [ "string", "null" ], "description": "City name" }, "state": { "type": [ "string", "null" ], "description": "State or province" }, "country": { "type": [ "string", "null" ], "description": "Country name" }, "countryCode": { "type": [ "string", "null" ], "description": "ISO country code" }, "coordinates": { "type": [ "object", "null" ], "properties": { "latitude": { "type": "number", "description": "Latitude" }, "longitude": { "type": "number", "description": "Longitude" } }, "required": [ "latitude", "longitude" ], "description": "Geocoded coordinates, when known" }, "streetAddress": { "type": [ "string", "null" ], "description": "Street address of the office" }, "postalCode": { "type": [ "string", "null" ], "description": "Postal or ZIP code" }, "changeType": { "type": [ "string", "null" ], "enum": [ "added", null ], "description": "Marks a location as newly added. New office alerts report only net-new locations, so this is always 'added'; the field is unset in other location signals." }, "officeMapUrl": { "type": [ "string", "null" ], "description": "Map link for this specific office location, when there is enough address data to build one." } } } ], "additionalProperties": true }, { "allOf": [ { "type": "object", "properties": { "type": { "type": "string", "description": "Funding round type" }, "amountUsd": { "type": [ "number", "null" ], "description": "Amount raised in USD" }, "date": { "type": [ "string", "null" ], "description": "ISO date of the round" }, "investors": { "type": "array", "items": { "type": "string" }, "description": "Investor names" }, "crunchbaseUrl": { "type": [ "string", "null" ], "description": "URL to the funding round page on Crunchbase, when available" } }, "required": [ "type", "investors" ] } ], "additionalProperties": true }, { "allOf": [ { "type": "object", "properties": { "jobId": { "type": "string", "description": "LinkedIn job ID" }, "title": { "type": "string", "description": "Job title" }, "jobUrl": { "type": [ "string", "null" ], "description": "URL to the job posting" }, "location": { "type": [ "string", "null" ], "description": "Job location" }, "locationType": { "type": [ "string", "null" ], "enum": [ "remote", "on_site", "hybrid", null ], "description": "Location type" }, "seniorityLevel": { "type": [ "string", "null" ], "description": "Seniority level" }, "jobFunction": { "type": [ "string", "null" ], "description": "Department or function" }, "jobFunctions": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "All job functions this posting belongs to" }, "postedAt": { "type": [ "string", "null" ], "description": "ISO date when posted" }, "status": { "type": "string", "enum": [ "active", "closed" ], "description": "Job posting status" } }, "required": [ "jobId", "title", "status" ] } ], "additionalProperties": true }, { "allOf": [ { "type": "object", "properties": { "url": { "type": "string", "description": "Article URL" }, "title": { "type": "string", "description": "Article title" }, "publishedAt": { "type": [ "string", "null" ], "description": "ISO date published" }, "publisherName": { "type": [ "string", "null" ], "description": "Publisher name" }, "summary": { "type": [ "string", "null" ], "description": "Article summary" }, "sentiment": { "type": [ "string", "null" ], "enum": [ "positive", "negative", "neutral", null ], "description": "Sentiment of the article. Null if not classified." } }, "required": [ "url", "title" ] } ], "additionalProperties": true }, { "allOf": [ { "type": "object", "properties": { "postId": { "type": "string", "description": "LinkedIn post ID" }, "postUrl": { "type": [ "string", "null" ], "description": "URL to the post" }, "caption": { "type": [ "string", "null" ], "description": "Post content" }, "postedAt": { "type": [ "string", "null" ], "description": "ISO date when posted" }, "numReactions": { "type": [ "number", "null" ], "description": "Number of reactions" }, "numComments": { "type": [ "number", "null" ], "description": "Number of comments" }, "numShares": { "type": [ "number", "null" ], "description": "Number of shares" }, "posterName": { "type": [ "string", "null" ], "description": "Display name of the person who posted" }, "posterSlug": { "type": [ "string", "null" ], "description": "LinkedIn slug of the poster (e.g. 'williamhgates')" }, "posterUrl": { "type": [ "string", "null" ], "description": "Full LinkedIn profile URL of the poster" }, "posterProfilePicture": { "type": [ "string", "null" ], "description": "Profile picture URL of the poster" } }, "required": [ "postId" ] } ], "additionalProperties": true }, { "allOf": [ { "allOf": [ { "type": "object", "properties": { "linkedinCompanyId": { "type": [ "string", "null" ], "description": "LinkedIn company ID" }, "companyName": { "type": [ "string", "null" ], "description": "Company name" }, "companyLinkedinUrl": { "type": [ "string", "null" ], "description": "Company LinkedIn URL" }, "linkedinCompanySlug": { "type": [ "string", "null" ], "description": "LinkedIn company vanity slug" }, "companyDomains": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Known company domains" }, "title": { "type": [ "string", "null" ], "description": "Job title" }, "isCurrent": { "type": "boolean", "description": "Whether this is a current position" }, "startDate": { "type": [ "string", "null" ], "description": "ISO start date" }, "endDate": { "type": [ "string", "null" ], "description": "ISO end date" }, "location": { "type": [ "string", "null" ], "description": "Position location" }, "employmentType": { "type": [ "string", "null" ], "description": "Employment type" }, "seniority": { "type": [ "string", "null" ], "description": "Seniority level" } }, "required": [ "isCurrent" ] } ], "properties": { "previousTitle": { "type": [ "string", "null" ], "description": "Title before the promotion" }, "previousCompany": { "type": [ "string", "null" ], "description": "Company name before the promotion" } } } ], "additionalProperties": true }, { "allOf": [ { "allOf": [ { "type": "object", "properties": { "linkedinCompanyId": { "type": [ "string", "null" ], "description": "LinkedIn company ID" }, "companyName": { "type": [ "string", "null" ], "description": "Company name" }, "companyLinkedinUrl": { "type": [ "string", "null" ], "description": "Company LinkedIn URL" }, "linkedinCompanySlug": { "type": [ "string", "null" ], "description": "LinkedIn company vanity slug" }, "companyDomains": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Known company domains" }, "title": { "type": [ "string", "null" ], "description": "Job title" }, "isCurrent": { "type": "boolean", "description": "Whether this is a current position" }, "startDate": { "type": [ "string", "null" ], "description": "ISO start date" }, "endDate": { "type": [ "string", "null" ], "description": "ISO end date" }, "location": { "type": [ "string", "null" ], "description": "Position location" }, "employmentType": { "type": [ "string", "null" ], "description": "Employment type" }, "seniority": { "type": [ "string", "null" ], "description": "Seniority level" } }, "required": [ "isCurrent" ] } ], "properties": { "previousTitle": { "type": [ "string", "null" ], "description": "Title before the demotion" }, "previousCompany": { "type": [ "string", "null" ], "description": "Company name before the demotion" } } } ], "additionalProperties": true }, { "allOf": [ { "allOf": [ { "allOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "numeric" }, "previous": { "type": [ "number", "null" ], "description": "Previous tenure in months" }, "current": { "type": [ "number", "null" ], "description": "Current tenure in months" }, "direction": { "type": "string", "enum": [ "increased", "decreased" ], "description": "Direction of change" }, "absoluteChange": { "type": "number", "description": "Absolute change in months" }, "percentChange": { "type": [ "number", "null" ], "description": "Percent change, null if previous was zero or null" } }, "required": [ "kind", "direction", "absoluteChange" ] } ], "properties": { "companyName": { "type": [ "string", "null" ], "description": "Name of the company where tenure was reached" }, "linkedinCompanyId": { "type": [ "string", "null" ], "description": "LinkedIn company identifier" } } } ], "properties": { "title": { "type": [ "string", "null" ], "description": "Job title of the role where tenure was reached" } } } ], "additionalProperties": true }, { "allOf": [ { "allOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "numeric" }, "previous": { "type": [ "number", "null" ], "description": "Previous tenure in months" }, "current": { "type": [ "number", "null" ], "description": "Current tenure in months" }, "direction": { "type": "string", "enum": [ "increased", "decreased" ], "description": "Direction of change" }, "absoluteChange": { "type": "number", "description": "Absolute change in months" }, "percentChange": { "type": [ "number", "null" ], "description": "Percent change, null if previous was zero or null" } }, "required": [ "kind", "direction", "absoluteChange" ] } ], "properties": { "companyName": { "type": [ "string", "null" ], "description": "Name of the company where tenure was reached" }, "linkedinCompanyId": { "type": [ "string", "null" ], "description": "LinkedIn company identifier" } } } ], "additionalProperties": true }, { "allOf": [ { "type": "object", "properties": { "date": { "type": [ "string", "null" ], "description": "ISO date of the layoff event" }, "numLaidOff": { "type": [ "number", "null" ], "description": "Number of employees laid off" }, "percentLaidOff": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100, "description": "Percentage of workforce laid off" }, "source": { "type": [ "string", "null" ], "description": "Source URL for the layoff report" } } } ], "additionalProperties": true }, { "allOf": [ { "type": "object", "properties": { "userId": { "type": "string", "description": "LinkedIn user ID" }, "name": { "type": [ "string", "null" ], "description": "Employee name" }, "title": { "type": [ "string", "null" ], "description": "Job title" }, "startDate": { "type": [ "string", "null" ], "description": "ISO date when the employee started at this company" }, "primarySlug": { "type": [ "string", "null" ], "description": "LinkedIn profile slug" }, "linkedinUrl": { "type": [ "string", "null" ], "description": "Full LinkedIn profile URL" } }, "required": [ "userId" ] } ], "additionalProperties": true }, { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "Investor name" }, "type": { "type": "array", "items": { "type": "string" }, "description": "Investor types" }, "linkedinSlug": { "type": [ "string", "null" ], "description": "Investor LinkedIn profile slug" }, "investorLinkedinUrl": { "type": [ "string", "null" ], "description": "Full LinkedIn URL for the investor." }, "crunchbaseUrl": { "type": [ "string", "null" ], "description": "Reference URL" } }, "required": [ "name", "type" ] } ], "additionalProperties": true }, { "allOf": [ { "type": "object", "properties": { "acquireeName": { "type": "string", "description": "Name of the acquired company" }, "acquireeUuid": { "type": [ "string", "null" ], "description": "Unique identifier" }, "acquireeUrl": { "type": [ "string", "null" ], "description": "Reference URL" }, "priceUsd": { "type": [ "number", "null" ], "description": "Acquisition price in USD" }, "acquisitionDate": { "type": [ "string", "null" ], "description": "ISO date of acquisition" } }, "required": [ "acquireeName" ] } ], "additionalProperties": true }, { "allOf": [ { "type": "object", "properties": { "title": { "type": "string", "description": "Certification title" }, "company": { "type": [ "string", "null" ], "description": "Issuing organization" }, "credentialId": { "type": [ "string", "null" ], "description": "Credential ID" }, "issueDate": { "type": [ "string", "null" ], "description": "ISO issue date" } }, "required": [ "title" ] } ], "additionalProperties": true }, { "allOf": [ { "type": "object", "properties": { "department": { "type": "string", "description": "Department name" }, "count": { "type": "number", "description": "Current employee count" } }, "required": [ "department", "count" ] } ], "additionalProperties": true }, { "allOf": [ { "type": "object", "properties": { "reactionId": { "type": "string", "description": "Unique reaction identifier (dedup key)" }, "type": { "type": [ "string", "null" ], "description": "Reaction type (LIKE, LOVE, INSIGHTFUL, CELEBRATE, SUPPORT, FUNNY)" }, "postContent": { "type": [ "string", "null" ], "description": "Content of the reacted post" }, "postUrl": { "type": [ "string", "null" ], "description": "URL to the LinkedIn post" }, "postAuthorName": { "type": [ "string", "null" ], "description": "Name of the post author" }, "reactedAgo": { "type": [ "string", "null" ], "description": "Relative time since the reaction" }, "reactedAt": { "type": [ "string", "null" ], "description": "Exact ISO timestamp when the reaction occurred" } }, "required": [ "reactionId" ] } ], "additionalProperties": true }, { "allOf": [ { "type": "object", "properties": { "commentId": { "type": "string", "description": "Unique comment identifier (dedup key)" }, "content": { "type": [ "string", "null" ], "description": "Content of the comment" }, "postContent": { "type": [ "string", "null" ], "description": "Content of the original post" }, "postUrl": { "type": [ "string", "null" ], "description": "URL to the LinkedIn post" }, "postAuthorName": { "type": [ "string", "null" ], "description": "Name of the post author" }, "commentedAgo": { "type": [ "string", "null" ], "description": "Relative time since the comment" }, "commentedAt": { "type": [ "string", "null" ], "description": "Exact ISO timestamp when the comment was made" } }, "required": [ "commentId" ] } ], "additionalProperties": true }, { "allOf": [ { "type": "object", "properties": { "listId": { "type": "string", "minLength": 1, "description": "ID of the dynamic tracker list the entity left" }, "listName": { "type": "string", "minLength": 1, "description": "Name of the dynamic tracker list the entity left" }, … _truncated to 65536 chars for ai-docs._ ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # listWebhookEndpoints `GET /v1/webhooks/endpoints` **Tags:** `Webhooks` List webhook endpoints **Endpoint:** `https://api.fiber.ai/v1/webhooks/endpoints` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "endpoints": { "type": "array", "items": { "type": "object", "properties": { "endpointId": { "type": "string", "description": "The unique ID of this webhook endpoint." }, "url": { "type": "string", "description": "The HTTPS URL that receives event payloads." }, "eventTypes": { "type": "array", "items": { "type": "string" }, "description": "The event types this endpoint is subscribed to. An empty array means the endpoint receives every event type; endpoints created through this API are always subscribed to one or more specific event types." }, "description": { "type": [ "string", "null" ], "description": "An optional human-readable label for this endpoint." }, "disabled": { "type": "boolean", "description": "Whether delivery to this endpoint is currently paused." }, "createdAt": { "type": "string", "description": "When the endpoint was created (ISO 8601)." }, "updatedAt": { "type": "string", "description": "When the endpoint was last updated (ISO 8601)." } }, "required": [ "endpointId", "url", "eventTypes", "disabled", "createdAt", "updatedAt" ] }, "description": "Your configured webhook endpoints." } }, "required": [ "endpoints" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # listWebhookEventTypes `GET /v1/webhooks/event-types` **Tags:** `Webhooks` List webhook event types **Endpoint:** `https://api.fiber.ai/v1/webhooks/event-types` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "eventTypes": { "type": "array", "items": { "type": "object", "properties": { "eventType": { "type": "string", "description": "The event type identifier you subscribe to." }, "description": { "type": "string", "description": "What this event represents and when it fires." }, "group": { "type": "string", "description": "The category this event belongs to." }, "examplePayload": { "type": "object", "additionalProperties": {}, "description": "An example payload delivered for this event type." } }, "required": [ "eventType", "description", "group", "examplePayload" ] }, "description": "All event types you can subscribe a webhook endpoint to." } }, "required": [ "eventTypes" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # liteContactReveal `POST /v1/contact-details/lite` **Tags:** `Contact details` Reveal contact details (lite) **Endpoint:** `https://api.fiber.ai/v1/contact-details/lite` ## Description Low-cost contact reveal path that searches for emails and phone numbers. Compared with other contact reveal endpoints, this endpoint is priced lower but has lower yield (it may miss contacts that other endpoints can find). ⚡ Rate limit: 500 requests per 1 minute 💰 Cost: 1 credit per lite email reveal + 2 credits per lite phone reveal ⓘ ⏱ Recommended timeout: 2 minutes ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "input": { "oneOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "linkedin" ] }, "linkedinIdentifier": { "type": "string", "minLength": 1, "description": "LinkedIn profile identifier — a full URL, bare slug, or URN (e.g. 'williamhgates', 'https://www.linkedin.com/in/williamhgates')." }, "fullName": { "type": [ "string", "null" ], "minLength": 1, "description": "Full name of the person. Optional — improves match accuracy." } }, "required": [ "mode", "linkedinIdentifier" ] }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "name-domain" ] }, "fullName": { "type": "string", "minLength": 1, "description": "Full name of the person." }, "companyDomain": { "type": "string", "minLength": 1, "description": "Company domain (e.g. 'gatesfoundation.org')." } }, "required": [ "mode", "fullName", "companyDomain" ] } ], "description": "Person lookup parameters. Use mode 'linkedin' or 'name-domain'." }, "enrichmentType": { "type": "object", "properties": { "getWorkEmails": { "type": "boolean", "default": true }, "getPersonalEmails": { "type": "boolean", "default": false }, "getPhoneNumbers": { "type": "boolean", "default": false } }, "description": "Which email and phone types to look for.", "default": { "getWorkEmails": true, "getPersonalEmails": false, "getPhoneNumbers": false } }, "patience": { "type": [ "string", "null" ], "enum": [ "MINIMUM", "LOW", "MEDIUM", "HIGH", "EXTREME", "MAXIMUM", null ], "description": "How long to wait for email deliverability validation after a contact is found. Higher patience increases average response time but improves deliverability accuracy. MINIMUM is the least thorough bounce-detection option." } }, "required": [ "apiKey", "input" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "profile": { "type": "object", "properties": { "emails": { "type": "array", "items": { "type": "object", "properties": { "emailAddress": { "type": [ "string", "null" ], "minLength": 1, "description": "Email address for the person." }, "type": { "type": [ "string", "null" ], "enum": [ "work", "personal", null ], "description": "Classification of the email address." }, "validationStatus": { "type": [ "string", "null" ], "enum": [ "valid", "risky", "unknown", "invalid", null ], "description": "Email verification result." }, "deliverabilityScore": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100, "description": "Confidence score ranking deliverability for this email. Higher values indicate higher likelihood of delivery." }, "isCatchAll": { "type": [ "boolean", "null" ], "description": "Whether the domain accepts email to any address (catch-all). Catch-all domains make individual address verification unreliable — the address may appear valid but not actually be monitored." } } }, "default": [], "description": "All emails found for this profile, ordered by priority." }, "phoneNumbers": { "type": "array", "items": { "type": "object", "properties": { "phoneNumber": { "type": [ "string", "null" ], "minLength": 1, "description": "Phone number for the person." }, "type": { "type": [ "string", "null" ], "enum": [ "mobile", "other", "unknown", null ], "description": "Classification of the phone number." } } }, "default": [], "description": "All phone numbers found for this profile." } }, "required": [ "emails", "phoneNumbers" ] } }, "required": [ "profile" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # liteReverseEmailLookup `POST /v1/email-to-person/single/lite` **Tags:** `Reverse lookup` Find person by email (lite, high-volume) **Endpoint:** `https://api.fiber.ai/v1/email-to-person/single/lite` ## Description 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. ⚡ Rate limit: 3000 requests per 1 minute 💰 Cost: 1 credit per email lookup (lite) ⓘ ⏱ Recommended timeout: 30 seconds ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "email": { "type": "string", "format": "email", "minLength": 1, "description": "The email address of a person whose LinkedIn profile you want to find." } }, "required": [ "apiKey", "email" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "articles": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "date_published": { "type": [ "string", "null" ] } } } }, "certifications": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "credential_id": { "type": [ "string", "null" ] }, "verify_url": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "date": { "type": [ "string", "null" ] } } } }, "connection_count": { "type": [ "number", "null" ] }, "courses": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "course_number": { "type": [ "string", "null" ] }, "association": { "type": "null" } } } }, "dob": { "type": [ "string", "null" ] }, "education": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "school_id": { "type": [ "string", "null" ] }, "school_name": { "type": [ "string", "null" ] }, "field_of_study_id": { "type": [ "string", "null" ] }, "field_of_study_name": { "type": [ "string", "null" ] }, "degree": { "type": [ "string", "null" ] }, "grade": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "activities": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } } } }, "experiences": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } } }, "first_name": { "type": [ "string", "null" ] }, "follower_count": { "type": [ "number", "null" ] }, "headline": { "type": [ "string", "null" ] }, "inferred_location": { "type": [ "object", "null" ], "properties": { "street_address": { "type": [ "string", "null" ] }, "neighborhood": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "state_name": { "type": [ "string", "null" ] }, "state_code": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] }, "country_code": { "type": [ "string", "null" ] }, "country_name": { "type": [ "string", "null" ] }, "coordinates": { "type": [ "object", "null" ], "properties": { "lat": { "type": "number" }, "lon": { "type": "number" } }, "required": [ "lat", "lon" ] }, "timezone": { "type": [ "string", "null" ] }, "full_address": { "type": [ "string", "null" ] }, "formatted_address": { "type": [ "string", "null" ] } } }, "interests": { "type": [ "array", "null" ], "items": { "type": "string" } }, "last_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "patents": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "number": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "date": { "type": [ "string", "null" ] } } } }, "profile_pic": { "type": [ "string", "null" ] }, "projects": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "project_id": { "type": [ "string", "null" ] }, "project_title": { "type": [ "string", "null" ] }, "project_url": { "type": [ "string", "null" ] }, "project_summary": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] } } } }, "publications": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "collaborators": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } } } }, "date": { "type": [ "string", "null" ] }, "id": { "type": [ "string", "null" ] }, "publisher": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } } } }, "skills": { "type": [ "array", "null" ], "items": { "type": "string" } }, "primary_slug": { "type": "string" }, "slugs": { "type": [ "array", "null" ], "items": { "type": "string" } }, "summary": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "user_id": { "type": [ "string", "null" ] }, "volunteering": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "role": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "cause": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] } } } }, "tenures": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "date_range": { "type": "object", "properties": { "gte": { "type": [ "string", "null" ] }, "lte": { "type": [ "string", "null" ] } } }, "range_length_days": { "type": [ "number", "null" ] }, "titles": { "type": "array", "items": { "type": "string" } }, "localities": { "type": "array", "items": { "type": "string" } } }, "required": [ "date_range", "titles", "localities" ] } }, "career_began_at": { "type": [ "string", "null" ] }, "tags": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "student", "attended-top-us-university", "attended-top-global-university", "second-time-founder", "deep-technical-background", "major-tech-company-experience", "fortune-500-executive", "recently-changed-companies", "recently-promoted", "decision-maker", "c-suite", "experienced-executive", "phd", "influencer", "board-member" ] } }, "entity_urn": { "type": [ "string", "null" ] }, "open_to_work": { "type": [ "boolean", "null" ] }, "premium": { "type": [ "boolean", "null" ] }, "influencer": { "type": [ "boolean", "null" ] }, "organizations": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] } } } }, "entity_urns": { "type": [ "array", "null" ], "items": { "type": "string" } }, "is_hiring": { "type": [ "boolean", "null" ] }, "websites": { "type": [ "array", "null" ], "items": { "type": "string" } }, "is_verified": { "type": [ "boolean", "null" ] }, "verifications": { "type": [ "object", "null" ], "properties": { "is_verified": { "type": [ "boolean", "null" ] }, "joined_date": { "type": [ "string", "null" ] }, "verification_types": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "subtitle": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] } } } } } }, "is_top_voice": { "type": [ "boolean", "null" ] }, "current_job": { "type": [ "object", "null" ], "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } }, "custom_data": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "relevance_score": { "type": [ "number", "null" ] }, "last_sort_key": { "type": [ "string", "null" ] }, "industry_name": { "type": [ "string", "null" ] }, "last_updated_at": { "type": [ "string", "null" ] }, "languages": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "proficiency_id": { "type": [ "string", "null" ] }, "proficiency_name": { "type": [ "string", "null" ] } } } }, "detailed_education": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "school_details": { "type": [ "object", "null" ], "properties": { "linkedin_ids": { "type": [ "array", "null" ], "items": { "type": "string" } }, "li_org_id": { "type": [ "string", "null" ] }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "preferred_name": { "type": [ "string", "null" ] } } }, "school_id": { "type": [ "string", "null" ] }, "school_name": { "type": [ "string", "null" ] }, "field_of_study_id": { "type": [ "string", "null" ] }, "field_of_study_name": { "type": [ "string", "null" ] }, "degree": { "type": [ "string", "null" ] }, "grade": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "activities": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } } } }, "detailed_work_experiences": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "company_details": { "type": [ "object", "null" ], "properties": { "linkedin_ids": { "type": [ "array", "null" ], "items": { "type": "string" } }, "li_org_id": { "type": [ "string", "null" ] }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "preferred_name": { "type": [ "string", "null" ] }, "crunchbase_slug": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "standard_industries": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "li_industries": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } } } }, "required": [ "primary_slug" ] }, "description": "LinkedIn profiles matching this email, ordered by best match. Usually contains one result.", "default": [] }, "rejection": { "type": [ "object", "null" ], "properties": { "reason": { "type": "string", "enum": [ "disposable_or_anonymous_email", "invalid_tld", "autogenerated_icloud_email", "digits_only_username", "role_based_mailbox", "junk_username", "spam_domain", "bot_farm_email", "mailing_list" ], "description": "Machine-readable rejection reason" }, "message": { "type": "string", "description": "Human-readable explanation" } }, "required": [ "reason", "message" ], "description": "Present when the email is unresolvable (e.g. disposable, anonymous relay, or role-based address). The request succeeded but there is no person to find." } }, "required": [ "data" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # locationTypeahead `POST /v1/typeahead/location` **Tags:** `Typeaheads` Location typeahead **Endpoint:** `https://api.fiber.ai/v1/typeahead/location` ## Description Get the latitude/longitude of a given city, including prefixes (e.g. 'san fr'). This makes it good for typeaheads in your UI. ⚡ Rate limit: 240 requests per 1 minute 💰 Cost: 1 credit per request ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "query": { "type": "string", "minLength": 1, "maxLength": 100, "description": "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." } }, "required": [ "apiKey", "query" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] }, "latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "longitude": { "type": "number", "minimum": -180, "maximum": 180 } }, "required": [ "latitude", "longitude" ] } }, "presetRegions": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "circle" ] }, "slug": { "type": "string", "enum": [ "sf-bay-area", "sf-north-bay", "sf-east-bay", "sf-south-bay", "sf-peninsula", "greater-new-york", "chicagoland", "washington-dmv", "greater-los-angeles", "inland-empire", "greater-philadelphia", "boston-route-128", "greater-austin", "toronto-golden-horseshoe", "greater-london", "greater-tokyo", "research-triangle", "seattle-puget-sound", "dallas-fort-worth", "miami-south-florida", "slc-silicon-slopes", "denver-front-range" ] }, "name": { "type": "string" }, "emoji": { "type": "string" }, "countryCode": { "type": "string", "minLength": 3, "maxLength": 3 }, "cities": { "type": "array", "items": { "type": "string" }, "maxItems": 5 }, "synonyms": { "type": "array", "items": { "type": "string" } }, "latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "longitude": { "type": "number", "minimum": -180, "maximum": 180 }, "radiusMiles": { "type": "number", "minimum": 0, "maximum": 12500 } }, "required": [ "type", "slug", "name", "emoji", "countryCode", "cities", "synonyms", "latitude", "longitude", "radiusMiles" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "polygon" ] }, "slug": { "type": "string", "enum": [ "sf-bay-area", "sf-north-bay", "sf-east-bay", "sf-south-bay", "sf-peninsula", "greater-new-york", "chicagoland", "washington-dmv", "greater-los-angeles", "inland-empire", "greater-philadelphia", "boston-route-128", "greater-austin", "toronto-golden-horseshoe", "greater-london", "greater-tokyo", "research-triangle", "seattle-puget-sound", "dallas-fort-worth", "miami-south-florida", "slc-silicon-slopes", "denver-front-range" ] }, "name": { "type": "string" }, "emoji": { "type": "string" }, "countryCode": { "type": "string", "minLength": 3, "maxLength": 3 }, "cities": { "type": "array", "items": { "type": "string" }, "maxItems": 5 }, "synonyms": { "type": "array", "items": { "type": "string" } }, "vertices": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "longitude": { "type": "number", "minimum": -180, "maximum": 180 } }, "required": [ "latitude", "longitude" ] }, "minItems": 4, "maxItems": 1000 } }, "required": [ "type", "slug", "name", "emoji", "countryCode", "cities", "synonyms", "vertices" ] } ] }, "description": "Preset metro area regions matching the query. Each includes a slug usable with the preset-region strategy in location-based search endpoints, plus geometry and major cities for display." } }, "required": [ "data", "presetRegions" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # manuallySpawnSavedSearchRun `POST /v1/saved-search/spawn` **Tags:** `Saved search` Manually spawn saved search run **Endpoint:** `https://api.fiber.ai/v1/saved-search/spawn` ## Description Manually spawn a new saved search run ⚡ Rate limit: 10 requests per 1 minute 💰 Cost: 2 credits per prospect/company found in search ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "savedSearchId": { "type": "string", "description": "The ID of the saved search" } }, "required": [ "apiKey", "savedSearchId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the saved search run" }, "startedAt": { "type": "string", "description": "The date and time the saved search run started" } }, "required": [ "id", "startedAt" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # multiSourceSearch `POST /v1/multi-source/search` **Tags:** `Agentic search` Multi-source AI search **Endpoint:** `https://api.fiber.ai/v1/multi-source/search` ## Description 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. **Pagination flow:** 1. **First page** — send `{ search: { request: "initial", query: "...", pageSize: 10 } }`. The `pageSize` you choose here is locked for the entire session. 2. **Subsequent pages** — send `{ search: { request: "subsequent", cursor: "" } }`. 3. When `nextCursor` is `null` in the response, there are no more results. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: Credits are charged after the search completes based on results: 2 credits per company found and 2 credits per prospect found. Each query resolves to either companies or prospects, so only one rate applies per page. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "search": { "oneOf": [ { "type": "object", "properties": { "request": { "type": "string", "description": "Use \"initial\" for the first page of a new search. Provide query, pageSize, and any filters.", "enum": [ "initial" ] }, "query": { "type": "string", "maxLength": 2000, "description": "Natural language search query, e.g. \"pizza shops in NYC\" or \"Series A SaaS founders in London\". The API infers whether to return companies or people." }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 10, "description": "Number of results per page (default 10, max 1000). This value is locked for the entire pagination session." }, "companyFilters": { "type": [ "object", "null" ], "properties": { "country_codes": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 3, "maxLength": 3 }, "description": "ISO 3166-1 alpha-3 country codes (e.g. USA, GBR)." }, "min_relevance": { "type": [ "number", "null" ], "minimum": 0, "maximum": 1, "description": "Minimum relevance score (0.0–1.0). Higher values mean a closer match to your query." }, "funding_stages": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "no_funding_yet", "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "series_i", "series_j", "venture_other", "private_equity" ] }, "description": "Last funding round stage filter. Acquired, public, closed, and unknown stages are not supported." }, "employee_growth": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "high", "growing", "stable", "declining" ] }, "description": "Year-over-year employee growth trend. Elements are OR-ed together." }, "website_traffic": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "<1K", "1K-10K", "10K-100K", "100K-1M", "1M+", "unknown" ] }, "description": "Monthly website traffic bucket filter. Elements are OR-ed together." }, "employee_count": { "type": [ "object", "null" ], "properties": { "min": { "type": [ "integer", "null" ], "minimum": 0 }, "max": { "type": [ "integer", "null" ], "minimum": 0 } }, "description": "Filter by number of employees (inclusive range)." }, "founded_year": { "type": [ "object", "null" ], "properties": { "min": { "type": [ "integer", "null" ], "minimum": 0 }, "max": { "type": [ "integer", "null" ], "minimum": 0 } }, "description": "Filter by company founding year (inclusive range)." }, "revenue": { "type": [ "object", "null" ], "properties": { "min": { "type": [ "number", "null" ], "minimum": 0 }, "max": { "type": [ "number", "null" ], "minimum": 0 } }, "description": "Annual revenue in USD (inclusive range)." }, "is_b2b": { "type": [ "boolean", "null" ], "description": "If `true`, include only B2B companies. If `false`, exclude B2B companies." }, "is_tech": { "type": [ "boolean", "null" ], "description": "If `true`, include only tech companies. If `false`, exclude tech companies." }, "is_saas": { "type": [ "boolean", "null" ], "description": "If `true`, include only SaaS companies. If `false`, exclude SaaS companies." }, "is_startup": { "type": [ "boolean", "null" ], "description": "If `true`, include only startup-stage companies. If `false`, exclude startups." }, "website_traffic_growth": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "high", "growing", "stable", "declining", "unknown" ] }, "description": "Year-over-year website traffic growth trend. Elements are OR-ed together." }, "has_linkedin_page": { "type": [ "boolean", "null" ], "description": "If `true`, include only companies with a LinkedIn page. If `false`, exclude them." }, "has_employees_on_linkedin": { "type": [ "boolean", "null" ], "description": "If `true`, include only companies that have employees listed on LinkedIn. If `false`, exclude them." }, "has_public_emails": { "type": [ "boolean", "null" ], "description": "If `true`, include only companies with public contact emails. If `false`, exclude them." }, "has_company_phone": { "type": [ "boolean", "null" ], "description": "If `true`, include only companies with a phone number. If `false`, exclude them." }, "hiring_is": { "type": [ "boolean", "null" ], "description": "If `true`, include only companies that are currently hiring. If `false`, exclude them." }, "is_ai": { "type": [ "boolean", "null" ], "description": "If `true`, include only AI-related companies. If `false`, exclude them." } }, "description": "Optional filters applied on top of the AI-derived company filters (e.g. country, funding stage, employee count, etc)." }, "peopleFilters": { "type": [ "object", "null" ], "properties": { "country_codes": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 3, "maxLength": 3 }, "description": "ISO 3166-1 alpha-3 country codes (e.g. USA, GBR)." }, "min_relevance": { "type": [ "number", "null" ], "minimum": 0, "maximum": 1, "description": "Minimum relevance score (0.0–1.0). Higher values mean a closer job-title match." }, "job_titles": { "type": [ "object", "null" ], "properties": { "include": { "type": [ "array", "null" ], "items": { "type": "string" }, "minItems": 1, "maxItems": 20, "description": "Job titles to search for. Abbreviations are supported (e.g. 'CTO'). Elements are OR-ed together." }, "exclude": { "type": [ "array", "null" ], "items": { "type": "string" }, "minItems": 1, "description": "Job title keywords to exclude from results." } } }, "max_people_per_company": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 1000, "description": "Maximum number of people to return per matched company." }, "company_linkedin_ids": { "type": [ "array", "null" ], "items": { "type": "string", "pattern": "^\\d+$" }, "description": "Restrict results to people from these companies. Provide the numeric LinkedIn company IDs returned by Fiber's company search endpoints." } }, "description": "Optional filters applied on top of the AI-derived people filters (e.g. job titles, country, max people per company). Only used when the query resolves to a people search." } }, "required": [ "request", "query" ] }, { "type": "object", "properties": { "request": { "type": "string", "description": "Use \"subsequent\" for page 2 and beyond. Only the cursor from the previous response is required; all other parameters are stored server-side.", "enum": [ "subsequent" ] }, "cursor": { "type": "string", "description": "The `nextCursor` value returned by the previous response. Valid for 3 days." } }, "required": [ "request", "cursor" ] } ] } }, "required": [ "apiKey", "search" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "data": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "companies" ] }, "results": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ], "description": "Company name" }, "domain": { "type": [ "string", "null" ], "description": "Company domain" }, "websiteUrl": { "type": [ "string", "null" ], "description": "Company website URL" }, "linkedinUrl": { "type": [ "string", "null" ], "description": "LinkedIn company page URL using the numeric company ID (e.g. https://linkedin.com/company/1234). Null if unavailable." }, "industry": { "type": [ "string", "null" ], "description": "Primary industry. The value comes from the data provider and may vary in format." }, "employeeCount": { "type": [ "integer", "null" ], "description": "Estimated employee count" }, "city": { "type": [ "string", "null" ], "description": "Company city" }, "countryCode": { "type": [ "string", "null" ], "description": "Company country (ISO alpha-3 code, e.g. USA)" }, "foundedYear": { "type": [ "integer", "null" ], "description": "Year the company was founded" }, "description": { "type": [ "string", "null" ], "description": "Company description" } } }, "description": "Matched companies" } }, "required": [ "type", "results" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "prospects" ] }, "results": { "type": "array", "items": { "type": "object", "properties": { "firstName": { "type": [ "string", "null" ], "description": "First name" }, "lastName": { "type": [ "string", "null" ], "description": "Last name" }, "jobTitle": { "type": [ "string", "null" ], "description": "Job title" }, "headline": { "type": [ "string", "null" ], "description": "LinkedIn headline" }, "linkedinUrl": { "type": [ "string", "null" ], "description": "LinkedIn profile URL" }, "countryCode": { "type": [ "string", "null" ], "description": "Person's country (ISO alpha-3 code, e.g. USA)" }, "companyName": { "type": [ "string", "null" ], "description": "The person's current company name" }, "companyDomain": { "type": [ "string", "null" ], "description": "The person's current company domain" }, "companyLinkedinUrl": { "type": [ "string", "null" ], "description": "The person's current company LinkedIn URL" }, "companyCity": { "type": [ "string", "null" ], "description": "The person's current company city" }, "companyCountryCode": { "type": [ "string", "null" ], "description": "The person's current company headquarters country (ISO alpha-3 code, e.g. USA)" } } }, "description": "Matched prospects with company info" } }, "required": [ "type", "results" ] } ], "description": "Search results — either companies or prospects, never both" }, "message": { "type": "string" }, "nextCursor": { "type": [ "string", "null" ], "description": "Cursor for the next page. Pass this as `cursor` in a `{ request: \"subsequent\", cursor: \"...\" }` request. `null` means there are no more results. Cursors expire after 3 days." } }, "required": [ "data", "message" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # nlpSearchParse `POST /v1/nlp-search/parse` **Tags:** `Agentic search` Parse natural language to search params **Endpoint:** `https://api.fiber.ai/v1/nlp-search/parse` ## Description Parses a natural language query into structured search parameters without executing the search. Use the returned `suggestedAction` to determine your next step: - `combinedSearch`: pass `parsedParams.companySearchParams` and `parsedParams.profileSearchParams` to POST /v1/combined-search/paginated - `companySearch`: pass `parsedParams.companySearchParams` to POST /v1/company-search - `profileSearch`: pass `parsedParams.profileSearchParams` to POST /v1/combined-search/paginated (with only profileConfig) - `personLookup`: use the `parsedParams.persons` array with POST /v1/person-lookup/enrich (one call per person) - `companyLookup`: use the `parsedParams.companies` array with POST /v1/company-lookup/enrich (one call per company) - `none`: query could not be interpreted Alternatively, use POST /v1/nlp-search/run to parse and execute in a single call. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: 2 credits per request ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "query": { "type": "string", "minLength": 1, "maxLength": 5000, "description": "Natural language search query to parse into structured filters." } }, "required": [ "apiKey", "query" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "searchId": { "type": "string", "description": "Unique identifier for this search session. Stable across paginated requests — all pages share the same searchId." }, "parsedParams": { "oneOf": [ { "type": "object", "properties": { "queryType": { "type": "string", "enum": [ "structuredSearch" ] }, "companySearchParams": { "type": [ "object", "null" ], "properties": { "exactCompanyV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "domain": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$" } }, "required": [ "identifier", "domain" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/(www\\.)?linkedin\\.com\\/company\\/[a-zA-Z0-9-]+\\/?.*$" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-org-id" ] }, "org_id": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "identifier", "org_id" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "advanced" ] }, "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string", "minLength": 1 }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "identifier", "li_org_id" ] } ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "domain": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$" } }, "required": [ "identifier", "domain" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/(www\\.)?linkedin\\.com\\/company\\/[a-zA-Z0-9-]+\\/?.*$" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-org-id" ] }, "org_id": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "identifier", "org_id" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "advanced" ] }, "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string", "minLength": 1 }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "identifier", "li_org_id" ] } ] } } } }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "headquartersCountryCode": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } } } }, "headquartersStateName": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string" } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "employeeCountV2": { "type": [ "object", "null" ], "properties": { "lowerBoundExclusive": { "type": [ "integer", "null" ], "minimum": 0 }, "upperBoundInclusive": { "type": [ "integer", "null" ], "minimum": 0 } } }, "keywords": { "type": [ "object", "null" ], "properties": { "containsAll": { "type": [ "array", "null" ], "items": { "type": "string" } }, "containsAny": { "type": [ "array", "null" ], "items": { "type": "string" } }, "containsNone": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "industriesV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "allOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } } } }, "stage": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "acquired", "public", "closed", "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "series_i", "series_j", "venture_other", "private_equity", "unknown", "no_funding_yet" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "acquired", "public", "closed", "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "series_i", "series_j", "venture_other", "private_equity", "unknown", "no_funding_yet" ] } } } }, "totalFundingUSD": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "lastFundingUSD": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "lastFundedOn": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ] }, "foundedOn": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] … _truncated to 65536 chars for ai-docs._ ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # paginatedCombinedSearch `POST /v1/combined-search/paginated` **Tags:** `Search` Combined people + company search **Endpoint:** `https://api.fiber.ai/v1/combined-search/paginated` ## Description Search for companies and profiles together. Returns results page by page using cursor-based pagination. Each entity type (companies, profiles) has its own cursor, so you can paginate them independently. ⚡ Rate limit: 30 requests per 1 minute 💰 Cost: Credits are charged per page based on results: 1 credits per company found and 1 credits per profile found. ⓘ ⏱ Recommended timeout: 1 minute ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "companyConfig": { "type": [ "object", "null" ], "properties": { "searchParams": { "type": "object", "properties": { "exactCompanyV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "domain": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$" } }, "required": [ "identifier", "domain" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/(www\\.)?linkedin\\.com\\/company\\/[a-zA-Z0-9-]+\\/?.*$" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-org-id" ] }, "org_id": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "identifier", "org_id" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "advanced" ] }, "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string", "minLength": 1 }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "identifier", "li_org_id" ] } ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "domain": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$" } }, "required": [ "identifier", "domain" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/(www\\.)?linkedin\\.com\\/company\\/[a-zA-Z0-9-]+\\/?.*$" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-org-id" ] }, "org_id": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "identifier", "org_id" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "advanced" ] }, "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string", "minLength": 1 }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "identifier", "li_org_id" ] } ] } } } }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "headquartersCountryCode": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } } } }, "headquartersStateName": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string" } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "employeeCountV2": { "type": [ "object", "null" ], "properties": { "lowerBoundExclusive": { "type": [ "integer", "null" ], "minimum": 0 }, "upperBoundInclusive": { "type": [ "integer", "null" ], "minimum": 0 } } }, "keywords": { "type": [ "object", "null" ], "properties": { "containsAll": { "type": [ "array", "null" ], "items": { "type": "string" } }, "containsAny": { "type": [ "array", "null" ], "items": { "type": "string" } }, "containsNone": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "industriesV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "allOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } } } }, "stage": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "acquired", "public", "closed", "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "series_i", "series_j", "venture_other", "private_equity", "unknown", "no_funding_yet" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "acquired", "public", "closed", "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "series_i", "series_j", "venture_other", "private_equity", "unknown", "no_funding_yet" ] } } } }, "totalFundingUSD": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "lastFundingUSD": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "lastFundedOn": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ] }, "foundedOn": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ] }, "nameLike": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string" } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "exactCompany": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string" }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "li_org_id" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string" }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "li_org_id" ] } } } }, "acceleratorsV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "acceleratorName": { "type": "string", "enum": [ "a16z_speedrun", "accel_atoms", "ai2_incubator", "alchemist_accelerator", "alliance", "antler", "berkeley_skydeck", "founders_inc", "google_startups", "launch_accelerator", "neo", "pear_x", "plug_and_play", "sosv", "south_park_commons", "startx", "techstars", "the_mint", "ycombinator" ] }, "batchSelection": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "all-batches" ] } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "only-these-batches" ] }, "batches": { "type": "array", "items": { "type": "string" }, "minItems": 0 } }, "required": [ "strategy", "batches" ] }, { "type": "null" } ] }, "years": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } } }, "required": [ "acceleratorName" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "acceleratorName": { "type": "string", "enum": [ "a16z_speedrun", "accel_atoms", "ai2_incubator", "alchemist_accelerator", "alliance", "antler", "berkeley_skydeck", "founders_inc", "google_startups", "launch_accelerator", "neo", "pear_x", "plug_and_play", "sosv", "south_park_commons", "startx", "techstars", "the_mint", "ycombinator" ] }, "batchSelection": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "all-batches" ] } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "only-these-batches" ] }, "batches": { "type": "array", "items": { "type": "string" }, "minItems": 0 } }, "required": [ "strategy", "batches" ] }, { "type": "null" } ] }, "years": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } } }, "required": [ "acceleratorName" ] } } … _truncated to 65536 chars for ai-docs._ ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "companies": { "type": "array", "items": { "type": "object", "properties": { "linkedin_id": { "type": [ "string", "null" ] }, "accelerator_statuses": { "type": [ "array", "null" ], "items": { "type": "string" } }, "accelerators": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "slug": { "type": [ "string", "null" ] }, "tags": { "type": [ "array", "null" ], "items": { "type": "string" } }, "year": { "type": [ "number", "null" ] }, "batch": { "type": [ "string", "null" ] }, "founders": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "full_name": { "type": [ "string", "null" ] }, "bio": { "type": [ "string", "null" ] }, "job_title": { "type": [ "string", "null" ] }, "is_active": { "type": [ "boolean", "null" ] }, "email_address": { "type": [ "string", "null" ] }, "facebook_url": { "type": [ "string", "null" ] }, "twitter_handle": { "type": [ "string", "null" ] }, "linkedin_slug": { "type": [ "string", "null" ] }, "github_username": { "type": [ "string", "null" ] } } } }, "description": { "type": [ "string", "null" ] }, "one_liner": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "company_domain": { "type": [ "string", "null" ] }, "accelerator_name": { "type": [ "string", "null" ] }, "accelerator_domain": { "type": [ "string", "null" ] } } } }, "blog_urls": { "type": [ "array", "null" ], "items": { "type": "string" } }, "custom_data": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "emails": { "type": [ "array", "null" ], "items": { "type": "string" } }, "phone_numbers": { "type": [ "array", "null" ], "items": { "type": "string" } }, "employee_count_consensus": { "type": [ "object", "null" ], "properties": { "gte": { "type": [ "number", "null" ] }, "lte": { "type": [ "number", "null" ] } } }, "facebook_urls": { "type": [ "array", "null" ], "items": { "type": "string" } }, "fortune_rankings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "list": { "type": "string", "enum": [ "fortune-500-usa", "forbes-global-2000" ] }, "year": { "type": "number" }, "rank": { "type": "number" } }, "required": [ "list", "year", "rank" ] } }, "founded_on_consensus": { "type": [ "string", "null" ] }, "github_usernames": { "type": [ "array", "null" ], "items": { "type": "string" } }, "instagram_handles": { "type": [ "array", "null" ], "items": { "type": "string" } }, "latest_funding_consensus": { "type": [ "number", "null" ] }, "linkedin_slugs": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "li_org_id": { "type": [ "string", "null" ] }, "li_category": { "type": [ "string", "null" ], "enum": [ "W", "S", "C", null ] }, "li_job_posts_stats": { "type": [ "object", "null" ], "properties": { "total_count": { "type": "number" }, "seniority_stats": { "type": [ "object", "null" ], "properties": { "Entry level": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Director": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Associate": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Mid-Senior level": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Internship": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Executive": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Not Applicable": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] } }, "additionalProperties": false }, "employment_type_stats": { "type": [ "object", "null" ], "properties": { "Full-time": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Temporary": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Internship": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Contract": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Part-time": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Volunteer": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Other": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] } }, "additionalProperties": false }, "country_location_stats": { "type": [ "object", "null" ], "properties": { "USA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GBR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "FRA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IND": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BRA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "DEU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ESP": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CAN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "AUS": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NLD": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ITA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ZAF": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BEL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CHN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "TUR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MEX": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CHE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NOR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ARE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SWE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "POL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IDN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ARG": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PRT": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "COL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CHL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PAK": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "DNK": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "JPN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NGA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SGP": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PER": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NZL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "AUT": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IRL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MYS": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BGD": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "EGY": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ISR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SAU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PHL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "FIN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IRN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ROU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CZE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GRC": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "HKG": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "HUN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "KEN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MAR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "VNM": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "RUS": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "UKR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ECU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "THA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LKA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "KOR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BGR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GHA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SRB": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "TWN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "HRV": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LTU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PRI": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SVK": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "TUN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "EST": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "VEN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CRI": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PAN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "URY": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LBN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LUX": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CYP": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NPL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "JOR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SVN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MTQ": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "QAT": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GLP": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "UGA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "DZA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GTM": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CMR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LVA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "DOM": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "AZE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GEO": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SEN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "TZA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ZWE": { "type": "object", "properties": { "count": { "type": "number" }, "fr … _truncated to 65536 chars for ai-docs._ ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # peopleSearch `POST /v1/people-search` **Tags:** `Search` People search **Endpoint:** `https://api.fiber.ai/v1/people-search` ## Description Search for people using filters ⚡ Rate limit: 180 requests per 1 minute 💰 Cost: 1 credit per profile found, plus 1 credit when includeCount=true ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "searchParams": { "type": "object", "properties": { "country3LetterCode": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } } } }, "numConnections": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "numFollowers": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "approxAge": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "keywords": { "type": [ "object", "null" ], "properties": { "containsAll": { "type": [ "array", "null" ], "items": { "type": "string" } }, "containsAny": { "type": [ "array", "null" ], "items": { "type": "string" } }, "containsNone": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "keywordsV2": { "type": [ "object", "null" ], "properties": { "operator": { "type": "string", "enum": [ "AND", "OR" ], "default": "AND" }, "clauses": { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "AND", "OR" ], "default": "OR" }, "terms": { "type": "array", "items": { "type": "string" }, "minItems": 1 }, "negate": { "type": "boolean", "default": false } }, "required": [ "terms" ] }, "minItems": 1 }, "options": { "type": [ "object", "null" ], "properties": { "fieldsToSearchOver": { "type": [ "object", "null" ], "properties": { "summary": { "type": "boolean", "default": true }, "headline": { "type": "boolean", "default": true }, "pastJobTitles": { "type": "boolean", "default": true }, "pastJobSummaries": { "type": "boolean", "default": true }, "pastCompanyNames": { "type": "boolean", "default": true }, "currentJobTitles": { "type": "boolean", "default": true }, "currentJobSummaries": { "type": "boolean", "default": true }, "currentCompanyNames": { "type": "boolean", "default": true }, "interests": { "type": "boolean", "default": true }, "skills": { "type": "boolean", "default": true }, "industry": { "type": "boolean", "default": true }, "education": { "type": "boolean", "default": true }, "publications": { "type": "boolean", "default": true }, "certifications": { "type": "boolean", "default": true }, "articles": { "type": "boolean", "default": true }, "courses": { "type": "boolean", "default": true }, "projects": { "type": "boolean", "default": true }, "patents": { "type": "boolean", "default": true }, "volunteering": { "type": "boolean", "default": false }, "languages": { "type": "boolean", "default": false } } } } } }, "required": [ "clauses" ] }, "keywordSearchOptions": { "type": [ "object", "null" ], "properties": { "fieldsToSearchOver": { "type": [ "object", "null" ], "properties": { "summary": { "type": "boolean", "default": true }, "headline": { "type": "boolean", "default": true }, "pastJobTitles": { "type": "boolean", "default": true }, "pastJobSummaries": { "type": "boolean", "default": true }, "pastCompanyNames": { "type": "boolean", "default": true }, "currentJobTitles": { "type": "boolean", "default": true }, "currentJobSummaries": { "type": "boolean", "default": true }, "currentCompanyNames": { "type": "boolean", "default": true }, "interests": { "type": "boolean", "default": true }, "skills": { "type": "boolean", "default": true }, "industry": { "type": "boolean", "default": true }, "education": { "type": "boolean", "default": true }, "publications": { "type": "boolean", "default": true }, "certifications": { "type": "boolean", "default": true }, "articles": { "type": "boolean", "default": true }, "courses": { "type": "boolean", "default": true }, "projects": { "type": "boolean", "default": true }, "patents": { "type": "boolean", "default": true }, "volunteering": { "type": "boolean", "default": false }, "languages": { "type": "boolean", "default": false } } } } }, "jobTitleV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "term" ] }, "term": { "type": "string" } }, "required": [ "type", "term" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "static-groups" ] }, "groups": { "type": "array", "items": { "type": "string", "enum": [ "founder", "c-suite", "board-member" ] } } }, "required": [ "type", "groups" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dynamic-groups" ] }, "groups": { "type": "array", "items": { "type": "string", "enum": [ "vp", "director", "management", "entry-level", "assistant", "intern" ] } }, "keywords": { "type": "array", "items": { "type": "string" }, "default": [] } }, "required": [ "type", "groups" ] } ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "term" ] }, "term": { "type": "string" } }, "required": [ "type", "term" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "static-groups" ] }, "groups": { "type": "array", "items": { "type": "string", "enum": [ "founder", "c-suite", "board-member" ] } } }, "required": [ "type", "groups" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dynamic-groups" ] }, "groups": { "type": "array", "items": { "type": "string", "enum": [ "vp", "director", "management", "entry-level", "assistant", "intern" ] } }, "keywords": { "type": "array", "items": { "type": "string" }, "default": [] } }, "required": [ "type", "groups" ] } ] } }, "allOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "term" ] }, "term": { "type": "string" } }, "required": [ "type", "term" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "static-groups" ] }, "groups": { "type": "array", "items": { "type": "string", "enum": [ "founder", "c-suite", "board-member" ] } } }, "required": [ "type", "groups" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dynamic-groups" ] }, "groups": { "type": "array", "items": { "type": "string", "enum": [ "vp", "director", "management", "entry-level", "assistant", "intern" ] } }, "keywords": { "type": "array", "items": { "type": "string" }, "default": [] } }, "required": [ "type", "groups" ] } ] } } } }, "exactProfile": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "profile_id": { "type": [ "string", "null" ] }, "primary_slug": { "type": [ "string", "null" ] } } } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "profile_id": { "type": [ "string", "null" ] }, "primary_slug": { "type": [ "string", "null" ] } } } } } }, "exactProfileV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-slug" ] }, "linkedin_slug": { "type": "string", "minLength": 1 } }, "required": [ "identifier", "linkedin_slug" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-user-id" ] }, "user_id": { "type": "string", "pattern": "^[0-9]+$", "minLength": 1 } }, "required": [ "identifier", "user_id" ] } ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-slug" ] }, "linkedin_slug": { "type": "string", "minLength": 1 } }, "required": [ "identifier", "linkedin_slug" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-user-id" ] }, "user_id": { "type": "string", "pattern": "^[0-9]+$", "minLength": 1 } }, "required": [ "identifier", "user_id" ] } ] } } } }, "startedInRole": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ] }, "startedAtCompany": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ] }, "location": { "type": [ "object", "null" ], "properties": { "unionAll": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "radial-distance" ] }, "center": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] }, "latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "longitude": { "type": "number", "minimum": -180, "maximum": 180 } }, "required": [ "latitude", "longitude" ] }, "radius": { "oneOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "miles" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 12500 } }, "required": [ "unit", "quantity" ] }, { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "kilometers" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 20100 } }, "required": [ "unit", "quantity" ] } ] } }, "required": [ "strategy", "center", "radius" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "free-form-city" ] }, "city": { "type": "string", "minLength": 1 }, "countryCode": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 3 }, "radius": { "oneOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "miles" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 12500 } }, "required": [ "unit", "quantity" ] }, { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "kilometers" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 20100 } }, "required": [ "unit", "quantity" ] } ] } }, "required": [ "strategy", "city", "radius" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "polygon" ] }, "vertices": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "longitude": { "type": "number", "minimum": -180, "maximum": 180 } }, "required": [ "latitude", "longitude" ] }, "minItems": 4, "maxItems": 1000 } }, "required": [ "strategy", "vertices" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "preset-region" ] }, "region": { "type": "string", "enum": [ "sf-bay-area", "sf-north-bay", "sf-east-bay", "sf-south-bay", "sf-peninsula", "greater-new-york", "chicagoland", "washington-dmv", "greater-los-angeles", "inland-empire", "greater-philadelphia", "boston-route-128", "greater-austin", "toronto-golden-horseshoe", "greater-london", "greater-tokyo", "research-triangle", "seattle-puget-sound", "dallas-fort-worth", "miami-south-florida", "slc-silicon-slopes", "denver-front-range" ] } }, "required": [ "strategy", "region" ] } ] } }, "subtractAll": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "radial-distance" ] }, "center": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] }, "latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "longitude": { "type": "number", "minimum": -180, "maximum": 180 } }, "required": [ "latitude", "longitude" ] }, "radius": { "oneOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "miles" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 12500 } }, "required": [ "unit", "quantity" ] }, { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "kilometers" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 20100 } }, "required": [ "unit", "quantity" ] } ] } }, "required": [ "strategy", "center", "radius" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "free-form-city" ] }, "city": { "type": "string", "minLength": 1 }, "countryCode": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 3 }, "radius": { "oneOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "miles" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 12500 } }, "required": [ "unit", "quantity" ] }, { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "kilometers" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 20100 } }, "required": [ "unit", "quantity" ] } ] } }, "required": [ "strategy", "city", … _truncated to 65536 chars for ai-docs._ ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "articles": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "date_published": { "type": [ "string", "null" ] } } } }, "certifications": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "credential_id": { "type": [ "string", "null" ] }, "verify_url": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "date": { "type": [ "string", "null" ] } } } }, "connection_count": { "type": [ "number", "null" ] }, "courses": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "course_number": { "type": [ "string", "null" ] }, "association": { "type": "null" } } } }, "dob": { "type": [ "string", "null" ] }, "education": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "school_id": { "type": [ "string", "null" ] }, "school_name": { "type": [ "string", "null" ] }, "field_of_study_id": { "type": [ "string", "null" ] }, "field_of_study_name": { "type": [ "string", "null" ] }, "degree": { "type": [ "string", "null" ] }, "grade": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "activities": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } } } }, "experiences": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } } }, "first_name": { "type": [ "string", "null" ] }, "follower_count": { "type": [ "number", "null" ] }, "headline": { "type": [ "string", "null" ] }, "inferred_location": { "type": [ "object", "null" ], "properties": { "street_address": { "type": [ "string", "null" ] }, "neighborhood": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "state_name": { "type": [ "string", "null" ] }, "state_code": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] }, "country_code": { "type": [ "string", "null" ] }, "country_name": { "type": [ "string", "null" ] }, "coordinates": { "type": [ "object", "null" ], "properties": { "lat": { "type": "number" }, "lon": { "type": "number" } }, "required": [ "lat", "lon" ] }, "timezone": { "type": [ "string", "null" ] }, "full_address": { "type": [ "string", "null" ] }, "formatted_address": { "type": [ "string", "null" ] } } }, "interests": { "type": [ "array", "null" ], "items": { "type": "string" } }, "last_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "patents": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "number": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "date": { "type": [ "string", "null" ] } } } }, "profile_pic": { "type": [ "string", "null" ] }, "projects": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "project_id": { "type": [ "string", "null" ] }, "project_title": { "type": [ "string", "null" ] }, "project_url": { "type": [ "string", "null" ] }, "project_summary": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] } } } }, "publications": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "collaborators": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } } } }, "date": { "type": [ "string", "null" ] }, "id": { "type": [ "string", "null" ] }, "publisher": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } } } }, "skills": { "type": [ "array", "null" ], "items": { "type": "string" } }, "primary_slug": { "type": "string" }, "slugs": { "type": [ "array", "null" ], "items": { "type": "string" } }, "summary": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "user_id": { "type": [ "string", "null" ] }, "volunteering": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "role": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "cause": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] } } } }, "tenures": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "date_range": { "type": "object", "properties": { "gte": { "type": [ "string", "null" ] }, "lte": { "type": [ "string", "null" ] } } }, "range_length_days": { "type": [ "number", "null" ] }, "titles": { "type": "array", "items": { "type": "string" } }, "localities": { "type": "array", "items": { "type": "string" } } }, "required": [ "date_range", "titles", "localities" ] } }, "career_began_at": { "type": [ "string", "null" ] }, "tags": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "student", "attended-top-us-university", "attended-top-global-university", "second-time-founder", "deep-technical-background", "major-tech-company-experience", "fortune-500-executive", "recently-changed-companies", "recently-promoted", "decision-maker", "c-suite", "experienced-executive", "phd", "influencer", "board-member" ] } }, "entity_urn": { "type": [ "string", "null" ] }, "open_to_work": { "type": [ "boolean", "null" ] }, "premium": { "type": [ "boolean", "null" ] }, "influencer": { "type": [ "boolean", "null" ] }, "organizations": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] } } } }, "entity_urns": { "type": [ "array", "null" ], "items": { "type": "string" } }, "is_hiring": { "type": [ "boolean", "null" ] }, "websites": { "type": [ "array", "null" ], "items": { "type": "string" } }, "is_verified": { "type": [ "boolean", "null" ] }, "verifications": { "type": [ "object", "null" ], "properties": { "is_verified": { "type": [ "boolean", "null" ] }, "joined_date": { "type": [ "string", "null" ] }, "verification_types": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "subtitle": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] } } } } } }, "is_top_voice": { "type": [ "boolean", "null" ] }, "current_job": { "type": [ "object", "null" ], "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } }, "custom_data": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "relevance_score": { "type": [ "number", "null" ] }, "last_sort_key": { "type": [ "string", "null" ] }, "industry_name": { "type": [ "string", "null" ] }, "last_updated_at": { "type": [ "string", "null" ] }, "languages": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "proficiency_id": { "type": [ "string", "null" ] }, "proficiency_name": { "type": [ "string", "null" ] } } } }, "detailed_education": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "school_details": { "type": [ "object", "null" ], "properties": { "linkedin_ids": { "type": [ "array", "null" ], "items": { "type": "string" } }, "li_org_id": { "type": [ "string", "null" ] }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "preferred_name": { "type": [ "string", "null" ] } } }, "school_id": { "type": [ "string", "null" ] }, "school_name": { "type": [ "string", "null" ] }, "field_of_study_id": { "type": [ "string", "null" ] }, "field_of_study_name": { "type": [ "string", "null" ] }, "degree": { "type": [ "string", "null" ] }, "grade": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "activities": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } } } }, "detailed_work_experiences": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "company_details": { "type": [ "object", "null" ], "properties": { "linkedin_ids": { "type": [ "array", "null" ], "items": { "type": "string" } }, "li_org_id": { "type": [ "string", "null" ] }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "preferred_name": { "type": [ "string", "null" ] }, "crunchbase_slug": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "standard_industries": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "li_industries": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } } } }, "required": [ "primary_slug" ] } }, "estimatedCount": { "type": [ "number", "null" ], "description": "The estimated total number of people who match your search parameters. Note that this does not account for exclusion lists." }, "nextCursor": { "type": [ "string", "null" ], "description": "The pagination cursor for the next page. Provide this in the next request to continue paginating." } }, "required": [ "data" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # peopleSearchCount `POST /v1/people-search/count` **Tags:** `Search` People search count **Endpoint:** `https://api.fiber.ai/v1/people-search/count` ## Description Get count of profiles matching search filters ⚡ Rate limit: 180 requests per 1 minute 💰 Cost: 1 credit per request ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "searchParams": { "type": "object", "properties": { "country3LetterCode": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } } } }, "numConnections": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "numFollowers": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "approxAge": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "keywords": { "type": [ "object", "null" ], "properties": { "containsAll": { "type": [ "array", "null" ], "items": { "type": "string" } }, "containsAny": { "type": [ "array", "null" ], "items": { "type": "string" } }, "containsNone": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "keywordsV2": { "type": [ "object", "null" ], "properties": { "operator": { "type": "string", "enum": [ "AND", "OR" ], "default": "AND" }, "clauses": { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "AND", "OR" ], "default": "OR" }, "terms": { "type": "array", "items": { "type": "string" }, "minItems": 1 }, "negate": { "type": "boolean", "default": false } }, "required": [ "terms" ] }, "minItems": 1 }, "options": { "type": [ "object", "null" ], "properties": { "fieldsToSearchOver": { "type": [ "object", "null" ], "properties": { "summary": { "type": "boolean", "default": true }, "headline": { "type": "boolean", "default": true }, "pastJobTitles": { "type": "boolean", "default": true }, "pastJobSummaries": { "type": "boolean", "default": true }, "pastCompanyNames": { "type": "boolean", "default": true }, "currentJobTitles": { "type": "boolean", "default": true }, "currentJobSummaries": { "type": "boolean", "default": true }, "currentCompanyNames": { "type": "boolean", "default": true }, "interests": { "type": "boolean", "default": true }, "skills": { "type": "boolean", "default": true }, "industry": { "type": "boolean", "default": true }, "education": { "type": "boolean", "default": true }, "publications": { "type": "boolean", "default": true }, "certifications": { "type": "boolean", "default": true }, "articles": { "type": "boolean", "default": true }, "courses": { "type": "boolean", "default": true }, "projects": { "type": "boolean", "default": true }, "patents": { "type": "boolean", "default": true }, "volunteering": { "type": "boolean", "default": false }, "languages": { "type": "boolean", "default": false } } } } } }, "required": [ "clauses" ] }, "keywordSearchOptions": { "type": [ "object", "null" ], "properties": { "fieldsToSearchOver": { "type": [ "object", "null" ], "properties": { "summary": { "type": "boolean", "default": true }, "headline": { "type": "boolean", "default": true }, "pastJobTitles": { "type": "boolean", "default": true }, "pastJobSummaries": { "type": "boolean", "default": true }, "pastCompanyNames": { "type": "boolean", "default": true }, "currentJobTitles": { "type": "boolean", "default": true }, "currentJobSummaries": { "type": "boolean", "default": true }, "currentCompanyNames": { "type": "boolean", "default": true }, "interests": { "type": "boolean", "default": true }, "skills": { "type": "boolean", "default": true }, "industry": { "type": "boolean", "default": true }, "education": { "type": "boolean", "default": true }, "publications": { "type": "boolean", "default": true }, "certifications": { "type": "boolean", "default": true }, "articles": { "type": "boolean", "default": true }, "courses": { "type": "boolean", "default": true }, "projects": { "type": "boolean", "default": true }, "patents": { "type": "boolean", "default": true }, "volunteering": { "type": "boolean", "default": false }, "languages": { "type": "boolean", "default": false } } } } }, "jobTitleV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "term" ] }, "term": { "type": "string" } }, "required": [ "type", "term" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "static-groups" ] }, "groups": { "type": "array", "items": { "type": "string", "enum": [ "founder", "c-suite", "board-member" ] } } }, "required": [ "type", "groups" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dynamic-groups" ] }, "groups": { "type": "array", "items": { "type": "string", "enum": [ "vp", "director", "management", "entry-level", "assistant", "intern" ] } }, "keywords": { "type": "array", "items": { "type": "string" }, "default": [] } }, "required": [ "type", "groups" ] } ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "term" ] }, "term": { "type": "string" } }, "required": [ "type", "term" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "static-groups" ] }, "groups": { "type": "array", "items": { "type": "string", "enum": [ "founder", "c-suite", "board-member" ] } } }, "required": [ "type", "groups" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dynamic-groups" ] }, "groups": { "type": "array", "items": { "type": "string", "enum": [ "vp", "director", "management", "entry-level", "assistant", "intern" ] } }, "keywords": { "type": "array", "items": { "type": "string" }, "default": [] } }, "required": [ "type", "groups" ] } ] } }, "allOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "term" ] }, "term": { "type": "string" } }, "required": [ "type", "term" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "static-groups" ] }, "groups": { "type": "array", "items": { "type": "string", "enum": [ "founder", "c-suite", "board-member" ] } } }, "required": [ "type", "groups" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dynamic-groups" ] }, "groups": { "type": "array", "items": { "type": "string", "enum": [ "vp", "director", "management", "entry-level", "assistant", "intern" ] } }, "keywords": { "type": "array", "items": { "type": "string" }, "default": [] } }, "required": [ "type", "groups" ] } ] } } } }, "exactProfile": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "profile_id": { "type": [ "string", "null" ] }, "primary_slug": { "type": [ "string", "null" ] } } } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "profile_id": { "type": [ "string", "null" ] }, "primary_slug": { "type": [ "string", "null" ] } } } } } }, "exactProfileV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-slug" ] }, "linkedin_slug": { "type": "string", "minLength": 1 } }, "required": [ "identifier", "linkedin_slug" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-user-id" ] }, "user_id": { "type": "string", "pattern": "^[0-9]+$", "minLength": 1 } }, "required": [ "identifier", "user_id" ] } ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-slug" ] }, "linkedin_slug": { "type": "string", "minLength": 1 } }, "required": [ "identifier", "linkedin_slug" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-user-id" ] }, "user_id": { "type": "string", "pattern": "^[0-9]+$", "minLength": 1 } }, "required": [ "identifier", "user_id" ] } ] } } } }, "startedInRole": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ] }, "startedAtCompany": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ] }, "location": { "type": [ "object", "null" ], "properties": { "unionAll": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "radial-distance" ] }, "center": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] }, "latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "longitude": { "type": "number", "minimum": -180, "maximum": 180 } }, "required": [ "latitude", "longitude" ] }, "radius": { "oneOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "miles" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 12500 } }, "required": [ "unit", "quantity" ] }, { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "kilometers" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 20100 } }, "required": [ "unit", "quantity" ] } ] } }, "required": [ "strategy", "center", "radius" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "free-form-city" ] }, "city": { "type": "string", "minLength": 1 }, "countryCode": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 3 }, "radius": { "oneOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "miles" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 12500 } }, "required": [ "unit", "quantity" ] }, { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "kilometers" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 20100 } }, "required": [ "unit", "quantity" ] } ] } }, "required": [ "strategy", "city", "radius" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "polygon" ] }, "vertices": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "longitude": { "type": "number", "minimum": -180, "maximum": 180 } }, "required": [ "latitude", "longitude" ] }, "minItems": 4, "maxItems": 1000 } }, "required": [ "strategy", "vertices" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "preset-region" ] }, "region": { "type": "string", "enum": [ "sf-bay-area", "sf-north-bay", "sf-east-bay", "sf-south-bay", "sf-peninsula", "greater-new-york", "chicagoland", "washington-dmv", "greater-los-angeles", "inland-empire", "greater-philadelphia", "boston-route-128", "greater-austin", "toronto-golden-horseshoe", "greater-london", "greater-tokyo", "research-triangle", "seattle-puget-sound", "dallas-fort-worth", "miami-south-florida", "slc-silicon-slopes", "denver-front-range" ] } }, "required": [ "strategy", "region" ] } ] } }, "subtractAll": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "radial-distance" ] }, "center": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] }, "latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "longitude": { "type": "number", "minimum": -180, "maximum": 180 } }, "required": [ "latitude", "longitude" ] }, "radius": { "oneOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "miles" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 12500 } }, "required": [ "unit", "quantity" ] }, { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "kilometers" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 20100 } }, "required": [ "unit", "quantity" ] } ] } }, "required": [ "strategy", "center", "radius" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "free-form-city" ] }, "city": { "type": "string", "minLength": 1 }, "countryCode": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 3 }, "radius": { "oneOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "miles" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 12500 } }, "required": [ "unit", "quantity" ] }, { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "kilometers" ] }, "quantity": { "type": "number", "minimum": 0, "maximum": 20100 } }, "required": [ "unit", "quantity" ] } ] } }, "required": [ "strategy", "city", … _truncated to 65536 chars for ai-docs._ ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "totalProfilesFound": { "type": "integer", "minimum": 0, "description": "Total number of profiles matching the search criteria including exclusion lists" } }, "required": [ "totalProfilesFound" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # poll-google-maps-results `POST /v1/google-maps-search/poll` **Tags:** `Google maps` Poll for Google Maps results **Endpoint:** `https://api.fiber.ai/v1/google-maps-search/poll` ## Description Poll for Google Maps results ⚡ Rate limit: 120 requests per 1 minute ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "searchID": { "type": "string", "minLength": 1, "description": "The ID of the Google Maps search. You should get this from the start endpoint." }, "pageSize": { "type": "integer", "exclusiveMinimum": 0, "maximum": 1000, "default": 25, "description": "The number of results to return per page." }, "cursor": { "type": [ "string", "null" ], "description": "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." } }, "required": [ "apiKey", "searchID" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "placeId": { "type": "string" }, "name": { "type": "string" }, "address": { "type": [ "string", "null" ] }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "description": { "type": [ "string", "null" ] }, "website": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] }, "numReviews": { "type": [ "integer", "null" ] }, "primaryType": { "type": [ "string", "null" ] }, "allTypes": { "type": "array", "items": { "type": "string" } }, "priceLevel": { "type": [ "string", "null" ] }, "phoneNumber": { "type": [ "string", "null" ] }, "countryIsoCode": { "type": [ "string", "null" ] }, "googleMapsURL": { "type": "string", "description": "The Google Maps URL of the place" } }, "required": [ "placeId", "name", "latitude", "longitude", "allTypes", "googleMapsURL" ] }, "description": "The results of the search." }, "nextCursor": { "type": [ "string", "null" ], "description": "The cursor to use to get the next page of results. If this is null, then there are no more results to fetch." } }, "required": [ "results" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # pollBatchContactDetails `POST /v1/contact-details/batch/poll` **Tags:** `Contact details` Poll batch contact details **Endpoint:** `https://api.fiber.ai/v1/contact-details/batch/poll` ## Description Polls a batch contact details task. Returns partial results as they complete. Call this endpoint repeatedly until the 'done' field is true. Use the task ID returned from the 'Start batch contact details' endpoint. ⚡ Rate limit: 240 requests per 1 minute ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "taskId": { "type": "string", "minLength": 1, "description": "The task ID from the start endpoint response." }, "cursor": { "type": [ "string", "null" ], "description": "The pagination cursor from the previous poll response. Omit for the first request." }, "take": { "type": "integer", "exclusiveMinimum": 0, "maximum": 100, "default": 100, "description": "The number of people to return per page. Defaults to 100." } }, "required": [ "apiKey", "taskId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "overallStats": { "type": "object", "properties": { "totalPeopleToFetch": { "type": "integer", "minimum": 0, "description": "The total number of people in this batch task." }, "numCompleted": { "type": "integer", "minimum": 0, "description": "The number of people for which contact reveal has completed successfully." }, "numFailed": { "type": "integer", "minimum": 0, "description": "The number of people for which enrichment failed (no data found or error occurred)." }, "numRemaining": { "type": "integer", "minimum": 0, "description": "The number of people currently being processed (in progress)." }, "numRejected": { "type": "integer", "minimum": 0, "description": "The number of people rejected before queueing because healing failed (for example, an invalid or unresolvable LinkedIn URL)." }, "numDuplicates": { "type": "integer", "minimum": 0, "description": "The number of duplicates found in the input." } }, "required": [ "totalPeopleToFetch", "numCompleted", "numFailed", "numRemaining", "numRejected", "numDuplicates" ], "description": "The overall statistics for the batch enrichment task." }, "done": { "type": "boolean", "description": "Whether the batch task has finished. When true, check the 'failed' field to determine if it completed successfully or failed." }, "failed": { "type": "boolean", "description": "Whether the batch task failed. If true, the task encountered an error and won't be retried. If false and done=true, the task completed successfully or was cancelled (check the 'canceled' field). If done=false, this field indicates current processing state." }, "canceled": { "type": "boolean", "description": "Whether the batch task was cancelled. When true, unclaimed profiles were not processed and credits were refunded." }, "pageResults": { "type": "array", "items": { "type": "object", "properties": { "inputs": { "type": "object", "properties": { "linkedinUrl": { "type": "object", "properties": { "value": { "type": "string", "pattern": "^(?:https?:\\/\\/)?(?:[a-z]+\\.)?linkedin\\.[a-z]{2,}\\/(?:in|sales\\/lead|talent\\/profile)\\/(?:[^/\\\\?,#]+)\\/?(?:[\\?,#].*)?", "description": "A LinkedIn URL, like 'https://www.linkedin.com/in/jake'" } }, "required": [ "value" ] } }, "required": [ "linkedinUrl" ], "description": "The input details provided for this person." }, "outputs": { "type": [ "object", "null" ], "properties": { "emails": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "type": { "type": "string", "enum": [ "work", "personal", "other", "unknown", "generic" ] }, "status": { "type": "string", "enum": [ "valid", "risky", "unknown", "invalid" ] } }, "required": [ "email", "type" ] } }, "phoneNumbers": { "type": "array", "items": { "type": "object", "properties": { "number": { "type": "string" }, "type": { "type": "string", "enum": [ "mobile", "other", "unknown" ] } }, "required": [ "number", "type" ] } }, "exhaustive": { "type": [ "boolean", "null" ] } }, "required": [ "emails", "phoneNumbers" ], "description": "The reveal result for this person." } }, "required": [ "inputs" ] }, "description": "The array of results for each person in the current page." }, "nextCursor": { "type": [ "string", "null" ], "description": "The pagination cursor for the next page of results." } }, "required": [ "overallStats", "done", "failed", "canceled", "pageResults" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # pollBatchLiveEnrich `POST /v1/linkedin-live-fetch/batch/poll` **Tags:** `Live fetch` Poll batch live enrichment **Endpoint:** `https://api.fiber.ai/v1/linkedin-live-fetch/batch/poll` ## Description 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'. ⚡ Rate limit: 360 requests per 1 minute ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "taskId": { "type": "string", "minLength": 1, "description": "The batch ID returned from the start endpoint" }, "cursor": { "type": [ "string", "null" ], "description": "Pagination cursor from the previous poll response. Omit for the first request." }, "take": { "type": "integer", "exclusiveMinimum": 0, "maximum": 100, "default": 100, "description": "Number of results per page. Defaults to 100." } }, "required": [ "apiKey", "taskId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "COMPLETED", "FAILED" ], "description": "Current status of the batch job" }, "type": { "type": "string", "enum": [ "PROFILE", "COMPANY" ] }, "progress": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "description": "Total unique identifiers in the batch (excluding duplicates skipped at submission)" }, "completed": { "type": "integer", "minimum": 0, "description": "Number successfully enriched" }, "notFound": { "type": "integer", "minimum": 0, "description": "Number of identifiers not found on LinkedIn" }, "failed": { "type": "integer", "minimum": 0, "description": "Number that failed due to enrichment errors" }, "malformed": { "type": "integer", "minimum": 0, "description": "Number of identifiers that could not be parsed from your input" }, "pending": { "type": "integer", "minimum": 0, "description": "Number still waiting or in progress" } }, "required": [ "total", "completed", "notFound", "failed", "malformed", "pending" ] }, "results": { "type": "array", "items": { "type": "object", "properties": { "identifier": { "type": "string", "description": "The raw identifier that was submitted." }, "status": { "type": "string", "enum": [ "COMPLETED", "FAILED", "NOT_FOUND", "MALFORMED" ], "description": "The enrichment status for this identifier." }, "profile": { "type": [ "object", "null" ], "properties": { "articles": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "date_published": { "type": [ "string", "null" ] } } } }, "certifications": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "credential_id": { "type": [ "string", "null" ] }, "verify_url": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "date": { "type": [ "string", "null" ] } } } }, "connection_count": { "type": [ "number", "null" ] }, "courses": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "course_number": { "type": [ "string", "null" ] }, "association": { "type": "null" } } } }, "dob": { "type": [ "string", "null" ] }, "education": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "school_id": { "type": [ "string", "null" ] }, "school_name": { "type": [ "string", "null" ] }, "field_of_study_id": { "type": [ "string", "null" ] }, "field_of_study_name": { "type": [ "string", "null" ] }, "degree": { "type": [ "string", "null" ] }, "grade": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "activities": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } } } }, "experiences": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } } }, "first_name": { "type": [ "string", "null" ] }, "follower_count": { "type": [ "number", "null" ] }, "headline": { "type": [ "string", "null" ] }, "inferred_location": { "type": [ "object", "null" ], "properties": { "street_address": { "type": [ "string", "null" ] }, "neighborhood": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "state_name": { "type": [ "string", "null" ] }, "state_code": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] }, "country_code": { "type": [ "string", "null" ] }, "country_name": { "type": [ "string", "null" ] }, "coordinates": { "type": [ "object", "null" ], "properties": { "lat": { "type": "number" }, "lon": { "type": "number" } }, "required": [ "lat", "lon" ] }, "timezone": { "type": [ "string", "null" ] }, "full_address": { "type": [ "string", "null" ] }, "formatted_address": { "type": [ "string", "null" ] } } }, "interests": { "type": [ "array", "null" ], "items": { "type": "string" } }, "last_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "patents": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "number": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "date": { "type": [ "string", "null" ] } } } }, "profile_pic": { "type": [ "string", "null" ] }, "projects": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "project_id": { "type": [ "string", "null" ] }, "project_title": { "type": [ "string", "null" ] }, "project_url": { "type": [ "string", "null" ] }, "project_summary": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] } } } }, "publications": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "collaborators": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } } } }, "date": { "type": [ "string", "null" ] }, "id": { "type": [ "string", "null" ] }, "publisher": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } } } }, "skills": { "type": [ "array", "null" ], "items": { "type": "string" } }, "primary_slug": { "type": "string" }, "slugs": { "type": [ "array", "null" ], "items": { "type": "string" } }, "summary": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "user_id": { "type": [ "string", "null" ] }, "volunteering": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "role": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "cause": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] } } } }, "tenures": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "date_range": { "type": "object", "properties": { "gte": { "type": [ "string", "null" ] }, "lte": { "type": [ "string", "null" ] } } }, "range_length_days": { "type": [ "number", "null" ] }, "titles": { "type": "array", "items": { "type": "string" } }, "localities": { "type": "array", "items": { "type": "string" } } }, "required": [ "date_range", "titles", "localities" ] } }, "career_began_at": { "type": [ "string", "null" ] }, "tags": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "student", "attended-top-us-university", "attended-top-global-university", "second-time-founder", "deep-technical-background", "major-tech-company-experience", "fortune-500-executive", "recently-changed-companies", "recently-promoted", "decision-maker", "c-suite", "experienced-executive", "phd", "influencer", "board-member" ] } }, "entity_urn": { "type": [ "string", "null" ] }, "open_to_work": { "type": [ "boolean", "null" ] }, "premium": { "type": [ "boolean", "null" ] }, "influencer": { "type": [ "boolean", "null" ] }, "organizations": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] } } } }, "entity_urns": { "type": [ "array", "null" ], "items": { "type": "string" } }, "is_hiring": { "type": [ "boolean", "null" ] }, "websites": { "type": [ "array", "null" ], "items": { "type": "string" } }, "is_verified": { "type": [ "boolean", "null" ] }, "verifications": { "type": [ "object", "null" ], "properties": { "is_verified": { "type": [ "boolean", "null" ] }, "joined_date": { "type": [ "string", "null" ] }, "verification_types": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "subtitle": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] } } } } } }, "is_top_voice": { "type": [ "boolean", "null" ] }, "current_job": { "type": [ "object", "null" ], "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } }, "custom_data": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "relevance_score": { "type": [ "number", "null" ] }, "last_sort_key": { "type": [ "string", "null" ] }, "industry_name": { "type": [ "string", "null" ] }, "last_updated_at": { "type": [ "string", "null" ] }, "languages": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "proficiency_id": { "type": [ "string", "null" ] }, "proficiency_name": { "type": [ "string", "null" ] } } } }, "detailed_education": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "school_details": { "type": [ "object", "null" ], "properties": { "linkedin_ids": { "type": [ "array", "null" ], "items": { "type": "string" } }, "li_org_id": { "type": [ "string", "null" ] }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "preferred_name": { "type": [ "string", "null" ] } } }, "school_id": { "type": [ "string", "null" ] }, "school_name": { "type": [ "string", "null" ] }, "field_of_study_id": { "type": [ "string", "null" ] }, "field_of_study_name": { "type": [ "string", "null" ] }, "degree": { "type": [ "string", "null" ] }, "grade": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "activities": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } } } }, "detailed_work_experiences": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "company_details": { "type": [ "object", "null" ], "properties": { "linkedin_ids": { "type": [ "array", "null" ], "items": { "type": "string" } }, "li_org_id": { "type": [ "string", "null" ] }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "preferred_name": { "type": [ "string", "null" ] }, "crunchbase_slug": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "standard_industries": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "li_industries": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } } } }, "required": [ "primary_slug" ], "description": "Enriched profile data. Present only when type is profile and status is COMPLETED." }, "company": { "type": [ "object", "null" ], "properties": { "headline": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "employee_count": { "type": [ "number", "null" ] }, "follower_count": { "type": [ "number", "null" ] }, "founded_year": { "type": [ "number", "null" ] }, "industries": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "primary": { "type": [ "boolean", "null" ] } }, "required": [ "id", "name" ] } }, "inferred_location": { "type": [ "object", "null" ], "properties": { "street_address": { "type": [ "string", "null" ] }, "neighborhood": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "state_name": { "type": [ "string", "null" ] }, "state_code": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] }, "country_code": { "type": [ "string", "null" ] }, "country_name": { "type": [ "string", "null" ] }, "coordinates": { "type": [ "object", "null" ], "properties": { "lat": { "type": "number" }, "lon": { "type": "number" } }, "required": [ "lat", "lon" ] }, … _truncated to 65536 chars for ai-docs._ ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # pollDepthChart `POST /v1/depth-chart/poll` **Tags:** `Company info` Poll depth chart generation result **Endpoint:** `https://api.fiber.ai/v1/depth-chart/poll` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "reportId": { "type": "string", "minLength": 1, "description": "Report ID returned by the /depth-chart/start endpoint" } }, "required": [ "apiKey", "reportId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "oneOf": [ { "type": "object", "properties": { "status": { "type": "string", "description": "Report is still being generated", "enum": [ "pending" ] } }, "required": [ "status" ] }, { "type": "object", "properties": { "status": { "type": "string", "description": "Report generation succeeded", "enum": [ "completed" ] }, "report": { "type": "object", "properties": { "reportId": { "type": "string", "description": "Unique identifier for this report" }, "companyInfo": { "type": "object", "properties": { "name": { "type": [ "string", "null" ], "description": "Company name" }, "linkedinUrl": { "type": [ "string", "null" ], "description": "Full LinkedIn company profile URL" }, "linkedinOrgId": { "type": [ "string", "null" ], "description": "LinkedIn organization ID for the company" }, "domain": { "type": [ "string", "null" ], "description": "Company primary domain" } }, "description": "Company identification details" }, "totalEmployees": { "type": "number", "description": "Total employees at the company (official headcount when available, otherwise the classified count)" }, "classifiedEmployees": { "type": "number", "description": "Number of employees categorized in this depth chart. Bucket counts sum to this value." }, "categorizationNote": { "type": [ "string", "null" ], "description": "Explanation when the company is too large to categorize every employee in full" }, "averageTenureMonths": { "type": [ "number", "null" ], "description": "Overall average tenure in months across all employees" }, "buckets": { "type": "array", "items": { "type": "object", "properties": { "function": { "type": "string", "description": "Functional area (e.g. Engineering, Sales/GTM, Marketing, Product)" }, "seniority": { "type": "string", "description": "Seniority level (Junior, Mid-Level, Senior, Manager, Executive)" }, "totalEmployees": { "type": "number", "description": "Number of employees in this function x seniority combination" }, "averageTenureMonths": { "type": [ "number", "null" ], "description": "Average tenure in months for employees in this combination" } }, "required": [ "function", "seniority", "totalEmployees", "averageTenureMonths" ] }, "description": "One entry per function x seniority combination with headcount and average tenure. Includes summary stats for each bucket, but does not list the people in each bucket." }, "seniorityStats": { "type": "array", "items": { "type": "object", "properties": { "seniority": { "type": "string", "description": "Seniority level (Junior, Mid-Level, Senior, Manager, Executive)" }, "totalEmployees": { "type": "number", "description": "Total employees at this seniority level" }, "averageTenureMonths": { "type": [ "number", "null" ], "description": "Average tenure in months across all functions at this seniority level" } }, "required": [ "seniority", "totalEmployees", "averageTenureMonths" ] }, "description": "Aggregated headcount and tenure per seniority level" }, "functionStats": { "type": "array", "items": { "type": "object", "properties": { "function": { "type": "string", "description": "Functional area (e.g. Engineering, Sales/GTM, Marketing)" }, "totalEmployees": { "type": "number", "description": "Total employees in this function" }, "averageTenureMonths": { "type": [ "number", "null" ], "description": "Average tenure in months across all seniority levels in this function" } }, "required": [ "function", "totalEmployees", "averageTenureMonths" ] }, "description": "Aggregated headcount and tenure per functional area" }, "markdownSummary": { "type": "string", "description": "Human-readable markdown summary of the depth chart, including a grid table of employee counts by function and seniority" } }, "required": [ "reportId", "companyInfo", "totalEmployees", "classifiedEmployees", "categorizationNote", "averageTenureMonths", "buckets", "seniorityStats", "functionStats", "markdownSummary" ], "description": "The completed depth chart report" } }, "required": [ "status", "report" ] }, { "type": "object", "properties": { "status": { "type": "string", "description": "Report generation failed", "enum": [ "failed" ] }, "errorMessage": { "type": "string", "description": "Description of why generation failed" } }, "required": [ "status", "errorMessage" ] } ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # pollExhaustiveContactEnrichmentResult `POST /v1/contact-details/exhaustive/poll` **Tags:** `Contact details` Poll exhaustive contact details reveal result **Endpoint:** `https://api.fiber.ai/v1/contact-details/exhaustive/poll` ## Description Polls the status of an exhaustive contact reveal task. Pass the task ID returned by /contact-details/exhaustive/start. This is intentionally slow (completion typically takes approximately 4–8 minutes), as we run multiple enrichment sources in parallel to maximize yield. Do NOT use this in time-sensitive applications -- try any of our other contact detail grabbing endpoints instead. Returns the current status and, once complete, the full set of discovered emails and phone numbers. Includes both high-quality emails and low-quality emails (risky/undeliverable). Low-quality emails failed our internal validation checks and should be filtered out before use, but are included for transparency. ⚡ Rate limit: 240 requests per 1 minute ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "taskId": { "type": "string", "minLength": 1, "description": "Task ID from the \"start exhaustive contact enrichment\" endpoint" } }, "required": [ "apiKey", "taskId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "profile": { "type": "object", "properties": { "emails": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "type": { "type": "string", "enum": [ "work", "personal", "other", "unknown", "generic" ] }, "status": { "type": "string", "enum": [ "valid", "risky", "unknown", "invalid" ] } }, "required": [ "email", "type" ] } }, "phoneNumbers": { "type": "array", "items": { "type": "object", "properties": { "number": { "type": "string" }, "type": { "type": "string", "enum": [ "mobile", "other", "unknown" ] } }, "required": [ "number", "type" ] } }, "status": { "type": "string", "enum": [ "started", "live-enriching", "grabbing-contact-info", "completed", "failed" ] }, "error": { "type": "string" }, "exhaustive": { "type": [ "boolean", "null" ] }, "lowQualityEmails": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "email": { "type": "string" }, "type": { "type": "string", "enum": [ "work", "personal", "other", "unknown", "generic" ] }, "status": { "type": "string", "enum": [ "valid", "risky", "unknown", "invalid" ] } }, "required": [ "email", "type" ] }, "description": "Emails that failed internal validation checks (risky or undeliverable). These are included for transparency but should be filtered out before use." } }, "required": [ "emails", "phoneNumbers", "status" ] }, "done": { "type": "boolean", "description": "Whether the enrichment is completed or not." } }, "required": [ "profile", "done" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # pollLocalBusinessSearch `POST /v1/local-business-search/poll` **Tags:** `AI research` Poll local business search **Endpoint:** `https://api.fiber.ai/v1/local-business-search/poll` ## Description Poll Local Business Agent search results for a given researchRunId ⚡ Rate limit: 120 requests per 1 minute ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "researchRunId": { "type": "string", "description": "Research run ID of the local business search" }, "pageSize": { "type": "integer", "exclusiveMinimum": 0, "maximum": 1000, "default": 25, "description": "The number of results to return per page" }, "cursor": { "type": [ "string", "null" ], "description": "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." } }, "required": [ "apiKey", "researchRunId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "researchRunId": { "type": "string", "description": "Research run ID of the local business search" }, "status": { "type": "string", "enum": [ "PENDING", "RUNNING", "COMPLETED", "FAILED" ], "description": "Current status of the research run" }, "progress": { "type": "object", "properties": { "completed": { "type": "integer", "description": "Number of companies that have been processed so far" }, "total": { "type": "integer", "description": "Total number of companies submitted for research" } }, "required": [ "completed", "total" ], "description": "Progress of the research run" }, "data": { "type": "object", "properties": { "observations": { "type": "array", "items": { "type": "object", "properties": { "researchRunId": { "type": "string" }, "websiteUrls": { "type": "array", "items": { "type": "string" } }, "rationale": {}, "localBusiness": { "type": "object", "properties": { "companyName": { "type": "string" }, "domain": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] }, "stateCode": { "type": [ "string", "null" ] }, "countryName": { "type": [ "string", "null" ] }, "country3LetterCode": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] }, "context": { "type": [ "string", "null" ] } }, "required": [ "companyName" ] }, "businessEmails": { "type": "array", "items": { "type": "object", "properties": { "emailAddress": { "type": "string" }, "domain": { "type": [ "string", "null" ] } }, "required": [ "emailAddress" ] } }, "businessPhones": { "type": "array", "items": { "type": "object", "properties": { "phoneNumber": { "type": "string" }, "countryCode": { "type": [ "string", "null" ] }, "countryCallingCode": { "type": [ "number", "null" ] } }, "required": [ "phoneNumber" ] } }, "socialMediaLinks": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "platform": { "type": "string" } }, "required": [ "url", "platform" ] } }, "employees": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "role": { "type": [ "string", "null" ] }, "otherInfo": {}, "emailAddress": { "type": [ "object", "null" ], "properties": { "emailAddress": { "type": "string" }, "domain": { "type": "string" } }, "required": [ "emailAddress", "domain" ] }, "phoneNumber": { "type": [ "object", "null" ], "properties": { "phoneNumber": { "type": "string" }, "countryCode": { "type": [ "string", "null" ] }, "countryCallingCode": { "type": [ "number", "null" ] } }, "required": [ "phoneNumber" ] }, "socialMediaLinks": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "platform": { "type": "string" } }, "required": [ "url", "platform" ] } } }, "required": [ "name", "socialMediaLinks" ] } } }, "required": [ "researchRunId", "websiteUrls", "localBusiness", "businessEmails", "businessPhones", "socialMediaLinks", "employees" ] } } }, "required": [ "observations" ], "description": "The Local business agent search result" }, "nextCursor": { "type": [ "string", "null" ], "description": "The cursor to use to get the next page of results. If this is null, then there are no more results to fetch" } }, "required": [ "researchRunId", "status", "progress", "data" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # pollMosaic `POST /v1/mosaic/poll` **Tags:** `Repair Data` Poll Mosaic run status **Endpoint:** `https://api.fiber.ai/v1/mosaic/poll` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "runId": { "type": "string", "minLength": 1, "description": "Run ID returned by the /mosaic/start endpoint" } }, "required": [ "apiKey", "runId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "run": { "type": "object", "properties": { "runId": { "type": "string", "description": "Unique Mosaic run ID. Pass this to /mosaic/poll." }, "status": { "type": "string", "enum": [ "pending", "running", "done", "failed" ], "description": "Run lifecycle status. `pending` = queued, `running` = in progress, `done` = finished successfully, `failed` = terminal error. Download links are present only when status is `done`." }, "rowCount": { "type": [ "integer", "null" ], "minimum": 0, "description": "Rows detected in the input file." }, "processedRowCount": { "type": [ "integer", "null" ], "minimum": 0, "description": "Rows enriched and written to the output CSV (<= rowCount when maxRows or the free-trial cap applies)." }, "isFreeTrialRun": { "type": "boolean", "description": "True when this run used the organization's one-time free Mosaic trial (first 1,000 rows free)." }, "stats": { "type": [ "object", "null" ], "properties": { "inputRows": { "type": "integer", "minimum": 0 }, "outputRows": { "type": "integer", "minimum": 0 }, "rowsWhereProfileFound": { "type": "integer", "minimum": 0 }, "rowsWithContactDetails": { "type": "integer", "minimum": 0 }, "rowsWithErrors": { "type": "integer", "minimum": 0 } }, "required": [ "inputRows", "outputRows", "rowsWhereProfileFound", "rowsWithContactDetails", "rowsWithErrors" ], "description": "Aggregate enrichment statistics. Present when the run has finished processing rows." }, "outputCsvUrl": { "type": [ "string", "null" ], "description": "Temporary HTTPS download link for the enriched CSV. Present only when status is `done`." }, "reportUrl": { "type": [ "string", "null" ], "description": "Temporary HTTPS download link for the Markdown summary report. Present only when status is `done`." } }, "required": [ "runId", "status", "rowCount", "processedRowCount", "isFreeTrialRun", "stats", "outputCsvUrl", "reportUrl" ], "description": "Current Mosaic run state. When status is done, outputCsvUrl and reportUrl are temporary download links." } }, "required": [ "run" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # postCommentsLiveFetch `POST /v1/linkedin-live-fetch/post-comments` **Tags:** `LinkedIn activity` Fetch LinkedIn post comments **Endpoint:** `https://api.fiber.ai/v1/linkedin-live-fetch/post-comments` ## Description Fetches paginated comments for a LinkedIn post. Each page contains up to 10 comments. ⚡ Rate limit: 300 requests per 1 minute 💰 Cost: 2 credits per page of results ⓘ ⏱ Recommended timeout: 1 minute ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "contentId": { "type": "string", "minLength": 1, "description": "You can get LinkedIn posts from the Profile or Company Posts endpoints. (e.g., 'urn:li:activity:7123456789012345678' or 'urn:li:ugcPost:7391650829398675456')" }, "cursor": { "type": [ "string", "null" ], "description": "Pagination cursor for fetching additional pages of posts" }, "includeTaggedUsers": { "type": [ "boolean", "null" ], "default": false, "description": "When true, also returns the LinkedIn users @-mentioned (tagged) inside each comment. This might be slower so only enable it if needed." } }, "required": [ "apiKey", "contentId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "commentary": { "type": [ "string", "null" ] }, "commenter": { "type": [ "object", "null" ], "properties": { "linkedinUrl": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "profilePicture": { "type": [ "string", "null" ] }, "linkedinSlug": { "type": [ "string", "null" ] } } }, "numReactions": { "type": [ "number", "null" ] }, "numComments": { "type": [ "number", "null" ] }, "reactionsByType": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "numReactions": { "type": [ "number", "null" ] }, "reactionType": { "type": [ "string", "null" ], "enum": [ "LIKE", "LOVE", "INSIGHTFUL", "CELEBRATE", "SUPPORT", "FUNNY", null ], "description": "One of LinkedIn's reaction types. These match the tooltips on each of LinkedIn's six reaction buttons; for instance, 'Like' is the blue thumbs-up." } } } }, "createdAt": { "type": [ "string", "null" ] }, "taggedUsers": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "firstName": { "type": [ "string", "null" ] }, "lastName": { "type": [ "string", "null" ] }, "linkedinUrl": { "type": [ "string", "null" ] }, "linkedinSlug": { "type": [ "string", "null" ] }, "entityUrn": { "type": [ "string", "null" ] } } } }, "comments": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "commentary": { "type": [ "string", "null" ] }, "commenter": { "type": [ "object", "null" ], "properties": { "linkedinUrl": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "profilePicture": { "type": [ "string", "null" ] }, "linkedinSlug": { "type": [ "string", "null" ] } } }, "numReactions": { "type": [ "number", "null" ] }, "numComments": { "type": [ "number", "null" ] }, "reactionsByType": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "numReactions": { "type": [ "number", "null" ] }, "reactionType": { "type": [ "string", "null" ], "enum": [ "LIKE", "LOVE", "INSIGHTFUL", "CELEBRATE", "SUPPORT", "FUNNY", null ], "description": "One of LinkedIn's reaction types. These match the tooltips on each of LinkedIn's six reaction buttons; for instance, 'Like' is the blue thumbs-up." } } } }, "createdAt": { "type": [ "string", "null" ] }, "taggedUsers": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "firstName": { "type": [ "string", "null" ] }, "lastName": { "type": [ "string", "null" ] }, "linkedinUrl": { "type": [ "string", "null" ] }, "linkedinSlug": { "type": [ "string", "null" ] }, "entityUrn": { "type": [ "string", "null" ] } } } } } } } } } }, "cursor": { "type": [ "string", "null" ] } }, "required": [ "data" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # postReactionsLiveFetch `POST /v1/linkedin-live-fetch/post-reactions` **Tags:** `LinkedIn activity` Fetch LinkedIn post reactions **Endpoint:** `https://api.fiber.ai/v1/linkedin-live-fetch/post-reactions` ## Description Fetches paginated reactions of a specific type for a LinkedIn post. Each page contains up to 10 reactions. ⚡ Rate limit: 300 requests per 1 minute 💰 Cost: 2 credits per page of results ⓘ ⏱ Recommended timeout: 1 minute ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "contentId": { "type": "string", "minLength": 1, "description": "You can get LinkedIn posts from the Profile or Company Posts endpoints. (e.g., 'urn:li:activity:7123456789012345678' or 'urn:li:ugcPost:7391650829398675456')" }, "reactionType": { "type": [ "string", "null" ], "enum": [ "LIKE", "LOVE", "INSIGHTFUL", "CELEBRATE", "SUPPORT", "FUNNY", null ], "description": "Type of reaction to fetch. If null, all reactions will be fetched." }, "cursor": { "type": [ "string", "null" ], "description": "Pagination cursor for fetching additional pages of posts" } }, "required": [ "apiKey", "contentId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "reactionType": { "type": [ "string", "null" ], "enum": [ "LIKE", "LOVE", "INSIGHTFUL", "CELEBRATE", "SUPPORT", "FUNNY", null ], "description": "One of LinkedIn's reaction types. These match the tooltips on each of LinkedIn's six reaction buttons; for instance, 'Like' is the blue thumbs-up." }, "reactor": { "type": [ "object", "null" ], "properties": { "userId": { "type": [ "number", "null" ] }, "entityUrn": { "type": [ "string", "null" ] }, "profilePicture": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "headline": { "type": [ "string", "null" ] } } } } } }, "cursor": { "type": [ "string", "null" ] } }, "required": [ "data" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # postSearchByKeywords `POST /v1/linkedin-live-fetch/posts/search` **Tags:** `LinkedIn activity` Search LinkedIn posts by keywords **Endpoint:** `https://api.fiber.ai/v1/linkedin-live-fetch/posts/search` ## Description Search LinkedIn posts using keyword-based queries. Returns a paginated list of posts matching the search criteria, up to 50 per page. **Keyword Search Syntax:** - **Exact phrase:** Wrap keywords in quotes for exact phrase matching. "head of sales" matches the exact phrase, not the individual words. - **AND:** Use **AND** between keywords to require both terms. sales **AND** engineering matches posts containing both words. - **OR:** Use **OR** between keywords to match posts containing any of the terms. sales **OR** marketing matches posts with either word. - **NOT:** Use **NOT** before a keyword to exclude posts containing that term. sales **NOT** recruiter matches posts with "sales" but without "recruiter". - **Parentheses:** Group terms to control operator precedence. (sales **OR** marketing) **AND** "series A" finds posts about either sales or marketing that also mention "series A". **Order of precedence:** 1. **Quotes (" "):** Exact phrase match. Phrase matching occurs before any Boolean logic is applied. 2. **Parentheses (()):** Used to explicitly group Boolean logic. Grouped expressions are evaluated before ungrouped logic. 3. **NOT:** Applied after any parentheses or quoted phrases are resolved. 4. **AND:** Evaluated after **NOT** but before **OR**. 5. **OR:** Lowest precedence among Boolean operators. ⚡ Rate limit: 300 requests per 1 minute 💰 Cost: 2 credits per page of results ⓘ ⏱ Recommended timeout: 1 minute ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "keywords": { "type": "string", "minLength": 1, "maxLength": 10000, "description": "Keywords to search for in LinkedIn posts (comma-separated)" }, "recency": { "type": [ "string", "null" ], "enum": [ "Day", "Week", "Month", "Quarter", "HalfYear", "Year", null ], "description": "Filter by post age. Options: Day, Week, Month, Quarter, HalfYear, Year. Defaults to all time if omitted." }, "cursor": { "type": [ "string", "null" ], "description": "Pagination cursor for fetching additional pages of posts" } }, "required": [ "apiKey", "keywords" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "posts": { "type": "array", "items": { "type": "object", "properties": { "postId": { "type": "string" }, "content": { "type": [ "string", "null" ] }, "postUrl": { "type": [ "string", "null" ] }, "author": { "type": [ "object", "null" ], "properties": { "type": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "linkedinUrl": { "type": [ "string", "null" ] }, "headline": { "type": [ "string", "null" ] }, "website": { "type": [ "string", "null" ] }, "profilePicture": { "type": [ "string", "null" ] } } }, "publishedAt": { "type": [ "string", "null" ] }, "imageUrls": { "type": [ "array", "null" ], "items": { "type": "string" } }, "video": { "type": [ "object", "null" ], "properties": { "videoUrl": { "type": [ "string", "null" ] }, "thumbnailUrl": { "type": [ "string", "null" ] } } }, "article": { "type": [ "object", "null" ], "properties": { "title": { "type": [ "string", "null" ] }, "subtitle": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "imageUrl": { "type": [ "string", "null" ] } } }, "originalPostId": { "type": [ "string", "null" ] }, "originalPost": { "type": [ "object", "null" ], "additionalProperties": {} }, "resharedBy": { "type": [ "object", "null" ], "properties": { "name": { "type": [ "string", "null" ] }, "linkedinUrl": { "type": [ "string", "null" ] } } }, "newsletterUrl": { "type": [ "string", "null" ] }, "newsletterTitle": { "type": [ "string", "null" ] }, "engagement": { "type": [ "object", "null" ], "properties": { "numComments": { "type": [ "number", "null" ] }, "numShares": { "type": [ "number", "null" ] }, "numLikes": { "type": [ "number", "null" ] }, "reactionsByType": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "numReactions": { "type": [ "number", "null" ] }, "reactionType": { "type": [ "string", "null" ], "enum": [ "LIKE", "LOVE", "INSIGHTFUL", "CELEBRATE", "SUPPORT", "FUNNY", null ], "description": "One of LinkedIn's reaction types. These match the tooltips on each of LinkedIn's six reaction buttons; for instance, 'Like' is the blue thumbs-up." } } } } } } }, "required": [ "postId" ] } }, "cursor": { "type": [ "string", "null" ] } }, "required": [ "posts" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # premiumPhoneReveal `POST /v1/contact-details/premium-phone/sync` **Tags:** `Contact details` Premium phone number lookup **Endpoint:** `https://api.fiber.ai/v1/contact-details/premium-phone/sync` ## Description Find and verify phone numbers for a LinkedIn profile using multiple data sources. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: 5 credits per request ⓘ ⏱ Recommended timeout: 1 minute ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "linkedinUrl": { "type": "string", "minLength": 1, "description": "LinkedIn profile identifier. Accepts a full URL, a bare slug, or a LinkedIn entity URN." }, "patience": { "type": [ "string", "null" ], "enum": [ "MINIMUM", "LOW", "MEDIUM", "HIGH", "EXTREME", "MAXIMUM", null ], "description": "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." } }, "required": [ "apiKey", "linkedinUrl" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "linkedinUrl": { "type": "string", "description": "Resolved LinkedIn profile URL." }, "phoneNumbers": { "type": "array", "items": { "type": "object", "properties": { "number": { "type": "string", "description": "Phone number in E.164 format." }, "type": { "type": "string", "enum": [ "mobile", "other", "unknown" ], "description": "Phone line type." }, "callerIdValidation": { "type": [ "object", "null" ], "properties": { "category": { "type": "string", "enum": [ "EXACT_MATCH", "PROBABLE_MATCH", "FAMILY_MEMBER", "BUSINESS_LINE", "INCONCLUSIVE" ], "description": "How confidently this phone number is associated with the person." }, "reasoning": { "type": "string", "description": "Brief explanation for the confidence level." }, "callerIdName": { "type": "string", "description": "The registered name for this phone number." } }, "required": [ "category", "reasoning", "callerIdName" ], "description": "Result for attempted phone number verification." } }, "required": [ "number", "type" ] }, "description": "Phone numbers found for this person, annotated with identity verification when available." } }, "required": [ "linkedinUrl", "phoneNumbers" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # previewTrackerSignal `POST /v1/tracker/rules/preview-signal` **Tags:** `Tracker` Preview a signal **Endpoint:** `https://api.fiber.ai/v1/tracker/rules/preview-signal` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "config": { "oneOf": [ { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "headcount_crossed_threshold" }, "entityType": { "type": "string", "const": "company" }, "direction": { "type": "string", "enum": [ "above", "below" ], "description": "Whether to alert when headcount crosses the threshold going up or down" }, "threshold": { "type": "integer", "exclusiveMinimum": 0, "description": "The employee count threshold to watch for crossing. Any positive integer is accepted." } }, "required": [ "type", "entityType", "direction", "threshold" ], "title": "Headcount crossed threshold" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "headcount_growth_percent" }, "entityType": { "type": "string", "const": "company" }, "minPercentChange": { "type": "number", "exclusiveMinimum": 0, "maximum": 1000, "description": "Minimum percent change to trigger (e.g. 20 means 20% growth)" }, "direction": { "type": "string", "enum": [ "grew", "shrank", "either" ], "description": "Whether to alert on growth, shrinkage, or either" }, "minStartingHeadcount": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Only alert if the company had at least this many employees before the change. Omit for any starting size." } }, "required": [ "type", "entityType", "minPercentChange", "direction" ], "title": "Headcount growth percent" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "new_funding_round" }, "entityType": { "type": "string", "const": "company" }, "minAmountUsd": { "type": [ "number", "null" ], "minimum": 0, "description": "Only alert for rounds above this amount. Omit for any amount." }, "roundTypes": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "pre_seed", "seed", "angel", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "private_equity", "debt_financing", "grant", "convertible_note", "corporate_round", "undisclosed" ] }, "minItems": 1, "description": "Round types to alert on. Defaults to equity-focused types when omitted. Set explicitly to include debt/grant types." } }, "required": [ "type", "entityType" ], "title": "New funding round" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "funding_stage_changed" }, "entityType": { "type": "string", "const": "company" }, "toStages": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "private_equity", "public", "acquired" ] }, "minItems": 1, "description": "Only alert if new stage is one of these. Omit for any stage change." } }, "required": [ "type", "entityType" ], "title": "Funding stage changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "job_posting_with_keyword" }, "entityType": { "type": "string", "const": "company" }, "keywords": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Alert when a job posting title contains any of these keywords" }, "seniorityLevels": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Internship", "Entry level", "Associate", "Mid-Senior level", "Director", "Executive" ] }, "minItems": 1, "description": "Only alert for these seniority levels. Omit for any level." }, "modalities": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "On-site", "Remote", "Hybrid" ] }, "minItems": 1, "description": "Only alert for these job modalities. Omit for any." }, "locationTypes": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "remote", "on_site", "hybrid" ] }, "minItems": 1, "description": "Deprecated. Use modalities instead.", "deprecated": true }, "minPostings": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Only alert if at least this many NEW matching postings are detected in a single check cycle. Omit for 1 (any new match)." } }, "required": [ "type", "entityType", "keywords" ], "title": "Job posting with keyword" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "job_posting_in_function" }, "entityType": { "type": "string", "const": "company" }, "jobFunctions": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Accounting", "Administrative", "Advertising", "Analyst", "Art / Creative", "Business Development", "Community & Social Services", "Consulting", "Customer Service", "Design", "Distribution", "Education", "Engineering", "Entrepreneurship", "Finance", "General Business", "Health Care Provider", "Human Resources", "Information Technology", "Legal", "Management", "Manufacturing", "Marketing", "Military & Protective Services", "Other", "Product Management", "Production", "Program & Product Management", "Project Management", "Public Relations", "Purchasing", "Quality Assurance", "Real Estate", "Research", "Sales", "Science", "Strategy / Planning", "Supply Chain", "Training", "Writing / Editing" ] }, "description": "Alert when a job posting is in any of these departments/functions." }, "minPostings": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Only alert if at least this many NEW matching postings are detected in a single check cycle. Omit for 1 (any new match)." } }, "required": [ "type", "entityType", "jobFunctions" ], "title": "Job posting in function" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "news_with_keyword" }, "entityType": { "type": "string", "const": "company" }, "keywords": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Alert when a news article title or summary matches any keyword" }, "sentiment": { "type": [ "string", "null" ], "enum": [ "positive", "negative", "neutral", null ], "description": "Only alert for news with this sentiment. Omit for any sentiment." } }, "required": [ "type", "entityType", "keywords" ], "title": "News with keyword" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_news" }, "entityType": { "type": "string", "const": "company" }, "sentiment": { "type": [ "string", "null" ], "enum": [ "positive", "negative", "neutral", null ], "description": "Only alert for news with this sentiment. Omit for any sentiment." }, "minArticles": { "type": [ "integer", "null" ], "minimum": 1, "description": "Only alert when at least this many articles are detected in a single check. Useful for filtering noise from single tangential mentions. Omit for any count." } }, "required": [ "type", "entityType" ], "title": "Company news" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "hq_location_changed" }, "entityType": { "type": "string", "const": "company" } }, "required": [ "type", "entityType" ], "title": "HQ location changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_status_changed" }, "entityType": { "type": "string", "const": "company" }, "toStatuses": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "operating", "acquired", "closed", "ipo", "subsidiary" ] }, "minItems": 1, "description": "Only alert if new status is one of these. Omit for any status change." } }, "required": [ "type", "entityType" ], "title": "Company status changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "technology_added" }, "entityType": { "type": "string", "const": "company" }, "technologies": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert for these technologies. Omit for any new technology." } }, "required": [ "type", "entityType" ], "title": "Technology added" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_posted" }, "entityType": { "type": "string", "const": "company" }, "minReactions": { "type": [ "integer", "null" ], "minimum": 0, "description": "Only alert for posts with at least this many reactions. Omit for any." } }, "required": [ "type", "entityType" ], "title": "Company posted" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_posted_with_keyword" }, "entityType": { "type": "string", "const": "company" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Alert for posts matching these keywords." }, "minReactions": { "type": [ "integer", "null" ], "minimum": 0, "description": "Only alert for posts with at least this many reactions. Omit for any." } }, "required": [ "type", "entityType" ], "title": "Company posted with keyword" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "follower_count_growth" }, "entityType": { "type": "string", "const": "company" }, "minAbsoluteGrowth": { "type": [ "integer", "null" ], "minimum": 0, "description": "Minimum absolute follower increase to trigger. Omit or set to 0 for any increase." }, "minPercentGrowth": { "type": [ "number", "null" ], "exclusiveMinimum": 0, "description": "Minimum percent follower increase to trigger. Omit for any increase." }, "minStartingFollowerCount": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Only alert if the company had at least this many followers before the growth. Omit for any starting count." } }, "required": [ "type", "entityType" ], "title": "Follower count growth" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_name_changed" }, "entityType": { "type": "string", "const": "company" } }, "required": [ "type", "entityType" ], "title": "Company name changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_description_changed" }, "entityType": { "type": "string", "const": "company" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if new description contains one of these keywords. Omit for any change." } }, "required": [ "type", "entityType" ], "title": "Company description changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_went_inactive" }, "entityType": { "type": "string", "const": "company" } }, "required": [ "type", "entityType" ], "description": "Fires when a company becomes inactive.", "title": "Company went inactive" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "employee_count_milestone" }, "entityType": { "type": "string", "const": "company" }, "milestone": { "type": "integer", "exclusiveMinimum": 0, "description": "The employee count threshold to watch for crossing. Any positive integer is accepted. Equivalent to 'threshold' in headcount_crossed_threshold." }, "direction": { "type": "string", "enum": [ "above", "below" ], "description": "Whether to alert when crossing above or below the milestone" } }, "required": [ "type", "entityType", "milestone", "direction" ], "description": "Fires when the employee count crosses the specified value. Supports any positive integer, not just round milestones. Functionally equivalent to headcount_crossed_threshold.", "title": "Employee count milestone" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "new_office_location" }, "entityType": { "type": "string", "const": "company" }, "countries": { "type": [ "array", "null" ], "items": { "type": "string", "pattern": "^[A-Z]{3}$", "minLength": 3, "maxLength": 3 }, "minItems": 1, "description": "ISO 3166-1 alpha-3 country codes (e.g. 'USA', 'GBR', 'DEU'). Only alert for offices in these countries. Omit for any new office." }, "cities": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "City names (e.g. 'San Francisco', 'London', 'Berlin'). Only alert for offices in these cities. Omit for any new office." }, "regions": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Region codes (e.g. 'X-EMEA', 'X-APAC', 'X-EUROPE'). Expands to constituent country codes. Omit for any." }, "states": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "State or province names (e.g. 'California', 'Ontario'). Omit for any." } }, "required": [ "type", "entityType" ], "title": "New office location" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "company_logo_changed" }, "entityType": { "type": "string", "const": "company" } }, "required": [ "type", "entityType" ], "title": "Company logo changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "acquired_company" }, "entityType": { "type": "string", "const": "company" }, "minPriceUsd": { "type": [ "number", "null" ], "minimum": 0, "description": "Only alert for acquisitions above this price. Omit for any acquisition." } }, "required": [ "type", "entityType" ], "title": "Acquired company" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "new_investor" }, "entityType": { "type": "string", "const": "company" }, "investorNames": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert when a new investor's name matches one of these (exact, case-insensitive). Omit for any new investor." } }, "required": [ "type", "entityType" ], "title": "New investor" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "recently_hired_with_title" }, "entityType": { "type": "string", "const": "company" }, "titleKeywords": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Title keywords to search for. Fires when the company hires someone whose title matches any keyword." }, "minNewHires": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Minimum number of NEW hires detected in a single check cycle to trigger the alert. Only counts employees who appeared since the last check. Omit for 1." } }, "required": [ "type", "entityType", "titleKeywords" ], "title": "Recently hired with title" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "department_size_threshold" }, "entityType": { "type": "string", "const": "company" }, "department": { "type": "string", "enum": [ "Accounting", "Administrative", "Advertising", "Analyst", "Art / Creative", "Business Development", "Community & Social Services", "Consulting", "Customer Service", "Design", "Distribution", "Education", "Engineering", "Entrepreneurship", "Finance", "General Business", "Health Care Provider", "Human Resources", "Information Technology", "Legal", "Management", "Manufacturing", "Marketing", "Military & Protective Services", "Other", "Product Management", "Production", "Program & Product Management", "Project Management", "Public Relations", "Purchasing", "Quality Assurance", "Real Estate", "Research", "Sales", "Science", "Strategy / Planning", "Supply Chain", "Training", "Writing / Editing" ], "description": "Department to track. Matched against the company's organizational structure." }, "threshold": { "type": "integer", "exclusiveMinimum": 0, "description": "The employee count threshold to watch for crossing" }, "direction": { "type": "string", "enum": [ "above", "below" ], "description": "Whether to alert when department size crosses above or below the threshold" } }, "required": [ "type", "entityType", "department", "threshold", "direction" ], "title": "Department size threshold" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "recent_layoffs" }, "entityType": { "type": "string", "const": "company" }, "minPeopleAffected": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "description": "Only alert if at least this many people were laid off. Omit for any layoff." }, "minPercentAffected": { "type": [ "number", "null" ], "exclusiveMinimum": 0, "maximum": 100, "description": "Only alert if at least this percentage of the workforce was laid off. Omit for any layoff." } }, "required": [ "type", "entityType" ], "title": "Recent layoffs" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_changed_company" }, "entityType": { "type": "string", "const": "person" }, "toCompanies": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if they moved TO one of these companies (domains or slugs). Omit for any." }, "fromCompanies": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if they moved FROM one of these companies. Omit for any." }, "toTitleKeywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if their title at the new company contains one of these keywords." }, "toSeniorityLevels": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Internship", "Entry level", "Associate", "Mid-Senior level", "Director", "Executive" ] }, "minItems": 1, "description": "Only alert if their seniority at the new company is one of these levels." }, "toEmploymentTypes": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Part-time", "Contract", "Internship", "Temporary", "Volunteer" ] }, "minItems": 1, "description": "Only alert for these employment types at the new company. Omit for any." } }, "required": [ "type", "entityType" ], "title": "Person changed company" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_title_changed" }, "entityType": { "type": "string", "const": "person" }, "titleKeywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if new title contains one of these keywords. Omit for any title change." }, "toSeniority": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Internship", "Entry level", "Associate", "Mid-Senior level", "Director", "Executive" ] }, "minItems": 1, "description": "Only alert if the new position's seniority level matches one of these. Omit for any seniority." } }, "required": [ "type", "entityType" ], "title": "Person title changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_stealth_changed" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "entered", "exited", "either" ], "description": "Whether to alert on entering stealth, exiting, or either" } }, "required": [ "type", "entityType", "direction" ], "title": "Person stealth changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_open_to_work" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "started", "stopped", "either" ], "description": "Whether to alert when they start or stop signaling open-to-work" } }, "required": [ "type", "entityType", "direction" ], "title": "Person open to work" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_is_hiring" }, "entityType": { "type": "string", "const": "person" }, "direction": { "type": "string", "enum": [ "started", "stopped", "either" ], "description": "Whether to alert when they start or stop signaling is-hiring" } }, "required": [ "type", "entityType", "direction" ], "title": "Person is hiring" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_headline_changed" }, "entityType": { "type": "string", "const": "person" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert if new headline contains one of these keywords. Omit for any change." } }, "required": [ "type", "entityType" ], "title": "Person headline changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_location_changed" }, "entityType": { "type": "string", "const": "person" }, "toCountries": { "type": [ "array", "null" ], "items": { "type": "string", "pattern": "^[A-Z]{3}$", "minLength": 3, "maxLength": 3 }, "minItems": 1, "description": "ISO 3166-1 alpha-3 country codes (e.g. 'USA', 'GBR', 'DEU'). Only alert if moved to one of these countries. Omit for any relocation." }, "fromCountries": { "type": [ "array", "null" ], "items": { "type": "string", "pattern": "^[A-Z]{3}$", "minLength": 3, "maxLength": 3 }, "minItems": 1, "description": "Only alert if they moved FROM one of these countries. Omit for any." }, "regions": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Region codes (e.g. 'X-EMEA', 'X-APAC'). Only alert if destination country is in one of these regions. Omit for any." } }, "required": [ "type", "entityType" ], "title": "Person location changed" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_tag_gained" }, "entityType": { "type": "string", "const": "person" }, "tags": { "type": "array", "items": { "type": "string", "enum": [ "student", "attended-top-us-university", "attended-top-global-university", "second-time-founder", "deep-technical-background", "major-tech-company-experience", "fortune-500-executive", "recently-changed-companies", "recently-promoted", "decision-maker", "c-suite", "experienced-executive", "phd", "influencer", "board-member" ] }, "minItems": 1, "description": "Alert when the person gains any of these system-assigned tags." } }, "required": [ "type", "entityType", "tags" ], "title": "Person tag gained" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_posted" }, "entityType": { "type": "string", "const": "person" }, "minReactions": { "type": [ "integer", "null" ], "minimum": 0, "description": "Only alert for posts with at least this many reactions. Omit for any." } }, "required": [ "type", "entityType" ], "title": "Person posted" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_posted_with_keyword" }, "entityType": { "type": "string", "const": "person" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Alert for posts matching these keywords." }, "minReactions": { "type": [ "integer", "null" ], "minimum": 0, "description": "Only alert for posts with at least this many reactions. Omit for any." } }, "required": [ "type", "entityType" ], "title": "Person posted with keyword" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", "const": "person_reacted_to_post" }, "entityType": { "type": "string", "const": "person" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Only alert for reactions on posts whose content or author name matches these keywords. Omit for any reaction." }, "reactionTypes": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "LIKE", "LOVE", "INSIGHTFUL", "CELEBRATE", "SUPPORT", "FUNNY" ] }, "minItems": 1, "description": "Only alert for these reaction types. Omit for any type." } }, "required": [ "type", "entityType" ], "title": "Person reacted to post" }, { "type": "object", "properties": { "lookbackDays": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 90, "description": "Compare against a snapshot from approximately N days ago instead of the most recent prior snapshot. Omit for the default previous-snapshot comparison. Maximum 90 days." }, "isDummy": { "type": "boolean", "description": "When true, this rule only fires via the fire-dummy endpoint and is skipped during normal pipeline runs." }, "type": { "type": "string", … _truncated to 65536 chars for ai-docs._ ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "signal": { "type": "object", "properties": { "type": { "type": "string", "description": "Rule type slug (e.g. person_connections_milestone)." }, "summary": { "type": "string", "description": "Human-readable description of what changed." }, "changeData": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "description": "Structured payload describing what changed." }, "isDummy": { "type": "boolean", "enum": [ true ] } }, "required": [ "type", "summary", "changeData", "isDummy" ] } }, "required": [ "signal" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # profileCommentsLiveFetch `POST /v1/linkedin-live-fetch/profile-comments` **Tags:** `LinkedIn activity` Fetch LinkedIn profile comments **Endpoint:** `https://api.fiber.ai/v1/linkedin-live-fetch/profile-comments` ## Description 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. ⚡ Rate limit: 300 requests per 1 minute 💰 Cost: 2 credits per page of results ⓘ ⏱ Recommended timeout: 1 minute ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "identifier": { "type": "string", "description": "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/')" }, "cursor": { "type": [ "string", "null" ], "description": "Pagination cursor for fetching additional pages of comments" } }, "required": [ "apiKey", "identifier" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "comments": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "commentId": { "type": [ "string", "null" ] }, "content": { "type": [ "string", "null" ] }, "commentedAgo": { "type": [ "string", "null" ] }, "commentedAt": { "type": [ "string", "null" ] }, "commenter": { "type": [ "object", "null" ], "properties": { "linkedinUrl": { "type": [ "string", "null" ] }, "profilePicture": { "type": [ "string", "null" ] }, "entityUrn": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] } } }, "post": { "type": [ "object", "null" ], "properties": { "postUrn": { "type": [ "string", "null" ] }, "postUrl": { "type": [ "string", "null" ] }, "author": { "type": [ "object", "null" ], "properties": { "name": { "type": [ "string", "null" ] }, "linkedinUrl": { "type": [ "string", "null" ] }, "entityUrn": { "type": [ "string", "null" ] } } }, "content": { "type": [ "string", "null" ] } } } } } }, "cursor": { "type": [ "string", "null" ] } } }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # profileLiveEnrich `POST /v1/linkedin-live-fetch/profile/single` **Tags:** `Live fetch` Live fetch LinkedIn profile **Endpoint:** `https://api.fiber.ai/v1/linkedin-live-fetch/profile/single` ## Description 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. ⚡ Rate limit: 600 requests per 1 minute 💰 Cost: 2 credits per profile live fetch ⓘ ⏱ Recommended timeout: 30 seconds ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "identifier": { "type": "string", "description": "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')." }, "getDetailedEducation": { "type": [ "boolean", "null" ], "default": false, "description": "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." }, "getDetailedWorkExperience": { "type": [ "boolean", "null" ], "default": false, "description": "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." } }, "required": [ "apiKey", "identifier" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "oneOf": [ { "type": "object", "properties": { "found": { "type": "boolean", "enum": [ true ] }, "profile": { "type": "object", "properties": { "articles": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "date_published": { "type": [ "string", "null" ] } } } }, "certifications": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "credential_id": { "type": [ "string", "null" ] }, "verify_url": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "date": { "type": [ "string", "null" ] } } } }, "connection_count": { "type": [ "number", "null" ] }, "courses": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "course_number": { "type": [ "string", "null" ] }, "association": { "type": "null" } } } }, "dob": { "type": [ "string", "null" ] }, "education": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "school_id": { "type": [ "string", "null" ] }, "school_name": { "type": [ "string", "null" ] }, "field_of_study_id": { "type": [ "string", "null" ] }, "field_of_study_name": { "type": [ "string", "null" ] }, "degree": { "type": [ "string", "null" ] }, "grade": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "activities": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } } } }, "experiences": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } } }, "first_name": { "type": [ "string", "null" ] }, "follower_count": { "type": [ "number", "null" ] }, "headline": { "type": [ "string", "null" ] }, "inferred_location": { "type": [ "object", "null" ], "properties": { "street_address": { "type": [ "string", "null" ] }, "neighborhood": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "state_name": { "type": [ "string", "null" ] }, "state_code": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] }, "country_code": { "type": [ "string", "null" ] }, "country_name": { "type": [ "string", "null" ] }, "coordinates": { "type": [ "object", "null" ], "properties": { "lat": { "type": "number" }, "lon": { "type": "number" } }, "required": [ "lat", "lon" ] }, "timezone": { "type": [ "string", "null" ] }, "full_address": { "type": [ "string", "null" ] }, "formatted_address": { "type": [ "string", "null" ] } } }, "interests": { "type": [ "array", "null" ], "items": { "type": "string" } }, "last_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "patents": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "number": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "date": { "type": [ "string", "null" ] } } } }, "profile_pic": { "type": [ "string", "null" ] }, "projects": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "project_id": { "type": [ "string", "null" ] }, "project_title": { "type": [ "string", "null" ] }, "project_url": { "type": [ "string", "null" ] }, "project_summary": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] } } } }, "publications": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "collaborators": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } } } }, "date": { "type": [ "string", "null" ] }, "id": { "type": [ "string", "null" ] }, "publisher": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } } } }, "skills": { "type": [ "array", "null" ], "items": { "type": "string" } }, "primary_slug": { "type": "string" }, "slugs": { "type": [ "array", "null" ], "items": { "type": "string" } }, "summary": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "user_id": { "type": [ "string", "null" ] }, "volunteering": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "role": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "cause": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] } } } }, "tenures": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "date_range": { "type": "object", "properties": { "gte": { "type": [ "string", "null" ] }, "lte": { "type": [ "string", "null" ] } } }, "range_length_days": { "type": [ "number", "null" ] }, "titles": { "type": "array", "items": { "type": "string" } }, "localities": { "type": "array", "items": { "type": "string" } } }, "required": [ "date_range", "titles", "localities" ] } }, "career_began_at": { "type": [ "string", "null" ] }, "tags": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "student", "attended-top-us-university", "attended-top-global-university", "second-time-founder", "deep-technical-background", "major-tech-company-experience", "fortune-500-executive", "recently-changed-companies", "recently-promoted", "decision-maker", "c-suite", "experienced-executive", "phd", "influencer", "board-member" ] } }, "entity_urn": { "type": [ "string", "null" ] }, "open_to_work": { "type": [ "boolean", "null" ] }, "premium": { "type": [ "boolean", "null" ] }, "influencer": { "type": [ "boolean", "null" ] }, "organizations": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] } } } }, "entity_urns": { "type": [ "array", "null" ], "items": { "type": "string" } }, "is_hiring": { "type": [ "boolean", "null" ] }, "websites": { "type": [ "array", "null" ], "items": { "type": "string" } }, "is_verified": { "type": [ "boolean", "null" ] }, "verifications": { "type": [ "object", "null" ], "properties": { "is_verified": { "type": [ "boolean", "null" ] }, "joined_date": { "type": [ "string", "null" ] }, "verification_types": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "subtitle": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] } } } } } }, "is_top_voice": { "type": [ "boolean", "null" ] }, "current_job": { "type": [ "object", "null" ], "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } }, "custom_data": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "relevance_score": { "type": [ "number", "null" ] }, "last_sort_key": { "type": [ "string", "null" ] }, "industry_name": { "type": [ "string", "null" ] }, "last_updated_at": { "type": [ "string", "null" ] }, "languages": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "proficiency_id": { "type": [ "string", "null" ] }, "proficiency_name": { "type": [ "string", "null" ] } } } }, "detailed_education": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "school_details": { "type": [ "object", "null" ], "properties": { "linkedin_ids": { "type": [ "array", "null" ], "items": { "type": "string" } }, "li_org_id": { "type": [ "string", "null" ] }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "preferred_name": { "type": [ "string", "null" ] } } }, "school_id": { "type": [ "string", "null" ] }, "school_name": { "type": [ "string", "null" ] }, "field_of_study_id": { "type": [ "string", "null" ] }, "field_of_study_name": { "type": [ "string", "null" ] }, "degree": { "type": [ "string", "null" ] }, "grade": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "activities": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } } } }, "detailed_work_experiences": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "company_details": { "type": [ "object", "null" ], "properties": { "linkedin_ids": { "type": [ "array", "null" ], "items": { "type": "string" } }, "li_org_id": { "type": [ "string", "null" ] }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "preferred_name": { "type": [ "string", "null" ] }, "crunchbase_slug": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "standard_industries": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "li_industries": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } } } }, "required": [ "primary_slug" ] }, "isCached404": { "type": [ "boolean", "null" ], "description": "True when the profile is not found on LinkedIn but we have cached data in our database." } }, "required": [ "found", "profile" ], "title": "Profile Found and Enriched", "description": "The profile was found and enriched" }, { "type": "object", "properties": { "found": { "type": "boolean", "enum": [ false ] }, "message": { "type": "string" } }, "required": [ "found", "message" ], "title": "Profile Not Found", "description": "The profile was not found on LinkedIn. Check that the URL or identifier is still active." } ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # profilePostsLiveFetch `POST /v1/linkedin-live-fetch/profile-posts` **Tags:** `LinkedIn activity` Fetch LinkedIn profile posts **Endpoint:** `https://api.fiber.ai/v1/linkedin-live-fetch/profile-posts` ## Description 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. ⚡ Rate limit: 300 requests per 1 minute 💰 Cost: 2 credits per page of results ⓘ ⏱ Recommended timeout: 1 minute ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "identifier": { "type": "string", "description": "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/')" }, "cursor": { "type": [ "string", "null" ], "description": "Pagination cursor for fetching additional pages of posts" } }, "required": [ "apiKey", "identifier" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "postId": { "type": "string" }, "author": { "type": [ "object", "null" ], "properties": { "linkedinUrl": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "profilePicture": { "type": [ "string", "null" ] }, "linkedinSlug": { "type": [ "string", "null" ] } } }, "postedAt": { "type": [ "object", "null" ], "properties": { "noLaterThan": { "type": [ "string", "null" ] }, "noEarlierThan": { "type": [ "string", "null" ] } } }, "engagement": { "type": [ "object", "null" ], "properties": { "numComments": { "type": [ "number", "null" ] }, "numShares": { "type": [ "number", "null" ] }, "numReactions": { "type": [ "number", "null" ] }, "reactionsByType": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "numReactions": { "type": [ "number", "null" ] }, "reactionType": { "type": [ "string", "null" ], "enum": [ "LIKE", "LOVE", "INSIGHTFUL", "CELEBRATE", "SUPPORT", "FUNNY", null ], "description": "One of LinkedIn's reaction types. These match the tooltips on each of LinkedIn's six reaction buttons; for instance, 'Like' is the blue thumbs-up." } } } } } }, "imageUrls": { "type": [ "array", "null" ], "items": { "type": "string" } }, "postUrl": { "type": [ "string", "null" ] }, "video": { "type": [ "object", "null" ], "properties": { "videoUrl": { "type": [ "string", "null" ] }, "thumbnailUrl": { "type": [ "string", "null" ] } } }, "caption": { "type": [ "string", "null" ] }, "subText": { "type": [ "string", "null" ] }, "resharedPost": { "type": [ "object", "null" ], "properties": { "postId": { "type": "string" }, "author": { "type": [ "object", "null" ], "properties": { "linkedinUrl": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "profilePicture": { "type": [ "string", "null" ] }, "linkedinSlug": { "type": [ "string", "null" ] } } }, "postedAt": { "type": [ "object", "null" ], "properties": { "noLaterThan": { "type": [ "string", "null" ] }, "noEarlierThan": { "type": [ "string", "null" ] } } }, "engagement": { "type": [ "object", "null" ], "properties": { "numComments": { "type": [ "number", "null" ] }, "numShares": { "type": [ "number", "null" ] }, "numReactions": { "type": [ "number", "null" ] }, "reactionsByType": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "numReactions": { "type": [ "number", "null" ] }, "reactionType": { "type": [ "string", "null" ], "enum": [ "LIKE", "LOVE", "INSIGHTFUL", "CELEBRATE", "SUPPORT", "FUNNY", null ], "description": "One of LinkedIn's reaction types. These match the tooltips on each of LinkedIn's six reaction buttons; for instance, 'Like' is the blue thumbs-up." } } } } } }, "imageUrls": { "type": [ "array", "null" ], "items": { "type": "string" } }, "postUrl": { "type": [ "string", "null" ] }, "video": { "type": [ "object", "null" ], "properties": { "videoUrl": { "type": [ "string", "null" ] }, "thumbnailUrl": { "type": [ "string", "null" ] } } }, "caption": { "type": [ "string", "null" ] }, "subText": { "type": [ "string", "null" ] } }, "required": [ "postId" ] } }, "required": [ "postId" ] } }, "cursor": { "type": [ "string", "null" ] } }, "required": [ "data" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # profileReactionsLiveFetch `POST /v1/linkedin-live-fetch/profile-reactions` **Tags:** `LinkedIn activity` Fetch LinkedIn profile reactions **Endpoint:** `https://api.fiber.ai/v1/linkedin-live-fetch/profile-reactions` ## Description 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. ⚡ Rate limit: 300 requests per 1 minute 💰 Cost: 2 credits per page of results ⓘ ⏱ Recommended timeout: 1 minute ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "identifier": { "type": "string", "description": "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/')" }, "cursor": { "type": [ "string", "null" ], "description": "Pagination cursor for fetching additional pages of reactions" } }, "required": [ "apiKey", "identifier" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "reactions": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "reactionId": { "type": [ "string", "null" ] }, "type": { "type": [ "string", "null" ], "enum": [ "LIKE", "LOVE", "INSIGHTFUL", "CELEBRATE", "SUPPORT", "FUNNY", null ], "description": "One of LinkedIn's reaction types. These match the tooltips on each of LinkedIn's six reaction buttons; for instance, 'Like' is the blue thumbs-up." }, "target": { "type": [ "string", "null" ] }, "reactedAgo": { "type": [ "string", "null" ] }, "reactedAt": { "type": [ "string", "null" ] }, "reactor": { "type": [ "object", "null" ], "properties": { "linkedinUrl": { "type": [ "string", "null" ] }, "profilePicture": { "type": [ "string", "null" ] }, "entityUrn": { "type": [ "string", "null" ] } } }, "post": { "type": [ "object", "null" ], "properties": { "postUrn": { "type": [ "string", "null" ] }, "postUrl": { "type": [ "string", "null" ] }, "author": { "type": [ "object", "null" ], "properties": { "name": { "type": [ "string", "null" ] }, "linkedinUrl": { "type": [ "string", "null" ] }, "entityUrn": { "type": [ "string", "null" ] } } }, "content": { "type": [ "string", "null" ] } } }, "comment": { "type": [ "object", "null" ], "properties": { "content": { "type": [ "string", "null" ] }, "author": { "type": [ "object", "null" ], "properties": { "name": { "type": [ "string", "null" ] }, "linkedinUrl": { "type": [ "string", "null" ] }, "entityUrn": { "type": [ "string", "null" ] } } } } } } } }, "cursor": { "type": [ "string", "null" ] } } }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # quickCompanyResolve `POST /v1/company-resolve` **Tags:** `Search` Quickly resolve company identifiers **Endpoint:** `https://api.fiber.ai/v1/company-resolve` ## Description Resolves many company identifiers — LinkedIn slug, LinkedIn organization ID, LinkedIn company URL, or domain — to full company records in a single request. ⚡ Rate limit: 1500 requests per 1 minute 💰 Cost: 1 credit per company resolved ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "companies": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinUrl" ] }, "value": { "type": "string", "minLength": 1, "description": "LinkedIn company URL (e.g. 'https://www.linkedin.com/company/openai')." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinSlug" ] }, "value": { "type": "string", "minLength": 1, "description": "LinkedIn company slug (e.g. 'openai')." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinOrgId" ] }, "value": { "type": "string", "pattern": "^\\d+$", "minLength": 1, "description": "LinkedIn numeric organization ID (e.g. '11130470')." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "value": { "type": "string", "minLength": 1, "description": "Company website domain (e.g. 'openai.com')." } }, "required": [ "identifier", "value" ] } ] }, "minItems": 1, "maxItems": 100, "description": "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." } }, "required": [ "apiKey", "companies" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinUrl", "linkedinSlug", "linkedinOrgId", "domain" ], "description": "The identifier type you supplied, echoed back." }, "value": { "type": "string", "description": "The identifier value you supplied, echoed back." }, "found": { "type": "boolean" }, "company": { "type": [ "object", "null" ], "properties": { "linkedin_id": { "type": [ "string", "null" ] }, "accelerator_statuses": { "type": [ "array", "null" ], "items": { "type": "string" } }, "accelerators": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "slug": { "type": [ "string", "null" ] }, "tags": { "type": [ "array", "null" ], "items": { "type": "string" } }, "year": { "type": [ "number", "null" ] }, "batch": { "type": [ "string", "null" ] }, "founders": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "full_name": { "type": [ "string", "null" ] }, "bio": { "type": [ "string", "null" ] }, "job_title": { "type": [ "string", "null" ] }, "is_active": { "type": [ "boolean", "null" ] }, "email_address": { "type": [ "string", "null" ] }, "facebook_url": { "type": [ "string", "null" ] }, "twitter_handle": { "type": [ "string", "null" ] }, "linkedin_slug": { "type": [ "string", "null" ] }, "github_username": { "type": [ "string", "null" ] } } } }, "description": { "type": [ "string", "null" ] }, "one_liner": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "company_domain": { "type": [ "string", "null" ] }, "accelerator_name": { "type": [ "string", "null" ] }, "accelerator_domain": { "type": [ "string", "null" ] } } } }, "blog_urls": { "type": [ "array", "null" ], "items": { "type": "string" } }, "custom_data": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "emails": { "type": [ "array", "null" ], "items": { "type": "string" } }, "phone_numbers": { "type": [ "array", "null" ], "items": { "type": "string" } }, "employee_count_consensus": { "type": [ "object", "null" ], "properties": { "gte": { "type": [ "number", "null" ] }, "lte": { "type": [ "number", "null" ] } } }, "facebook_urls": { "type": [ "array", "null" ], "items": { "type": "string" } }, "fortune_rankings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "list": { "type": "string", "enum": [ "fortune-500-usa", "forbes-global-2000" ] }, "year": { "type": "number" }, "rank": { "type": "number" } }, "required": [ "list", "year", "rank" ] } }, "founded_on_consensus": { "type": [ "string", "null" ] }, "github_usernames": { "type": [ "array", "null" ], "items": { "type": "string" } }, "instagram_handles": { "type": [ "array", "null" ], "items": { "type": "string" } }, "latest_funding_consensus": { "type": [ "number", "null" ] }, "linkedin_slugs": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "li_org_id": { "type": [ "string", "null" ] }, "li_category": { "type": [ "string", "null" ], "enum": [ "W", "S", "C", null ] }, "li_job_posts_stats": { "type": [ "object", "null" ], "properties": { "total_count": { "type": "number" }, "seniority_stats": { "type": [ "object", "null" ], "properties": { "Entry level": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Director": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Associate": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Mid-Senior level": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Internship": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Executive": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Not Applicable": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] } }, "additionalProperties": false }, "employment_type_stats": { "type": [ "object", "null" ], "properties": { "Full-time": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Temporary": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Internship": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Contract": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Part-time": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Volunteer": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "Other": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] } }, "additionalProperties": false }, "country_location_stats": { "type": [ "object", "null" ], "properties": { "USA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GBR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "FRA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IND": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BRA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "DEU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ESP": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CAN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "AUS": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NLD": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ITA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ZAF": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BEL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CHN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "TUR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MEX": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CHE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NOR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ARE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SWE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "POL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IDN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ARG": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PRT": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "COL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CHL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PAK": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "DNK": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "JPN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NGA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SGP": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PER": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NZL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "AUT": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IRL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MYS": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BGD": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "EGY": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ISR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SAU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PHL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "FIN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "IRN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ROU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CZE": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GRC": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "HKG": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "HUN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "KEN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "MAR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "VNM": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "RUS": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "UKR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "ECU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "THA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LKA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "KOR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "BGR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "GHA": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SRB": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "TWN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "HRV": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LTU": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PRI": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SVK": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "TUN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "EST": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "VEN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CRI": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "PAN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "URY": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LBN": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "LUX": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "CYP": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "NPL": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "JOR": { "type": "object", "properties": { "count": { "type": "number" }, "fraction": { "type": "number" } }, "required": [ "count", "fraction" ] }, "SVN": { … _truncated to 65536 chars for ai-docs._ ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # quickPersonResolve `POST /v1/person-resolve` **Tags:** `Search` Quickly resolve person identifiers **Endpoint:** `https://api.fiber.ai/v1/person-resolve` ## Description Resolves many person identifiers — LinkedIn slug, numeric LinkedIn user ID, LinkedIn profile URL, or LinkedIn entity URN — to full profile records in a single request. ⚡ Rate limit: 1500 requests per 1 minute 💰 Cost: 1 credit per person resolved ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "people": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinUrl" ] }, "value": { "type": "string", "minLength": 1, "description": "LinkedIn profile URL (e.g. 'https://www.linkedin.com/in/williamhgates')." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinSlug" ] }, "value": { "type": "string", "minLength": 1, "description": "LinkedIn profile slug (e.g. 'williamhgates')." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinUserId" ] }, "value": { "type": "string", "pattern": "^\\d+$", "minLength": 1, "description": "LinkedIn numeric user ID (e.g. '251749025'). This is NOT derived from the profile URL." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "entityUrn" ] }, "value": { "type": "string", "minLength": 1, "description": "LinkedIn entity URN (e.g. 'ACoAAA8BYqEBCGLg_vT_ca6mMEqkpp9nVffJ3hc'). The opaque id LinkedIn uses internally." } }, "required": [ "identifier", "value" ] } ] }, "minItems": 1, "maxItems": 100, "description": "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." } }, "required": [ "apiKey", "people" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinUrl", "linkedinSlug", "linkedinUserId", "entityUrn" ], "description": "The identifier type you supplied, echoed back." }, "value": { "type": "string", "description": "The identifier value you supplied, echoed back." }, "found": { "type": "boolean" }, "person": { "type": [ "object", "null" ], "properties": { "articles": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "date_published": { "type": [ "string", "null" ] } } } }, "certifications": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "credential_id": { "type": [ "string", "null" ] }, "verify_url": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "date": { "type": [ "string", "null" ] } } } }, "connection_count": { "type": [ "number", "null" ] }, "courses": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "course_number": { "type": [ "string", "null" ] }, "association": { "type": "null" } } } }, "dob": { "type": [ "string", "null" ] }, "education": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "school_id": { "type": [ "string", "null" ] }, "school_name": { "type": [ "string", "null" ] }, "field_of_study_id": { "type": [ "string", "null" ] }, "field_of_study_name": { "type": [ "string", "null" ] }, "degree": { "type": [ "string", "null" ] }, "grade": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "activities": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } } } }, "experiences": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } } }, "first_name": { "type": [ "string", "null" ] }, "follower_count": { "type": [ "number", "null" ] }, "headline": { "type": [ "string", "null" ] }, "inferred_location": { "type": [ "object", "null" ], "properties": { "street_address": { "type": [ "string", "null" ] }, "neighborhood": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "state_name": { "type": [ "string", "null" ] }, "state_code": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] }, "country_code": { "type": [ "string", "null" ] }, "country_name": { "type": [ "string", "null" ] }, "coordinates": { "type": [ "object", "null" ], "properties": { "lat": { "type": "number" }, "lon": { "type": "number" } }, "required": [ "lat", "lon" ] }, "timezone": { "type": [ "string", "null" ] }, "full_address": { "type": [ "string", "null" ] }, "formatted_address": { "type": [ "string", "null" ] } } }, "interests": { "type": [ "array", "null" ], "items": { "type": "string" } }, "last_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "patents": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "number": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "date": { "type": [ "string", "null" ] } } } }, "profile_pic": { "type": [ "string", "null" ] }, "projects": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "project_id": { "type": [ "string", "null" ] }, "project_title": { "type": [ "string", "null" ] }, "project_url": { "type": [ "string", "null" ] }, "project_summary": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] } } } }, "publications": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "collaborators": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } } } }, "date": { "type": [ "string", "null" ] }, "id": { "type": [ "string", "null" ] }, "publisher": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } } } }, "skills": { "type": [ "array", "null" ], "items": { "type": "string" } }, "primary_slug": { "type": "string" }, "slugs": { "type": [ "array", "null" ], "items": { "type": "string" } }, "summary": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "user_id": { "type": [ "string", "null" ] }, "volunteering": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "role": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "cause": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] } } } }, "tenures": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "date_range": { "type": "object", "properties": { "gte": { "type": [ "string", "null" ] }, "lte": { "type": [ "string", "null" ] } } }, "range_length_days": { "type": [ "number", "null" ] }, "titles": { "type": "array", "items": { "type": "string" } }, "localities": { "type": "array", "items": { "type": "string" } } }, "required": [ "date_range", "titles", "localities" ] } }, "career_began_at": { "type": [ "string", "null" ] }, "tags": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "student", "attended-top-us-university", "attended-top-global-university", "second-time-founder", "deep-technical-background", "major-tech-company-experience", "fortune-500-executive", "recently-changed-companies", "recently-promoted", "decision-maker", "c-suite", "experienced-executive", "phd", "influencer", "board-member" ] } }, "entity_urn": { "type": [ "string", "null" ] }, "open_to_work": { "type": [ "boolean", "null" ] }, "premium": { "type": [ "boolean", "null" ] }, "influencer": { "type": [ "boolean", "null" ] }, "organizations": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] } } } }, "entity_urns": { "type": [ "array", "null" ], "items": { "type": "string" } }, "is_hiring": { "type": [ "boolean", "null" ] }, "websites": { "type": [ "array", "null" ], "items": { "type": "string" } }, "is_verified": { "type": [ "boolean", "null" ] }, "verifications": { "type": [ "object", "null" ], "properties": { "is_verified": { "type": [ "boolean", "null" ] }, "joined_date": { "type": [ "string", "null" ] }, "verification_types": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "subtitle": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] } } } } } }, "is_top_voice": { "type": [ "boolean", "null" ] }, "current_job": { "type": [ "object", "null" ], "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } }, "custom_data": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "relevance_score": { "type": [ "number", "null" ] }, "last_sort_key": { "type": [ "string", "null" ] }, "industry_name": { "type": [ "string", "null" ] }, "last_updated_at": { "type": [ "string", "null" ] }, "languages": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "proficiency_id": { "type": [ "string", "null" ] }, "proficiency_name": { "type": [ "string", "null" ] } } } }, "detailed_education": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "school_details": { "type": [ "object", "null" ], "properties": { "linkedin_ids": { "type": [ "array", "null" ], "items": { "type": "string" } }, "li_org_id": { "type": [ "string", "null" ] }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "preferred_name": { "type": [ "string", "null" ] } } }, "school_id": { "type": [ "string", "null" ] }, "school_name": { "type": [ "string", "null" ] }, "field_of_study_id": { "type": [ "string", "null" ] }, "field_of_study_name": { "type": [ "string", "null" ] }, "degree": { "type": [ "string", "null" ] }, "grade": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "activities": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } } } }, "detailed_work_experiences": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "company_details": { "type": [ "object", "null" ], "properties": { "linkedin_ids": { "type": [ "array", "null" ], "items": { "type": "string" } }, "li_org_id": { "type": [ "string", "null" ] }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "preferred_name": { "type": [ "string", "null" ] }, "crunchbase_slug": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "standard_industries": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "li_industries": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } } } }, "required": [ "primary_slug" ] } }, "required": [ "identifier", "value", "found" ] } } }, "required": [ "data" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", … _truncated to 65536 chars for ai-docs._ ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # redditPostComments `POST /v1/reddit/post/comments` **Tags:** `Reddit` Fetch post comments **Endpoint:** `https://api.fiber.ai/v1/reddit/post/comments` ## Description 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). ⚡ Rate limit: 300 requests per 1 minute 💰 Cost: 2 credits per page of results ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "postUrlOrId": { "type": "string", "minLength": 1, "description": "Full Reddit post URL/permalink or post ID (e.g. 't3_ablzuq')." }, "nextPageToken": { "type": [ "string", "null" ], "minLength": 1, "description": "Pagination token from a previous response to retrieve the next page. Omit for the first page." } }, "required": [ "apiKey", "postUrlOrId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "post": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "description": "Stable Reddit post identifier (e.g. `ablzuq`). Use this as the primary key when storing posts in a database. Pass as `t3_` to `/reddit/post/comments` to fetch comments for this post." }, "title": { "type": [ "string", "null" ], "description": "Post title." }, "author": { "type": [ "string", "null" ], "description": "Author username." }, "subreddit": { "type": [ "string", "null" ], "description": "Subreddit name." }, "bodyText": { "type": [ "string", "null" ], "description": "Post body text." }, "url": { "type": [ "string", "null" ], "description": "Content URL. For link posts this is the external URL the post points at; for text and media posts it is the post's permalink on Reddit." }, "permalink": { "type": [ "string", "null" ], "description": "Reddit discussion URL. Always points at the post's comments page on reddit.com regardless of post type." }, "score": { "type": [ "number", "null" ], "description": "Net vote score (upvotes minus downvotes, subject to Reddit vote fuzzing)." }, "upvoteRatio": { "type": [ "number", "null" ], "minimum": 0, "maximum": 1, "description": "Ratio of upvotes to total votes (0 to 1)." }, "commentCount": { "type": [ "number", "null" ], "description": "Number of comments." }, "thumbnailUrl": { "type": [ "string", "null" ], "description": "Thumbnail URL when available." }, "publishedAt": { "type": [ "string", "null" ], "description": "Publication timestamp in ISO 8601 format." }, "isVideo": { "type": [ "boolean", "null" ], "description": "True when the post contains video media." }, "isOver18": { "type": [ "boolean", "null" ], "description": "True when the post is marked NSFW." }, "isSpoiler": { "type": [ "boolean", "null" ], "description": "True when the post is marked as a spoiler." } }, "required": [ "id" ], "description": "Post metadata for the requested comment thread." }, "comments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Stable Reddit comment identifier (e.g. `ed1czme`). Use this as the primary key when storing comments in a database." }, "parentCommentId": { "type": [ "string", "null" ], "description": "Parent comment ID when this entry is a reply to another comment. Null for top-level comments (whose parent is the post). Use this field to rebuild the thread tree by grouping comments on `parentCommentId`." }, "author": { "type": [ "string", "null" ], "description": "Comment author username." }, "bodyText": { "type": [ "string", "null" ], "description": "Comment body text." }, "score": { "type": [ "number", "null" ], "description": "Net vote score (upvotes minus downvotes, subject to Reddit vote fuzzing)." }, "publishedAt": { "type": [ "string", "null" ], "description": "Comment timestamp in ISO 8601 format." }, "replyCount": { "type": [ "number", "null" ], "description": "Total number of direct replies on this comment. May exceed the number of reply entries actually present in `comments[]` when some replies are collapsed by Reddit and not included in the current page." }, "permalink": { "type": [ "string", "null" ], "description": "Canonical Reddit permalink for the comment." } }, "required": [ "id" ] }, "description": "Flat list of comments returned for the post, including replies. Each entry's `parentCommentId` is null for top-level comments and points at the parent comment's `id` for replies. The list is depth-first ordered (each top-level comment is followed by its descendants), so customers who want a tree can group on `parentCommentId`." }, "nextPageToken": { "type": [ "string", "null" ], "minLength": 1, "description": "Token to retrieve the next page of top-level comments (their nested replies are included automatically). Pass as `nextPageToken` in the next request. Null if no more pages." } }, "required": [ "comments" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # redditSearch `POST /v1/reddit/search` **Tags:** `Reddit` Search Reddit posts **Endpoint:** `https://api.fiber.ai/v1/reddit/search` ## Description 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. Queries with no matching posts return an empty list and are not charged credits. ⚡ Rate limit: 300 requests per 1 minute 💰 Cost: 2 credits per page of results ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "query": { "type": "string", "minLength": 1, "description": "Search query." }, "sort": { "type": "string", "enum": [ "relevance", "new", "top", "comment_count" ], "default": "relevance", "description": "Sort order for global Reddit post search." }, "timeframe": { "type": "string", "enum": [ "all", "day", "week", "month", "year" ], "default": "all", "description": "Time window for global search filtering." }, "nextPageToken": { "type": [ "string", "null" ], "minLength": 1, "description": "Pagination token from a previous response to retrieve the next page. Omit for the first page." } }, "required": [ "apiKey", "query" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "posts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Stable Reddit post identifier (e.g. `ablzuq`). Use this as the primary key when storing posts in a database. Pass as `t3_` to `/reddit/post/comments` to fetch comments for this post." }, "title": { "type": [ "string", "null" ], "description": "Post title." }, "author": { "type": [ "string", "null" ], "description": "Author username." }, "subreddit": { "type": [ "string", "null" ], "description": "Subreddit name." }, "bodyText": { "type": [ "string", "null" ], "description": "Post body text." }, "url": { "type": [ "string", "null" ], "description": "Content URL. For link posts this is the external URL the post points at; for text and media posts it is the post's permalink on Reddit." }, "permalink": { "type": [ "string", "null" ], "description": "Reddit discussion URL. Always points at the post's comments page on reddit.com regardless of post type." }, "score": { "type": [ "number", "null" ], "description": "Net vote score (upvotes minus downvotes, subject to Reddit vote fuzzing)." }, "upvoteRatio": { "type": [ "number", "null" ], "minimum": 0, "maximum": 1, "description": "Ratio of upvotes to total votes (0 to 1)." }, "commentCount": { "type": [ "number", "null" ], "description": "Number of comments." }, "thumbnailUrl": { "type": [ "string", "null" ], "description": "Thumbnail URL when available." }, "publishedAt": { "type": [ "string", "null" ], "description": "Publication timestamp in ISO 8601 format." }, "isVideo": { "type": [ "boolean", "null" ], "description": "True when the post contains video media." }, "isOver18": { "type": [ "boolean", "null" ], "description": "True when the post is marked NSFW." }, "isSpoiler": { "type": [ "boolean", "null" ], "description": "True when the post is marked as a spoiler." } }, "required": [ "id" ] }, "description": "Posts matching the global Reddit query." }, "nextPageToken": { "type": [ "string", "null" ], "minLength": 1, "description": "Token to retrieve the next page. Pass as `nextPageToken` in the next request. Null if no more pages." } }, "required": [ "posts" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # redditSubredditPosts `POST /v1/reddit/subreddit/posts` **Tags:** `Reddit` List subreddit posts **Endpoint:** `https://api.fiber.ai/v1/reddit/subreddit/posts` ## Description 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. ⚡ Rate limit: 300 requests per 1 minute 💰 Cost: 2 credits per page of results ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "subreddit": { "type": "string", "minLength": 1, "description": "Subreddit name (e.g. 'AskReddit'), r/ prefix form (e.g. 'r/AskReddit'), or full subreddit URL." }, "sort": { "type": "string", "enum": [ "best", "hot", "new", "top", "rising" ], "default": "hot", "description": "Sort order for subreddit posts." }, "timeframe": { "type": "string", "enum": [ "all", "day", "week", "month", "year" ], "default": "all", "description": "Time window for filtering. Only applies when `sort` is 'top'; ignored for other sort modes (which are inherently time-ordered)." }, "nextPageToken": { "type": [ "string", "null" ], "minLength": 1, "description": "Pagination token from a previous response to retrieve the next page. Omit for the first page." } }, "required": [ "apiKey", "subreddit" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "posts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Stable Reddit post identifier (e.g. `ablzuq`). Use this as the primary key when storing posts in a database. Pass as `t3_` to `/reddit/post/comments` to fetch comments for this post." }, "title": { "type": [ "string", "null" ], "description": "Post title." }, "author": { "type": [ "string", "null" ], "description": "Author username." }, "subreddit": { "type": [ "string", "null" ], "description": "Subreddit name." }, "bodyText": { "type": [ "string", "null" ], "description": "Post body text." }, "url": { "type": [ "string", "null" ], "description": "Content URL. For link posts this is the external URL the post points at; for text and media posts it is the post's permalink on Reddit." }, "permalink": { "type": [ "string", "null" ], "description": "Reddit discussion URL. Always points at the post's comments page on reddit.com regardless of post type." }, "score": { "type": [ "number", "null" ], "description": "Net vote score (upvotes minus downvotes, subject to Reddit vote fuzzing)." }, "upvoteRatio": { "type": [ "number", "null" ], "minimum": 0, "maximum": 1, "description": "Ratio of upvotes to total votes (0 to 1)." }, "commentCount": { "type": [ "number", "null" ], "description": "Number of comments." }, "thumbnailUrl": { "type": [ "string", "null" ], "description": "Thumbnail URL when available." }, "publishedAt": { "type": [ "string", "null" ], "description": "Publication timestamp in ISO 8601 format." }, "isVideo": { "type": [ "boolean", "null" ], "description": "True when the post contains video media." }, "isOver18": { "type": [ "boolean", "null" ], "description": "True when the post is marked NSFW." }, "isSpoiler": { "type": [ "boolean", "null" ], "description": "True when the post is marked as a spoiler." } }, "required": [ "id" ] }, "description": "List of subreddit posts." }, "nextPageToken": { "type": [ "string", "null" ], "minLength": 1, "description": "Token to retrieve the next page. Pass as `nextPageToken` in the next request. Null if no more pages." } }, "required": [ "posts" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # redditSubredditSearch `POST /v1/reddit/subreddit/search` **Tags:** `Reddit` Search within a subreddit **Endpoint:** `https://api.fiber.ai/v1/reddit/subreddit/search` ## Description 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. ⚡ Rate limit: 300 requests per 1 minute 💰 Cost: 2 credits per page of results ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "subreddit": { "type": "string", "minLength": 1, "description": "Subreddit name (e.g. 'AskReddit'), r/ prefix form (e.g. 'r/AskReddit'), or full subreddit URL." }, "query": { "type": "string", "minLength": 1, "description": "Search query." }, "sort": { "type": "string", "enum": [ "relevance", "hot", "top", "new", "comment_count" ], "default": "relevance", "description": "Sort order for subreddit search results." }, "timeframe": { "type": "string", "enum": [ "all", "day", "week", "month", "year" ], "default": "all", "description": "Time window for subreddit search filtering." }, "nextPageToken": { "type": [ "string", "null" ], "minLength": 1, "description": "Pagination token from a previous response to retrieve the next page. Omit for the first page." } }, "required": [ "apiKey", "subreddit", "query" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "posts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Stable Reddit post identifier (e.g. `ablzuq`). Use this as the primary key when storing posts in a database. Pass as `t3_` to `/reddit/post/comments` to fetch comments for this post." }, "title": { "type": [ "string", "null" ], "description": "Post title." }, "author": { "type": [ "string", "null" ], "description": "Author username." }, "subreddit": { "type": [ "string", "null" ], "description": "Subreddit name." }, "bodyText": { "type": [ "string", "null" ], "description": "Post body text." }, "url": { "type": [ "string", "null" ], "description": "Content URL. For link posts this is the external URL the post points at; for text and media posts it is the post's permalink on Reddit." }, "permalink": { "type": [ "string", "null" ], "description": "Reddit discussion URL. Always points at the post's comments page on reddit.com regardless of post type." }, "score": { "type": [ "number", "null" ], "description": "Net vote score (upvotes minus downvotes, subject to Reddit vote fuzzing)." }, "upvoteRatio": { "type": [ "number", "null" ], "minimum": 0, "maximum": 1, "description": "Ratio of upvotes to total votes (0 to 1)." }, "commentCount": { "type": [ "number", "null" ], "description": "Number of comments." }, "thumbnailUrl": { "type": [ "string", "null" ], "description": "Thumbnail URL when available." }, "publishedAt": { "type": [ "string", "null" ], "description": "Publication timestamp in ISO 8601 format." }, "isVideo": { "type": [ "boolean", "null" ], "description": "True when the post contains video media." }, "isOver18": { "type": [ "boolean", "null" ], "description": "True when the post is marked NSFW." }, "isSpoiler": { "type": [ "boolean", "null" ], "description": "True when the post is marked as a spoiler." } }, "required": [ "id" ] }, "description": "List of posts matching the subreddit query." }, "nextPageToken": { "type": [ "string", "null" ], "minLength": 1, "description": "Token to retrieve the next page. Pass as `nextPageToken` in the next request. Null if no more pages." } }, "required": [ "posts" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # refreshTrackerCompanyList `POST /v1/tracker/company-lists/{listId}/refresh` **Tags:** `Tracker` Refresh company tracker list **Endpoint:** `https://api.fiber.ai/v1/tracker/company-lists/{listId}/refresh` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: Credits charged per entity processed (silver/gold tier based on org volume). ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `listId` | path | yes | The unique ID of the tracker list. | ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" } }, "required": [ "apiKey" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "entityCount": { "type": "integer", "minimum": 0, "description": "Number of entities that will be processed." }, "estimatedCredits": { "type": "number", "minimum": 0, "description": "Estimated credit cost for this refresh. Actual cost may vary based on organization pricing or if tracked entities change before processing completes." }, "message": { "type": "string", "description": "Human-readable confirmation of the refresh initiation." } }, "required": [ "entityCount", "estimatedCredits", "message" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # refreshTrackerPersonList `POST /v1/tracker/person-lists/{listId}/refresh` **Tags:** `Tracker` Refresh person tracker list **Endpoint:** `https://api.fiber.ai/v1/tracker/person-lists/{listId}/refresh` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: Credits charged per entity processed (silver/gold tier based on org volume). ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `listId` | path | yes | The unique ID of the tracker list. | ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" } }, "required": [ "apiKey" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "entityCount": { "type": "integer", "minimum": 0, "description": "Number of entities that will be processed." }, "estimatedCredits": { "type": "number", "minimum": 0, "description": "Estimated credit cost for this refresh. Actual cost may vary based on organization pricing or if tracked entities change before processing completes." }, "message": { "type": "string", "description": "Human-readable confirmation of the refresh initiation." } }, "required": [ "entityCount", "estimatedCredits", "message" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # removeCompanyFromExclusionList `POST /v1/exclusions/companies/remove-from-list` **Tags:** `Exclusions` Remove company from company exclusion list **Endpoint:** `https://api.fiber.ai/v1/exclusions/companies/remove-from-list` ## Description Remove a company from a company exclusion list ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "listId": { "type": "string", "description": "The ID of the company exclusion list to remove the company from." }, "excludedCompanyDetails": { "type": "object", "properties": { "domains": { "type": [ "array", "null" ], "items": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$", "description": "A domain, like 'example.com' or 'https://example.com'" }, "default": [], "description": "Domains of the companies to remove from the exclusion list" }, "linkedinUrls": { "type": [ "array", "null" ], "items": { "type": "string", "format": "uri", "pattern": "^(https?:\\/\\/)?(\\w+\\.)?linkedin\\.\\w+(\\.\\w+)?\\/(company|company-beta|showcase|organization|school|companies)\\/(?:[^\\/\\?#]+)\\/?(\\?.*)?(#.*)?$", "description": "A LinkedIn company URL, like 'https://www.linkedin.com/company/google'" }, "default": [], "description": "LinkedIn URLs of the companies to remove from the exclusion list" } }, "description": "Details of the companies to remove from the exclusion list" } }, "required": [ "apiKey", "listId", "excludedCompanyDetails" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "deletedExcludedCompanies": { "type": "number", "description": "Number of companies removed from the exclusion list" } }, "required": [ "deletedExcludedCompanies" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # removeProspectFromExclusionList `POST /v1/exclusions/prospects/remove-from-list` **Tags:** `Exclusions` Remove prospect from prospect exclusion list **Endpoint:** `https://api.fiber.ai/v1/exclusions/prospects/remove-from-list` ## Description Remove a prospect from a prospect exclusion list ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "listId": { "type": "string", "description": "The ID of the prospect exclusion list to remove the prospect from." }, "excludedProspectDetails": { "type": "object", "properties": { "linkedinUrls": { "type": "array", "items": { "type": "string" }, "minItems": 1, "description": "LinkedIn URLs of the prospects to remove from the exclusion list" } }, "required": [ "linkedinUrls" ], "description": "Details of the prospects to remove from the exclusion list" } }, "required": [ "apiKey", "listId", "excludedProspectDetails" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "deletedExcludedProspectIds": { "type": "array", "items": { "type": "string" }, "description": "The IDs of the excluded prospects that were removed from the exclusion list." } }, "required": [ "deletedExcludedProspectIds" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # removeTrackerCompanies `DELETE /v1/tracker/company-lists/{listId}/companies` **Tags:** `Tracker` Remove companies from tracker list **Endpoint:** `https://api.fiber.ai/v1/tracker/company-lists/{listId}/companies` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | | `listId` | path | yes | The unique ID of the tracker list. | ## Request body (JSON Schema) ```json { "type": "object", "properties": { "companies": { "type": "array", "items": { "type": "object", "properties": { "linkedinUrl": { "type": [ "string", "null" ], "minLength": 1, "description": "Full LinkedIn company URL." }, "linkedinOrgId": { "type": [ "string", "null" ], "pattern": "^\\d+$", "minLength": 1, "description": "A company's stable numeric identifier. This is NOT derived from their company page URL — retrieve it from a live enrichment lookup. Digits only." }, "linkedinSlug": { "type": [ "string", "null" ], "minLength": 1, "description": "The handle in a company page URL — e.g. `microsoft` in https://www.linkedin.com/company/microsoft/." }, "domain": { "type": [ "string", "null" ], "minLength": 1, "description": "Company website domain (e.g. 'fiber.ai'). Will be resolved to the company profile identifier." } } }, "minItems": 1, "maxItems": 10000, "description": "Companies to remove. Uses the same identifier format as add-companies." } }, "required": [ "companies" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "removed": { "type": "integer", "minimum": 0, "description": "Number of companies successfully deactivated." }, "notFound": { "type": "integer", "minimum": 0, "description": "Number of identifiers not found or already inactive." }, "failedIdentifiers": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "description": "Index in the input array." }, "reason": { "type": "string", "description": "Why this company could not be removed." } }, "required": [ "index", "reason" ] }, "description": "Details on identifiers that could not be removed." } }, "required": [ "removed", "notFound", "failedIdentifiers" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # removeTrackerPeople `DELETE /v1/tracker/person-lists/{listId}/people` **Tags:** `Tracker` Remove people from tracker list **Endpoint:** `https://api.fiber.ai/v1/tracker/person-lists/{listId}/people` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `apiKey` | query | yes | Your Fiber API key | | `listId` | path | yes | The unique ID of the tracker list. | ## Request body (JSON Schema) ```json { "type": "object", "properties": { "people": { "type": "array", "items": { "type": "object", "properties": { "linkedinUrl": { "type": [ "string", "null" ], "minLength": 1, "description": "Full LinkedIn profile URL" }, "linkedinUserId": { "type": [ "string", "null" ], "pattern": "^\\d+$", "minLength": 1, "description": "A person's stable numeric identifier. This is NOT derived from their profile URL — retrieve it from a live enrichment lookup. Digits only." }, "linkedinSlug": { "type": [ "string", "null" ], "minLength": 1, "description": "The handle in a profile URL — e.g. `williamhgates` in https://www.linkedin.com/in/williamhgates/." } } }, "minItems": 1, "maxItems": 10000, "description": "People to remove. Uses the same identifier format as add-people." } }, "required": [ "people" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "removed": { "type": "integer", "minimum": 0, "description": "Number of people successfully deactivated." }, "notFound": { "type": "integer", "minimum": 0, "description": "Number of identifiers not found or already inactive." }, "failedIdentifiers": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "description": "Index in the input array." }, "reason": { "type": "string", "description": "Why this person could not be removed." } }, "required": [ "index", "reason" ] }, "description": "Details on identifiers that could not be removed." } }, "required": [ "removed", "notFound", "failedIdentifiers" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # resetApiKeyUsage `POST /v1/api-keys/usage/reset` **Tags:** `API key` Reset API key usage **Endpoint:** `https://api.fiber.ai/v1/api-keys/usage/reset` ## Description Reset an API key's lifetime usage back to zero. Acts on the key that authenticates this request unless target is OTHER. Use this after raising a key's limit, or to give a key a fresh allowance without changing its ceiling. 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. ⚡ Rate limit: 30 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "target": { "type": "string", "enum": [ "SELF", "OTHER" ], "default": "SELF", "description": "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." }, "targetApiKey": { "type": [ "string", "null" ], "minLength": 1, "description": "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." } }, "required": [ "apiKey" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "id": { "type": "string", "description": "id of your api key. This or prefix can be used to identify the key." }, "name": { "type": "string", "description": "Name of your api key." }, "prefix": { "type": "string", "description": "Non secret prefix of your api key. Used for identification." }, "expiresAt": { "type": [ "string", "null" ], "format": "date-time", "description": "When the key expires. Null implies key never expires." }, "maxCredits": { "type": [ "number", "null" ], "minimum": 0, "description": "The lifetime credit ceiling for this key. Null implies key has no per-key credit limit." }, "creditsUsed": { "type": "number", "minimum": 0, "description": "Credits consumed by this key so far over its lifetime." }, "createdAt": { "type": "string", "format": "date-time", "description": "When the key was created, as an ISO 8601 timestamp." }, "isRevoked": { "type": "boolean", "description": "Whether the key has been revoked. Revoked keys can no longer authenticate. Only ever true in listings that include revoked keys." } }, "required": [ "id", "name", "prefix", "expiresAt", "maxCredits", "creditsUsed", "createdAt", "isRevoked" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # reverseEmailLookup `POST /v1/email-to-person/single` **Tags:** `Reverse lookup` Find person by email (single) **Endpoint:** `https://api.fiber.ai/v1/email-to-person/single` ## Description 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. Billing: you are charged for one lookup operation per request — a hit bills `emailToLinkedinUrl`, a completed miss that queried providers bills `emailToLinkedinMiss`. Cached not-found results and rejected inputs are not billed. ⚡ Rate limit: 3500 requests per 1 minute 💰 Cost: 2 credits per email lookup ⓘ ⏱ Recommended timeout: 1 minute ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "email": { "type": "string", "format": "email", "minLength": 1, "description": "The email address of a person whose LinkedIn profile you want to find." } }, "required": [ "apiKey", "email" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "articles": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "date_published": { "type": [ "string", "null" ] } } } }, "certifications": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "credential_id": { "type": [ "string", "null" ] }, "verify_url": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "date": { "type": [ "string", "null" ] } } } }, "connection_count": { "type": [ "number", "null" ] }, "courses": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "course_number": { "type": [ "string", "null" ] }, "association": { "type": "null" } } } }, "dob": { "type": [ "string", "null" ] }, "education": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "school_id": { "type": [ "string", "null" ] }, "school_name": { "type": [ "string", "null" ] }, "field_of_study_id": { "type": [ "string", "null" ] }, "field_of_study_name": { "type": [ "string", "null" ] }, "degree": { "type": [ "string", "null" ] }, "grade": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "activities": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } } } }, "experiences": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } } }, "first_name": { "type": [ "string", "null" ] }, "follower_count": { "type": [ "number", "null" ] }, "headline": { "type": [ "string", "null" ] }, "inferred_location": { "type": [ "object", "null" ], "properties": { "street_address": { "type": [ "string", "null" ] }, "neighborhood": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "state_name": { "type": [ "string", "null" ] }, "state_code": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] }, "country_code": { "type": [ "string", "null" ] }, "country_name": { "type": [ "string", "null" ] }, "coordinates": { "type": [ "object", "null" ], "properties": { "lat": { "type": "number" }, "lon": { "type": "number" } }, "required": [ "lat", "lon" ] }, "timezone": { "type": [ "string", "null" ] }, "full_address": { "type": [ "string", "null" ] }, "formatted_address": { "type": [ "string", "null" ] } } }, "interests": { "type": [ "array", "null" ], "items": { "type": "string" } }, "last_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "patents": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "number": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "date": { "type": [ "string", "null" ] } } } }, "profile_pic": { "type": [ "string", "null" ] }, "projects": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "project_id": { "type": [ "string", "null" ] }, "project_title": { "type": [ "string", "null" ] }, "project_url": { "type": [ "string", "null" ] }, "project_summary": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] } } } }, "publications": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "collaborators": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } } } }, "date": { "type": [ "string", "null" ] }, "id": { "type": [ "string", "null" ] }, "publisher": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } } } }, "skills": { "type": [ "array", "null" ], "items": { "type": "string" } }, "primary_slug": { "type": "string" }, "slugs": { "type": [ "array", "null" ], "items": { "type": "string" } }, "summary": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "user_id": { "type": [ "string", "null" ] }, "volunteering": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "role": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "cause": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] } } } }, "tenures": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "date_range": { "type": "object", "properties": { "gte": { "type": [ "string", "null" ] }, "lte": { "type": [ "string", "null" ] } } }, "range_length_days": { "type": [ "number", "null" ] }, "titles": { "type": "array", "items": { "type": "string" } }, "localities": { "type": "array", "items": { "type": "string" } } }, "required": [ "date_range", "titles", "localities" ] } }, "career_began_at": { "type": [ "string", "null" ] }, "tags": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "student", "attended-top-us-university", "attended-top-global-university", "second-time-founder", "deep-technical-background", "major-tech-company-experience", "fortune-500-executive", "recently-changed-companies", "recently-promoted", "decision-maker", "c-suite", "experienced-executive", "phd", "influencer", "board-member" ] } }, "entity_urn": { "type": [ "string", "null" ] }, "open_to_work": { "type": [ "boolean", "null" ] }, "premium": { "type": [ "boolean", "null" ] }, "influencer": { "type": [ "boolean", "null" ] }, "organizations": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] } } } }, "entity_urns": { "type": [ "array", "null" ], "items": { "type": "string" } }, "is_hiring": { "type": [ "boolean", "null" ] }, "websites": { "type": [ "array", "null" ], "items": { "type": "string" } }, "is_verified": { "type": [ "boolean", "null" ] }, "verifications": { "type": [ "object", "null" ], "properties": { "is_verified": { "type": [ "boolean", "null" ] }, "joined_date": { "type": [ "string", "null" ] }, "verification_types": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "subtitle": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] } } } } } }, "is_top_voice": { "type": [ "boolean", "null" ] }, "current_job": { "type": [ "object", "null" ], "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } }, "custom_data": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "relevance_score": { "type": [ "number", "null" ] }, "last_sort_key": { "type": [ "string", "null" ] }, "industry_name": { "type": [ "string", "null" ] }, "last_updated_at": { "type": [ "string", "null" ] }, "languages": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "proficiency_id": { "type": [ "string", "null" ] }, "proficiency_name": { "type": [ "string", "null" ] } } } }, "detailed_education": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "school_details": { "type": [ "object", "null" ], "properties": { "linkedin_ids": { "type": [ "array", "null" ], "items": { "type": "string" } }, "li_org_id": { "type": [ "string", "null" ] }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "preferred_name": { "type": [ "string", "null" ] } } }, "school_id": { "type": [ "string", "null" ] }, "school_name": { "type": [ "string", "null" ] }, "field_of_study_id": { "type": [ "string", "null" ] }, "field_of_study_name": { "type": [ "string", "null" ] }, "degree": { "type": [ "string", "null" ] }, "grade": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "activities": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } } } }, "detailed_work_experiences": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "company_details": { "type": [ "object", "null" ], "properties": { "linkedin_ids": { "type": [ "array", "null" ], "items": { "type": "string" } }, "li_org_id": { "type": [ "string", "null" ] }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "preferred_name": { "type": [ "string", "null" ] }, "crunchbase_slug": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "standard_industries": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "li_industries": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } } } }, "required": [ "primary_slug" ] }, "description": "LinkedIn profiles matching this email, ordered by best match. Usually contains one result.", "default": [] }, "rejection": { "type": [ "object", "null" ], "properties": { "reason": { "type": "string", "enum": [ "disposable_or_anonymous_email", "invalid_tld", "autogenerated_icloud_email", "digits_only_username", "role_based_mailbox", "junk_username", "spam_domain", "bot_farm_email", "mailing_list" ], "description": "Machine-readable rejection reason" }, "message": { "type": "string", "description": "Human-readable explanation" } }, "required": [ "reason", "message" ], "description": "Present when the email is unresolvable (e.g. disposable, anonymous relay, or role-based address). The request succeeded but there is no person to find." } }, "required": [ "data" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # reversePhoneLookup `POST /v1/phone-to-person/single` **Tags:** `Reverse lookup` Find person or company by phone (single) **Endpoint:** `https://api.fiber.ai/v1/phone-to-person/single` ## Description Given a phone number, find the associated LinkedIn profile or company. Mobile and home phones typically resolve to people, while front desk or business phones may resolve to companies. Only charges 1 credit when a result is found. No charge for invalid numbers or misses. If you have additional identifiers (name, company, email) beyond just the phone number, use the Kitchen Sink endpoint instead for better match quality. ⚡ Rate limit: 600 requests per 1 minute 💰 Cost: 3 credits per phone lookup ⓘ ⏱ Recommended timeout: 30 seconds ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "phoneNumber": { "type": "string", "minLength": 1, "description": "The phone number to look up. Accepts E.164 format (+12125551234) or various national formats." } }, "required": [ "apiKey", "phoneNumber" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "profile" ] }, "profile": { "type": "object", "properties": { "articles": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "date_published": { "type": [ "string", "null" ] } } } }, "certifications": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "credential_id": { "type": [ "string", "null" ] }, "verify_url": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "date": { "type": [ "string", "null" ] } } } }, "connection_count": { "type": [ "number", "null" ] }, "courses": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "course_number": { "type": [ "string", "null" ] }, "association": { "type": "null" } } } }, "dob": { "type": [ "string", "null" ] }, "education": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "school_id": { "type": [ "string", "null" ] }, "school_name": { "type": [ "string", "null" ] }, "field_of_study_id": { "type": [ "string", "null" ] }, "field_of_study_name": { "type": [ "string", "null" ] }, "degree": { "type": [ "string", "null" ] }, "grade": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "activities": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } } } }, "experiences": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } } }, "first_name": { "type": [ "string", "null" ] }, "follower_count": { "type": [ "number", "null" ] }, "headline": { "type": [ "string", "null" ] }, "inferred_location": { "type": [ "object", "null" ], "properties": { "street_address": { "type": [ "string", "null" ] }, "neighborhood": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "state_name": { "type": [ "string", "null" ] }, "state_code": { "type": [ "string", "null" ] }, "county": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] }, "country_code": { "type": [ "string", "null" ] }, "country_name": { "type": [ "string", "null" ] }, "coordinates": { "type": [ "object", "null" ], "properties": { "lat": { "type": "number" }, "lon": { "type": "number" } }, "required": [ "lat", "lon" ] }, "timezone": { "type": [ "string", "null" ] }, "full_address": { "type": [ "string", "null" ] }, "formatted_address": { "type": [ "string", "null" ] } } }, "interests": { "type": [ "array", "null" ], "items": { "type": "string" } }, "last_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "patents": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "number": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "date": { "type": [ "string", "null" ] } } } }, "profile_pic": { "type": [ "string", "null" ] }, "projects": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "project_id": { "type": [ "string", "null" ] }, "project_title": { "type": [ "string", "null" ] }, "project_url": { "type": [ "string", "null" ] }, "project_summary": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] } } } }, "publications": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "collaborators": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } } } }, "date": { "type": [ "string", "null" ] }, "id": { "type": [ "string", "null" ] }, "publisher": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } } } }, "skills": { "type": [ "array", "null" ], "items": { "type": "string" } }, "primary_slug": { "type": "string" }, "slugs": { "type": [ "array", "null" ], "items": { "type": "string" } }, "summary": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "user_id": { "type": [ "string", "null" ] }, "volunteering": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "role": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "cause": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] } } } }, "tenures": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "date_range": { "type": "object", "properties": { "gte": { "type": [ "string", "null" ] }, "lte": { "type": [ "string", "null" ] } } }, "range_length_days": { "type": [ "number", "null" ] }, "titles": { "type": "array", "items": { "type": "string" } }, "localities": { "type": "array", "items": { "type": "string" } } }, "required": [ "date_range", "titles", "localities" ] } }, "career_began_at": { "type": [ "string", "null" ] }, "tags": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "student", "attended-top-us-university", "attended-top-global-university", "second-time-founder", "deep-technical-background", "major-tech-company-experience", "fortune-500-executive", "recently-changed-companies", "recently-promoted", "decision-maker", "c-suite", "experienced-executive", "phd", "influencer", "board-member" ] } }, "entity_urn": { "type": [ "string", "null" ] }, "open_to_work": { "type": [ "boolean", "null" ] }, "premium": { "type": [ "boolean", "null" ] }, "influencer": { "type": [ "boolean", "null" ] }, "organizations": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] } } } }, "entity_urns": { "type": [ "array", "null" ], "items": { "type": "string" } }, "is_hiring": { "type": [ "boolean", "null" ] }, "websites": { "type": [ "array", "null" ], "items": { "type": "string" } }, "is_verified": { "type": [ "boolean", "null" ] }, "verifications": { "type": [ "object", "null" ], "properties": { "is_verified": { "type": [ "boolean", "null" ] }, "joined_date": { "type": [ "string", "null" ] }, "verification_types": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "subtitle": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] } } } } } }, "is_top_voice": { "type": [ "boolean", "null" ] }, "current_job": { "type": [ "object", "null" ], "properties": { "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } }, "custom_data": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "relevance_score": { "type": [ "number", "null" ] }, "last_sort_key": { "type": [ "string", "null" ] }, "industry_name": { "type": [ "string", "null" ] }, "last_updated_at": { "type": [ "string", "null" ] }, "languages": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "proficiency_id": { "type": [ "string", "null" ] }, "proficiency_name": { "type": [ "string", "null" ] } } } }, "detailed_education": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "school_details": { "type": [ "object", "null" ], "properties": { "linkedin_ids": { "type": [ "array", "null" ], "items": { "type": "string" } }, "li_org_id": { "type": [ "string", "null" ] }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "preferred_name": { "type": [ "string", "null" ] } } }, "school_id": { "type": [ "string", "null" ] }, "school_name": { "type": [ "string", "null" ] }, "field_of_study_id": { "type": [ "string", "null" ] }, "field_of_study_name": { "type": [ "string", "null" ] }, "degree": { "type": [ "string", "null" ] }, "grade": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "activities": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } } } }, "detailed_work_experiences": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "company_details": { "type": [ "object", "null" ], "properties": { "linkedin_ids": { "type": [ "array", "null" ], "items": { "type": "string" } }, "li_org_id": { "type": [ "string", "null" ] }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "preferred_name": { "type": [ "string", "null" ] }, "crunchbase_slug": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "standard_industries": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "li_industries": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "linkedin_company_id": { "type": [ "string", "null" ] }, "is_current": { "type": [ "boolean", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "locality": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seniority": { "type": [ "string", "null" ], "enum": [ "Entry level", "Director", "Associate", "Mid-Senior level", "Internship", "Executive", null ] }, "job_function": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Arts and Design", "Business Development", "Community & Social Services", "Consulting", "Education", "Engineering", "Entrepreneurship", "Healthcare Services", "Human Resources", "Information Technology", "Legal", "Military & Protective Services", "Operations", "Program & Product Management", "Real Estate", "Sales", "Support", "Administrative", "Finance", "Marketing", "Purchasing", "Product Management", "Advertising", "Analyst", "Customer Service", "Distribution", "Design", "General Business", "Management", "Manufacturing", "Other", "Public Relations", "Project Management", "Production", "Quality Assurance", "Research", "Science", "Supply Chain", "Training", "Health Care Provider", "Accounting", "Art / Creative", "Strategy / Planning", "Writing / Editing" ] } }, "employment_type": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Full-time", "Temporary", "Internship", "Contract", "Part-time", "Volunteer", "Other" ] } }, "academic_qualification": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "High School", "Associate Degree", "Bachelor Degree" ] } }, "company_start_date": { "type": [ "string", "null" ] }, "company_end_date": { "type": [ "string", "null" ] } } } } … _truncated to 65536 chars for ai-docs._ ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # revokeCurrentApiKey `POST /v1/api-keys/revoke` **Tags:** `API key` Revoke API key **Endpoint:** `https://api.fiber.ai/v1/api-keys/revoke` ## Description Permanently revoke an API key. Acts on the key that authenticates this request unless target is OTHER. The key stops working immediately and cannot be restored. Create a replacement sandbox key via POST /v1/api-keys/create-sandbox, or a live key from the dashboard, before revoking a key that is still in use. 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. ⚡ Rate limit: 30 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "target": { "type": "string", "enum": [ "SELF", "OTHER" ], "default": "SELF", "description": "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." }, "targetApiKey": { "type": [ "string", "null" ], "minLength": 1, "description": "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." } }, "required": [ "apiKey" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "revoked": { "type": "boolean", "description": "Revocation status of the key." }, "id": { "type": "string", "description": "The identifier of the revoked key." } }, "required": [ "revoked", "id" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # rotateWebhookEndpointSecret `POST /v1/webhooks/endpoints/{endpointId}/rotate-secret` **Tags:** `Webhooks` Rotate webhook signing secret **Endpoint:** `https://api.fiber.ai/v1/webhooks/endpoints/{endpointId}/rotate-secret` ## Description 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. ⚡ Rate limit: 60 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `endpointId` | path | yes | The unique ID of the webhook endpoint. | ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" } }, "required": [ "apiKey" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "endpointId": { "type": "string", "description": "The ID of the webhook endpoint whose secret was rotated." }, "signingSecret": { "type": "string", "description": "The new signing secret. Store it securely — it will not be shown again." } }, "required": [ "endpointId", "signingSecret" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # sendTestWebhookEvent `POST /v1/webhooks/endpoints/{endpointId}/test-event` **Tags:** `Webhooks` Send test webhook event **Endpoint:** `https://api.fiber.ai/v1/webhooks/endpoints/{endpointId}/test-event` ## Description 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. ⚡ Rate limit: 60 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `endpointId` | path | yes | The unique ID of the webhook endpoint. | ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "eventType": { "type": "string", "enum": [ "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" ], "description": "The event type to send an example payload for. Retrieve available event types from the webhook event types endpoint." } }, "required": [ "apiKey", "eventType" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "endpointId": { "type": "string", "description": "The ID of the endpoint the test event was sent to." }, "eventType": { "type": "string", "description": "The event type of the test event." }, "messageId": { "type": "string", "description": "The ID of the test message, useful for tracing the delivery." } }, "required": [ "endpointId", "eventType", "messageId" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # skillsTypeahead `POST /v1/typeahead/skills` **Tags:** `Typeaheads` Skills Typeahead **Endpoint:** `https://api.fiber.ai/v1/typeahead/skills` ## Description Search for professional skills by name. Supports prefix and partial matches with relevance-based ranking. Useful for building autocomplete in search UIs. ⚡ Rate limit: 240 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "query": { "type": "string", "minLength": 1, "description": "Search query for skill names. Supports prefix and partial matches." } }, "required": [ "apiKey", "query" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "array", "items": { "type": "object", "properties": { "skill": { "type": "string", "minLength": 1, "description": "The skill name" }, "rank": { "type": "integer", "exclusiveMinimum": 0, "description": "Relevance rank within this result set (1 = best match)" } }, "required": [ "skill", "rank" ] } }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # skipNextSavedSearchRun `POST /v1/saved-search/skip-next-run` **Tags:** `Saved search` Skip next saved search auto-run **Endpoint:** `https://api.fiber.ai/v1/saved-search/skip-next-run` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: FREE! No credits are charged for this API. ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "savedSearchId": { "type": "string", "minLength": 1, "description": "The ID of the saved search to skip the next auto-run for" } }, "required": [ "apiKey", "savedSearchId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "id": { "type": "string", "description": "The saved search ID" }, "skipUntil": { "type": "string", "description": "The date until which auto-runs are suppressed. After this date passes, the saved search resumes its normal schedule." } }, "required": [ "id", "skipUntil" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # slushieRun `POST /v1/nlp-search/run` **Tags:** `Agentic search` Natural language search **Endpoint:** `https://api.fiber.ai/v1/nlp-search/run` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: Fixed costs per request (first page only):• 2 credits for AI search interpretationVariable costs per result:• 1 credits per company returned• 1 credits per profile returned ⓘ ⏱ Recommended timeout: 1 minute ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "query": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 5000, "description": "Natural language search query. Required on the first request. Ignored when pageToken is provided." }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 25, "description": "Number of results per page (1-1000). Applied to whichever result type is returned." }, "companyExclusionListIDs": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "description": "IDs of exclusion lists to filter out companies. Applied when returning companies, or to narrow company-based profile filtering." }, "peopleExclusionListIDs": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "description": "IDs of exclusion lists to filter out people." }, "pageToken": { "type": [ "string", "null" ], "description": "Pagination token from a previous response. Pass the value of nextPageToken from the prior response." }, "getDetailedEducation": { "type": [ "boolean", "null" ], "description": "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." }, "getDetailedWorkExperience": { "type": [ "boolean", "null" ], "description": "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." } }, "required": [ "apiKey" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "searchId": { "type": "string", "description": "Unique identifier for this search session. Stable across paginated requests — all pages share the same searchId." }, "parsedParams": { "oneOf": [ { "type": "object", "properties": { "queryType": { "type": "string", "enum": [ "structuredSearch" ] }, "companySearchParams": { "type": [ "object", "null" ], "properties": { "exactCompanyV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "domain": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$" } }, "required": [ "identifier", "domain" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/(www\\.)?linkedin\\.com\\/company\\/[a-zA-Z0-9-]+\\/?.*$" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-org-id" ] }, "org_id": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "identifier", "org_id" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "advanced" ] }, "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string", "minLength": 1 }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "identifier", "li_org_id" ] } ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "domain": { "type": "string", "pattern": "^(https?:\\/\\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(\\/.*)?$" } }, "required": [ "identifier", "domain" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/(www\\.)?linkedin\\.com\\/company\\/[a-zA-Z0-9-]+\\/?.*$" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-org-id" ] }, "org_id": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "identifier", "org_id" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "advanced" ] }, "linkedin_id": { "type": [ "string", "null" ] }, "li_org_id": { "type": "string", "minLength": 1 }, "preferred_name": { "type": [ "string", "null" ] }, "names": { "type": [ "array", "null" ], "items": { "type": "string" } }, "linkedin_primary_slug": { "type": [ "string", "null" ] }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "logo_url": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ], "enum": [ "csv", null ] } }, "required": [ "identifier", "li_org_id" ] } ] } } } }, "domains": { "type": [ "array", "null" ], "items": { "type": "string" } }, "headquartersCountryCode": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } } } }, "headquartersStateName": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string" } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "employeeCountV2": { "type": [ "object", "null" ], "properties": { "lowerBoundExclusive": { "type": [ "integer", "null" ], "minimum": 0 }, "upperBoundInclusive": { "type": [ "integer", "null" ], "minimum": 0 } } }, "keywords": { "type": [ "object", "null" ], "properties": { "containsAll": { "type": [ "array", "null" ], "items": { "type": "string" } }, "containsAny": { "type": [ "array", "null" ], "items": { "type": "string" } }, "containsNone": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "industriesV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } }, "allOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Administrative Services", "Aerospace & Military", "Artificial Intelligence", "Arts & Music", "Automotive", "Business Services", "Cloud", "Construction", "Consulting", "Consumer Goods", "Consumer Services", "Design", "Education", "Energy", "Entertainment", "Environmental", "Events", "Farming & Agriculture", "Finance", "Food & Beverage", "Gaming", "Government", "Hardware", "Healthcare", "Hospitality", "Industrials", "Information Technology", "Insurance", "Legal", "Life Sciences", "Logistics", "Manufacturing", "Marketing & Advertising", "Media", "Mining", "Nonprofit", "Publishing", "Real Estate", "Retail", "Science & Engineering", "Security", "Software", "Sports", "Telecom", "Trade", "Transportation", "Travel & Tourism", "Utilities", "Venture Capital" ] } } } }, "stage": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "acquired", "public", "closed", "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "series_i", "series_j", "venture_other", "private_equity", "unknown", "no_funding_yet" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "acquired", "public", "closed", "pre_seed", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "series_i", "series_j", "venture_other", "private_equity", "unknown", "no_funding_yet" ] } } } }, "totalFundingUSD": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "lastFundingUSD": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "lastFundedOn": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ] }, "foundedOn": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] … _truncated to 65536 chars for ai-docs._ ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # socialMediaLookupBatchPolling `POST /v1/social-media-lookup/batch/poll` **Tags:** `Social media lookup` Poll batch social media lookup **Endpoint:** `https://api.fiber.ai/v1/social-media-lookup/batch/poll` ## Description Poll for the results of a batch social media lookup. Returns partial results as they become available, with overall progress statistics. ⚡ Rate limit: 240 requests per 1 minute ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "runId": { "type": "string", "description": "The ID of the batch run returned by the batch trigger endpoint." }, "nextPageToken": { "type": [ "string", "null" ], "description": "Token from the previous response to fetch the next page. Omit for the first page." }, "pageSize": { "type": "number", "minimum": 1, "maximum": 100, "default": 50, "description": "Number of results to return per page (default 50, max 100)." } }, "required": [ "apiKey", "runId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "in_progress", "completed", "failed" ], "description": "Current status of the batch run." }, "overallStats": { "type": "object", "properties": { "totalPeople": { "type": "integer", "minimum": 0, "description": "Total number of people in this batch." }, "numCompleted": { "type": "integer", "minimum": 0, "description": "Number of people whose lookup has completed (success or no-match)." }, "numFailed": { "type": "integer", "minimum": 0, "description": "Number of people whose lookup failed (insufficient info, error)." }, "numRemaining": { "type": "integer", "minimum": 0, "description": "Number of people still being processed." } }, "required": [ "totalPeople", "numCompleted", "numFailed", "numRemaining" ], "description": "Summary statistics for the entire batch." }, "results": { "type": "array", "items": { "type": "object", "properties": { "fullName": { "type": "string", "description": "The full name of the person this result corresponds to." }, "customerProvidedId": { "type": [ "string", "null" ], "description": "The external ID echoed back from the input for joining results to your original dataset." }, "outcome": { "type": [ "string", "null" ], "enum": [ "FOUND_CANDIDATES", "NO_CANDIDATES_FOUND", "INSUFFICIENT_INFORMATION", null ], "description": "Overall outcome: FOUND_CANDIDATES if at least one profile was found, NO_CANDIDATES_FOUND if the search returned nothing, INSUFFICIENT_INFORMATION if there was not enough input to search." }, "candidates": { "type": "array", "items": { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TWITTER", "LINKEDIN", "INSTAGRAM", "FACEBOOK", "TIKTOK", "YOUTUBE", "THREADS", "PINTEREST", "BLUESKY", "TWITCH", "ASK_FM", "STEAM", "MEDIUM", "YELP", "TRIPADVISOR", "DISCORD", "OTHER" ], "description": "The social media platform this candidate is for." }, "handle": { "type": "string", "description": "The handle or username on that platform, without any @ prefix (e.g. 'karpathy')." }, "profileUrl": { "type": [ "string", "null" ], "format": "uri", "description": "Full URL to the profile on that platform (e.g. 'https://x.com/karpathy')." }, "displayName": { "type": [ "string", "null" ], "description": "The display name shown on the profile." }, "bio": { "type": [ "string", "null" ], "description": "Profile bio or description." }, "location": { "type": [ "string", "null" ], "description": "Location as displayed on the profile." }, "followerCount": { "type": [ "integer", "null" ], "minimum": 0, "description": "Number of followers on that platform." }, "isVerified": { "type": [ "boolean", "null" ], "description": "Whether the account is verified on that platform." }, "confidenceOutOf10": { "type": "integer", "minimum": 0, "maximum": 10, "description": "Confidence score from 0 to 10. Higher scores indicate a stronger match." }, "rationale": { "type": [ "string", "null" ], "description": "The AI reasoning for why this profile was selected as the best match." } }, "required": [ "platform", "handle", "confidenceOutOf10" ] }, "description": "The best-match profiles found, one per platform. Empty if no confident matches were found." }, "errorMessage": { "type": [ "string", "null" ], "description": "Error message if the lookup failed for this person. Null on success." } }, "required": [ "fullName", "candidates" ] }, "description": "One entry per person on this page." }, "nextPageToken": { "type": [ "string", "null" ], "description": "Token for the next page of results. Null when there are no more results." } }, "required": [ "status", "overallStats", "results" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # socialMediaLookupBatchTrigger `POST /v1/social-media-lookup/batch/trigger` **Tags:** `Social media lookup` Start batch social media lookup (X, Instagram) **Endpoint:** `https://api.fiber.ai/v1/social-media-lookup/batch/trigger` ## Description 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. ⚡ Rate limit: 10 requests per 1 minute 💰 Cost: 3 credits per platform searched per person ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "overallContext": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 1000, "description": "Optional context about this batch to help disambiguation (e.g. 'AI startup founders'). Applied to all people in the batch." }, "platforms": { "type": "array", "items": { "type": "string", "enum": [ "TWITTER", "INSTAGRAM" ] }, "minItems": 1, "default": [ "TWITTER" ], "description": "Which social media platforms to search. Defaults to Twitter/X." }, "people": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "customerProvidedId": { "type": [ "string", "null" ], "description": "Your external ID for this person, echoed back in the response for joining results to your dataset." }, "inputType": { "type": "string", "enum": [ "linkedinUrl" ] }, "linkedinUrl": { "type": "string", "minLength": 1, "description": "LinkedIn profile URL, slug, or entity URN (e.g. https://www.linkedin.com/in/karpathy or just 'karpathy')." } }, "required": [ "inputType", "linkedinUrl" ] }, { "type": "object", "properties": { "customerProvidedId": { "type": [ "string", "null" ], "description": "Your external ID for this person, echoed back in the response for joining results to your dataset." }, "inputType": { "type": "string", "enum": [ "linkedinUserId" ] }, "linkedinUserId": { "type": "string", "pattern": "^\\d+$", "minLength": 1, "description": "LinkedIn numeric user ID for this person." } }, "required": [ "inputType", "linkedinUserId" ] }, { "type": "object", "properties": { "customerProvidedId": { "type": [ "string", "null" ], "description": "Your external ID for this person, echoed back in the response for joining results to your dataset." }, "inputType": { "type": "string", "enum": [ "manual" ] }, "fullName": { "type": "string", "minLength": 1, "maxLength": 256, "description": "The full name of the person to look up." }, "company": { "type": [ "string", "null" ], "minLength": 1, "description": "Current company, used to disambiguate common names." }, "jobTitle": { "type": [ "string", "null" ], "minLength": 1, "description": "Current job title." }, "workEmail": { "type": [ "string", "null" ], "format": "email", "description": "Work email address." }, "linkedinUrl": { "type": [ "string", "null" ], "format": "uri", "description": "LinkedIn profile URL for additional context (e.g. https://www.linkedin.com/in/karpathy)." } }, "required": [ "inputType", "fullName" ] } ] }, "minItems": 1, "maxItems": 100, "description": "Array of people to look up (1-100). Each person can be identified by LinkedIn URL, LinkedIn user ID, or manual name+context." } }, "required": [ "apiKey", "people" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "runId": { "type": "string", "description": "The ID of this batch run. Provide to the batch polling endpoint to get results." }, "numPeopleEnqueued": { "type": "integer", "minimum": 0, "description": "Number of people enqueued for lookup after deduplication." }, "numDuplicatesSkipped": { "type": "integer", "minimum": 0, "description": "Number of duplicate people skipped (same LinkedIn profile submitted multiple times)." } }, "required": [ "runId", "numPeopleEnqueued", "numDuplicatesSkipped" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # socialMediaLookupPolling `POST /v1/social-media-lookup/polling` **Tags:** `Social media lookup` Poll social media lookup **Endpoint:** `https://api.fiber.ai/v1/social-media-lookup/polling` ## Description Poll for the results of a social media lookup task. ⚡ Rate limit: 300 requests per 1 minute ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "socialMediaFinderRunId": { "type": "string", "description": "The ID of the social media finder run returned by the trigger endpoint." }, "cursor": { "type": [ "string", "null" ], "description": "Cursor from the previous response to fetch the next page. Omit for the first page." }, "pageSize": { "type": "number", "minimum": 1, "maximum": 100, "default": 10, "description": "Number of results to return per page." } }, "required": [ "apiKey", "socialMediaFinderRunId" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "in_progress", "completed", "failed" ], "description": "Current status of the lookup run: pending, in_progress, completed, or failed." }, "data": { "type": "array", "items": { "type": "object", "properties": { "fullName": { "type": "string", "description": "The full name of the person this result corresponds to." }, "customerProvidedId": { "type": [ "string", "null" ], "description": "The external ID echoed back from the input for joining results to your original dataset." }, "outcome": { "type": [ "string", "null" ], "enum": [ "FOUND_CANDIDATES", "NO_CANDIDATES_FOUND", "INSUFFICIENT_INFORMATION", null ], "description": "Overall outcome: FOUND_CANDIDATES if at least one profile was found, NO_CANDIDATES_FOUND if the search returned nothing, INSUFFICIENT_INFORMATION if there was not enough input to search." }, "candidates": { "type": "array", "items": { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TWITTER", "LINKEDIN", "INSTAGRAM", "FACEBOOK", "TIKTOK", "YOUTUBE", "THREADS", "PINTEREST", "BLUESKY", "TWITCH", "ASK_FM", "STEAM", "MEDIUM", "YELP", "TRIPADVISOR", "DISCORD", "OTHER" ], "description": "The social media platform this candidate is for." }, "handle": { "type": "string", "description": "The handle or username on that platform, without any @ prefix (e.g. 'karpathy')." }, "profileUrl": { "type": [ "string", "null" ], "format": "uri", "description": "Full URL to the profile on that platform (e.g. 'https://x.com/karpathy')." }, "displayName": { "type": [ "string", "null" ], "description": "The display name shown on the profile." }, "bio": { "type": [ "string", "null" ], "description": "Profile bio or description." }, "location": { "type": [ "string", "null" ], "description": "Location as displayed on the profile." }, "followerCount": { "type": [ "integer", "null" ], "minimum": 0, "description": "Number of followers on that platform." }, "isVerified": { "type": [ "boolean", "null" ], "description": "Whether the account is verified on that platform." }, "confidenceOutOf10": { "type": "integer", "minimum": 0, "maximum": 10, "description": "Confidence score from 0 to 10. Higher scores indicate a stronger match." }, "rationale": { "type": [ "string", "null" ], "description": "The AI reasoning for why this profile was selected as the best match." } }, "required": [ "platform", "handle", "confidenceOutOf10" ] }, "description": "The best-match profiles found, one per platform. Empty if no confident matches were found." }, "errorMessage": { "type": [ "string", "null" ], "description": "Error message if the lookup failed for this person. Null on success." } }, "required": [ "fullName", "candidates" ] }, "description": "The lookup results for each person in this run." }, "nextCursor": { "type": [ "string", "null" ], "description": "Cursor for the next page of results. Null if there are no more results." }, "hasMore": { "type": "boolean", "description": "Whether there are more results to fetch." } }, "required": [ "status", "data", "hasMore" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # socialMediaLookupTrigger `POST /v1/social-media-lookup/trigger` **Tags:** `Social media lookup` Start social media lookup **Endpoint:** `https://api.fiber.ai/v1/social-media-lookup/trigger` ## Description 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. ⚡ Rate limit: 300 requests per 1 minute 💰 Cost: 3 credits per platform searched ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "overallContext": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 1000, "description": "Optional context about the person to help disambiguation (e.g. \"AI researcher at OpenAI\"). Useful for common names. Max 1000 characters." }, "platforms": { "type": "array", "items": { "type": "string", "enum": [ "TWITTER", "INSTAGRAM" ] }, "minItems": 1, "default": [ "TWITTER" ], "description": "Which social media platforms to search. Defaults to Twitter. Supported: TWITTER, INSTAGRAM." }, "person": { "oneOf": [ { "type": "object", "properties": { "customerProvidedId": { "type": [ "string", "null" ], "description": "Your external ID for this person, echoed back in the response for joining results to your dataset." }, "inputType": { "type": "string", "enum": [ "linkedinUrl" ] }, "linkedinUrl": { "type": "string", "minLength": 1, "description": "LinkedIn profile URL, slug, or entity URN (e.g. https://www.linkedin.com/in/karpathy or just 'karpathy')." } }, "required": [ "inputType", "linkedinUrl" ] }, { "type": "object", "properties": { "customerProvidedId": { "type": [ "string", "null" ], "description": "Your external ID for this person, echoed back in the response for joining results to your dataset." }, "inputType": { "type": "string", "enum": [ "linkedinUserId" ] }, "linkedinUserId": { "type": "string", "pattern": "^\\d+$", "minLength": 1, "description": "LinkedIn numeric user ID for this person." } }, "required": [ "inputType", "linkedinUserId" ] }, { "type": "object", "properties": { "customerProvidedId": { "type": [ "string", "null" ], "description": "Your external ID for this person, echoed back in the response for joining results to your dataset." }, "inputType": { "type": "string", "enum": [ "manual" ] }, "fullName": { "type": "string", "minLength": 1, "maxLength": 256, "description": "The full name of the person to look up." }, "company": { "type": [ "string", "null" ], "minLength": 1, "description": "Current company, used to disambiguate common names." }, "jobTitle": { "type": [ "string", "null" ], "minLength": 1, "description": "Current job title." }, "workEmail": { "type": [ "string", "null" ], "format": "email", "description": "Work email address." }, "linkedinUrl": { "type": [ "string", "null" ], "format": "uri", "description": "LinkedIn profile URL for additional context (e.g. https://www.linkedin.com/in/karpathy)." } }, "required": [ "inputType", "fullName" ] } ], "description": "The person to look up." } }, "required": [ "apiKey", "person" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "socialMediaFinderRunId": { "type": "string", "description": "The ID of the social media finder run. Provide this to the polling endpoint to get results." } }, "required": [ "socialMediaFinderRunId" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # standardizeCompany `POST /v1/standardize/company/single` **Tags:** `Repair Data` Standardize LinkedIn company identifier **Endpoint:** `https://api.fiber.ai/v1/standardize/company/single` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: 1 credit per company standardized ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "identifier": { "type": "string", "minLength": 1, "description": "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')." } }, "required": [ "apiKey", "identifier" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "linkedinUrl": { "type": "string", "description": "The standardized LinkedIn company URL (e.g., 'https://www.linkedin.com/company/microsoft')" }, "name": { "type": [ "string", "null" ], "description": "The company name, if available" }, "websiteUrl": { "type": [ "string", "null" ], "description": "The company's website URL, if available" } }, "required": [ "linkedinUrl" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # standardizeCompanyBulk `POST /v1/standardize/company/bulk` **Tags:** `Repair Data` Bulk standardize LinkedIn company identifiers **Endpoint:** `https://api.fiber.ai/v1/standardize/company/bulk` ## Description 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. ⚡ Rate limit: 60 requests per 1 minute 💰 Cost: 1 credit per company standardized ⓘ ⏱ Recommended timeout: 2 minutes ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "identifiers": { "type": "array", "items": { "type": "string", "minLength": 1, "description": "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')." }, "minItems": 1, "maxItems": 50, "description": "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." } }, "required": [ "apiKey", "identifiers" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "companiesFound": { "type": "array", "items": { "type": "object", "properties": { "linkedinUrl": { "type": "string", "description": "The standardized LinkedIn company URL (e.g., 'https://www.linkedin.com/company/microsoft')" }, "name": { "type": [ "string", "null" ], "description": "The company name, if available" }, "websiteUrl": { "type": [ "string", "null" ], "description": "The company's website URL, if available" }, "identifier": { "type": "string", "minLength": 1, "description": "The input identifier this result was resolved from (slug, organization ID, or URL as provided in the request)." } }, "required": [ "linkedinUrl", "identifier" ] }, "maxItems": 50, "description": "Successfully resolved companies. Use the `identifier` field to match each result back to your input; ordering is not guaranteed." }, "unresolvedIdentifiers": { "type": "array", "items": { "type": "string" }, "description": "Input identifiers that could not be resolved to a LinkedIn company. Reflects the deduplicated set — equivalent identifiers submitted more than once appear at most once." } }, "required": [ "companiesFound", "unresolvedIdentifiers" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # standardizeProfile `POST /v1/standardize/profile/single` **Tags:** `Repair Data` Standardize LinkedIn profile entity URN **Endpoint:** `https://api.fiber.ai/v1/standardize/profile/single` ## Description 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...'). ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: 1 credit per profile standardization ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "identifier": { "type": "string", "minLength": 1, "description": "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'." } }, "required": [ "apiKey", "identifier" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "linkedinUrl": { "type": "string", "description": "The resolved LinkedIn profile URL (e.g., 'https://www.linkedin.com/in/williamhgates')" }, "fullName": { "type": [ "string", "null" ], "description": "The person's full name, if available" } }, "required": [ "linkedinUrl" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # startBatchContactDetails `POST /v1/contact-details/batch/start` **Tags:** `Contact details` Start batch contact details **Endpoint:** `https://api.fiber.ai/v1/contact-details/batch/start` ## Description Starts fetching contact details for multiple people (up to 2000) in batch. This is an asynchronous task; use the polling endpoint to check progress and get results. ⚡ Rate limit: 30 requests per 1 minute 💰 Cost: Pay only for the data you request:• 5 credits for all phone numbers AND all emails• 2 credits for work email only• 2 credits for personal email only• 3 credits for phone only ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "personDetails": { "type": "array", "items": { "type": "object", "properties": { "linkedinUrl": { "type": "object", "properties": { "value": { "type": "string", "pattern": "^(?:https?:\\/\\/)?(?:[a-z]+\\.)?linkedin\\.[a-z]{2,}\\/(?:in|sales\\/lead|talent\\/profile)\\/(?:[^/\\\\?,#]+)\\/?(?:[\\?,#].*)?", "description": "A LinkedIn URL, like 'https://www.linkedin.com/in/jake'" } }, "required": [ "value" ] } }, "required": [ "linkedinUrl" ] }, "minItems": 1, "maxItems": 2000 }, "enrichmentTypes": { "type": "object", "properties": { "getWorkEmails": { "type": "boolean", "default": true }, "getPersonalEmails": { "type": "boolean", "default": true }, "getPhoneNumbers": { "type": "boolean", "default": true } }, "description": "The types of contact information to request for each person. Credits are charged per selected type.", "default": { "getWorkEmails": true, "getPersonalEmails": true, "getPhoneNumbers": true } } }, "required": [ "apiKey", "personDetails" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "taskId": { "type": "string", "minLength": 1, "description": "The task ID. Use this to poll for results." }, "numPeopleEnqueued": { "type": "integer", "exclusiveMinimum": 0, "description": "The total number of people queued for enrichment." }, "numDuplicatesSkipped": { "type": [ "integer", "null" ], "description": "The number of duplicate people found in the input list. Duplicates are skipped and not charged." } }, "required": [ "taskId", "numPeopleEnqueued" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # startBatchLiveEnrich `POST /v1/linkedin-live-fetch/batch/start` **Tags:** `Live fetch` Start batch live enrichment **Endpoint:** `https://api.fiber.ai/v1/linkedin-live-fetch/batch/start` ## Description 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. ⚡ Rate limit: 30 requests per 1 minute 💰 Cost: 2 credits per live fetch ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "type": { "type": "string", "enum": [ "PROFILE", "COMPANY" ], "description": "Whether to enrich people or companies" }, "identifiers": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "maxItems": 10000, "description": "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')." } }, "required": [ "apiKey", "type", "identifiers" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "taskId": { "type": "string", "description": "Use this ID to poll for progress via the poll endpoint." }, "type": { "type": "string", "enum": [ "PROFILE", "COMPANY" ] }, "numIdentifiersEnqueued": { "type": "integer", "minimum": 0, "description": "Number of unique identifiers queued for enrichment" }, "numDuplicatesSkipped": { "type": "integer", "minimum": 0, "description": "Number of duplicate identifiers skipped." }, "numMalformed": { "type": "integer", "minimum": 0, "description": "Number of identifiers that could not be parsed. numIdentifiersEnqueued + numDuplicatesSkipped + numMalformed = length of your input." } }, "required": [ "taskId", "type", "numIdentifiersEnqueued", "numDuplicatesSkipped", "numMalformed" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # startDepthChart `POST /v1/depth-chart/start` **Tags:** `Company info` Start depth chart generation **Endpoint:** `https://api.fiber.ai/v1/depth-chart/start` ## Description 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. ⚡ Rate limit: 30 requests per 1 minute 💰 Cost: 8 credits per depth chart report ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "company": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinUrl" ] }, "value": { "type": "string", "minLength": 1, "description": "LinkedIn company URL (e.g. 'https://www.linkedin.com/company/openai')." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinSlug" ] }, "value": { "type": "string", "minLength": 1, "description": "LinkedIn company slug (e.g. 'openai')." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedinOrgId" ] }, "value": { "type": "string", "pattern": "^\\d+$", "minLength": 1, "description": "LinkedIn numeric organization ID (e.g. '11130470')." } }, "required": [ "identifier", "value" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "domain" ] }, "value": { "type": "string", "minLength": 1, "description": "Company website domain (e.g. 'openai.com')." } }, "required": [ "identifier", "value" ] } ], "description": "Company identifier. Set identifier to 'linkedinUrl', 'linkedinSlug', 'linkedinOrgId', or 'domain' and provide the corresponding value." }, "functions": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "maxItems": 30, "description": "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." } }, "required": [ "apiKey", "company" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "reportId": { "type": "string", "description": "Unique report ID. Poll /depth-chart/poll with this ID to check status and retrieve results." } }, "required": [ "reportId" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # startLocalBusinessSearch `POST /v1/local-business-search/start` **Tags:** `AI research` Start Local business AI search **Endpoint:** `https://api.fiber.ai/v1/local-business-search/start` ## Description 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. ⚡ Rate limit: 10 requests per 1 minute 💰 Cost: 4 credits per company ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "companies": { "type": "array", "items": { "type": "object", "properties": { "companyName": { "type": "string", "description": "The name of the company to search for." }, "companyWebsite": { "type": [ "string", "null" ], "description": "The website URL of the company." }, "companyCity": { "type": [ "string", "null" ], "description": "The city where the company is located." }, "companyState": { "type": [ "string", "null" ], "description": "The state where the company is located." }, "companyCountryName": { "type": [ "string", "null" ], "description": "The country of the company." }, "companyCountryCode": { "type": [ "string", "null" ], "description": "The ISO 3166-1 alpha-2 country code." }, "companyAddress": { "type": [ "string", "null" ], "description": "The address of the company." }, "context": { "type": [ "string", "null" ], "description": "Additional context about the company. Helps distinguish between companies with similar names." } }, "required": [ "companyName" ] }, "description": "The companies to search for." }, "jobTitles": { "type": [ "array", "null" ], "items": { "type": "string", "minLength": 1, "maxLength": 50 }, "maxItems": 6, "description": "Job titles to search for at each company (e.g. ['CEO', 'Owner']). Omit or null to skip person search." }, "strictJobTitleMatch": { "type": "boolean", "default": false, "description": "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)." }, "contactPreferences": { "type": "object", "properties": { "companyEmails": { "type": "boolean", "default": true, "description": "Fetch emails found on the company website" }, "companyPhones": { "type": "boolean", "default": true, "description": "Fetch phone numbers found on the company website" }, "personEmails": { "type": "boolean", "default": true, "description": "Fetch work/personal emails of people found via job title search" }, "personPhones": { "type": "boolean", "default": true, "description": "Fetch phone numbers of people found via job title search" } }, "default": {}, "description": "Controls which contact data to fetch for all companies in this payload." } }, "required": [ "apiKey", "companies" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "researchRunId": { "type": "string", "description": "Run ID for the local business agent run. Use this ID to poll the result of the run." } }, "required": [ "researchRunId" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # startMosaic `POST /v1/mosaic/start` **Tags:** `Repair Data` Start Mosaic CSV healing **Endpoint:** `https://api.fiber.ai/v1/mosaic/start` ## Description 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. ⚡ Rate limit: 20 requests per 1 minute 💰 Cost: Credits are charged after the file is parsed inside the background job. Cost is based on the number of billable rows plus any optional enrichments (contact details, company details) you enable. The first Mosaic run for an organization may be a free trial (first 1,000 rows free; overage billed against normal credits). ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "sourceUrl": { "type": "string", "format": "uri", "description": "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." }, "customInstructions": { "type": [ "string", "null" ], "description": "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\"." }, "options": { "type": [ "object", "null" ], "properties": { "contactInfo": { "type": [ "object", "null" ], "properties": { "getWorkEmails": { "type": "boolean", "default": true }, "getPersonalEmails": { "type": "boolean", "default": true }, "getPhoneNumbers": { "type": "boolean", "default": true } }, "description": "Which kinds of contact info to reveal per row — work email, personal email, and/or phone — independently selectable. Omit to skip contact reveal entirely. When enabled, adds the matching contact-reveal operation(s) per billable row." }, "includeCompanyDetails": { "type": "boolean", "default": false, "description": "When true, enriches each person's current employer with funding, offices, headcount, and related company fields. Adds the company lookup operation per billable row." }, "liveFetch": { "type": "boolean", "default": true, "description": "When true, runs live profile fetch and web-search slug recovery when the enrichment plan calls for it. Bundled into the base Mosaic row charge — no separate operation. When false, the engine skips gated live-fetch steps only." }, "runRedline": { "type": "boolean", "default": false, "description": "When true, compares enriched output against your input columns to flag staleness or mismatches. No separate billing operation." }, "maxRows": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "maximum": 20000, "description": "Cap how many input rows are processed and billed for this run (maximum 20,000). Useful for trial runs or cost control." } }, "description": "Feature toggles that control billing and enrichment (contact info, company details, live fetch, redline, max rows)." } }, "required": [ "apiKey", "sourceUrl" ] } ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "runId": { "type": "string", "description": "Unique Mosaic run ID. Poll /mosaic/poll with this ID to check status and retrieve results." }, "isFreeTrialRun": { "type": "boolean", "description": "True when this run used the organization's one-time free Mosaic trial. The first 1,000 rows are free; rows beyond that are billed against normal credits." } }, "required": [ "runId", "isFreeTrialRun" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # stealthFoundersCount `POST /v1/stealth-founders/count` **Tags:** `Stealth` Count stealth/ex-stealth founders **Endpoint:** `https://api.fiber.ai/v1/stealth-founders/count` ## Description Count profiles matching stealth founder filters. Uses the same filters as the stealth founders search endpoint but returns only the total count. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: 1 credit per request ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "stealthConfig": { "oneOf": [ { "type": "object", "properties": { "mode": { "type": "string", "description": "Find people currently in stealth. Optional enteredStealthAt narrows by entry date.", "enum": [ "in-stealth" ] }, "enteredStealthAt": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "integer", "null" ], "minimum": 0 }, "upperBound": { "type": [ "integer", "null" ], "minimum": 0 } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ], "description": "Date selection for when people entered stealth. Supports absolute or relative windows." } }, "required": [ "mode" ], "additionalProperties": false }, { "type": "object", "properties": { "mode": { "type": "string", "description": "Find people who recently exited stealth. leftStealthAt defaults to the last year when omitted.", "enum": [ "left-stealth" ] }, "enteredStealthAt": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "integer", "null" ], "minimum": 0 }, "upperBound": { "type": [ "integer", "null" ], "minimum": 0 } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ], "description": "Optional date selection for when people entered stealth." }, "leftStealthAt": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "integer", "null" ], "minimum": 0 }, "upperBound": { "type": [ "integer", "null" ], "minimum": 0 } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ], "default": { "strategy": "relative", "window": { "method": "within", "period": "year", "lowerBound": 0, "upperBound": 1 } }, "description": "Date selection for when people exited stealth. Defaults to the last year when omitted." } }, "required": [ "mode" ], "additionalProperties": false } ], "description": "Stealth mode configuration. Use in-stealth for current stealth founders, or left-stealth for exited stealth founders." }, "searchParams": { "type": "object", "properties": { "country3LetterCode": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "USA", "GBR", "FRA", "IND", "BRA", "DEU", "ESP", "CAN", "AUS", "NLD", "ITA", "ZAF", "BEL", "CHN", "TUR", "MEX", "CHE", "NOR", "ARE", "SWE", "POL", "IDN", "ARG", "PRT", "COL", "CHL", "PAK", "DNK", "JPN", "NGA", "SGP", "PER", "NZL", "AUT", "IRL", "MYS", "BGD", "EGY", "ISR", "SAU", "PHL", "FIN", "IRN", "ROU", "CZE", "GRC", "HKG", "HUN", "KEN", "MAR", "VNM", "RUS", "UKR", "ECU", "THA", "LKA", "KOR", "BGR", "GHA", "SRB", "TWN", "HRV", "LTU", "PRI", "SVK", "TUN", "EST", "VEN", "CRI", "PAN", "URY", "LBN", "LUX", "CYP", "NPL", "JOR", "SVN", "MTQ", "QAT", "GLP", "UGA", "DZA", "GTM", "CMR", "LVA", "DOM", "AZE", "GEO", "SEN", "TZA", "ZWE", "KWT", "MLT", "OMN", "BOL", "SLV", "ARM", "PRY", "IRQ", "KHM", "BIH", "AGO", "BHR", "ALB", "KAZ", "CIV", "ETH", "MUS", "ZMB", "MKD", "COD", "BLR", "MOZ", "REU", "TTO", "GUF", "ISL", "MMR", "HND", "RWA", "MDG", "BEN", "UZB", "NAM", "BWA", "MDA", "JEY", "NIC", "SDN", "JAM", "IMN", "BFA", "MNG", "MNE", "MCO", "TGO", "AFG", "LBY", "XKX", "CYM", "MWI", "SOM", "PNG", "MDV", "MLI", "GIN", "PSE", "GAB", "LIE", "HTI", "SYR", "BRB", "YEM", "GGY", "NCL", "AND", "SUR", "MYT", "KGZ", "BHS", "GIB", "COG", "FJI", "BLM", "CUW", "CUB", "SLE", "BLZ", "NER", "LBR", "VIR", "PYF", "GUM", "MRT", "ABW", "SYC", "GUY", "LSO", "SWZ", "SSD", "LCA", "MAC", "SMR", "LAO", "BRN", "TCD", "BMU", "VGB", "PRK", "BTN", "BDI", "FRO", "TJK", "GMB", "STP", "ANT", "VCT", "DJI", "CPV", "TKM", "ATG", "TCA", "KNA", "GRD", "ASM", "VUT", "GNQ", "GRL", "SXM", "MNP", "COM", "TLS", "SJM", "CAF", "DMA", "MAF", "WSM", "BES", "MHL", "AIA", "TON", "COK", "SLB", "SPM", "GNB", "ATA", "TUV", "ALA", "IOT", "ERI", "PLW", "FSM", "NRU", "PCN", "FLK", "MSR", "VAT", "KIR", "SHN", "NIU", "WLF", "HMD", "CXR", "NFK", "ATF", "CCK", "SGS", "BVT", "UMI", "ESH", "TKL", "X-SOUTH_ASIA", "X-SOUTH_EAST_EUROPE", "X-NORTHERN_AFRICA", "X-PACIFIC", "X-SOUTH_WEST_EUROPE", "X-SOUTHERN_AFRICA", "X-WEST_INDIES", "X-SOUTH_AMERICA", "X-SOUTH_WEST_ASIA", "X-CENTRAL_EUROPE", "X-EASTERN_EUROPE", "X-WESTERN_EUROPE", "X-CENTRAL_AMERICA", "X-WESTERN_AFRICA", "X-SOUTH_ATLANTIC_OCEAN", "X-SOUTH_EAST_ASIA", "X-CENTRAL_AFRICA", "X-NORTH_AMERICA", "X-EAST_ASIA", "X-NORTHERN_EUROPE", "X-EASTERN_AFRICA", "X-SOUTHERN_INDIAN_OCEAN", "X-SOUTHERN_EUROPE", "X-CENTRAL_ASIA", "X-NORTHERN_ASIA", "X-ASIA", "X-EUROPE", "X-AFRICA", "X-OCEANIA", "X-AMERICAS", "X-ANTARCTICA", "X-ATLANTIC_OCEAN", "X-INDIAN_OCEAN", "X-MIDDLE_EAST", "X-MENA", "X-EMEA", "X-EUROPEAN_UNION", "X-EFTA", "X-APAC", "X-LATAM", "X-ANGLOSPHERE", "X-DACH", "X-NORDICS", "X-BENELUX", "X-GCC", "X-BRICS", "X-G20", "X-OECD", "X-SANCTIONED" ] } } } }, "numConnections": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "numFollowers": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "approxAge": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } } }, "keywords": { "type": [ "object", "null" ], "properties": { "containsAll": { "type": [ "array", "null" ], "items": { "type": "string" } }, "containsAny": { "type": [ "array", "null" ], "items": { "type": "string" } }, "containsNone": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "keywordsV2": { "type": [ "object", "null" ], "properties": { "operator": { "type": "string", "enum": [ "AND", "OR" ], "default": "AND" }, "clauses": { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "AND", "OR" ], "default": "OR" }, "terms": { "type": "array", "items": { "type": "string" }, "minItems": 1 }, "negate": { "type": "boolean", "default": false } }, "required": [ "terms" ] }, "minItems": 1 }, "options": { "type": [ "object", "null" ], "properties": { "fieldsToSearchOver": { "type": [ "object", "null" ], "properties": { "summary": { "type": "boolean", "default": true }, "headline": { "type": "boolean", "default": true }, "pastJobTitles": { "type": "boolean", "default": true }, "pastJobSummaries": { "type": "boolean", "default": true }, "pastCompanyNames": { "type": "boolean", "default": true }, "currentJobTitles": { "type": "boolean", "default": true }, "currentJobSummaries": { "type": "boolean", "default": true }, "currentCompanyNames": { "type": "boolean", "default": true }, "interests": { "type": "boolean", "default": true }, "skills": { "type": "boolean", "default": true }, "industry": { "type": "boolean", "default": true }, "education": { "type": "boolean", "default": true }, "publications": { "type": "boolean", "default": true }, "certifications": { "type": "boolean", "default": true }, "articles": { "type": "boolean", "default": true }, "courses": { "type": "boolean", "default": true }, "projects": { "type": "boolean", "default": true }, "patents": { "type": "boolean", "default": true }, "volunteering": { "type": "boolean", "default": false }, "languages": { "type": "boolean", "default": false } } } } } }, "required": [ "clauses" ] }, "keywordSearchOptions": { "type": [ "object", "null" ], "properties": { "fieldsToSearchOver": { "type": [ "object", "null" ], "properties": { "summary": { "type": "boolean", "default": true }, "headline": { "type": "boolean", "default": true }, "pastJobTitles": { "type": "boolean", "default": true }, "pastJobSummaries": { "type": "boolean", "default": true }, "pastCompanyNames": { "type": "boolean", "default": true }, "currentJobTitles": { "type": "boolean", "default": true }, "currentJobSummaries": { "type": "boolean", "default": true }, "currentCompanyNames": { "type": "boolean", "default": true }, "interests": { "type": "boolean", "default": true }, "skills": { "type": "boolean", "default": true }, "industry": { "type": "boolean", "default": true }, "education": { "type": "boolean", "default": true }, "publications": { "type": "boolean", "default": true }, "certifications": { "type": "boolean", "default": true }, "articles": { "type": "boolean", "default": true }, "courses": { "type": "boolean", "default": true }, "projects": { "type": "boolean", "default": true }, "patents": { "type": "boolean", "default": true }, "volunteering": { "type": "boolean", "default": false }, "languages": { "type": "boolean", "default": false } } } } }, "jobTitleV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "term" ] }, "term": { "type": "string" } }, "required": [ "type", "term" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "static-groups" ] }, "groups": { "type": "array", "items": { "type": "string", "enum": [ "founder", "c-suite", "board-member" ] } } }, "required": [ "type", "groups" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dynamic-groups" ] }, "groups": { "type": "array", "items": { "type": "string", "enum": [ "vp", "director", "management", "entry-level", "assistant", "intern" ] } }, "keywords": { "type": "array", "items": { "type": "string" }, "default": [] } }, "required": [ "type", "groups" ] } ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "term" ] }, "term": { "type": "string" } }, "required": [ "type", "term" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "static-groups" ] }, "groups": { "type": "array", "items": { "type": "string", "enum": [ "founder", "c-suite", "board-member" ] } } }, "required": [ "type", "groups" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dynamic-groups" ] }, "groups": { "type": "array", "items": { "type": "string", "enum": [ "vp", "director", "management", "entry-level", "assistant", "intern" ] } }, "keywords": { "type": "array", "items": { "type": "string" }, "default": [] } }, "required": [ "type", "groups" ] } ] } }, "allOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "term" ] }, "term": { "type": "string" } }, "required": [ "type", "term" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "static-groups" ] }, "groups": { "type": "array", "items": { "type": "string", "enum": [ "founder", "c-suite", "board-member" ] } } }, "required": [ "type", "groups" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dynamic-groups" ] }, "groups": { "type": "array", "items": { "type": "string", "enum": [ "vp", "director", "management", "entry-level", "assistant", "intern" ] } }, "keywords": { "type": "array", "items": { "type": "string" }, "default": [] } }, "required": [ "type", "groups" ] } ] } } } }, "exactProfileV2": { "type": [ "object", "null" ], "properties": { "anyOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-slug" ] }, "linkedin_slug": { "type": "string", "minLength": 1 } }, "required": [ "identifier", "linkedin_slug" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-user-id" ] }, "user_id": { "type": "string", "pattern": "^[0-9]+$", "minLength": 1 } }, "required": [ "identifier", "user_id" ] } ] } }, "noneOf": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-slug" ] }, "linkedin_slug": { "type": "string", "minLength": 1 } }, "required": [ "identifier", "linkedin_slug" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-url" ] }, "linkedin_url": { "type": "string", "format": "uri" } }, "required": [ "identifier", "linkedin_url" ] }, { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "linkedin-user-id" ] }, "user_id": { "type": "string", "pattern": "^[0-9]+$", "minLength": 1 } }, "required": [ "identifier", "user_id" ] } ] } } } }, "startedInRole": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ] }, "startedAtCompany": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "lastN" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "quantity": { "type": "number", "minimum": 1 } }, "required": [ "method", "period", "quantity" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "number", "null" ] }, "upperBound": { "type": [ "number", "null" ] } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ] }, "location": { "type": [ "object", "null" ], "properties": { "unionAll": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "radial-distance" ] }, "center": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] }, "latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "longitude": { "type … _truncated to 65536 chars for ai-docs._ ``` ## Response — success (JSON Schema) ```json { "type": "object", "properties": { "output": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "description": "Total number of profiles matching this stealth query." } }, "required": [ "count" ] }, "chargeInfo": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-now" ] }, "creditsCharged": { "type": "number" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged" ], "description": "Credits were charged immediately for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charging-later" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "Credits will be charged after the operation completes" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "charged-for-async-process" ] }, "creditsCharged": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsCharged", "message" ], "description": "Credits that were charged for an asynchronous operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "free" ] }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "message" ], "description": "No credits were charged for this operation" }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "credits-refunded" ] }, "creditsRefunded": { "type": "number" }, "message": { "type": "string" }, "lowCreditAlert": { "type": [ "object", "null" ], "properties": { "getMoreCreditsUrl": { "type": "string", "format": "uri", "description": "URL to top up credits or restart billing cycle to get fresh credits." }, "message": { "type": "string", "description": "Human-readable credits warning." }, "availableCredits": { "type": "number", "description": "Number of credits remaining in the current billing period." } }, "required": [ "getMoreCreditsUrl", "message", "availableCredits" ], "description": "Contains a link to get more credits, a warning message, and the remaining credit count." } }, "required": [ "method", "creditsRefunded", "message" ], "description": "Credits were refunded for this operation" } ] }, "warnings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')" }, "message": { "type": "string", "description": "Warning message" } }, "required": [ "field", "message" ] }, "description": "Warnings about extraneous fields in request" }, "advice": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Tips, recommendations, and suggestions for using this API effectively." } }, "required": [ "output", "chargeInfo" ], "additionalProperties": false } ``` --- Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json) Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md) --- > **For AI agents:** this page is a focused, LLM-optimized view of a > single Fiber AI operation. Before calling it, fetch the routing > instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation > index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md). # stealthFoundersSearch `POST /v1/stealth-founders/search` **Tags:** `Stealth` Search stealth/ex-stealth founders **Endpoint:** `https://api.fiber.ai/v1/stealth-founders/search` ## Description 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. ⚡ Rate limit: 120 requests per 1 minute 💰 Cost: 1 credit per profile found ⓘ ## Request body (JSON Schema) ```json { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Your Fiber API key" }, "stealthConfig": { "oneOf": [ { "type": "object", "properties": { "mode": { "type": "string", "description": "Find people currently in stealth. Optional enteredStealthAt narrows by entry date.", "enum": [ "in-stealth" ] }, "enteredStealthAt": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "integer", "null" ], "minimum": 0 }, "upperBound": { "type": [ "integer", "null" ], "minimum": 0 } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar" ] }, "which": { "type": "string", "enum": [ "current", "previous" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] } }, "required": [ "method", "which", "period" ] }, { "type": "null" } ] } }, "required": [ "strategy" ] }, { "type": "null" } ], "description": "Date selection for when people entered stealth. Supports absolute or relative windows." } }, "required": [ "mode" ], "additionalProperties": false }, { "type": "object", "properties": { "mode": { "type": "string", "description": "Find people who recently exited stealth. leftStealthAt defaults to the last year when omitted.", "enum": [ "left-stealth" ] }, "enteredStealthAt": { "oneOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "absolute" ] }, "range": { "type": [ "object", "null" ], "properties": { "lowerBound": { "type": [ "string", "null" ] }, "upperBound": { "type": [ "string", "null" ] } } } }, "required": [ "strategy" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "relative" ] }, "window": { "oneOf": [ { "type": "object", "properties": { "method": { "type": "string", "enum": [ "within" ] }, "period": { "type": "string", "enum": [ "day", "week", "month", "quarter", "year" ] }, "lowerBound": { "type": [ "integer", "null" ], "minimum": 0 }, "upperBound": { "type": [ "integer", "null" ], "minimum": 0 } }, "required": [ "method", "period" ] }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "calendar"