{ "openapi": "3.1.0", "x-zeroclick-navigation": { "fullSpec": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/openapi.json", "services": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/services", "serviceSpecTemplate": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/services/{slug}/openapi.json", "searchTemplate": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/openapi.json?q={text}", "operationTemplate": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/openapi.json?path={path}&method={method}", "firstPage": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/openapi.json?page=1", "instructions": [ "Use this spec if it contains the operation and details you need. Otherwise, search or open a relevant service spec using the links below.", "Find service slugs in x-zeroclick-services or x-payment-info.rates[].service; use them in serviceSpecTemplate, never as request values.", "URL-encode template values. Search is ranked; service, path, and method filters are exact. Filters combine.", "Pages contain up to 10 operations; follow info.x-next or the Link header if you need more results. Shared operations retain all selector values." ] }, "info": { "title": "Pubrio", "version": "1.0.0", "description": "Pubrio detects when companies enter new markets and returns the company and people data behind each move. Expansion signals (local hiring, new offices and entities, localized ads, news, cloud hosting) are typed, dated and tied to evidence across 200+ markets, with strong coverage of Asia-Pacific and other markets that Western-built datasets miss. The graph covers 800M+ companies and 560M+ contacts from 50+ local data sources, refreshed daily. Search companies, people, job postings, news, ads and cloud footprints with filters or a plain-language query; look up records by domain, LinkedIn URL or Pubrio id; find lookalike companies and people; read hiring, news, advertising and cloud insights for one company; and reveal verified work emails, personal emails and phone numbers. Each call costs the number of credits listed on its endpoint. This server is a pay-per-use, transparent proxy in front of Pubrio's own API: it handles identity, payment, and proxying. Agents can purchase autonomously or with their human's approval. The complete verified paid surface is listed at /openapi.json, the source of truth for available operations. Each operation here carries its live price in x-payment-info. Use the operations and details here when they meet your needs. Filtered specs contain only matching operations; if you cannot find what you need here, use search or the service catalog. The live catalog at /manifest.json is authoritative for prices and any free included units (prices[].includedUnits) - some meters include free usage per account before any charge, reserved for agents claimed by a human with a verified email.", "contact": { "email": "support@pubrio.com" }, "x-guidance": "This is a filtered API reference. Request and response schemas are preserved. Shared operations retain selector values and prices for all their services; service slugs are pricing labels, never request values. If this spec lacks what you need, use the navigation links to search or open a relevant service spec." }, "x-service-info": { "docs": { "homepage": "https://www.pubrio.com", "apiReference": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/openapi.json", "llms": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/llms.txt" } }, "externalDocs": { "url": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/llms-full.txt", "description": "How to authenticate, pay, and call this API; links the upstream API reference." }, "servers": [ { "url": "https://agents.pubrio.com/zcj/1a9mcogbgy5u", "description": "Pay-per-use access to Pubrio's API" } ], "security": [ { "payPerUse": [] } ], "components": { "securitySchemes": { "payPerUse": { "type": "apiKey", "in": "header", "name": "x-payment", "description": "Pay-per-use access. An unpaid call returns 402 Payment Required with a signed challenge; settle it with a supported payment method (x402 or MPP today) and retry with the proof in this header (x402) or as Authorization: Payment (MPP; use ZC-Agent-Authorization for a separate buyer bearer). No upstream API key is needed, and an agent without a payment method can set one up instantly at no cost." }, "sellerAgentX402": { "type": "apiKey", "in": "header", "name": "Payment-Signature", "description": "Signed $0 x402 proof from the 402 challenge" }, "sellerAgentMpp": { "type": "http", "scheme": "Payment", "description": "Signed $0 MPP proof from the 402 challenge" } }, "schemas": { "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref0": { "type": "array", "items": { "type": "string" }, "example": [ "TW", "AE", "NO" ], "description": "Country codes the results must target. Combines with `filter_conditions` as OR by default — a result matches if it targets any of them." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref1": { "type": "array", "items": { "type": "string" }, "example": [ "IS", "GB", "FR", "IE", "ES" ], "description": "Country codes the results must not target. Combines with `filter_conditions` as OR by default — a result matches if it targets any of them." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref2": { "type": "array", "items": { "type": "string" }, "example": [ "pubrio" ], "description": "A list of strings over which we want to filter the results." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref3": { "type": "array", "items": { "type": "string" }, "example": [ "ASUS", "iPhone" ], "description": "A list of headlines to filter search results." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref4": { "type": "array", "items": { "type": "object", "properties": { "key": { "enum": [ "target_locations", "publisher_platforms" ], "type": "string", "example": "target_locations", "description": "The filter key specifying which property to apply the operator to." }, "operator": { "enum": [ "or", "and" ], "type": "string", "example": "or", "description": "The logical operator to apply. Use 'or' to match advertisements carrying any of the listed values, or 'and' to require all of them." } } }, "description": "Advanced filtering options for advertisement searches. Specify conditions to refine your search results for the ads search endpoint." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref5": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-01", "2025-12-01" ], "description": "A list of start dates to filter search results." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref6": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-25", "2025-12-25" ], "description": "A list of end dates to filter search results." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref7": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2026-08-01", "2026-08-31" ], "maxItems": 2, "minItems": 2, "description": "Inclusive `[from, to]` window (UTC). Returns ads running at any point in it, including ones that started earlier, so it reconciles with Advertisement Insights. Undated ads count from `created_at`. Both dates required, `from` ≤ `to`." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref8": { "type": "string", "format": "date-time", "example": "2026-09-02T12:00:00Z", "description": "Ingested at or after this instant (UTC). Date or ISO timestamp. For incremental syncs pass the `created_at` of your newest stored row." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref9": { "type": "array", "items": { "type": "string" }, "example": [ "US", "SG", "CN" ], "description": "The location of the company headquarters. Check out `location` endpoints under the Filters tab for more information." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref10": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A list of unique identifiers (domain_search_id) used for company and people search operations." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref11": { "type": "string", "format": "uuid", "example": "a92643e8-9033-4029-aa65-ef929327cebb", "description": "A unique identifier for the advertisement search result. Used to reference specific advertisements returned from the ads search endpoint." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref12": { "type": "array", "items": { "type": "string" }, "example": [ "pubrio.com" ], "description": "List of company domains used for company and people search operations. If we receive a URL such as `www.pubrio.com` or `https://docs.pubrio.com/`, the system will convert it to `pubrio.com` for processing." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref13": { "type": "array", "items": { "type": "string" }, "example": [ "https://www.linkedin.com/company/pubrio" ], "description": "The fully formed URL of the LinkedIn company profile. URL begin with `http` and contain `linkedin.com/company/`" }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref14": { "type": "boolean", "default": false, "example": true, "description": "Opt into realtime enrichment for a single, company-scoped query (filtered by `domain_search_id`, `domains`, or `linkedin_urls`). When the initial search returns zero results, the endpoint scrapes the source, persists the records, and re-runs the search before responding. Subject to a per-route deadline." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref15": { "type": "array", "items": { "enum": [ "image", "video", "text", "carousel", "dynamic_product", "document", "message", "event", "article", "spotlight", "follow", "job", "engagement" ], "type": "string" }, "example": [ "image", "video" ], "description": "Find companies with at least one advertisement in any of these creative formats." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref16": { "type": "array", "items": { "enum": [ "lt_1k", "1k_10k", "10k_50k", "50k_100k", "100k_500k", "500k_1m", "1m_plus" ], "type": "string" }, "example": [ "100k_500k", "500k_1m", "1m_plus" ], "description": "Impression band of the ad: `lt_1k`, `1k_10k`, `10k_50k`, `50k_100k`, `100k_500k`, `500k_1m`, `1m_plus`. Ads without a `total_impressions` value never match; unknown slugs match nothing." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref17": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum count of the company's currently active advertisements, across all countries. Use `null` for an open-ended bound, e.g. `[1, null]` for \"at least one active ad\"." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref18": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum count of the company's advertisements that are still running (no end date, or an end date in the future). Currently populated for LinkedIn ads only." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref19": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 10, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum count of the company's total advertisements ever recorded, across all countries." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref20": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 2, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum number of distinct ad platforms (linkedin, facebook, google, tiktok, apple) the company is actively advertising on." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref21": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 2, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum number of distinct advertisement creative formats the company is actively running." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref22": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1000, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum estimated advertisement impressions, summed across all countries. Only advertisements with a reported impression range are counted." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref23": { "type": "object", "example": { "rank": [ null, 500 ], "country": "US" }, "required": [ "country" ], "properties": { "rank": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ null, 500 ], "maxItems": 2, "minItems": 2, "description": "Rank within that country by advertising volume. 1 is the biggest spender, and the number increases as advertising volume decreases. Use `[null, 500]` to find the top 500 biggest spenders in that country; use `[500, null]` to find everyone ranked 500th or lower." }, "country": { "type": "string", "example": "US", "description": "ISO 3166-1 alpha-2 country code to scope this filter to. Required." }, "last_seen": { "type": "array", "items": { "type": "string", "format": "date", "nullable": true }, "example": [ "2026-07-01", null ], "maxItems": 2, "minItems": 2, "description": "[from, to] window for when the company's most recent ad in this country ran, for the opposite question: who has gone quiet in a market." }, "total_ads": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 10, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum total advertisements, scoped to this country." }, "active_ads": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum active advertisements, scoped to this country." }, "first_seen": { "type": "array", "items": { "type": "string", "format": "date", "nullable": true }, "example": [ "2026-07-01", null ], "maxItems": 2, "minItems": 2, "description": "[from, to] window for when the company's earliest ad in this country ran — the \"newly entered this market\" filter. Either bound may be null for an open-ended window; dates use the request timezone. A company whose ads carry no start date has no first-seen value and is never reported as new." }, "percentile": { "type": "array", "items": { "type": "number", "nullable": true }, "example": [ 90, null ], "maxItems": 2, "minItems": 2, "description": "Percentile within that country by advertising volume, 0-100. Higher means a bigger spender. Use `[90, null]` for the top 10% of spenders in that country." }, "impressions": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1000, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum estimated impressions, scoped to this country." }, "running_ads": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum running advertisements, scoped to this country. Currently populated for LinkedIn ads only." }, "volume_score": { "type": "array", "items": { "type": "number", "nullable": true }, "example": [ 0.5, null ], "maxItems": 2, "minItems": 2, "description": "The underlying 0-1 advertising volume score that `rank` and `percentile` are both computed from." } }, "description": "Advertising activity for one specific country. `country` is required, and at least one other field must be set (a country by itself matches nothing). For an all-country total instead, use the top-level `advertisement_active_ads` / `advertisement_total_ads` / `advertisement_impressions_estimate` filters." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref24": { "type": "array", "items": { "enum": [ "linkedin", "facebook", "google", "tiktok", "apple" ], "type": "string" }, "example": [ "linkedin", "facebook" ], "description": "Sources to include: `linkedin`, `facebook` (`meta` accepted), `google`, `tiktok`, `apple`. Unknown values match nothing and are echoed in `metadata.unsupported_source_types`." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref25": { "type": "array", "items": { "enum": [ "linkedin", "facebook", "google", "tiktok", "apple" ], "type": "string" }, "example": [ "apple" ], "description": "Exclude ads captured from these sources. Same vocabulary as `source_types` (`linkedin`, `facebook`, `google`, `tiktok`, `apple`; `meta` is an alias of `facebook`). Unknown values are ignored." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref26": { "enum": [ "default", "latest" ], "type": "string", "default": "default", "example": "latest", "description": "Controls realtime enrichment behavior. `default` returns whatever is already in the database, and triggers enrichment only when the result set is empty and `is_realtime_enrichment` is set. `latest` bypasses the cache and forces a re-enrichment pass against the freshest source records on every call — it triggers enrichment on its own without needing any other flag." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref27": { "type": "integer", "default": 25, "example": 25, "maximum": 25, "description": "Records per page. Defaults to 25, which is also the ceiling on most plans — the limit is your subscription's `max_search_per_page`, returned by [Profile](/en/api-reference/endpoint/profile/profile). Exceeding it returns **HTTP 416** with code `41676` (or `41613` on company and people search), not a clamped result set." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref28": { "type": "integer", "default": 1, "example": 1, "description": "Page number, starting at 1. The ceiling is your subscription's `max_search_page` (`max_company_search_page` for company search), returned by [Profile](/en/api-reference/endpoint/profile/profile). Exceeding it returns **HTTP 416**." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref29": { "type": "boolean", "default": false, "example": false, "description": "Sort direction. Results are returned newest-first by default; set `true` for oldest-first. There is no `sort_by` on this endpoint — the sort key is fixed and stated in the endpoint description." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref30": { "type": "array", "items": { "enum": [ "facebook", "instagram", "messenger", "threads", "audience_network" ], "type": "string" }, "example": [ "facebook", "instagram" ], "description": "Filter Facebook/Meta ads by the platform surface they were delivered on. Lowercase and case-insensitive. Only applies to the `facebook` source (other sources are single-platform)." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref31": { "type": "array", "items": { "enum": [ "facebook", "instagram", "messenger", "threads", "audience_network" ], "type": "string" }, "example": [ "audience_network" ], "description": "Exclude Facebook/Meta ads delivered on these platform surfaces." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref32": { "type": "boolean", "default": false, "example": true, "description": "Include ads not yet linked to a resolved company (raw-layer ads, e.g. scam or burner-page ads). Defaults to false, which returns only company-attributed ads." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref33": { "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref34" }, { "type": "object", "properties": { "coverage_notes": { "type": "array", "items": { "type": "object", "properties": { "scope": { "enum": [ "eea_uk_ch" ], "type": "string" }, "source_type": { "type": "string" } } }, "description": "Coverage notes for the requested sources, when applicable." }, "applied_source_types": { "type": "array", "items": { "type": "string" }, "description": "Only when `source_types` was sent: the values that were recognised and applied." }, "skipped_source_types": { "type": "array", "items": { "type": "object", "properties": { "reason": { "enum": [ "country_unknown_until_enriched" ], "type": "string", "description": "Why the source was not applied." }, "source_type": { "type": "string", "description": "Source that was skipped." } } }, "description": "Sources that were not applied for the requested `target_locations`, each with a `reason`." }, "unsupported_source_types": { "type": "array", "items": { "type": "string" }, "description": "Only when `source_types` contained a value that is not a known source. Those values match nothing." } } } ], "description": "Request context." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref34": { "type": "object", "properties": { "filters": { "type": "object", "description": "Echo of the request body as the endpoint applied it, including defaults such as `per_page` and `language`." }, "profile": { "type": "object", "nullable": true, "description": "Credit block (`credit`, `topup_credit`, `total_credit_cost`) when credit accounting is requested; `null` on plain API-key traffic." }, "ignored_fields": { "type": "array", "items": { "type": "string" }, "description": "Body keys the endpoint did not recognise and dropped. Empty means every key applied — a misspelled filter widens the search instead of failing." } }, "description": "Request context." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref35": { "type": "object", "properties": { "page": { "type": "integer", "description": "Current page number." }, "per_page": { "type": "integer", "description": "Records per page." }, "is_timeout": { "type": "boolean", "description": "`true` when the search ran out of time. `total_entries` then only counts the rows returned so far, and an empty page means the search did not finish, not that nothing matched." }, "total_pages": { "type": "integer", "description": "`total_entries` divided by `per_page`." }, "is_estimated": { "type": "boolean", "description": "`true` when `total_entries` is an estimate rather than an exact count. Do not use an estimated total to decide when to stop paging; stop when a page returns fewer rows than `per_page`." }, "total_entries": { "type": "integer", "description": "Total matching records. An estimate when `is_estimated` is `true`." }, "total_display_pages": { "type": "integer", "description": "Page count for this result, capped by your plan's `max_display_search_page`." } }, "description": "Pagination for the result set." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref36": { "type": "object", "properties": { "title": { "type": "string", "nullable": true, "description": "Headline or ad title." }, "ended_at": { "type": "string", "format": "date-time", "nullable": true, "description": "When the ad stopped running; `null` while it is still running." }, "companies": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref37" }, "image_url": { "type": "string", "nullable": true, "description": "Creative image, when the ad has one." }, "video_url": { "type": "string", "nullable": true, "description": "Creative video, when the ad has one." }, "advertiser": { "type": "string", "nullable": true, "description": "Advertiser name as shown by the source." }, "created_at": { "type": "string", "format": "date-time", "description": "When Pubrio first captured the ad. This is the default sort key." }, "started_at": { "type": "string", "format": "date-time", "nullable": true, "description": "When the ad started running, as reported by the source." }, "source_type": { "enum": [ "linkedin", "facebook", "google", "tiktok", "apple" ], "type": "string", "description": "Source the ad was captured from. Same vocabulary as the `source_types` filter." }, "raw_link_url": { "type": "string", "nullable": true, "description": "The original link exactly as captured, before unwrapping." }, "last_modified": { "type": "string", "format": "date-time", "description": "When the record was last updated." }, "advertiser_url": { "type": "string", "nullable": true, "description": "Advertiser page at the source, when available." }, "carousel_images": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Carousel frames, for carousel formats." }, "destination_url": { "type": "string", "nullable": true, "description": "Resolved landing page. Facebook click-wrappers such as `fb.me` are unwrapped to the real funnel URL." }, "advertisement_id": { "type": "string", "format": "uuid", "description": "Advertisement identifier." }, "advertisement_url": { "type": "string", "nullable": true, "description": "Link to the ad in the source's ad library, when available." }, "total_impressions": { "type": "string", "nullable": true, "description": "Impression estimate exactly as the source publishes it, e.g. `< 1k`, `10k-50k`. `null` for sources that do not report impressions." }, "is_company_matched": { "type": "boolean", "description": "`true` when the ad is linked to a Pubrio company record. Unlinked ads are returned only with `is_include_unlinked_companies: true`." }, "publisher_platforms": { "type": "array", "items": { "enum": [ "facebook", "instagram", "messenger", "threads", "audience_network" ], "type": "string" }, "nullable": true, "description": "Meta surfaces the ad ran on: `facebook`, `instagram`, `messenger`, `threads`, `audience_network`. `null` for non-`facebook` sources." }, "advertisement_format": { "type": "string", "nullable": true, "description": "Format label exactly as the source publishes it, e.g. `Single Image Ad`, `MULTI_IMAGES`." }, "target_country_codes": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Countries the ad was shown in (ISO 3166-1 alpha-2). Same vocabulary as the `target_locations` filter." }, "advertisement_search_id": { "type": "string", "format": "uuid", "description": "Same value as `advertisement_id`. Pass it to Advertisement Lookup." }, "total_impressions_lower": { "type": "integer", "nullable": true, "description": "Lower bound of the impression range; `null` for `< N` ranges." }, "total_impressions_upper": { "type": "integer", "nullable": true, "description": "Upper bound of the impression range; `null` for open-ended ranges." }, "advertisement_format_normalized": { "enum": [ "image", "video", "text", "carousel", "dynamic_product", "document", "message", "event", "article", "spotlight", "follow", "job", "engagement", "other" ], "type": "string", "nullable": true, "description": "Canonical format, the vocabulary the `advertisement_formats` filter accepts. `other` when the raw label is not mapped." } }, "description": "One advertisement." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref37": { "type": "object", "properties": { "domain": { "type": "string", "description": "Company domain, normalised (`stripe.com`)." }, "logo_url": { "type": "string", "nullable": true, "description": "Company logo URL." }, "company_url": { "type": "string", "nullable": true, "description": "Company website URL." }, "company_name": { "type": "string", "description": "Company name." }, "country_code": { "type": "string", "nullable": true, "description": "ISO 3166-1 alpha-2 code of the company headquarters." }, "linkedin_name": { "type": "string", "nullable": true, "description": "LinkedIn company slug (the part after `linkedin.com/company/`)." }, "domain_search_id": { "type": "string", "format": "uuid", "description": "Pubrio company identifier. Pass it to `companies` on any search, or to Company Lookup." } }, "description": "The company the record is linked to." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref38": { "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "details" ], "properties": { "code": { "type": "integer", "example": 40001 }, "details": { "type": "object" }, "message": { "type": "string", "example": "Errors and codes will vary depending on the scenario, please see the documentation for information." } } } } }, "description": "Bad request. The request was malformed or contained invalid parameters. Check the error code and message for details." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref39": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "Request rate limit exceeded. Please wait and try again later." } } } } }, "description": "Rate limit exceeded. Too many requests were made in a given time period. Retry after the rate limit window resets." }, "sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref40": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "An unexpected error occurred on the server." } } } } }, "description": "Internal server error. An unexpected error occurred on the server. Contact support if the error persists." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref0": { "type": "array", "items": { "type": "string" }, "example": [ "AWS", "Cloudflare", "Hetzner" ], "description": "Restrict results to footprint rows matching these cloud or hosting providers. Scoped to this footprint row — one provider in one country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref1": { "type": "array", "items": { "type": "string" }, "example": [ "AWS", "Cloudflare", "Hetzner" ], "description": "Remove footprint rows matching these cloud or hosting providers. Scoped to this footprint row — one provider in one country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref2": { "type": "array", "items": { "type": "string" }, "example": [ "TW", "AE", "NO" ], "description": "Country codes the results must target. Combines with `filter_conditions` as OR by default — a result matches if it targets any of them." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref3": { "type": "array", "items": { "type": "string" }, "example": [ "IS", "GB", "FR", "IE", "ES" ], "description": "Country codes the results must not target. Combines with `filter_conditions` as OR by default — a result matches if it targets any of them." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref4": { "type": "array", "items": { "type": "string" }, "example": [ "us-east-1", "eu-central-1" ], "description": "Restrict results to footprint rows matching these cloud regions. Scoped to this footprint row — one provider in one country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref5": { "type": "array", "items": { "type": "string" }, "example": [ "us-east-1", "eu-central-1" ], "description": "Remove footprint rows matching these cloud regions. Scoped to this footprint row — one provider in one country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref6": { "type": "array", "items": { "type": "string" }, "example": [ "Ashburn", "Frankfurt" ], "description": "Restrict results to footprint rows matching these cities. Scoped to this footprint row — one provider in one country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref7": { "type": "array", "items": { "type": "string" }, "example": [ "Ashburn", "Frankfurt" ], "description": "Remove footprint rows matching these cities. Scoped to this footprint row — one provider in one country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref8": { "type": "array", "items": { "type": "string", "nullable": true }, "example": [ "2026-01-01", null ], "maxItems": 2, "minItems": 2, "description": "Two ISO 8601 dates (YYYY-MM-DD) bounding when the footprint was first seen. Scoped to this footprint row — one provider in one country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref9": { "type": "array", "items": { "type": "string", "nullable": true }, "example": [ "2026-01-01", null ], "maxItems": 2, "minItems": 2, "description": "Two ISO 8601 dates (YYYY-MM-DD) bounding when the footprint was last seen. Scoped to this footprint row — one provider in one country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref10": { "type": "boolean", "example": true, "description": "When true, return only footprint rows outside the company's home market. Rows whose company has no known headquarters are excluded." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref11": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum hosts. Use `null` for an open-ended bound. Scoped to this footprint row — one provider in one country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref12": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum servers (distinct IP addresses). Use `null` for an open-ended bound. Scoped to this footprint row — one provider in one country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref13": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum servers shared with other companies. Use `null` for an open-ended bound. Scoped to this footprint row — one provider in one country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref14": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum cloud regions. Use `null` for an open-ended bound. Scoped to this footprint row — one provider in one country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref15": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum cities. Use `null` for an open-ended bound. Scoped to this footprint row — one provider in one country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref16": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum hosts. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref17": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum servers (distinct IP addresses). Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref18": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum servers shared with other companies. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref19": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum distinct providers used by the company. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref20": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum countries the company hosts in. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref21": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum countries outside the company's home market. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref22": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum cloud regions. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref23": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum cities. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref24": { "type": "array", "items": { "type": "string" }, "example": [ "US", "SG", "CN" ], "description": "The location of the company headquarters. Check out `location` endpoints under the Filters tab for more information." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref25": { "type": "string", "format": "uuid", "example": "f28215e6-f6ed-40c2-ac9b-d8e70164c0be", "description": "Identifier of a single cloud footprint row." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref26": { "type": "array", "items": { "type": "string", "format": "uuid" }, "example": [ "f28215e6-f6ed-40c2-ac9b-d8e70164c0be" ], "description": "Identifiers of specific cloud footprint rows, for exporting a selection." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref27": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A list of unique identifiers (domain_search_id) used for company and people search operations." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref28": { "type": "array", "items": { "type": "string" }, "example": [ "pubrio.com" ], "description": "List of company domains used for company and people search operations. If we receive a URL such as `www.pubrio.com` or `https://docs.pubrio.com/`, the system will convert it to `pubrio.com` for processing." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref29": { "type": "integer", "default": 25, "example": 25, "maximum": 25, "description": "Records per page. Defaults to 25, which is also the ceiling on most plans — the limit is your subscription's `max_search_per_page`, returned by [Profile](/en/api-reference/endpoint/profile/profile). Exceeding it returns **HTTP 416** with code `41676` (or `41613` on company and people search), not a clamped result set." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref30": { "type": "integer", "default": 1, "example": 1, "description": "Page number, starting at 1. The ceiling is your subscription's `max_search_page` (`max_company_search_page` for company search), returned by [Profile](/en/api-reference/endpoint/profile/profile). Exceeding it returns **HTTP 416**." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref31": { "type": "boolean", "default": false, "example": false, "description": "Sort direction. Results are returned newest-first by default; set `true` for oldest-first. There is no `sort_by` on this endpoint — the sort key is fixed and stated in the endpoint description." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref32": { "type": "array", "items": { "type": "string" }, "example": [ "AWS", "Cloudflare" ], "description": "Companies that use any of these providers anywhere. The unprefixed `providers` narrows the rows returned; this narrows the companies." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref33": { "type": "array", "items": { "type": "string" }, "example": [ "DE", "SG" ], "description": "Companies present in any of these countries anywhere in their footprint." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref34": { "type": "array", "items": { "type": "string" }, "example": [ "AWS" ], "description": "Companies whose single largest provider is one of these." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref35": { "type": "string", "example": "pubrio.com", "description": "A company domain used for company search operations. If we receive a URL such as `www.pubrio.com` or `https://docs.pubrio.com/`, the system will convert it to `pubrio.com` for processing." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref36": { "type": "string", "format": "uuid", "description": "A unique identifier for the company search operation." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref37": { "type": "array", "items": { "type": "string" }, "example": [ "https://www.linkedin.com/company/pubrio" ], "description": "The fully formed URL of the LinkedIn company profile. URL begin with `http` and contain `linkedin.com/company/`" }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref38": { "type": "array", "items": { "type": "object", "properties": { "key": { "enum": [ "cloud_regions", "cities" ], "type": "string", "example": "cloud_regions", "description": "Which array filter the operator applies to." }, "operator": { "enum": [ "or", "and" ], "type": "string", "example": "and", "description": "`or` matches rows carrying any listed value; `and` requires all of them." } } }, "description": "Switches an array filter from OR (default: match any value) to AND (match all values). Applies to `cloud_regions` and `cities`." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref39": { "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "details" ], "properties": { "code": { "type": "integer", "example": 40001 }, "details": { "type": "object" }, "message": { "type": "string", "example": "Errors and codes will vary depending on the scenario, please see the documentation for information." } } } } }, "description": "Bad request. The request was malformed or contained invalid parameters. Check the error code and message for details." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref40": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "Request rate limit exceeded. Please wait and try again later." } } } } }, "description": "Rate limit exceeded. Too many requests were made in a given time period. Retry after the rate limit window resets." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref41": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "An unexpected error occurred on the server." } } } } }, "description": "Internal server error. An unexpected error occurred on the server. Contact support if the error persists." }, "sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref0": { "type": "array", "items": { "type": "string" }, "example": [ "US", "SG", "CN" ], "description": "ISO 3166-1 alpha-2 (cca2) is used for filtering locations. Check out `location` endpoints under the Filters tab for more information." }, "sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref1": { "type": "array", "items": { "type": "integer" }, "example": [ 357, 419 ], "description": "Posting country by Pubrio `location_id` (Locations endpoint; also on each row). Alternative to `locations`." }, "sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref2": { "type": "array", "items": { "type": "string" }, "example": [ "US", "SG", "CN" ], "description": "The location of the company headquarters. Check out `location` endpoints under the Filters tab for more information." }, "sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref3": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A list of unique identifiers (domain_search_id) used for company and people search operations." }, "sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref4": { "type": "array", "items": { "type": "string" }, "example": [ "pubrio.com" ], "description": "List of company domains used for company and people search operations. If we receive a URL such as `www.pubrio.com` or `https://docs.pubrio.com/`, the system will convert it to `pubrio.com` for processing." }, "sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref5": { "type": "array", "items": { "type": "string" }, "example": [ "https://www.linkedin.com/company/pubrio" ], "description": "The fully formed URL of the LinkedIn company profile. URL begin with `http` and contain `linkedin.com/company/`" }, "sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref6": { "type": "string", "example": "pubrio", "description": "A string of words over which we want to filter the results." }, "sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref7": { "type": "array", "items": { "type": "string" }, "example": [ "sales manager", "marketing manager" ], "description": "Job titles associated with the individuals you aim to locate. \n\n The results will also encompass job titles that include similar terminology, even if they do not match exactly. For instance, searching for `software engineer` may yield results for individuals with the title `senior software engineer`." }, "sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref8": { "type": "array", "items": { "type": "string" }, "example": [ "engineering", "product_management" ], "description": "Function slugs derived from the title, e.g. `engineering`, `sales`, `marketing`, `finance`, `product_management`, or a [Department Functions](/en/api-reference/endpoint/departments/function) slug such as `software_development`, in any case. Unknown slugs match nothing. Full list: [Enums & Constants](/en/api-reference/enums#job-functions)." }, "sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref9": { "type": "array", "items": { "enum": [ 1, 2, 3, 4, 5 ], "type": "integer" }, "example": [ 4, 5 ], "description": "Seniority tier from the title: `1` junior, `2` senior, `3` manager, `4` director, `5` executive. A value outside 1–5 matches nothing. Rows return their tier in `seniority_rank` (`0` = unclassified)." }, "sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref10": { "type": "array", "items": { "type": "string" }, "example": [ "2025-01-01", "2025-01-10" ], "description": "Date range of the posted date. The maximum value is the current day. Day boundaries follow your workspace timezone." }, "sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref11": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2026-08-01", "2026-08-31" ], "maxItems": 2, "minItems": 1, "description": "Inclusive `[from, to]` window (UTC) on the launch date: `posting_date`, or the ingestion day when absent. Matches how Job Insights counts. A single date matches that day." }, "sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref12": { "type": "string", "format": "date-time", "example": "2026-09-02T12:00:00Z", "description": "Ingested at or after this instant (UTC). Date or ISO timestamp. For incremental syncs pass the `created_at` of your newest stored row." }, "sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref13": { "type": "boolean", "default": false, "example": true, "description": "Opt into realtime enrichment for a single, company-scoped query (filtered by `domain_search_id`, `domains`, or `linkedin_urls`). When the initial search returns zero results, the endpoint scrapes the source, persists the records, and re-runs the search before responding. Subject to a per-route deadline." }, "sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref14": { "type": "boolean", "default": false, "example": false, "description": "Sort direction. Results are returned newest-first by default; set `true` for oldest-first. There is no `sort_by` on this endpoint — the sort key is fixed and stated in the endpoint description." }, "sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref15": { "type": "integer", "default": 25, "example": 25, "maximum": 25, "description": "Records per page. Defaults to 25, which is also the ceiling on most plans — the limit is your subscription's `max_search_per_page`, returned by [Profile](/en/api-reference/endpoint/profile/profile). Exceeding it returns **HTTP 416** with code `41676` (or `41613` on company and people search), not a clamped result set." }, "sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref16": { "type": "integer", "default": 1, "example": 1, "description": "Page number, starting at 1. The ceiling is your subscription's `max_search_page` (`max_company_search_page` for company search), returned by [Profile](/en/api-reference/endpoint/profile/profile). Exceeding it returns **HTTP 416**." }, "sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref17": { "type": "object", "properties": { "filters": { "type": "object", "description": "Echo of the request body as the endpoint applied it, including defaults such as `per_page` and `language`." }, "profile": { "type": "object", "nullable": true, "description": "Credit block (`credit`, `topup_credit`, `total_credit_cost`) when credit accounting is requested; `null` on plain API-key traffic." }, "ignored_fields": { "type": "array", "items": { "type": "string" }, "description": "Body keys the endpoint did not recognise and dropped. Empty means every key applied — a misspelled filter widens the search instead of failing." } }, "description": "Request context." }, "sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref18": { "type": "object", "properties": { "page": { "type": "integer", "description": "Current page number." }, "per_page": { "type": "integer", "description": "Records per page." }, "is_timeout": { "type": "boolean", "description": "`true` when the search ran out of time. `total_entries` then only counts the rows returned so far, and an empty page means the search did not finish, not that nothing matched." }, "total_pages": { "type": "integer", "description": "`total_entries` divided by `per_page`." }, "is_estimated": { "type": "boolean", "description": "`true` when `total_entries` is an estimate rather than an exact count. Do not use an estimated total to decide when to stop paging; stop when a page returns fewer rows than `per_page`." }, "total_entries": { "type": "integer", "description": "Total matching records. An estimate when `is_estimated` is `true`." }, "total_display_pages": { "type": "integer", "description": "Page count for this result, capped by your plan's `max_display_search_page`." } }, "description": "Pagination for the result set." }, "sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref19": { "type": "object", "properties": { "title": { "type": "string", "description": "Job title as published." }, "job_id": { "type": "string", "format": "uuid", "description": "Posting identifier." }, "country": { "type": "string", "nullable": true, "description": "Country name of the posting." }, "job_url": { "type": "string", "description": "Link to the posting at the source." }, "location": { "type": "string", "nullable": true, "description": "Free-text location as published." }, "companies": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref20" }, "functions": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Job-function slugs resolved from the title; `null` when unclassified. Same vocabulary as the `functions` filter." }, "created_at": { "type": "string", "format": "date-time", "description": "When Pubrio first ingested the posting. This is the default sort key." }, "base_salary": { "type": "string", "nullable": true, "description": "Salary text as published, when the source provides one." }, "departments": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Department slugs resolved from the title; `null` when unclassified. Same vocabulary as the `departments` filter." }, "location_id": { "type": "integer", "nullable": true, "description": "Pubrio `location_id` of the posting's country. Same vocabulary as the `location_ids` filter." }, "source_type": { "type": "string", "description": "Source the posting was captured from, e.g. `linkedin`." }, "country_code": { "type": "string", "nullable": true, "description": "ISO 3166-1 alpha-2 code of the posting's country. Same vocabulary as the `locations` filter." }, "posting_date": { "type": "string", "format": "date", "nullable": true, "description": "Publisher's posting date. `launch_dates` filters on it, falling back to `created_at` when it is absent." }, "job_search_id": { "type": "string", "format": "uuid", "description": "Same value as `job_id`. Pass it to Job Lookup." }, "last_modified": { "type": "string", "format": "date-time", "description": "When the record was last updated." }, "seniority_rank": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "description": "Seniority tier `1`–`5` as defined on the `seniority_ranks` filter; `0` when the title could not be classified." }, "employment_type": { "type": "string", "nullable": true, "description": "Employment type as published (e.g. `Full-time`), when the source provides one." }, "education_requirement": { "type": "string", "nullable": true, "description": "Education requirement as published, when the source provides one." }, "experience_requirement": { "type": "string", "nullable": true, "description": "Experience requirement as published, when the source provides one." } }, "description": "One job posting." }, "sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref20": { "type": "object", "properties": { "domain": { "type": "string", "description": "Company domain, normalised (`stripe.com`)." }, "logo_url": { "type": "string", "nullable": true, "description": "Company logo URL." }, "company_url": { "type": "string", "nullable": true, "description": "Company website URL." }, "company_name": { "type": "string", "description": "Company name." }, "country_code": { "type": "string", "nullable": true, "description": "ISO 3166-1 alpha-2 code of the company headquarters." }, "linkedin_name": { "type": "string", "nullable": true, "description": "LinkedIn company slug (the part after `linkedin.com/company/`)." }, "domain_search_id": { "type": "string", "format": "uuid", "description": "Pubrio company identifier. Pass it to `companies` on any search, or to Company Lookup." } }, "description": "The company the record is linked to." }, "sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref21": { "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "details" ], "properties": { "code": { "type": "integer", "example": 40001 }, "details": { "type": "object" }, "message": { "type": "string", "example": "Errors and codes will vary depending on the scenario, please see the documentation for information." } } } } }, "description": "Bad request. The request was malformed or contained invalid parameters. Check the error code and message for details." }, "sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref22": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "Request rate limit exceeded. Please wait and try again later." } } } } }, "description": "Rate limit exceeded. Too many requests were made in a given time period. Retry after the rate limit window resets." }, "sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref23": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "An unexpected error occurred on the server." } } } } }, "description": "Internal server error. An unexpected error occurred on the server. Contact support if the error persists." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref0": { "type": "array", "items": { "type": "string" }, "example": [ "US", "SG", "CN" ], "description": "ISO 3166-1 alpha-2 (cca2) is used for filtering locations. Check out `location` endpoints under the Filters tab for more information." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref1": { "type": "array", "items": { "type": "string" }, "example": [ "US", "SG", "CN" ], "description": "The location of the company headquarters. Check out `location` endpoints under the Filters tab for more information." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref2": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A list of unique identifiers (domain_search_id) used for company and people search operations." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref3": { "type": "string", "format": "uuid", "example": "4110b929-17cd-42aa-a159-906ead0c9b56", "description": "A unique identifier for the company news search operation." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref4": { "type": "array", "items": { "type": "string" }, "example": [ "pubrio.com" ], "description": "List of company domains used for company and people search operations. If we receive a URL such as `www.pubrio.com` or `https://docs.pubrio.com/`, the system will convert it to `pubrio.com` for processing." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref5": { "type": "array", "items": { "type": "string" }, "example": [ "https://www.linkedin.com/company/pubrio" ], "description": "The fully formed URL of the LinkedIn company profile. URL begin with `http` and contain `linkedin.com/company/`" }, "sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref6": { "type": "string", "example": "pubrio", "description": "A string of words over which we want to filter the results." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref7": { "type": "array", "items": { "type": "string" }, "example": [ "launches" ], "description": "List of `category slugs` for searching for specific news categories. To find a slug, call the `news categories` endpoint under the Filters tab." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref8": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A list of `news_gallery_id` used to search for specific news galleries. To find the ID, call the `news galleries` endpoint under the Filters tab." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref9": { "type": "array", "items": { "type": "string" }, "example": [ "2025-01-01", "2025-01-10" ], "description": "Date range of the published date. The maximum value is the current day. Day boundaries follow your workspace timezone." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref10": { "type": "string", "format": "date-time", "example": "2026-09-01T00:00:00Z", "description": "Published at or after this instant (UTC). Date or ISO timestamp. `published_dates` is the closed-window form and uses your workspace timezone." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref11": { "type": "integer", "default": 25, "example": 25, "maximum": 25, "description": "Records per page. Defaults to 25, which is also the ceiling on most plans — the limit is your subscription's `max_search_per_page`, returned by [Profile](/en/api-reference/endpoint/profile/profile). Exceeding it returns **HTTP 416** with code `41676` (or `41613` on company and people search), not a clamped result set." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref12": { "type": "integer", "default": 1, "example": 1, "description": "Page number, starting at 1. The ceiling is your subscription's `max_search_page` (`max_company_search_page` for company search), returned by [Profile](/en/api-reference/endpoint/profile/profile). Exceeding it returns **HTTP 416**." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref13": { "type": "boolean", "default": false, "example": false, "description": "Sort direction. Results are returned newest-first by default; set `true` for oldest-first. There is no `sort_by` on this endpoint — the sort key is fixed and stated in the endpoint description." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref14": { "type": "boolean", "description": "When `true`, attaches the resolved expansion signals (`expansion_signals`) to each news item and enables the `expansion_signal_types` / `expansion_signal_polarities` filters. Leave unset for the fastest search — the expansion join is only added when this flag is on." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref15": { "type": "array", "items": { "enum": [ "AD", "AUDIENCE", "DNS", "ENTITY", "EVENT", "EVENT_PLUS", "EXEC", "HIRE", "INFRA", "IP", "NEWS", "OFFICE", "PARTNER", "PRODUCT", "REG", "SCALE", "TECH" ], "type": "string" }, "example": [ "HIRE", "PARTNER" ], "description": "Return only news that produced an expansion signal of one of these types (uppercase slugs). Requires `is_expansion_signal_available: true`. A list with only unknown slugs matches nothing." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref16": { "type": "array", "items": { "enum": [ "expansion", "contraction_leading", "contraction_confirming", "contraction_lagging" ], "type": "string" }, "example": [ "expansion" ], "description": "Return only news whose expansion signal carries one of these polarities. Requires `is_expansion_signal_available: true`. Combined with `expansion_signal_types` as AND." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref17": { "type": "object", "properties": { "filters": { "type": "object", "description": "Echo of the request body as the endpoint applied it, including defaults such as `per_page` and `language`." }, "profile": { "type": "object", "nullable": true, "description": "Credit block (`credit`, `topup_credit`, `total_credit_cost`) when credit accounting is requested; `null` on plain API-key traffic." }, "ignored_fields": { "type": "array", "items": { "type": "string" }, "description": "Body keys the endpoint did not recognise and dropped. Empty means every key applied — a misspelled filter widens the search instead of failing." } }, "description": "Request context." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref18": { "type": "object", "properties": { "page": { "type": "integer", "description": "Current page number." }, "per_page": { "type": "integer", "description": "Records per page." }, "is_timeout": { "type": "boolean", "description": "`true` when the search ran out of time. `total_entries` then only counts the rows returned so far, and an empty page means the search did not finish, not that nothing matched." }, "total_pages": { "type": "integer", "description": "`total_entries` divided by `per_page`." }, "is_estimated": { "type": "boolean", "description": "`true` when `total_entries` is an estimate rather than an exact count. Do not use an estimated total to decide when to stop paging; stop when a page returns fewer rows than `per_page`." }, "total_entries": { "type": "integer", "description": "Total matching records. An estimate when `is_estimated` is `true`." }, "total_display_pages": { "type": "integer", "description": "Page count for this result, capped by your plan's `max_display_search_page`." } }, "description": "Pagination for the result set." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref19": { "type": "object", "properties": { "url": { "type": "string", "description": "Link to the article." }, "title": { "type": "string", "description": "Headline." }, "source": { "type": "string", "nullable": true, "description": "Publisher domain." }, "domains": { "type": "array", "items": { "type": "string" }, "description": "Domains of every company the article mentions." }, "news_id": { "type": "string", "format": "uuid", "description": "Article identifier." }, "summary": { "type": "string", "nullable": true, "description": "Short summary of the article." }, "category": { "type": "string", "nullable": true, "description": "News category slug. Same vocabulary as the `categories` filter and the News Categories endpoint." }, "language": { "type": "string", "nullable": true, "description": "ISO 639-1 language code of the article. Same vocabulary as the `news_languages` filter." }, "companies": { "type": "array", "items": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref20" }, "description": "Every company the article mentions, in the same order as `domains`." }, "image_url": { "type": "string", "nullable": true, "description": "Lead image, when the article has one." }, "locations": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Place names mentioned in the article; `null` when none." }, "published_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Publication time. This is the default sort key (undated articles sort last)." }, "country_codes": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Countries the article is about (ISO 3166-1 alpha-2); `null` when not detected. Same vocabulary as the `locations` filter." }, "last_modified": { "type": "string", "format": "date-time", "description": "When the record was last updated." }, "news_galleries": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": "string" }, "news_gallery_id": { "type": "string", "format": "uuid" } } }, "nullable": true, "description": "Galleries the article belongs to; `null` when none." }, "news_search_id": { "type": "string", "format": "uuid", "description": "Search-record identifier. Pass it to News Lookup." }, "expansion_signals": { "type": "array", "items": { "type": "object", "properties": { "polarity": { "type": "string", "description": "`expansion`, `contraction_leading`, `contraction_confirming` or `contraction_lagging`." }, "event_date": { "type": "string", "format": "date-time", "description": "When the signal occurred." }, "country_code": { "type": "string", "nullable": true, "description": "Market the signal points at." }, "domain_search_id": { "type": "string", "format": "uuid", "description": "Company the signal belongs to." }, "signal_type_slug": { "type": "string", "description": "Signal type, e.g. `HIRE`, `PARTNER`, `PRODUCT`." }, "signal_subtype_slug": { "type": "string", "nullable": true, "description": "Signal subtype, when the type has one." }, "signal_strength_slug": { "type": "string", "description": "Signal strength: `low`, `medium`, `high`, `very_high`." } } }, "description": "Only when `is_expansion_signal_available: true`: the expansion signals this article produced. Empty array when none." }, "news_category_name": { "type": "string", "nullable": true, "description": "Human-readable category name, localised to `language`." }, "company_country_codes": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Headquarters countries of the companies mentioned. Same vocabulary as the `company_locations` filter." } }, "description": "One news article." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref20": { "type": "object", "properties": { "domain": { "type": "string", "description": "Company domain, normalised (`stripe.com`)." }, "logo_url": { "type": "string", "nullable": true, "description": "Company logo URL." }, "company_url": { "type": "string", "nullable": true, "description": "Company website URL." }, "company_name": { "type": "string", "description": "Company name." }, "country_code": { "type": "string", "nullable": true, "description": "ISO 3166-1 alpha-2 code of the company headquarters." }, "linkedin_name": { "type": "string", "nullable": true, "description": "LinkedIn company slug (the part after `linkedin.com/company/`)." }, "domain_search_id": { "type": "string", "format": "uuid", "description": "Pubrio company identifier. Pass it to `companies` on any search, or to Company Lookup." } }, "description": "The company the record is linked to." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref21": { "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "details" ], "properties": { "code": { "type": "integer", "example": 40001 }, "details": { "type": "object" }, "message": { "type": "string", "example": "Errors and codes will vary depending on the scenario, please see the documentation for information." } } } } }, "description": "Bad request. The request was malformed or contained invalid parameters. Check the error code and message for details." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref22": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "Request rate limit exceeded. Please wait and try again later." } } } } }, "description": "Rate limit exceeded. Too many requests were made in a given time period. Retry after the rate limit window resets." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref23": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "An unexpected error occurred on the server." } } } } }, "description": "Internal server error. An unexpected error occurred on the server. Contact support if the error persists." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref0": { "type": "string", "example": "pubrio", "description": "Filter search results to include a specific company name. \n \n If the value you enter for this parameter does not match with a company's name, the company will not appear in search results, even if it matches other parameters. Partial matches are accepted." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref1": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A list of unique identifiers (domain_search_id) used for company and people search operations." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref2": { "type": "array", "items": { "type": "string" }, "example": [ "pubrio.com" ], "description": "List of company domains used for company and people search operations. If we receive a URL such as `www.pubrio.com` or `https://docs.pubrio.com/`, the system will convert it to `pubrio.com` for processing." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref3": { "type": "array", "items": { "type": "string" }, "example": [ "https://www.linkedin.com/company/pubrio" ], "description": "The fully formed URL of the LinkedIn company profile. URL begin with `http` and contain `linkedin.com/company/`" }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref4": { "type": "object", "example": { "technologies": [ 37, 152 ], "founded_dates": [ 2015, 2023 ], "company_locations": [ "US" ], "filter_conditions": [ { "key": "technologies", "operator": "and" } ] }, "description": "Wrapper object for company-level filters. Recommended grouping that visually separates which keys filter the *person* (top-level) from which filter the *company*. Accepts the same keys as the top-level company filters (e.g. `technologies`, `verticals`, `vertical_categories`, `vertical_sub_categories`, `categories`, `keywords`, `founded_dates`, `employees`, `revenues`, `company_locations`, `company_exclude_locations`, `company_places`, `company_exclude_places`, `companies`, `domains`, `company_linkedin_urls`, `is_enable_similarity_search`, `similarity_score`, plus `filter_conditions`). Engine flattens this object to the top level before processing — top-level keys win on conflict. Same shape used by Monitor `company_filters`. See the Filters Overview developer guide for examples." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref5": { "type": "array", "items": { "type": "string" }, "example": [ "US", "SG", "CN" ], "description": "ISO 3166-1 alpha-2 (cca2) is used for filtering locations. Check out `location` endpoints under the Filters tab for more information." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref6": { "type": "array", "items": { "type": "string" }, "example": [ "CN", "US", "RU", "CA" ], "description": "ISO 3166-1 alpha-2 (cca2) is used to filter out locations that does not need to be returned. Check out `location` endpoints under the Filters tab for more information." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref7": { "type": "array", "items": { "type": "string" }, "example": [ "Tokyo" ], "description": "Place names (city, region) used to filter results. Accepts localized or English place names." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref8": { "type": "array", "items": { "type": "string" }, "example": [ "Tokyo" ], "description": "Place names (city, region) to exclude from results. Accepts localized or English place names." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref9": { "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref6" } ], "description": "Geographic locations to exclude from job posting results." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref10": { "type": "array", "items": { "type": "string" }, "example": [ "2025-01-01", "2025-01-10" ], "description": "Date range of the posted date. The maximum value is the current day. Day boundaries follow your workspace timezone." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref11": { "type": "array", "items": { "type": "string" }, "example": [ "sales manager", "marketing manager" ], "description": "Job titles associated with the individuals you aim to locate. \n\n The results will also encompass job titles that include similar terminology, even if they do not match exactly. For instance, searching for `software engineer` may yield results for individuals with the title `senior software engineer`." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref12": { "type": "array", "items": { "type": "integer" }, "description": "A list of `vertical_id` used to search for companies in a specific vertical or industry. To find the ID, call the `vertical` endpoint under the Filters tab.\n\nThis filter supports `is_enable_similarity_search`, once enabled you can enter any free text, e.g. `[\"AI\"]`." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref13": { "type": "array", "items": { "type": "integer" }, "description": "A list of `vertical_category_id` used to search for companies in a specific vertical category. To find the ID, call the `vertical category` endpoint under the Filters tab.\n\nThis filter supports `is_enable_similarity_search`, once enabled you can enter any free text, e.g. `[\"Information Technology\"]`." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref14": { "type": "array", "items": { "type": "integer" }, "description": "A list of `vertical_sub_category_id` used to search for companies in a specific vertical sub-category. To find the ID, call the `vertical sub category` endpoint under the Filters tab.\n\nThis filter supports `is_enable_similarity_search`, once enabled you can enter any free text, e.g. `[\"Software\"]`." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref15": { "type": "array", "items": { "type": "integer" }, "description": "A list of `category_id` used to search for specific categories of technology used by companies. To find the ID, call the `category` endpoint under the Filters tab.\n\nThis filter supports `is_enable_similarity_search`, once enabled you can enter any free text, e.g. `[\"CDN\"]`." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref16": { "type": "array", "items": { "type": "integer" }, "description": "A list of `tag_id` used to search for specific technologies used by companies. To find the ID, call the `technology` endpoint under the Filters tab.\n\nThis filter supports `is_enable_similarity_search`, once enabled you can enter any free text, e.g. `[\"Shopify\"]`.\n\nA product name the technology list knows matches that product and its own products (`\"Salesforce\"` also matches Salesforce Desk and Salesforce Service Cloud), never look-alikes; other text matches by similarity." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref17": { "type": "array", "items": { "type": "array", "items": { "type": "string" } }, "example": [ [ 1, 10 ], [ 11, 20 ], [ 10001 ] ], "description": "The number range of employees working for the company. This enables you to find companies based on headcount. You can add multiple ranges to expand your search results. \n\n Check out `company size` endpoints under the Filters tab for more information." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref18": { "type": "array", "items": { "type": "integer" }, "example": [ 0, 100000 ], "description": "Minimum and maximum range of company revenue." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref19": { "type": "array", "items": { "type": "integer" }, "example": [ 2018, 2024 ], "description": "Years of company founded range. The maximum value founded is the current year." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref20": { "type": "array", "items": { "type": "string" }, "example": [ "ecommerce", "ai", "fintech" ], "description": "A list of keywords to filter companies by relevance, specialties, or descriptions." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref21": { "type": "array", "items": { "enum": [ "linkedin", "facebook", "instagram", "tiktok", "twitter", "x", "github", "wantedly", "rocketpunch" ], "type": "string" }, "example": [ "tiktok" ], "description": "Companies with a profile on any of: `linkedin`, `facebook`, `instagram`, `tiktok`, `twitter`, `x`, `github`, `wantedly`, `rocketpunch`. Promote to AND with `filter_conditions`." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref22": { "type": "array", "items": { "type": "string" }, "example": [ "launches" ], "description": "List of `category slugs` for searching for specific news categories. To find a slug, call the `news categories` endpoint under the Filters tab." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref23": { "type": "array", "items": { "type": "string" }, "example": [ "2025-01-01", "2025-01-10" ], "description": "Date range of the published date. The maximum value is the current day. Day boundaries follow your workspace timezone." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref24": { "type": "array", "items": { "type": "string" }, "example": [ "asus" ], "description": "Keywords used to search within advertisement content or titles." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref25": { "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref26" } ], "description": "Target geographic locations for advertisements." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref26": { "type": "array", "items": { "type": "string" }, "example": [ "TW", "AE", "NO" ], "description": "Country codes the results must target. Combines with `filter_conditions` as OR by default — a result matches if it targets any of them." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref27": { "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref28" } ], "description": "Geographic locations to exclude from advertisement targeting." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref28": { "type": "array", "items": { "type": "string" }, "example": [ "IS", "GB", "FR", "IE", "ES" ], "description": "Country codes the results must not target. Combines with `filter_conditions` as OR by default — a result matches if it targets any of them." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref29": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-25", "2025-12-25" ], "description": "Start date range for advertisement filtering." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref30": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-25", "2025-12-25" ], "description": "End date range for advertisement filtering." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref31": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2026-01-01", "2026-01-31" ], "description": "Find advertisements that were running at any point during this date range (overlap-based: includes ads that started before the range and are still running, not just ads that started inside it)." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref32": { "type": "array", "items": { "enum": [ "currently_running", "active_last_30_min" ], "type": "string" }, "example": [ "currently_running" ], "description": "`currently_running`: companies with advertising on record. `active_last_30_min`: companies whose advertising changed in the last 30 minutes." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref33": { "type": "array", "items": { "type": "string" }, "example": [ "limited time offer" ], "description": "Keywords to search for within advertisement headline text." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref34": { "type": "array", "items": { "enum": [ "linkedin", "facebook", "google", "tiktok", "apple" ], "type": "string" }, "example": [ "linkedin", "facebook" ], "description": "Filter by which ad library the advertisement was sourced from. Lowercase, case-insensitive. `meta` is accepted as an alias for `facebook`." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref35": { "type": "array", "items": { "enum": [ "facebook", "instagram", "messenger", "threads", "audience_network" ], "type": "string" }, "example": [ "facebook", "instagram" ], "description": "Filter Facebook/Meta ads by the platform surface they were delivered on. Lowercase and case-insensitive. Only applies to the `facebook` source (other sources are single-platform)." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref36": { "type": "array", "items": { "enum": [ "facebook", "instagram", "messenger", "threads", "audience_network" ], "type": "string" }, "example": [ "audience_network" ], "description": "Exclude Facebook/Meta ads delivered on these platform surfaces." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref37": { "type": "array", "items": { "enum": [ "image", "video", "text", "carousel", "dynamic_product", "document", "message", "event", "article", "spotlight", "follow", "job", "engagement" ], "type": "string" }, "example": [ "image", "video" ], "description": "Find companies with at least one advertisement in any of these creative formats." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref38": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum count of the company's currently active advertisements, across all countries. Use `null` for an open-ended bound, e.g. `[1, null]` for \"at least one active ad\"." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref39": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum count of the company's advertisements that are still running (no end date, or an end date in the future). Currently populated for LinkedIn ads only." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref40": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 10, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum count of the company's total advertisements ever recorded, across all countries." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref41": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 2, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum number of distinct ad platforms (linkedin, facebook, google, tiktok, apple) the company is actively advertising on." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref42": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 2, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum number of distinct advertisement creative formats the company is actively running." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref43": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1000, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum estimated advertisement impressions, summed across all countries. Only advertisements with a reported impression range are counted." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref44": { "type": "object", "example": { "rank": [ null, 500 ], "country": "US" }, "required": [ "country" ], "properties": { "rank": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ null, 500 ], "maxItems": 2, "minItems": 2, "description": "Rank within that country by advertising volume. 1 is the biggest spender, and the number increases as advertising volume decreases. Use `[null, 500]` to find the top 500 biggest spenders in that country; use `[500, null]` to find everyone ranked 500th or lower." }, "country": { "type": "string", "example": "US", "description": "ISO 3166-1 alpha-2 country code to scope this filter to. Required." }, "last_seen": { "type": "array", "items": { "type": "string", "format": "date", "nullable": true }, "example": [ "2026-07-01", null ], "maxItems": 2, "minItems": 2, "description": "[from, to] window for when the company's most recent ad in this country ran, for the opposite question: who has gone quiet in a market." }, "total_ads": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 10, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum total advertisements, scoped to this country." }, "active_ads": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum active advertisements, scoped to this country." }, "first_seen": { "type": "array", "items": { "type": "string", "format": "date", "nullable": true }, "example": [ "2026-07-01", null ], "maxItems": 2, "minItems": 2, "description": "[from, to] window for when the company's earliest ad in this country ran — the \"newly entered this market\" filter. Either bound may be null for an open-ended window; dates use the request timezone. A company whose ads carry no start date has no first-seen value and is never reported as new." }, "percentile": { "type": "array", "items": { "type": "number", "nullable": true }, "example": [ 90, null ], "maxItems": 2, "minItems": 2, "description": "Percentile within that country by advertising volume, 0-100. Higher means a bigger spender. Use `[90, null]` for the top 10% of spenders in that country." }, "impressions": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1000, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum estimated impressions, scoped to this country." }, "running_ads": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum running advertisements, scoped to this country. Currently populated for LinkedIn ads only." }, "volume_score": { "type": "array", "items": { "type": "number", "nullable": true }, "example": [ 0.5, null ], "maxItems": 2, "minItems": 2, "description": "The underlying 0-1 advertising volume score that `rank` and `percentile` are both computed from." } }, "description": "Advertising activity for one specific country. `country` is required, and at least one other field must be set (a country by itself matches nothing). For an all-country total instead, use the top-level `advertisement_active_ads` / `advertisement_total_ads` / `advertisement_impressions_estimate` filters." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref45": { "enum": [ "relevance", "name", "number_of_employees", "founded_year", "advertisement_country_rank" ], "type": "string", "example": "advertisement_country_rank", "description": "Result ordering. Omit for the default relevance order. `advertisement_country_rank` orders by the company's advertising rank inside the country named in `advertisement_country_activity` (rank 1 = biggest advertiser in that market) and is ignored unless that filter is present. Pair with `is_ascending_order: false` to list the smallest advertisers first. Not yet available: `name` (either direction) and `relevance` with `is_ascending_order: false` — those requests time out. Use the default relevance order, `number_of_employees` or `founded_year` instead." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref46": { "type": "array", "items": { "type": "object", "properties": { "key": { "enum": [ "keywords", "verticals", "vertical_categories", "vertical_sub_categories", "technologies", "categories", "social_media", "advertisement_target_locations", "job_exclude_locations" ], "type": "string", "example": "keywords", "description": "The filter key specifying which property to apply the operator to." }, "operator": { "enum": [ "or", "and" ], "type": "string", "example": "or", "description": "The logical operator to apply. Use 'or' to match any of the specified values, or 'and' to require all specified values." } } }, "description": "Advanced filtering options for company searches. Specify conditions combining keys and logical operators to refine search results." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref47": { "type": "boolean", "description": "When enabled, the filters listed above that support similarity searches can be filled with free text for specific IDs." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref48": { "type": "number", "format": "float", "example": 0.7, "description": "It is used in conjunction with `is_enable_similarity_search`. This number is used to analyze whether a specific slug (e.g. vertical industry, technology) is similar to the user input, and the higher the number, the more stringent it is." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref49": { "type": "array", "items": { "type": "string" }, "example": [ "emails", "phones", "contacts" ], "description": "List of fields to exclude from the response payload." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref50": { "type": "boolean", "description": "Indicates whether parameter metadata is available for the request." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref51": { "type": "boolean", "description": "Indicates whether profile metadata is available for the request." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref52": { "type": "integer", "default": 25, "example": 25, "maximum": 25, "description": "Records per page. Defaults to 25, which is also the ceiling on most plans — the limit is your subscription's `max_search_per_page`, returned by [Profile](/en/api-reference/endpoint/profile/profile). Exceeding it returns **HTTP 416** with code `41676` (or `41613` on company and people search), not a clamped result set." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref53": { "type": "integer", "default": 1, "example": 1, "description": "Page number, starting at 1. The ceiling is your subscription's `max_search_page` (`max_company_search_page` for company search), returned by [Profile](/en/api-reference/endpoint/profile/profile). Exceeding it returns **HTTP 416**." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref54": { "type": "array", "items": { "type": "string" }, "example": [ "AWS", "Cloudflare" ], "description": "Companies that use any of these providers anywhere. The unprefixed `providers` narrows the rows returned; this narrows the companies." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref55": { "type": "array", "items": { "type": "string" }, "example": [ "AWS", "Cloudflare", "Hetzner" ], "description": "Remove footprint rows matching these cloud or hosting providers. Scoped to this footprint row — one provider in one country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref56": { "type": "array", "items": { "type": "string" }, "example": [ "DE", "SG" ], "description": "Companies present in any of these countries anywhere in their footprint." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref57": { "type": "array", "items": { "type": "string" }, "example": [ "DE", "US", "SG" ], "description": "Remove footprint rows matching these country codes the infrastructure sits in." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref58": { "type": "array", "items": { "type": "string" }, "example": [ "us-east-1", "eu-central-1" ], "description": "Restrict results to footprint rows matching these cloud regions. Scoped to this footprint row — one provider in one country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref59": { "type": "array", "items": { "type": "string" }, "example": [ "us-east-1", "eu-central-1" ], "description": "Remove footprint rows matching these cloud regions. Scoped to this footprint row — one provider in one country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref60": { "type": "array", "items": { "type": "string" }, "example": [ "Ashburn", "Frankfurt" ], "description": "Restrict results to footprint rows matching these cities. Scoped to this footprint row — one provider in one country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref61": { "type": "array", "items": { "type": "string" }, "example": [ "Ashburn", "Frankfurt" ], "description": "Remove footprint rows matching these cities. Scoped to this footprint row — one provider in one country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref62": { "type": "array", "items": { "type": "string", "nullable": true }, "example": [ "2026-01-01", null ], "maxItems": 2, "minItems": 2, "description": "Two ISO 8601 dates (YYYY-MM-DD) bounding when the footprint was first seen. Scoped to this footprint row — one provider in one country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref63": { "type": "array", "items": { "type": "string", "nullable": true }, "example": [ "2026-01-01", null ], "maxItems": 2, "minItems": 2, "description": "Two ISO 8601 dates (YYYY-MM-DD) bounding when the footprint was last seen. Scoped to this footprint row — one provider in one country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref64": { "type": "boolean", "example": true, "description": "When true, return only footprint rows outside the company's home market. Rows whose company has no known headquarters are excluded." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref65": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum hosts. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref66": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum servers (distinct IP addresses). Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref67": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum servers shared with other companies. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref68": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum distinct providers used by the company. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref69": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum countries the company hosts in. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref70": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum countries outside the company's home market. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref71": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum cloud regions. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref72": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum cities. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref73": { "type": "array", "items": { "type": "string" }, "example": [ "AWS" ], "description": "Companies whose single largest provider is one of these." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref74": { "type": "object", "required": [ "country" ], "properties": { "country": { "type": "string", "example": "DE", "description": "ISO 3166-1 alpha-2 country code." }, "last_seen": { "type": "array", "items": { "type": "string", "nullable": true }, "example": [ "2026-07-01", null ], "maxItems": 2, "minItems": 2 }, "city_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 100, null ], "maxItems": 2, "minItems": 2 }, "first_seen": { "type": "array", "items": { "type": "string", "nullable": true }, "example": [ "2026-07-01", null ], "maxItems": 2, "minItems": 2 }, "host_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 100, null ], "maxItems": 2, "minItems": 2 }, "region_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 100, null ], "maxItems": 2, "minItems": 2 }, "server_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 100, null ], "maxItems": 2, "minItems": 2 }, "shared_server_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 100, null ], "maxItems": 2, "minItems": 2 } }, "description": "Bounds scoped to one country: `{\"country\":\"DE\",\"host_count\":[100,null]}` finds companies running 100+ hosts in Germany specifically. The bare `cloud_footprint_host_count` is the company total across all countries, so the two cannot express this together. `country` alone is rejected." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref75": { "type": "object", "nullable": true, "description": "Response info depends on specific endpoint." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref76": { "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "details" ], "properties": { "code": { "type": "integer", "example": 40001 }, "details": { "type": "object" }, "message": { "type": "string", "example": "Errors and codes will vary depending on the scenario, please see the documentation for information." } } } } }, "description": "Bad request. The request was malformed or contained invalid parameters. Check the error code and message for details." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref77": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "Request rate limit exceeded. Please wait and try again later." } } } } }, "description": "Rate limit exceeded. Too many requests were made in a given time period. Retry after the rate limit window resets." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref78": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "An unexpected error occurred on the server." } } } } }, "description": "Internal server error. An unexpected error occurred on the server. Contact support if the error persists." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref0": { "type": "string", "example": "pubrio", "description": "A string of words over which we want to filter the results." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref1": { "type": "string", "example": "king", "description": "Filter search results to include a specific people name." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref2": { "type": "array", "items": { "type": "string" }, "example": [ "sales manager", "marketing manager" ], "description": "Job titles associated with the individuals you aim to locate. \n\n The results will also encompass job titles that include similar terminology, even if they do not match exactly. For instance, searching for `software engineer` may yield results for individuals with the title `senior software engineer`." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref3": { "type": "array", "items": { "type": "string" }, "example": [ "intern", "assistant" ], "description": "Job titles to leave out. Same word-level matching as `people_titles`, so `[\"senior\"]` removes every title containing that word. Applied after `people_titles`." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref4": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A list of unique identifiers (people_search_id) used for people search operations." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref5": { "type": "array", "items": { "enum": [ "c_suite", "director", "entry", "founder", "head", "intern", "manager", "owner", "partner", "senior", "vp" ], "type": "string" }, "example": [ "c_suite", "vp" ], "description": "Reporting tier of the person. The C-suite slug is `c_suite`, not `c_level`. An unknown slug matches nobody. Full list from the `management level` endpoint under Filters." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref6": { "type": "array", "items": { "type": "string" }, "example": [ "master_human_resources" ], "description": "The department field can search for people in specific areas of expertise. \n\n Check out `department` endpoints under the Filters tab for more information." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref7": { "type": "array", "items": { "type": "string" }, "example": [ "master_human_resources" ], "description": "Department slugs to leave out. Same vocabulary as `departments`. People with no department recorded are kept." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref8": { "type": "array", "items": { "type": "string" }, "example": [ "human_resources" ], "description": "The filter field for job functions can specify particular roles or areas of expertise when searching for people. \n\n Check out `department functions` endpoints under the Filters tab for more information." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref9": { "type": "array", "items": { "type": "string" }, "example": [ "software_development" ], "description": "Function slugs to leave out. Same vocabulary as `department_functions`. People with no function recorded are kept." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref10": { "type": "array", "items": { "type": "array", "items": { "type": "string" } }, "example": [ [ 1, 10 ], [ 11, 20 ], [ 10001 ] ], "description": "The number range of employees working for the company. This enables you to find companies based on headcount. You can add multiple ranges to expand your search results. \n\n Check out `company size` endpoints under the Filters tab for more information." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref11": { "type": "array", "items": { "type": "string" }, "example": [ "US", "SG", "CN" ], "description": "The location where people live. Check out `location` endpoints under the Filters tab for more information." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref12": { "type": "array", "items": { "type": "string" }, "example": [ "US" ], "description": "Countries the person must **not** live in (ISO 3166-1 alpha-2). Companion of `people_locations`." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref13": { "type": "array", "items": { "type": "string" }, "example": [ "US", "SG", "CN" ], "description": "The location of the company headquarters. Check out `location` endpoints under the Filters tab for more information." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref14": { "type": "array", "items": { "type": "string" }, "example": [ "CN" ], "description": "Headquarters countries to leave out (ISO 3166-1 alpha-2). Companion of `company_locations`; sending the same code in both returns nothing." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref15": { "type": "array", "items": { "type": "string" }, "example": [ "https://www.linkedin.com/company/pubrio" ], "description": "The fully formed URL of the LinkedIn company profile. URL begin with `http` and contain `linkedin.com/company/`" }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref16": { "type": "array", "items": { "type": "string" }, "example": [ "http://www.linkedin.com/in/king-lai-605382b7" ], "description": "The fully formed URL of the LinkedIn user profile. URL begin with `http` and contain `linkedin.com/in/` or `linkedin.com/pub/`" }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref17": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A list of unique identifiers (domain_search_id) used for company and people search operations." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref18": { "type": "array", "items": { "type": "string" }, "example": [ "pubrio.com" ], "description": "List of company domains used for company and people search operations. If we receive a URL such as `www.pubrio.com` or `https://docs.pubrio.com/`, the system will convert it to `pubrio.com` for processing." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref19": { "type": "object", "example": { "technologies": [ 37, 152 ], "founded_dates": [ 2015, 2023 ], "company_locations": [ "US" ], "filter_conditions": [ { "key": "technologies", "operator": "and" } ] }, "description": "Wrapper object for company-level filters. Recommended grouping that visually separates which keys filter the *person* (top-level) from which filter the *company*. Accepts the same keys as the top-level company filters (e.g. `technologies`, `verticals`, `vertical_categories`, `vertical_sub_categories`, `categories`, `keywords`, `founded_dates`, `employees`, `revenues`, `company_locations`, `company_exclude_locations`, `company_places`, `company_exclude_places`, `companies`, `domains`, `company_linkedin_urls`, `is_enable_similarity_search`, `similarity_score`, plus `filter_conditions`). Engine flattens this object to the top level before processing — top-level keys win on conflict. Same shape used by Monitor `company_filters`. See the Filters Overview developer guide for examples." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref20": { "type": "array", "items": { "type": "object", "properties": { "key": { "enum": [ "keywords", "verticals", "vertical_categories", "vertical_sub_categories", "technologies", "categories", "social_media" ], "type": "string", "example": "technologies", "description": "The filter key specifying which property to apply the operator to." }, "operator": { "enum": [ "or", "and" ], "type": "string", "example": "and", "description": "The logical operator to apply. Use 'or' to match any of the specified values, or 'and' to require all specified values." } } }, "description": "Per-key AND/OR override for filters in /people/search. Defaults to OR when omitted. See the People + Company Filters developer guide for the full key-remap reference." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref21": { "type": "boolean", "description": "When enabled, the filters listed above that support similarity searches can be filled with free text for specific IDs." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref22": { "type": "number", "format": "float", "example": 0.7, "description": "It is used in conjunction with `is_enable_similarity_search`. This number is used to analyze whether a specific slug (e.g. vertical industry, technology) is similar to the user input, and the higher the number, the more stringent it is." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref23": { "type": "integer", "default": 25, "example": 25, "maximum": 25, "description": "Records per page. Defaults to 25, which is also the ceiling on most plans — the limit is your subscription's `max_search_per_page`, returned by [Profile](/en/api-reference/endpoint/profile/profile). Exceeding it returns **HTTP 416** with code `41676` (or `41613` on company and people search), not a clamped result set." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref24": { "type": "integer", "default": 1, "example": 1, "description": "Page number, starting at 1. The ceiling is your subscription's `max_search_page` (`max_company_search_page` for company search), returned by [Profile](/en/api-reference/endpoint/profile/profile). Exceeding it returns **HTTP 416**." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref25": { "type": "array", "items": { "type": "integer" }, "description": "A list of `tag_id` used to search for specific technologies used by companies. To find the ID, call the `technology` endpoint under the Filters tab.\n\nThis filter supports `is_enable_similarity_search`, once enabled you can enter any free text, e.g. `[\"Shopify\"]`.\n\nA product name the technology list knows matches that product and its own products (`\"Salesforce\"` also matches Salesforce Desk and Salesforce Service Cloud), never look-alikes; other text matches by similarity." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref26": { "type": "array", "items": { "type": "integer" }, "description": "A list of `category_id` used to search for specific categories of technology used by companies. To find the ID, call the `category` endpoint under the Filters tab.\n\nThis filter supports `is_enable_similarity_search`, once enabled you can enter any free text, e.g. `[\"CDN\"]`." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref27": { "type": "array", "items": { "type": "integer" }, "description": "A list of `vertical_id` used to search for companies in a specific vertical or industry. To find the ID, call the `vertical` endpoint under the Filters tab.\n\nThis filter supports `is_enable_similarity_search`, once enabled you can enter any free text, e.g. `[\"AI\"]`." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref28": { "type": "array", "items": { "type": "integer" }, "description": "A list of `vertical_category_id` used to search for companies in a specific vertical category. To find the ID, call the `vertical category` endpoint under the Filters tab.\n\nThis filter supports `is_enable_similarity_search`, once enabled you can enter any free text, e.g. `[\"Information Technology\"]`." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref29": { "type": "array", "items": { "type": "integer" }, "description": "A list of `vertical_sub_category_id` used to search for companies in a specific vertical sub-category. To find the ID, call the `vertical sub category` endpoint under the Filters tab.\n\nThis filter supports `is_enable_similarity_search`, once enabled you can enter any free text, e.g. `[\"Software\"]`." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref30": { "type": "array", "items": { "type": "string" }, "example": [ "ecommerce", "ai", "fintech" ], "description": "A list of keywords to filter companies by relevance, specialties, or descriptions." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref31": { "type": "array", "items": { "type": "integer" }, "example": [ 2018, 2024 ], "description": "Years of company founded range. The maximum value founded is the current year." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref32": { "type": "array", "items": { "type": "integer" }, "example": [ 0, 100000 ], "description": "Minimum and maximum range of company revenue." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref33": { "type": "array", "items": { "type": "string" }, "example": [ "Tokyo" ], "description": "Place names (city, region) used to filter results. Accepts localized or English place names." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref34": { "type": "array", "items": { "type": "string" }, "example": [ "Tokyo" ], "description": "Place names (city, region) to exclude from results. Accepts localized or English place names." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref35": { "type": "object", "nullable": true, "description": "Response info depends on specific endpoint." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref36": { "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "details" ], "properties": { "code": { "type": "integer", "example": 40001 }, "details": { "type": "object" }, "message": { "type": "string", "example": "Errors and codes will vary depending on the scenario, please see the documentation for information." } } } } }, "description": "Bad request. The request was malformed or contained invalid parameters. Check the error code and message for details." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref37": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "Request rate limit exceeded. Please wait and try again later." } } } } }, "description": "Rate limit exceeded. Too many requests were made in a given time period. Retry after the rate limit window resets." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref38": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "An unexpected error occurred on the server." } } } } }, "description": "Internal server error. An unexpected error occurred on the server. Contact support if the error persists." } } }, "paths": { "/companies/advertisements/search": { "post": { "summary": "Search for company advertisements", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref35", "type": "object", "properties": { "page": { "type": "integer", "description": "Current page number." }, "per_page": { "type": "integer", "description": "Records per page." }, "is_timeout": { "type": "boolean", "description": "`true` when the search ran out of time. `total_entries` then only counts the rows returned so far, and an empty page means the search did not finish, not that nothing matched." }, "total_pages": { "type": "integer", "description": "`total_entries` divided by `per_page`." }, "is_estimated": { "type": "boolean", "description": "`true` when `total_entries` is an estimate rather than an exact count. Do not use an estimated total to decide when to stop paging; stop when a page returns fewer rows than `per_page`." }, "total_entries": { "type": "integer", "description": "Total matching records. An estimate when `is_estimated` is `true`." }, "total_display_pages": { "type": "integer", "description": "Page count for this result, capped by your plan's `max_display_search_page`." } }, "description": "Pagination for the result set." }, "advertisements": { "type": "array", "items": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref36", "type": "object", "properties": { "title": { "type": "string", "nullable": true, "description": "Headline or ad title." }, "ended_at": { "type": "string", "format": "date-time", "nullable": true, "description": "When the ad stopped running; `null` while it is still running." }, "companies": { "type": "object", "properties": { "domain": { "type": "string", "description": "Company domain, normalised (`stripe.com`)." }, "logo_url": { "type": "string", "nullable": true, "description": "Company logo URL." }, "company_url": { "type": "string", "nullable": true, "description": "Company website URL." }, "company_name": { "type": "string", "description": "Company name." }, "country_code": { "type": "string", "nullable": true, "description": "ISO 3166-1 alpha-2 code of the company headquarters." }, "linkedin_name": { "type": "string", "nullable": true, "description": "LinkedIn company slug (the part after `linkedin.com/company/`)." }, "domain_search_id": { "type": "string", "format": "uuid", "description": "Pubrio company identifier. Pass it to `companies` on any search, or to Company Lookup." } }, "description": "The company the record is linked to." }, "image_url": { "type": "string", "nullable": true, "description": "Creative image, when the ad has one." }, "video_url": { "type": "string", "nullable": true, "description": "Creative video, when the ad has one." }, "advertiser": { "type": "string", "nullable": true, "description": "Advertiser name as shown by the source." }, "created_at": { "type": "string", "format": "date-time", "description": "When Pubrio first captured the ad. This is the default sort key." }, "started_at": { "type": "string", "format": "date-time", "nullable": true, "description": "When the ad started running, as reported by the source." }, "source_type": { "type": "string", "description": "Source the ad was captured from. Same vocabulary as the `source_types` filter. Allowed values: linkedin, facebook, google, tiktok, apple." }, "raw_link_url": { "type": "string", "nullable": true, "description": "The original link exactly as captured, before unwrapping." }, "last_modified": { "type": "string", "format": "date-time", "description": "When the record was last updated." }, "advertiser_url": { "type": "string", "nullable": true, "description": "Advertiser page at the source, when available." }, "carousel_images": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Carousel frames, for carousel formats." }, "destination_url": { "type": "string", "nullable": true, "description": "Resolved landing page. Facebook click-wrappers such as `fb.me` are unwrapped to the real funnel URL." }, "advertisement_id": { "type": "string", "format": "uuid", "description": "Advertisement identifier." }, "advertisement_url": { "type": "string", "nullable": true, "description": "Link to the ad in the source's ad library, when available." }, "total_impressions": { "type": "string", "nullable": true, "description": "Impression estimate exactly as the source publishes it, e.g. `< 1k`, `10k-50k`. `null` for sources that do not report impressions." }, "is_company_matched": { "type": "boolean", "description": "`true` when the ad is linked to a Pubrio company record. Unlinked ads are returned only with `is_include_unlinked_companies: true`." }, "publisher_platforms": { "type": "array", "items": { "type": "string", "description": "Allowed values: facebook, instagram, messenger, threads, audience_network." }, "nullable": true, "description": "Meta surfaces the ad ran on: `facebook`, `instagram`, `messenger`, `threads`, `audience_network`. `null` for non-`facebook` sources." }, "advertisement_format": { "type": "string", "nullable": true, "description": "Format label exactly as the source publishes it, e.g. `Single Image Ad`, `MULTI_IMAGES`." }, "target_country_codes": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Countries the ad was shown in (ISO 3166-1 alpha-2). Same vocabulary as the `target_locations` filter." }, "advertisement_search_id": { "type": "string", "format": "uuid", "description": "Same value as `advertisement_id`. Pass it to Advertisement Lookup." }, "total_impressions_lower": { "type": "integer", "nullable": true, "description": "Lower bound of the impression range; `null` for `< N` ranges." }, "total_impressions_upper": { "type": "integer", "nullable": true, "description": "Upper bound of the impression range; `null` for open-ended ranges." }, "advertisement_format_normalized": { "type": "string", "nullable": true, "description": "Canonical format, the vocabulary the `advertisement_formats` filter accepts. `other` when the raw label is not mapped. Allowed values: image, video, text, carousel, dynamic_product, document, message, event, article, spotlight, follow, job, engagement, other." } }, "description": "One advertisement." } } } }, "metadata": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref33", "type": "object", "properties": { "filters": { "type": "object", "description": "Echo of the request body as the endpoint applied it, including defaults such as `per_page` and `language`." }, "profile": { "type": "object", "nullable": true, "description": "Credit block (`credit`, `topup_credit`, `total_credit_cost`) when credit accounting is requested; `null` on plain API-key traffic." }, "coverage_notes": { "type": "array", "items": { "type": "object", "properties": { "scope": { "type": "string", "description": "Allowed values: eea_uk_ch." }, "source_type": { "type": "string" } } }, "description": "Coverage notes for the requested sources, when applicable." }, "ignored_fields": { "type": "array", "items": { "type": "string" }, "description": "Body keys the endpoint did not recognise and dropped. Empty means every key applied — a misspelled filter widens the search instead of failing." }, "applied_source_types": { "type": "array", "items": { "type": "string" }, "description": "Only when `source_types` was sent: the values that were recognised and applied." }, "skipped_source_types": { "type": "array", "items": { "type": "object", "properties": { "reason": { "type": "string", "description": "Why the source was not applied. Allowed values: country_unknown_until_enriched." }, "source_type": { "type": "string", "description": "Source that was skipped." } } }, "description": "Sources that were not applied for the requested `target_locations`, each with a `reason`." }, "unsupported_source_types": { "type": "array", "items": { "type": "string" }, "description": "Only when `source_types` contained a value that is not a known source. Those values match nothing." } }, "description": "Request context." } } }, "example": { "data": { "pagination": { "page": 1, "per_page": 25, "is_timeout": false, "total_pages": 27775, "total_entries": 694356, "total_display_pages": 250 }, "advertisements": [ { "title": "Thuraya-4 Satellite Solutions for Energy", "ended_at": "2026-03-02T00:00:00.000Z", "companies": { "domain": "space42.ai", "logo_url": "https://buckets.pubrio.com/company-logo/MjA3NTQ4NjQyM2lsajlzc25qMXNwYWNlNDIuYWlsaW5rZWRpbl82NDIyMjM3NA==.jpg", "company_name": "Space42", "country_code": "AE", "linkedin_name": "space42ai", "domain_search_id": "fe3963dc-87a4-4016-8c95-217ea68cd57a" }, "image_url": "https://buckets.pubrio.com/images/public/cL1U5ghYPAy65qc4cu5wtmgzv8P9xJgrofNTwohPWsyT3S5ob2zNp6Jov1nM9aaDRy.jpg", "video_url": null, "advertiser": "Thuraya", "created_at": "2026-03-03T01:46:35.909Z", "started_at": "2026-02-25T00:00:00.000Z", "source_type": "linkedin", "raw_link_url": null, "last_modified": "2026-03-03T12:46:25.289Z", "advertiser_url": "https://www.linkedin.com/company/thuraya", "carousel_images": null, "destination_url": "https://www.thuraya.com/en/thuraya-4-ngs/home/index.html?trk=ad_library_ad_preview_headline_content", "advertisement_id": "3af8cb80-9a04-49a8-832d-333961d5f77a", "advertisement_url": "https://www.linkedin.com/ad-library/detail/1518455034", "total_impressions": "< 1k", "is_company_matched": true, "publisher_platforms": null, "advertisement_format": "Single Image Ad", "target_country_codes": [ "US", "GB", "SG" ], "advertisement_search_id": "3af8cb80-9a04-49a8-832d-333961d5f77a", "total_impressions_lower": null, "total_impressions_upper": 1000, "advertisement_format_normalized": "image" }, { "title": "Dubai Opportunities. One Exclusive Event", "ended_at": "2026-06-03T07:00:00.000Z", "companies": { "domain": "damacproperties.com", "logo_url": "https://buckets.pubrio.com/company-logo/MjYwODA0MjRkYW1hY3Byb3BlcnRpZXMuY29tbGlua2VkaW5fcF9sb2dvMTU=.jpg", "company_name": "Damac Properties", "country_code": "AE", "linkedin_name": "damac-properties", "domain_search_id": "9da7386c-5bdc-42b2-8fee-456e91024a3a" }, "image_url": "https://buckets.pubrio.com/images/public/4snZgJwKCWEYwAUwxrkkK1ooEFEAMF92Xet6Bm16oAyqwUSoqekDjX8S9DmfixutuH.jpg", "video_url": null, "advertiser": "Thuraya", "created_at": "2026-06-03T22:00:33.035Z", "started_at": "2026-05-25T07:00:00.000Z", "source_type": "facebook", "raw_link_url": "http://fb.me/", "last_modified": "2026-06-05T18:15:51.823Z", "advertiser_url": "https://www.linkedin.com/company/thuraya", "carousel_images": null, "destination_url": "https://promotions.damacproperties.com/en/event-in-egypt-social-specific/", "advertisement_id": "47eb6229-e7aa-427f-bcd3-76e154fd5022", "advertisement_url": "https://www.linkedin.com/ad-library/detail/1518455034", "total_impressions": "< 1k", "is_company_matched": true, "publisher_platforms": [ "facebook", "instagram" ], "advertisement_format": "DCO", "target_country_codes": [ "US", "GB", "SG" ], "advertisement_search_id": "47eb6229-e7aa-427f-bcd3-76e154fd5022", "total_impressions_lower": null, "total_impressions_upper": 1000, "advertisement_format_normalized": "image" }, "..." ] }, "metadata": { "filters": { "language": "en", "per_page": 25, "source_types": [ "linkedin" ] }, "profile": null, "ignored_fields": [], "applied_source_types": [ "linkedin" ] } } } }, "description": "Successful response containing company advertisement search details." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref38", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "details" ], "properties": { "code": { "type": "integer", "example": 40001 }, "details": { "type": "object" }, "message": { "type": "string", "example": "Errors and codes will vary depending on the scenario, please see the documentation for information." } } } } }, "description": "Bad request. The request was malformed or contained invalid parameters. Check the error code and message for details." }, "402": { "description": "Payment required" }, "429": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref39", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "Request rate limit exceeded. Please wait and try again later." } } } } }, "description": "Rate limit exceeded. Too many requests were made in a given time period. Retry after the rate limit window resets." }, "500": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref40", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "An unexpected error occurred on the server." } } } } }, "description": "Internal server error. An unexpected error occurred on the server. Contact support if the error persists." } }, "description": "Search advertisements run by companies. See the [Advertisement Search guide](/en/developer-guides/search/advertisement-search).", "operationId": "companies_search_advertisements", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref28", "type": "integer", "default": 1, "example": 1, "description": "Page number, starting at 1. The ceiling is your subscription's `max_search_page` (`max_company_search_page` for company search), returned by [Profile](/en/api-reference/endpoint/profile/profile). Exceeding it returns **HTTP 416**." }, "query": { "type": "string" }, "domains": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref12", "type": "array", "items": { "type": "string" }, "example": [ "pubrio.com" ], "description": "List of company domains used for company and people search operations. If we receive a URL such as `www.pubrio.com` or `https://docs.pubrio.com/`, the system will convert it to `pubrio.com` for processing." }, "filters": { "type": "object", "properties": { "source_types": { "type": "array", "items": { "enum": [ "linkedin", "facebook", "google", "tiktok", "apple" ], "type": "string" } }, "advertisement_formats": { "type": "array", "items": { "enum": [ "image", "video", "text", "carousel", "dynamic_product", "document", "message", "event", "article", "spotlight", "follow", "job", "engagement", "other" ], "type": "string" } } } }, "per_page": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref27", "type": "integer", "default": 25, "example": 25, "description": "Records per page. Defaults to 25, which is also the ceiling on most plans — the limit is your subscription's `max_search_per_page`, returned by [Profile](/en/api-reference/endpoint/profile/profile). Exceeding it returns **HTTP 416** with code `41676` (or `41613` on company and people search), not a clamped result set." }, "companies": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref10", "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A list of unique identifiers (domain_search_id) used for company and people search operations." }, "end_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref6", "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-25", "2025-12-25" ], "description": "A list of end dates to filter search results." }, "headlines": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref3", "type": "array", "items": { "type": "string" }, "example": [ "ASUS", "iPhone" ], "description": "A list of headlines to filter search results." }, "created_at": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref8", "type": "string", "example": "2026-09-02T12:00:00Z", "description": "Ingested at or after this instant (UTC). Date or ISO timestamp. For incremental syncs pass the `created_at` of your newest stored row." }, "reach_tiers": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref16", "type": "array", "items": { "type": "string", "description": "Allowed values: lt_1k, 1k_10k, 10k_50k, 50k_100k, 100k_500k, 500k_1m, 1m_plus." }, "example": [ "100k_500k", "500k_1m", "1m_plus" ], "description": "Impression band of the ad: `lt_1k`, `1k_10k`, `10k_50k`, `50k_100k`, `100k_500k`, `500k_1m`, `1m_plus`. Ads without a `total_impressions` value never match; unknown slugs match nothing." }, "search_term": { "type": "string" }, "start_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref5", "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-01", "2025-12-01" ], "description": "A list of start dates to filter search results." }, "active_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref7", "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2026-08-01", "2026-08-31" ], "maxItems": 2, "minItems": 2, "description": "Inclusive `[from, to]` window (UTC). Returns ads running at any point in it, including ones that started earlier, so it reconciles with Advertisement Insights. Undated ads count from `created_at`. Both dates required, `from` ≤ `to`." }, "search_terms": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref2", "type": "array", "items": { "type": "string" }, "example": [ "pubrio" ], "description": "A list of strings over which we want to filter the results." }, "source_types": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref24", "type": "array", "items": { "type": "string", "description": "Allowed values: linkedin, facebook, google, tiktok, apple." }, "example": [ "linkedin", "facebook" ], "description": "Sources to include: `linkedin`, `facebook` (`meta` accepted), `google`, `tiktok`, `apple`. Unknown values match nothing and are echoed in `metadata.unsupported_source_types`." }, "linkedin_urls": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref13", "type": "array", "items": { "type": "string" }, "example": [ "https://www.linkedin.com/company/pubrio" ], "description": "The fully formed URL of the LinkedIn company profile. URL begin with `http` and contain `linkedin.com/company/`" }, "enrichment_mode": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref26", "type": "string", "default": "default", "example": "latest", "description": "Controls realtime enrichment behavior. `default` returns whatever is already in the database, and triggers enrichment only when the result set is empty and `is_realtime_enrichment` is set. `latest` bypasses the cache and forces a re-enrichment pass against the freshest source records on every call — it triggers enrichment on its own without needing any other flag. Allowed values: default, latest." }, "target_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref0", "type": "array", "items": { "type": "string" }, "example": [ "TW", "AE", "NO" ], "description": "Country codes the results must target. Combines with `filter_conditions` as OR by default — a result matches if it targets any of them." }, "company_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref9", "type": "array", "items": { "type": "string" }, "example": [ "US", "SG", "CN" ], "description": "The location of the company headquarters. Check out `location` endpoints under the Filters tab for more information." }, "filter_conditions": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref4", "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "target_locations", "description": "The filter key specifying which property to apply the operator to. Allowed values: target_locations, publisher_platforms." }, "operator": { "type": "string", "example": "or", "description": "The logical operator to apply. Use 'or' to match advertisements carrying any of the listed values, or 'and' to require all of them. Allowed values: or, and." } } }, "description": "Advanced filtering options for advertisement searches. Specify conditions to refine your search results for the ads search endpoint." }, "is_ascending_order": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref29", "type": "boolean", "default": false, "example": false, "description": "Sort direction. Results are returned newest-first by default; set `true` for oldest-first. There is no `sort_by` on this endpoint — the sort key is fixed and stated in the endpoint description." }, "publisher_platforms": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref30", "type": "array", "items": { "type": "string", "description": "Allowed values: facebook, instagram, messenger, threads, audience_network." }, "example": [ "facebook", "instagram" ], "description": "Filter Facebook/Meta ads by the platform surface they were delivered on. Lowercase and case-insensitive. Only applies to the `facebook` source (other sources are single-platform)." }, "exclude_source_types": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref25", "type": "array", "items": { "type": "string", "description": "Allowed values: linkedin, facebook, google, tiktok, apple." }, "example": [ "apple" ], "description": "Exclude ads captured from these sources. Same vocabulary as `source_types` (`linkedin`, `facebook`, `google`, `tiktok`, `apple`; `meta` is an alias of `facebook`). Unknown values are ignored." }, "advertisement_formats": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref15", "type": "array", "items": { "type": "string", "description": "Allowed values: image, video, text, carousel, dynamic_product, document, message, event, article, spotlight, follow, job, engagement." }, "example": [ "image", "video" ], "description": "Find companies with at least one advertisement in any of these creative formats." }, "is_realtime_enrichment": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref14", "type": "boolean", "default": false, "example": true, "description": "Opt into realtime enrichment for a single, company-scoped query (filtered by `domain_search_id`, `domains`, or `linkedin_urls`). When the initial search returns zero results, the endpoint scrapes the source, persists the records, and re-runs the search before responding. Subject to a per-route deadline." }, "advertisement_search_id": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref11" } ], "example": "a92643e8-9033-4029-aa65-ef929327cebb", "description": "Return only this one record. Handy for re-fetching a row you stored earlier without paging." }, "advertisement_total_ads": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref19", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 10, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum count of the company's total advertisements ever recorded, across all countries." }, "advertisement_active_ads": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref17", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum count of the company's currently active advertisements, across all countries. Use `null` for an open-ended bound, e.g. `[1, null]` for \"at least one active ad\"." }, "exclude_target_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref1", "type": "array", "items": { "type": "string" }, "example": [ "IS", "GB", "FR", "IE", "ES" ], "description": "Country codes the results must not target. Combines with `filter_conditions` as OR by default — a result matches if it targets any of them." }, "advertisement_running_ads": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref18", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum count of the company's advertisements that are still running (no end date, or an end date in the future). Currently populated for LinkedIn ads only." }, "advertisement_format_count": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref21", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 2, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum number of distinct advertisement creative formats the company is actively running." }, "exclude_publisher_platforms": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref31", "type": "array", "items": { "type": "string", "description": "Allowed values: facebook, instagram, messenger, threads, audience_network." }, "example": [ "audience_network" ], "description": "Exclude Facebook/Meta ads delivered on these platform surfaces." }, "advertisement_platform_count": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref20", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 2, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum number of distinct ad platforms (linkedin, facebook, google, tiktok, apple) the company is actively advertising on." }, "is_include_unlinked_companies": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref32", "type": "boolean", "default": false, "example": true, "description": "Include ads not yet linked to a resolved company (raw-layer ads, e.g. scam or burner-page ads). Defaults to false, which returns only company-attributed ads." }, "advertisement_country_activity": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref23", "type": "object", "example": { "rank": [ null, 500 ], "country": "US" }, "properties": { "rank": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ null, 500 ], "maxItems": 2, "minItems": 2, "description": "Rank within that country by advertising volume. 1 is the biggest spender, and the number increases as advertising volume decreases. Use `[null, 500]` to find the top 500 biggest spenders in that country; use `[500, null]` to find everyone ranked 500th or lower." }, "country": { "type": "string", "example": "US", "description": "ISO 3166-1 alpha-2 country code to scope this filter to. Required." }, "last_seen": { "type": "array", "items": { "type": "string", "format": "date", "nullable": true }, "example": [ "2026-07-01", null ], "maxItems": 2, "minItems": 2, "description": "[from, to] window for when the company's most recent ad in this country ran, for the opposite question: who has gone quiet in a market." }, "total_ads": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 10, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum total advertisements, scoped to this country." }, "active_ads": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum active advertisements, scoped to this country." }, "first_seen": { "type": "array", "items": { "type": "string", "format": "date", "nullable": true }, "example": [ "2026-07-01", null ], "maxItems": 2, "minItems": 2, "description": "[from, to] window for when the company's earliest ad in this country ran — the \"newly entered this market\" filter. Either bound may be null for an open-ended window; dates use the request timezone. A company whose ads carry no start date has no first-seen value and is never reported as new." }, "percentile": { "type": "array", "items": { "type": "number", "nullable": true }, "example": [ 90, null ], "maxItems": 2, "minItems": 2, "description": "Percentile within that country by advertising volume, 0-100. Higher means a bigger spender. Use `[90, null]` for the top 10% of spenders in that country." }, "impressions": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1000, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum estimated impressions, scoped to this country." }, "running_ads": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum running advertisements, scoped to this country. Currently populated for LinkedIn ads only." }, "volume_score": { "type": "array", "items": { "type": "number", "nullable": true }, "example": [ 0.5, null ], "maxItems": 2, "minItems": 2, "description": "The underlying 0-1 advertising volume score that `rank` and `percentile` are both computed from." } }, "description": "Advertising activity for one specific country. `country` is required, and at least one other field must be set (a country by itself matches nothing). For an all-country total instead, use the top-level `advertisement_active_ads` / `advertisement_total_ads` / `advertisement_impressions_estimate` filters." }, "advertisement_impressions_estimate": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_e921baa7c4aaa095_ref22", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1000, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum estimated advertisement impressions, summed across all countries. Only advertisements with a reported impression range are counted." } } } } }, "required": true }, "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Bczf0ngsC6bcl6q0Du2IG", "authority": "official", "conflicts": [], "revisionId": "sdrn_4iDCRIPFDsZRmP0aGdw03" }, { "gaps": [], "pages": [], "sourceId": "sds_2u3p4yN9ciqx-ocEBGR74", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/created_at/format", "/requestBody/content/application/json/schema/properties/advertisement_search_id/format", "/requestBody/content/application/json/schema/properties/advertisement_country_activity/required" ], "revisionId": "sdrn_sF4Id8BIBdrnOh1M8jbor" }, { "gaps": [ "Missing request body schema and response schema details." ], "pages": [ 1 ], "sourceId": "sds__qoL1UlQ2hahHjRv-3RyA", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_8lrHjOTkOAWhpSD8DCe8p" }, { "gaps": [ "Missing specific schema for response body fields" ], "pages": [ 1 ], "sourceId": "sds_4QU1K-UtbB0JEFxtFT9j9", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/properties/per_page/maximum" ], "revisionId": "sdrn_YF3wEfhXeBDGcT4L2-sCE" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_GSpq9b1mCVzlyxet3sGTK", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/properties/per_page/maximum" ], "revisionId": "sdrn_1rAnE6tkDcV8ucEOBvBz-" }, { "gaps": [], "pages": [], "sourceId": "sds_H53dAzk1aB4Z5eLGWJqyx", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/created_at/format", "/requestBody/content/application/json/schema/properties/advertisement_search_id/format", "/requestBody/content/application/json/schema/properties/advertisement_country_activity/required" ], "revisionId": "sdrn_8wqdTxRjS8JDhJzOPw2b8" }, { "gaps": [ "Missing request body schema and parameters." ], "pages": [ 1 ], "sourceId": "sds_HSejgb_e4hgob_BpRggAh", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_-IurdnY8i0UFkVA71GDS4" }, { "gaps": [ "Missing full request schema definition", "Missing response schema definition" ], "pages": [ 1 ], "sourceId": "sds_iUXJyfBmCE_7260rzOdkp", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/properties/per_page/maximum" ], "revisionId": "sdrn_hQQ-C8uEx2j76eTz0TPqt" }, { "gaps": [ "Missing full response schema" ], "pages": [ 2, 3 ], "sourceId": "sds_nn5ddYxGCUtV3V6ihXysQ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/filter_conditions/items/required", "/requestBody/content/application/json/schema/properties/filter_conditions/items/properties/operator/enum", "/requestBody/required" ], "revisionId": "sdrn_f2SngYKaqfb5GyGVv4DE5" }, { "gaps": [ "Missing specific request/response schema details" ], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId", "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/required" ], "revisionId": "sdrn_BPN1iHD5tCVT4d4YJh-Wj" }, { "gaps": [ "Missing request body schema and response details." ], "pages": [ 1 ], "sourceId": "sds_szyMKh2_p4dgcKv4HWc5U", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_MjFi5p9pj2Upopb3AwYNv" }, { "gaps": [ "Missing explicit required fields in requestBody schema beyond filter_conditions." ], "pages": [ 1 ], "sourceId": "sds_TamtIq3Xczl_FSnnA8tJJ", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/required", "/requestBody/content/application/json/schema/properties/domains/description", "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/created_at/format", "/requestBody/content/application/json/schema/properties/created_at/description", "/requestBody/content/application/json/schema/properties/reach_tiers/items/enum", "/requestBody/content/application/json/schema/properties/reach_tiers/description", "/requestBody/content/application/json/schema/properties/active_dates/description", "/requestBody/content/application/json/schema/properties/source_types/items/enum", "/requestBody/content/application/json/schema/properties/linkedin_urls/description", "/requestBody/content/application/json/schema/properties/enrichment_mode/enum", "/requestBody/content/application/json/schema/properties/target_locations/description", "/requestBody/content/application/json/schema/properties/company_locations/description", "/requestBody/content/application/json/schema/properties/filter_conditions/items/properties/key/enum", "/requestBody/content/application/json/schema/properties/filter_conditions/items/properties/operator/enum", "/requestBody/content/application/json/schema/properties/filter_conditions/description", "/requestBody/content/application/json/schema/properties/publisher_platforms/items/enum", "/requestBody/content/application/json/schema/properties/exclude_source_types/items/enum", "/requestBody/content/application/json/schema/properties/advertisement_formats/items/enum", "/requestBody/content/application/json/schema/properties/advertisement_search_id/format", "/requestBody/content/application/json/schema/properties/advertisement_search_id/description", "/requestBody/content/application/json/schema/properties/advertisement_total_ads/description", "/requestBody/content/application/json/schema/properties/advertisement_active_ads/description", "/requestBody/content/application/json/schema/properties/exclude_target_locations/description", "/requestBody/content/application/json/schema/properties/advertisement_running_ads/description", "/requestBody/content/application/json/schema/properties/advertisement_format_count/description", "/requestBody/content/application/json/schema/properties/exclude_publisher_platforms/items/enum", "/requestBody/content/application/json/schema/properties/advertisement_platform_count/description", "/requestBody/content/application/json/schema/properties/advertisement_country_activity/required", "/requestBody/content/application/json/schema/properties/advertisement_impressions_estimate/description" ], "revisionId": "sdrn_rGwiYAEiJz_K4SrpiKDh-" }, { "gaps": [ "Missing explicit schema for filter_conditions object", "Missing full list of advertisement_formats enum values" ], "pages": [ 1 ], "sourceId": "sds_vFyb0GyZw9ybezxCTNBWb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/reach_tiers/items/enum", "/requestBody/content/application/json/schema/properties/active_dates/description", "/requestBody/content/application/json/schema/properties/source_types/items/enum", "/requestBody/content/application/json/schema/properties/enrichment_mode/enum", "/requestBody/content/application/json/schema/properties/advertisement_total_ads/items/type", "/requestBody/content/application/json/schema/properties/advertisement_active_ads/items/type", "/requestBody/content/application/json/schema/properties/advertisement_running_ads/items/type", "/requestBody/content/application/json/schema/properties/advertisement_format_count/items/type", "/requestBody/content/application/json/schema/properties/advertisement_platform_count/items/type", "/requestBody/content/application/json/schema/properties/advertisement_impressions_estimate/items/type" ], "revisionId": "sdrn_2DxLgs-5nooz-WV3Zij8Y" } ], "x-zeroclick-services": [ "search" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per credit (credits, service search)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "search", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/companies/cloud_footprints/search": { "post": { "summary": "Search for company cloud footprints", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": { "pagination": { "page": 1, "per_page": 1, "is_timeout": false, "total_pages": 48700, "total_entries": 48700, "total_display_pages": 250 }, "cloud_footprints": [ { "cities": null, "provider": "AWS", "companies": { "domain": "rtiap.com", "logo_url": "https://buckets.pubrio.com/company-logo/MTc4ODM0MDY5Nmlsajlzc25qMXJ0aWFwLmNvbWxpbmtlZGluXzQ3Njc2Nzkw.jpg", "company_url": "http://www.rtiap.com", "company_name": "RTIAP Soluciones Tecnológicas SpA", "country_code": "CL", "linkedin_name": "rtiap", "domain_search_id": "2ebd09b1-3bdf-4bf0-9732-c2ed6a734f77" }, "city_count": 0, "host_count": 232, "country_code": "US", "evidence_url": "https://www.pubrio.com/evidence/84c941ea04a8fa9ed1bbeabc8ff496a7", "last_seen_at": "2026-09-04T10:07:09.799Z", "region_count": 1, "server_count": 3, "cloud_regions": [ "us-east-1" ], "first_seen_at": "2026-07-26T16:57:20.362Z", "last_modified": "2026-09-04T10:26:52.183Z", "is_home_market": false, "domain_search_id": "2ebd09b1-3bdf-4bf0-9732-c2ed6a734f77", "cloud_footprint_id": "042fee02-5121-4f23-a166-69bc48e9dfe8", "shared_server_count": 0, "company_country_code": "CL" } ] }, "metadata": { "filters": { "page": 1, "language": "en", "per_page": 1, "is_cross_border_only": true }, "profile": null, "ignored_fields": [] } } } }, "description": "Paginated cloud footprint rows." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref39", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "details" ], "properties": { "code": { "type": "integer", "example": 40001 }, "details": { "type": "object" }, "message": { "type": "string", "example": "Errors and codes will vary depending on the scenario, please see the documentation for information." } } } } }, "description": "Bad request. The request was malformed or contained invalid parameters. Check the error code and message for details." }, "402": { "description": "Payment required" }, "429": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref40", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "Request rate limit exceeded. Please wait and try again later." } } } } }, "description": "Rate limit exceeded. Too many requests were made in a given time period. Retry after the rate limit window resets." }, "500": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref41", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "An unexpected error occurred on the server." } } } } }, "description": "Internal server error. An unexpected error occurred on the server. Contact support if the error persists." } }, "description": "Search the public cloud and hosting footprint of companies: which providers, countries and regions they run infrastructure in. Each row is one company at one provider in one country. See the [Cloud Footprint Search guide](/en/developer-guides/search/cloud-footprint-search).", "operationId": "companies_search_cloud_footprints", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref30", "type": "integer", "default": 1, "example": 1, "description": "Page number, starting at 1. The ceiling is your subscription's `max_search_page` (`max_company_search_page` for company search), returned by [Profile](/en/api-reference/endpoint/profile/profile). Exceeding it returns **HTTP 416**." }, "query": { "type": "string" }, "cities": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref6", "type": "array", "items": { "type": "string" }, "example": [ "Ashburn", "Frankfurt" ], "description": "Restrict results to footprint rows matching these cities. Scoped to this footprint row — one provider in one country." }, "domain": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref35", "type": "string", "example": "pubrio.com", "description": "A company domain used for company search operations. If we receive a URL such as `www.pubrio.com` or `https://docs.pubrio.com/`, the system will convert it to `pubrio.com` for processing." }, "domains": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref28", "type": "array", "items": { "type": "string" }, "example": [ "pubrio.com" ], "description": "List of company domains used for company and people search operations. If we receive a URL such as `www.pubrio.com` or `https://docs.pubrio.com/`, the system will convert it to `pubrio.com` for processing." }, "per_page": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref29", "type": "integer", "default": 25, "example": 25, "description": "Records per page. Defaults to 25, which is also the ceiling on most plans — the limit is your subscription's `max_search_per_page`, returned by [Profile](/en/api-reference/endpoint/profile/profile). Exceeding it returns **HTTP 416** with code `41676` (or `41613` on company and people search), not a clamped result set." }, "companies": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref27", "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A list of unique identifiers (domain_search_id) used for company and people search operations." }, "providers": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref0", "type": "array", "items": { "type": "string" }, "example": [ "AWS", "Cloudflare", "Hetzner" ], "description": "Restrict results to footprint rows matching these cloud or hosting providers. Scoped to this footprint row — one provider in one country." }, "city_count": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref15", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum cities. Use `null` for an open-ended bound. Scoped to this footprint row — one provider in one country." }, "host_count": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref11", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum hosts. Use `null` for an open-ended bound. Scoped to this footprint row — one provider in one country." }, "region_count": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref14", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum cloud regions. Use `null` for an open-ended bound. Scoped to this footprint row — one provider in one country." }, "server_count": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref12", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum servers (distinct IP addresses). Use `null` for an open-ended bound. Scoped to this footprint row — one provider in one country." }, "cloud_regions": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref4", "type": "array", "items": { "type": "string" }, "example": [ "us-east-1", "eu-central-1" ], "description": "Restrict results to footprint rows matching these cloud regions. Scoped to this footprint row — one provider in one country." }, "linkedin_urls": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref37", "type": "array", "items": { "type": "string" }, "example": [ "https://www.linkedin.com/company/pubrio" ], "description": "The fully formed URL of the LinkedIn company profile. URL begin with `http` and contain `linkedin.com/company/`" }, "exclude_cities": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref7", "type": "array", "items": { "type": "string" }, "example": [ "Ashburn", "Frankfurt" ], "description": "Remove footprint rows matching these cities. Scoped to this footprint row — one provider in one country." }, "last_seen_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref9", "type": "array", "items": { "type": "string", "nullable": true }, "example": [ "2026-01-01", null ], "maxItems": 2, "minItems": 2, "description": "Two ISO 8601 dates (YYYY-MM-DD) bounding when the footprint was last seen. Scoped to this footprint row — one provider in one country." }, "domain_search_id": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref36", "type": "string", "description": "A unique identifier for the company search operation." }, "first_seen_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref8", "type": "array", "items": { "type": "string", "nullable": true }, "example": [ "2026-01-01", null ], "maxItems": 2, "minItems": 2, "description": "Two ISO 8601 dates (YYYY-MM-DD) bounding when the footprint was first seen. Scoped to this footprint row — one provider in one country." }, "target_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref2", "type": "array", "items": { "type": "string" }, "example": [ "TW", "AE", "NO" ], "description": "Country codes the results must target. Combines with `filter_conditions` as OR by default — a result matches if it targets any of them." }, "company_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref24", "type": "array", "items": { "type": "string" }, "example": [ "US", "SG", "CN" ], "description": "The location of the company headquarters. Check out `location` endpoints under the Filters tab for more information." }, "exclude_providers": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref1", "type": "array", "items": { "type": "string" }, "example": [ "AWS", "Cloudflare", "Hetzner" ], "description": "Remove footprint rows matching these cloud or hosting providers. Scoped to this footprint row — one provider in one country." }, "filter_conditions": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref38", "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "cloud_regions", "description": "Which array filter the operator applies to. Allowed values: cloud_regions, cities." }, "operator": { "type": "string", "example": "and", "description": "`or` matches rows carrying any listed value; `and` requires all of them. Allowed values: or, and." } } }, "description": "Switches an array filter from OR (default: match any value) to AND (match all values). Applies to `cloud_regions` and `cities`." }, "cloud_footprint_id": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref25", "type": "string", "example": "f28215e6-f6ed-40c2-ac9b-d8e70164c0be", "description": "Identifier of a single cloud footprint row." }, "is_ascending_order": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref31", "type": "boolean", "default": false, "example": false, "description": "Sort direction. Results are returned newest-first by default; set `true` for oldest-first. There is no `sort_by` on this endpoint — the sort key is fixed and stated in the endpoint description." }, "cloud_footprint_ids": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref26", "type": "array", "items": { "type": "string", "format": "uuid" }, "example": [ "f28215e6-f6ed-40c2-ac9b-d8e70164c0be" ], "description": "Identifiers of specific cloud footprint rows, for exporting a selection." }, "shared_server_count": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref13", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum servers shared with other companies. Use `null` for an open-ended bound. Scoped to this footprint row — one provider in one country." }, "is_cross_border_only": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref10", "type": "boolean", "example": true, "description": "When true, return only footprint rows outside the company's home market. Rows whose company has no known headquarters are excluded." }, "exclude_cloud_regions": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref5", "type": "array", "items": { "type": "string" }, "example": [ "us-east-1", "eu-central-1" ], "description": "Remove footprint rows matching these cloud regions. Scoped to this footprint row — one provider in one country." }, "exclude_target_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref3", "type": "array", "items": { "type": "string" }, "example": [ "IS", "GB", "FR", "IE", "ES" ], "description": "Country codes the results must not target. Combines with `filter_conditions` as OR by default — a result matches if it targets any of them." }, "cloud_footprint_providers": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref32", "type": "array", "items": { "type": "string" }, "example": [ "AWS", "Cloudflare" ], "description": "Companies that use any of these providers anywhere. The unprefixed `providers` narrows the rows returned; this narrows the companies." }, "cloud_footprint_city_count": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref23", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum cities. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "cloud_footprint_host_count": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref16", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum hosts. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "cloud_footprint_region_count": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref22", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum cloud regions. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "cloud_footprint_server_count": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref17", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum servers (distinct IP addresses). Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "cloud_footprint_country_count": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref20", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum countries the company hosts in. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "cloud_footprint_provider_count": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref19", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum distinct providers used by the company. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "cloud_footprint_primary_provider": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref34", "type": "array", "items": { "type": "string" }, "example": [ "AWS" ], "description": "Companies whose single largest provider is one of these." }, "cloud_footprint_target_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref33", "type": "array", "items": { "type": "string" }, "example": [ "DE", "SG" ], "description": "Companies present in any of these countries anywhere in their footprint." }, "cloud_footprint_shared_server_count": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref18", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum servers shared with other companies. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "cloud_footprint_cross_border_country_count": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4995c06877cbfdcd_ref21", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum countries outside the company's home market. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." } } } } }, "required": true }, "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Bczf0ngsC6bcl6q0Du2IG", "authority": "official", "conflicts": [], "revisionId": "sdrn_4iDCRIPFDsZRmP0aGdw03" }, { "gaps": [], "pages": [], "sourceId": "sds_2u3p4yN9ciqx-ocEBGR74", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/domain_search_id/format", "/requestBody/content/application/json/schema/properties/cloud_footprint_id/format" ], "revisionId": "sdrn_sF4Id8BIBdrnOh1M8jbor" }, { "gaps": [ "Missing request body schema and response schema details." ], "pages": [ 1 ], "sourceId": "sds__qoL1UlQ2hahHjRv-3RyA", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_8lrHjOTkOAWhpSD8DCe8p" }, { "gaps": [ "Missing specific schema for response body fields" ], "pages": [ 1 ], "sourceId": "sds_4QU1K-UtbB0JEFxtFT9j9", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/properties/per_page/maximum" ], "revisionId": "sdrn_YF3wEfhXeBDGcT4L2-sCE" }, { "gaps": [ "Full list of filter parameters not explicitly enumerated in the text", "Response schema details beyond the provided example" ], "pages": [ 1 ], "sourceId": "sds_5KELJHy5vSYxbie9pGw-G", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/properties/per_page/maximum" ], "revisionId": "sdrn_5WVjJI2L97MfQxH4KYS2N" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_fUyJMwjjAhazlUtXH8ZxI", "authority": "supplemental", "conflicts": [ "/responses/400/description", "/responses/429/description", "/responses/500/description", "/description", "/requestBody/content/application/json/schema/properties/domain_search_id/format", "/requestBody/content/application/json/schema/properties/cloud_footprint_id/format" ], "revisionId": "sdrn_T68CEZECLdkSoFiP6cHAw" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_GSpq9b1mCVzlyxet3sGTK", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/properties/per_page/maximum" ], "revisionId": "sdrn_1rAnE6tkDcV8ucEOBvBz-" }, { "gaps": [], "pages": [], "sourceId": "sds_H53dAzk1aB4Z5eLGWJqyx", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/domain_search_id/format", "/requestBody/content/application/json/schema/properties/cloud_footprint_id/format" ], "revisionId": "sdrn_8wqdTxRjS8JDhJzOPw2b8" }, { "gaps": [ "Missing specific request/response schema details" ], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId", "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/required" ], "revisionId": "sdrn_BPN1iHD5tCVT4d4YJh-Wj" }, { "gaps": [ "Missing request body schema and response details." ], "pages": [ 1 ], "sourceId": "sds_szyMKh2_p4dgcKv4HWc5U", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_MjFi5p9pj2Upopb3AwYNv" } ], "x-zeroclick-services": [ "search" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per credit (credits, service search)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "search", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/companies/jobs/search": { "post": { "summary": "Search for job postings", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref19", "type": "object", "properties": { "title": { "type": "string", "description": "Job title as published." }, "job_id": { "type": "string", "format": "uuid", "description": "Posting identifier." }, "country": { "type": "string", "nullable": true, "description": "Country name of the posting." }, "job_url": { "type": "string", "description": "Link to the posting at the source." }, "location": { "type": "string", "nullable": true, "description": "Free-text location as published." }, "companies": { "type": "object", "properties": { "domain": { "type": "string", "description": "Company domain, normalised (`stripe.com`)." }, "logo_url": { "type": "string", "nullable": true, "description": "Company logo URL." }, "company_url": { "type": "string", "nullable": true, "description": "Company website URL." }, "company_name": { "type": "string", "description": "Company name." }, "country_code": { "type": "string", "nullable": true, "description": "ISO 3166-1 alpha-2 code of the company headquarters." }, "linkedin_name": { "type": "string", "nullable": true, "description": "LinkedIn company slug (the part after `linkedin.com/company/`)." }, "domain_search_id": { "type": "string", "format": "uuid", "description": "Pubrio company identifier. Pass it to `companies` on any search, or to Company Lookup." } }, "description": "The company the record is linked to." }, "functions": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Job-function slugs resolved from the title; `null` when unclassified. Same vocabulary as the `functions` filter." }, "created_at": { "type": "string", "format": "date-time", "description": "When Pubrio first ingested the posting. This is the default sort key." }, "base_salary": { "type": "string", "nullable": true, "description": "Salary text as published, when the source provides one." }, "departments": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Department slugs resolved from the title; `null` when unclassified. Same vocabulary as the `departments` filter." }, "location_id": { "type": "integer", "nullable": true, "description": "Pubrio `location_id` of the posting's country. Same vocabulary as the `location_ids` filter." }, "source_type": { "type": "string", "description": "Source the posting was captured from, e.g. `linkedin`." }, "country_code": { "type": "string", "nullable": true, "description": "ISO 3166-1 alpha-2 code of the posting's country. Same vocabulary as the `locations` filter." }, "posting_date": { "type": "string", "format": "date", "nullable": true, "description": "Publisher's posting date. `launch_dates` filters on it, falling back to `created_at` when it is absent." }, "job_search_id": { "type": "string", "format": "uuid", "description": "Same value as `job_id`. Pass it to Job Lookup." }, "last_modified": { "type": "string", "format": "date-time", "description": "When the record was last updated." }, "seniority_rank": { "type": "integer", "description": "Seniority tier `1`–`5` as defined on the `seniority_ranks` filter; `0` when the title could not be classified. Allowed values: 0, 1, 2, 3, 4, 5." }, "employment_type": { "type": "string", "nullable": true, "description": "Employment type as published (e.g. `Full-time`), when the source provides one." }, "education_requirement": { "type": "string", "nullable": true, "description": "Education requirement as published, when the source provides one." }, "experience_requirement": { "type": "string", "nullable": true, "description": "Experience requirement as published, when the source provides one." } }, "description": "One job posting." } }, "pagination": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref18", "type": "object", "properties": { "page": { "type": "integer", "description": "Current page number." }, "per_page": { "type": "integer", "description": "Records per page." }, "is_timeout": { "type": "boolean", "description": "`true` when the search ran out of time. `total_entries` then only counts the rows returned so far, and an empty page means the search did not finish, not that nothing matched." }, "total_pages": { "type": "integer", "description": "`total_entries` divided by `per_page`." }, "is_estimated": { "type": "boolean", "description": "`true` when `total_entries` is an estimate rather than an exact count. Do not use an estimated total to decide when to stop paging; stop when a page returns fewer rows than `per_page`." }, "total_entries": { "type": "integer", "description": "Total matching records. An estimate when `is_estimated` is `true`." }, "total_display_pages": { "type": "integer", "description": "Page count for this result, capped by your plan's `max_display_search_page`." } }, "description": "Pagination for the result set." } } }, "metadata": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref17", "type": "object", "properties": { "filters": { "type": "object", "description": "Echo of the request body as the endpoint applied it, including defaults such as `per_page` and `language`." }, "profile": { "type": "object", "nullable": true, "description": "Credit block (`credit`, `topup_credit`, `total_credit_cost`) when credit accounting is requested; `null` on plain API-key traffic." }, "ignored_fields": { "type": "array", "items": { "type": "string" }, "description": "Body keys the endpoint did not recognise and dropped. Empty means every key applied — a misspelled filter widens the search instead of failing." } }, "description": "Request context." } } }, "example": { "data": { "jobs": [ { "title": "Software Engineer, gReach Program for People with Disabilities (장애인 채용)", "job_id": "371d0c44-4c56-4c9c-98e2-ef6dd986b848", "country": "South Korea", "job_url": "https://kr.linkedin.com/jobs/view/software-engineer-greach-program-for-people-with-disabilities-%EC%9E%A5%EC%95%A0%EC%9D%B8-%EC%B1%84%EC%9A%A9-at-google-4224659596?position=7&pageNum=0&refId=DwDpGXGftUql%2FkETvFCwXw%3D%3D&trackingId=gAvrIP0yUQuf8fjK67HSbQ%3D%3D", "location": "Seoul, Seoul, South Korea", "companies": { "domain": "google.com", "logo_url": "https://buckets.pubrio.com/company-logo/OTQxMjYxMTFnb29nbGUuY29tLnBrbGlua2VkaW5fcF9sb2dvMTU=.jpg", "company_name": "Google", "country_code": "US", "linkedin_name": "google", "domain_search_id": "539e2c34-de6b-4613-8f5b-e3aa18b4ef47" }, "functions": null, "created_at": "2025-05-10T14:30:58.348Z", "base_salary": null, "location_id": 491, "source_type": "linkedin", "country_code": "KR", "posting_date": "2025-05-31", "job_search_id": "371d0c44-4c56-4c9c-98e2-ef6dd986b848", "last_modified": "2025-05-31T20:41:27.894Z", "seniority_rank": 0, "employment_type": null, "education_requirement": null, "experience_requirement": null }, "..." ], "pagination": { "page": 1, "per_page": 25, "is_timeout": false, "total_pages": 89146, "total_entries": 2228628, "total_display_pages": 250 } }, "metadata": { "filters": { "domains": [ "google.com" ], "language": "en", "per_page": 25 }, "profile": null, "ignored_fields": [] } } } }, "description": "Successful response containing company job search details." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref21", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "details" ], "properties": { "code": { "type": "integer", "example": 40001 }, "details": { "type": "object" }, "message": { "type": "string", "example": "Errors and codes will vary depending on the scenario, please see the documentation for information." } } } } }, "description": "Bad request. The request was malformed or contained invalid parameters. Check the error code and message for details." }, "402": { "description": "Payment required" }, "429": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref22", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "Request rate limit exceeded. Please wait and try again later." } } } } }, "description": "Rate limit exceeded. Too many requests were made in a given time period. Retry after the rate limit window resets." }, "500": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref23", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "An unexpected error occurred on the server." } } } } }, "description": "Internal server error. An unexpected error occurred on the server. Contact support if the error persists." } }, "description": "Search job postings. See the [Job Search guide](/en/developer-guides/search/job-search).", "operationId": "companies_search_jobs", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref16", "type": "integer", "default": 1, "example": 1, "description": "Page number, starting at 1. The ceiling is your subscription's `max_search_page` (`max_company_search_page` for company search), returned by [Profile](/en/api-reference/endpoint/profile/profile). Exceeding it returns **HTTP 416**." }, "query": { "type": "string" }, "titles": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref7", "type": "array", "items": { "type": "string" }, "example": [ "sales manager", "marketing manager" ], "description": "Job titles associated with the individuals you aim to locate. \n\n The results will also encompass job titles that include similar terminology, even if they do not match exactly. For instance, searching for `software engineer` may yield results for individuals with the title `senior software engineer`." }, "domains": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref4", "type": "array", "items": { "type": "string" }, "example": [ "pubrio.com" ], "description": "List of company domains used for company and people search operations. If we receive a URL such as `www.pubrio.com` or `https://docs.pubrio.com/`, the system will convert it to `pubrio.com` for processing." }, "filters": { "type": "object", "properties": { "functions": { "type": "array", "items": { "type": "string" } }, "seniority_ranks": { "type": "array", "items": { "enum": [ 1, 2, 3, 4, 5 ], "type": "integer" } } } }, "per_page": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref15", "type": "integer", "default": 25, "example": 25, "description": "Records per page. Defaults to 25, which is also the ceiling on most plans — the limit is your subscription's `max_search_per_page`, returned by [Profile](/en/api-reference/endpoint/profile/profile). Exceeding it returns **HTTP 416** with code `41676` (or `41613` on company and people search), not a clamped result set." }, "companies": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref3", "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A list of unique identifiers (domain_search_id) used for company and people search operations." }, "functions": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref8", "type": "array", "items": { "type": "string" }, "example": [ "engineering", "product_management" ], "description": "Function slugs derived from the title, e.g. `engineering`, `sales`, `marketing`, `finance`, `product_management`, or a [Department Functions](/en/api-reference/endpoint/departments/function) slug such as `software_development`, in any case. Unknown slugs match nothing. Full list: [Enums & Constants](/en/api-reference/enums#job-functions)." }, "locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref0", "type": "array", "items": { "type": "string" }, "example": [ "US", "SG", "CN" ], "description": "ISO 3166-1 alpha-2 (cca2) is used for filtering locations. Check out `location` endpoints under the Filters tab for more information." }, "created_at": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref12", "type": "string", "example": "2026-09-02T12:00:00Z", "description": "Ingested at or after this instant (UTC). Date or ISO timestamp. For incremental syncs pass the `created_at` of your newest stored row." }, "departments": { "type": "array", "items": { "type": "string" }, "example": [ "master_sales" ], "description": "Department slugs or names, e.g. `master_sales` or `Sales` (any case), from [Departments](/en/api-reference/endpoint/departments/departments). Matches jobs whose title carries any of them; a value the catalog does not name matches nothing." }, "search_term": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref6", "type": "string", "example": "pubrio", "description": "A string of words over which we want to filter the results." }, "launch_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref11", "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2026-08-01", "2026-08-31" ], "maxItems": 2, "minItems": 1, "description": "Inclusive `[from, to]` window (UTC) on the launch date: `posting_date`, or the ingestion day when absent. Matches how Job Insights counts. A single date matches that day." }, "location_ids": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref1", "type": "array", "items": { "type": "integer" }, "example": [ 357, 419 ], "description": "Posting country by Pubrio `location_id` (Locations endpoint; also on each row). Alternative to `locations`." }, "posted_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref10", "type": "array", "items": { "type": "string" }, "example": [ "2025-01-01", "2025-01-10" ], "description": "Date range of the posted date. The maximum value is the current day. Day boundaries follow your workspace timezone." }, "search_terms": { "type": "array", "items": { "type": "string" }, "example": [ "Software Developer" ], "description": "Array of keyword strings to filter job postings. Each term is matched against job content. Use `search_term` for a single string or `search_terms` for multiple keywords." }, "linkedin_urls": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref5", "type": "array", "items": { "type": "string" }, "example": [ "https://www.linkedin.com/company/pubrio" ], "description": "The fully formed URL of the LinkedIn company profile. URL begin with `http` and contain `linkedin.com/company/`" }, "seniority_ranks": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref9", "type": "array", "items": { "type": "integer", "description": "Allowed values: 1, 2, 3, 4, 5." }, "example": [ 4, 5 ], "description": "Seniority tier from the title: `1` junior, `2` senior, `3` manager, `4` director, `5` executive. A value outside 1–5 matches nothing. Rows return their tier in `seniority_rank` (`0` = unclassified)." }, "company_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref2", "type": "array", "items": { "type": "string" }, "example": [ "US", "SG", "CN" ], "description": "The location of the company headquarters. Check out `location` endpoints under the Filters tab for more information." }, "exclude_locations": { "type": "array", "items": { "type": "string" }, "example": [ "TW" ], "description": "ISO 3166-1 alpha-2 (cca2) location codes to exclude from job results. Check out the `location` endpoints under the Filters tab for valid codes." }, "is_ascending_order": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref14", "type": "boolean", "default": false, "example": false, "description": "Sort direction. Results are returned newest-first by default; set `true` for oldest-first. There is no `sort_by` on this endpoint — the sort key is fixed and stated in the endpoint description." }, "exclude_departments": { "type": "array", "items": { "type": "string" }, "example": [ "c_suite" ], "description": "Department slugs or names to leave out. A job with no department is kept." }, "is_realtime_enrichment": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_061bd610ef9e4caf_ref13", "type": "boolean", "default": false, "example": true, "description": "Opt into realtime enrichment for a single, company-scoped query (filtered by `domain_search_id`, `domains`, or `linkedin_urls`). When the initial search returns zero results, the endpoint scrapes the source, persists the records, and re-runs the search before responding. Subject to a per-route deadline." } } } } }, "required": true }, "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Bczf0ngsC6bcl6q0Du2IG", "authority": "official", "conflicts": [], "revisionId": "sdrn_4iDCRIPFDsZRmP0aGdw03" }, { "gaps": [], "pages": [], "sourceId": "sds_2u3p4yN9ciqx-ocEBGR74", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/created_at/format" ], "revisionId": "sdrn_sF4Id8BIBdrnOh1M8jbor" }, { "gaps": [ "Missing request body schema and response schema details." ], "pages": [ 1 ], "sourceId": "sds__qoL1UlQ2hahHjRv-3RyA", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_8lrHjOTkOAWhpSD8DCe8p" }, { "gaps": [ "Missing specific schema for response body fields" ], "pages": [ 1 ], "sourceId": "sds_4QU1K-UtbB0JEFxtFT9j9", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/properties/per_page/maximum" ], "revisionId": "sdrn_YF3wEfhXeBDGcT4L2-sCE" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_7QewmuylUdTdMqFz_zA6v", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/page/description", "/requestBody/content/application/json/schema/properties/titles/description", "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/per_page/description", "/requestBody/content/application/json/schema/properties/functions/description", "/requestBody/content/application/json/schema/properties/created_at/format", "/requestBody/content/application/json/schema/properties/created_at/description", "/requestBody/content/application/json/schema/properties/departments/description", "/requestBody/content/application/json/schema/properties/launch_dates/description", "/requestBody/content/application/json/schema/properties/posted_dates/description", "/requestBody/content/application/json/schema/properties/seniority_ranks/items/enum", "/requestBody/content/application/json/schema/properties/seniority_ranks/description", "/requestBody/content/application/json/schema/properties/is_ascending_order/description" ], "revisionId": "sdrn_yfjUJfaLgKySQeP9Q_vnB" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_GSpq9b1mCVzlyxet3sGTK", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/properties/per_page/maximum" ], "revisionId": "sdrn_1rAnE6tkDcV8ucEOBvBz-" }, { "gaps": [], "pages": [], "sourceId": "sds_H53dAzk1aB4Z5eLGWJqyx", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/created_at/format" ], "revisionId": "sdrn_8wqdTxRjS8JDhJzOPw2b8" }, { "gaps": [ "Missing request body schema and parameters." ], "pages": [ 1 ], "sourceId": "sds_HSejgb_e4hgob_BpRggAh", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_-IurdnY8i0UFkVA71GDS4" }, { "gaps": [ "Missing full request schema definition", "Missing response schema definition" ], "pages": [ 1 ], "sourceId": "sds_iUXJyfBmCE_7260rzOdkp", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/properties/per_page/maximum" ], "revisionId": "sdrn_hQQ-C8uEx2j76eTz0TPqt" }, { "gaps": [ "Full list of valid function slugs", "Full list of valid department slugs", "Detailed error response schema for 40037" ], "pages": [ 1, 2, 3 ], "sourceId": "sds_sbx1HKQOJQuQ2XL2WKAEU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/properties/per_page/maximum" ], "revisionId": "sdrn_bCM9OUm1zl1gkZM25l-TD" }, { "gaps": [ "Missing specific request/response schema details" ], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId", "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/required" ], "revisionId": "sdrn_BPN1iHD5tCVT4d4YJh-Wj" }, { "gaps": [ "Missing request body schema and response details." ], "pages": [ 1 ], "sourceId": "sds_szyMKh2_p4dgcKv4HWc5U", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_MjFi5p9pj2Upopb3AwYNv" } ], "x-zeroclick-services": [ "search" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per credit (credits, service search)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "search", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/companies/news/search": { "post": { "summary": "Search for company news", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "news": { "type": "array", "items": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref19", "type": "object", "properties": { "url": { "type": "string", "description": "Link to the article." }, "title": { "type": "string", "description": "Headline." }, "source": { "type": "string", "nullable": true, "description": "Publisher domain." }, "domains": { "type": "array", "items": { "type": "string" }, "description": "Domains of every company the article mentions." }, "news_id": { "type": "string", "format": "uuid", "description": "Article identifier." }, "summary": { "type": "string", "nullable": true, "description": "Short summary of the article." }, "category": { "type": "string", "nullable": true, "description": "News category slug. Same vocabulary as the `categories` filter and the News Categories endpoint." }, "language": { "type": "string", "nullable": true, "description": "ISO 639-1 language code of the article. Same vocabulary as the `news_languages` filter." }, "companies": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string", "description": "Company domain, normalised (`stripe.com`)." }, "logo_url": { "type": "string", "nullable": true, "description": "Company logo URL." }, "company_url": { "type": "string", "nullable": true, "description": "Company website URL." }, "company_name": { "type": "string", "description": "Company name." }, "country_code": { "type": "string", "nullable": true, "description": "ISO 3166-1 alpha-2 code of the company headquarters." }, "linkedin_name": { "type": "string", "nullable": true, "description": "LinkedIn company slug (the part after `linkedin.com/company/`)." }, "domain_search_id": { "type": "string", "format": "uuid", "description": "Pubrio company identifier. Pass it to `companies` on any search, or to Company Lookup." } }, "description": "The company the record is linked to." }, "description": "Every company the article mentions, in the same order as `domains`." }, "image_url": { "type": "string", "nullable": true, "description": "Lead image, when the article has one." }, "locations": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Place names mentioned in the article; `null` when none." }, "published_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Publication time. This is the default sort key (undated articles sort last)." }, "country_codes": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Countries the article is about (ISO 3166-1 alpha-2); `null` when not detected. Same vocabulary as the `locations` filter." }, "last_modified": { "type": "string", "format": "date-time", "description": "When the record was last updated." }, "news_galleries": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": "string" }, "news_gallery_id": { "type": "string", "format": "uuid" } } }, "nullable": true, "description": "Galleries the article belongs to; `null` when none." }, "news_search_id": { "type": "string", "format": "uuid", "description": "Search-record identifier. Pass it to News Lookup." }, "expansion_signals": { "type": "array", "items": { "type": "object", "properties": { "polarity": { "type": "string", "description": "`expansion`, `contraction_leading`, `contraction_confirming` or `contraction_lagging`." }, "event_date": { "type": "string", "format": "date-time", "description": "When the signal occurred." }, "country_code": { "type": "string", "nullable": true, "description": "Market the signal points at." }, "domain_search_id": { "type": "string", "format": "uuid", "description": "Company the signal belongs to." }, "signal_type_slug": { "type": "string", "description": "Signal type, e.g. `HIRE`, `PARTNER`, `PRODUCT`." }, "signal_subtype_slug": { "type": "string", "nullable": true, "description": "Signal subtype, when the type has one." }, "signal_strength_slug": { "type": "string", "description": "Signal strength: `low`, `medium`, `high`, `very_high`." } } }, "description": "Only when `is_expansion_signal_available: true`: the expansion signals this article produced. Empty array when none." }, "news_category_name": { "type": "string", "nullable": true, "description": "Human-readable category name, localised to `language`." }, "company_country_codes": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Headquarters countries of the companies mentioned. Same vocabulary as the `company_locations` filter." } }, "description": "One news article." } }, "pagination": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref18", "type": "object", "properties": { "page": { "type": "integer", "description": "Current page number." }, "per_page": { "type": "integer", "description": "Records per page." }, "is_timeout": { "type": "boolean", "description": "`true` when the search ran out of time. `total_entries` then only counts the rows returned so far, and an empty page means the search did not finish, not that nothing matched." }, "total_pages": { "type": "integer", "description": "`total_entries` divided by `per_page`." }, "is_estimated": { "type": "boolean", "description": "`true` when `total_entries` is an estimate rather than an exact count. Do not use an estimated total to decide when to stop paging; stop when a page returns fewer rows than `per_page`." }, "total_entries": { "type": "integer", "description": "Total matching records. An estimate when `is_estimated` is `true`." }, "total_display_pages": { "type": "integer", "description": "Page count for this result, capped by your plan's `max_display_search_page`." } }, "description": "Pagination for the result set." } } }, "metadata": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref17", "type": "object", "properties": { "filters": { "type": "object", "description": "Echo of the request body as the endpoint applied it, including defaults such as `per_page` and `language`." }, "profile": { "type": "object", "nullable": true, "description": "Credit block (`credit`, `topup_credit`, `total_credit_cost`) when credit accounting is requested; `null` on plain API-key traffic." }, "ignored_fields": { "type": "array", "items": { "type": "string" }, "description": "Body keys the endpoint did not recognise and dropped. Empty means every key applied — a misspelled filter widens the search instead of failing." } }, "description": "Request context." } } }, "example": { "data": { "news": [ { "url": "http://enold.prnasia.com/p/asia-story-125304015-0.shtml", "title": "Digital China's AI-driven transformation showcased at INSEAD", "source": "prnasia.com", "domains": [ "insead.edu", "digitalchina.com" ], "news_id": "0b0f1c53-7a04-4a46-b5bc-3b17a7c4cfbd", "summary": "Guo Wei, Chairman of Digital China, presented on AI-era corporate management at INSEAD 2025 Asia AI Conference, launching a case study on Digital China's AI transformation journey.", "category": "launches", "language": "id", "companies": [ { "domain": "insead.edu", "logo_url": "https://buckets.pubrio.com/company-logo/MjY5OTY5NDJpbnNlYWQuZWR1bGlua2VkaW5fcF9sb2dvMTU=.jpg", "company_name": "Insead", "country_code": "FR", "linkedin_name": "insead", "domain_search_id": "dfbe6797-5311-46f9-9518-bf1a7c3d09bc" }, { "domain": "digitalchina.com", "logo_url": "https://buckets.pubrio.com/company-logo/NDA2NTQ5NTFkaWdpdGFsY2hpbmEuY29tbGlua2VkaW5fcF9sb2dvMTU=.jpg", "company_name": "Digital China", "country_code": "CN", "linkedin_name": "digital-china", "domain_search_id": "e13a9e24-a07d-4630-9b47-fceb778df74e" } ], "image_url": null, "locations": [ "Singapore", "China" ], "published_at": "2025-06-01T08:00:00.000Z", "country_codes": [ "CN", "SG" ], "last_modified": "2025-06-01T08:15:23.945Z", "news_galleries": [ { "name": "Banking/Financial Service", "slug": "banking-financial-service", "news_gallery_id": "7c8ec9cc-66c5-4153-82da-9c8f356c6c99" } ], "news_search_id": "4110b929-17cd-42aa-a159-906ead0c9b56", "news_category_name": "Launches", "company_country_codes": [ "CN", "FR" ] }, "..." ], "pagination": { "page": 1, "per_page": 25, "is_timeout": false, "total_pages": 14072, "total_entries": 351800, "total_display_pages": 250 } }, "metadata": { "filters": { "domains": [ "stripe.com" ], "language": "en", "per_page": 25 }, "profile": null, "ignored_fields": [] } } } }, "description": "Successful response containing company news search details." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref21", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "details" ], "properties": { "code": { "type": "integer", "example": 40001 }, "details": { "type": "object" }, "message": { "type": "string", "example": "Errors and codes will vary depending on the scenario, please see the documentation for information." } } } } }, "description": "Bad request. The request was malformed or contained invalid parameters. Check the error code and message for details." }, "402": { "description": "Payment required" }, "429": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref22", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "Request rate limit exceeded. Please wait and try again later." } } } } }, "description": "Rate limit exceeded. Too many requests were made in a given time period. Retry after the rate limit window resets." }, "500": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref23", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "An unexpected error occurred on the server." } } } } }, "description": "Internal server error. An unexpected error occurred on the server. Contact support if the error persists." } }, "description": "Search news about companies. See the [News Search guide](/en/developer-guides/search/news-search).", "operationId": "companies_search_news", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref12", "type": "integer", "default": 1, "example": 1, "description": "Page number, starting at 1. The ceiling is your subscription's `max_search_page` (`max_company_search_page` for company search), returned by [Profile](/en/api-reference/endpoint/profile/profile). Exceeding it returns **HTTP 416**." }, "query": { "type": "string" }, "domains": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref4", "type": "array", "items": { "type": "string" }, "example": [ "pubrio.com" ], "description": "List of company domains used for company and people search operations. If we receive a URL such as `www.pubrio.com` or `https://docs.pubrio.com/`, the system will convert it to `pubrio.com` for processing." }, "filters": { "type": "object", "properties": { "news_languages": { "type": "array", "items": { "type": "string" } } } }, "sources": { "type": "array", "items": { "type": "string" }, "example": [ "bbc.co.uk" ], "description": "Only articles from these publishers. Use the publisher's domain, e.g. `bbc.co.uk` — the same value as the `source` field on every article. A full URL or a `www.` address also works." }, "per_page": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref11", "type": "integer", "default": 25, "example": 25, "description": "Records per page. Defaults to 25, which is also the ceiling on most plans — the limit is your subscription's `max_search_per_page`, returned by [Profile](/en/api-reference/endpoint/profile/profile). Exceeding it returns **HTTP 416** with code `41676` (or `41613` on company and people search), not a clamped result set." }, "companies": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref2", "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A list of unique identifiers (domain_search_id) used for company and people search operations." }, "locations": { "type": "array", "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref0" } ], "items": { "type": "string" }, "example": [ "US", "SG", "CN" ], "description": "Countries the story itself is about, read from the article text (ISO 3166-1 alpha-2). Empty when the article names no place. For where a mentioned company is headquartered, use `company_locations`." }, "categories": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref7", "type": "array", "items": { "type": "string" }, "example": [ "launches" ], "description": "List of `category slugs` for searching for specific news categories. To find a slug, call the `news categories` endpoint under the Filters tab." }, "search_term": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref6", "type": "string", "example": "pubrio", "description": "A string of words over which we want to filter the results." }, "published_at": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref10", "type": "string", "example": "2026-09-01T00:00:00Z", "description": "Published at or after this instant (UTC). Date or ISO timestamp. `published_dates` is the closed-window form and uses your workspace timezone." }, "search_terms": { "type": "array", "items": { "type": "string" }, "example": [ "Trump" ], "description": "Array of keyword strings to filter news articles. Each term is matched against article content. Use `search_term` for a single string or `search_terms` for multiple keywords." }, "linkedin_urls": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref5", "type": "array", "items": { "type": "string" }, "example": [ "https://www.linkedin.com/company/pubrio" ], "description": "The fully formed URL of the LinkedIn company profile. URL begin with `http` and contain `linkedin.com/company/`" }, "news_galleries": { "type": "array", "items": { "type": "string" }, "example": [ "electronic-commerce" ], "description": "List of `gallery slugs` for filtering news by gallery. To find a slug, call the `news galleries` endpoint under the Filters tab." }, "news_languages": { "type": "array", "items": { "type": "string" }, "example": [ "en" ], "description": "List of `locale_code` values for filtering news by language. To find available codes, call the `news languages` endpoint under the Filters tab." }, "news_search_id": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref3" } ], "example": "4110b929-17cd-42aa-a159-906ead0c9b56", "description": "Return only this one record. Handy for re-fetching a row you stored earlier without paging." }, "exclude_sources": { "type": "array", "items": { "type": "string" }, "example": [ "prnasia.com" ], "description": "Leave out articles from these publishers. Same format as `sources`. Articles with no recorded publisher are kept." }, "published_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref9", "type": "array", "items": { "type": "string" }, "example": [ "2025-01-01", "2025-01-10" ], "description": "Date range of the published date. The maximum value is the current day. Day boundaries follow your workspace timezone." }, "news_gallery_ids": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref8", "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A list of `news_gallery_id` used to search for specific news galleries. To find the ID, call the `news galleries` endpoint under the Filters tab." }, "company_locations": { "type": "array", "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref1" } ], "items": { "type": "string" }, "example": [ "US", "SG", "CN" ], "description": "Headquarters country of the companies the article mentions (ISO 3166-1 alpha-2) — not where the story happened; for that, use `locations`." }, "is_ascending_order": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref13", "type": "boolean", "default": false, "example": false, "description": "Sort direction. Results are returned newest-first by default; set `true` for oldest-first. There is no `sort_by` on this endpoint — the sort key is fixed and stated in the endpoint description." }, "exclude_search_terms": { "type": "array", "items": { "type": "string" }, "example": [ "layoffs" ], "description": "Leave out articles that mention any of these words, matched the same way as `search_terms`. `exclude_keywords` is accepted as another name." }, "expansion_signal_types": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref15", "type": "array", "items": { "type": "string", "description": "Allowed values: AD, AUDIENCE, DNS, ENTITY, EVENT, EVENT_PLUS, EXEC, HIRE, INFRA, IP, NEWS, OFFICE, PARTNER, PRODUCT, REG, SCALE, TECH." }, "example": [ "HIRE", "PARTNER" ], "description": "Return only news that produced an expansion signal of one of these types (uppercase slugs). Requires `is_expansion_signal_available: true`. A list with only unknown slugs matches nothing." }, "expansion_signal_polarities": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref16", "type": "array", "items": { "type": "string", "description": "Allowed values: expansion, contraction_leading, contraction_confirming, contraction_lagging." }, "example": [ "expansion" ], "description": "Return only news whose expansion signal carries one of these polarities. Requires `is_expansion_signal_available: true`. Combined with `expansion_signal_types` as AND." }, "is_expansion_signal_available": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f820cd5177ef2f7a_ref14", "type": "boolean", "description": "When `true`, attaches the resolved expansion signals (`expansion_signals`) to each news item and enables the `expansion_signal_types` / `expansion_signal_polarities` filters. Leave unset for the fastest search — the expansion join is only added when this flag is on." } } } } }, "required": true }, "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Bczf0ngsC6bcl6q0Du2IG", "authority": "official", "conflicts": [], "revisionId": "sdrn_4iDCRIPFDsZRmP0aGdw03" }, { "gaps": [], "pages": [], "sourceId": "sds_2u3p4yN9ciqx-ocEBGR74", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/published_at/format", "/requestBody/content/application/json/schema/properties/news_search_id/format" ], "revisionId": "sdrn_sF4Id8BIBdrnOh1M8jbor" }, { "gaps": [ "Missing request body schema and response schema details." ], "pages": [ 1 ], "sourceId": "sds__qoL1UlQ2hahHjRv-3RyA", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_8lrHjOTkOAWhpSD8DCe8p" }, { "gaps": [ "Missing specific schema for response body fields" ], "pages": [ 1 ], "sourceId": "sds_4QU1K-UtbB0JEFxtFT9j9", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/properties/per_page/maximum" ], "revisionId": "sdrn_YF3wEfhXeBDGcT4L2-sCE" }, { "gaps": [ "The exact schema of the response object is inferred from the example; full field definitions are not explicitly provided in the text.", "The exact format of the published_dates array elements is not explicitly defined beyond the example." ], "pages": [ 1 ], "sourceId": "sds_8APT2sxFyC0oIxp0sob1V", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/required" ], "revisionId": "sdrn__tIn0LzOjZdpprlCIYBSv" }, { "gaps": [], "pages": [], "sourceId": "sds_H53dAzk1aB4Z5eLGWJqyx", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/published_at/format", "/requestBody/content/application/json/schema/properties/news_search_id/format" ], "revisionId": "sdrn_8wqdTxRjS8JDhJzOPw2b8" }, { "gaps": [ "Missing explicit required field array in requestBody schema." ], "pages": [ 1 ], "sourceId": "sds_h8dGit2q0gcBBEtKWhnFX", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/page/description", "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/per_page/description", "/requestBody/content/application/json/schema/properties/published_at/format", "/requestBody/content/application/json/schema/properties/news_galleries/description", "/requestBody/content/application/json/schema/properties/news_languages/description", "/requestBody/content/application/json/schema/properties/news_search_id/format", "/requestBody/content/application/json/schema/properties/is_ascending_order/description", "/requestBody/content/application/json/schema/properties/expansion_signal_types/items/enum", "/requestBody/content/application/json/schema/properties/expansion_signal_types/description", "/requestBody/content/application/json/schema/properties/expansion_signal_polarities/items/enum", "/requestBody/content/application/json/schema/properties/expansion_signal_polarities/description", "/requestBody/content/application/json/schema/properties/is_expansion_signal_available/description" ], "revisionId": "sdrn_q-zVLt--7IMf0Mdvmi8DC" }, { "gaps": [ "Missing request body schema and parameters." ], "pages": [ 1 ], "sourceId": "sds_HSejgb_e4hgob_BpRggAh", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_-IurdnY8i0UFkVA71GDS4" }, { "gaps": [ "Missing full request schema definition", "Missing response schema definition" ], "pages": [ 1 ], "sourceId": "sds_iUXJyfBmCE_7260rzOdkp", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/properties/per_page/maximum" ], "revisionId": "sdrn_hQQ-C8uEx2j76eTz0TPqt" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_BPN1iHD5tCVT4d4YJh-Wj" }, { "gaps": [ "Missing request body schema and response details." ], "pages": [ 1 ], "sourceId": "sds_szyMKh2_p4dgcKv4HWc5U", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_MjFi5p9pj2Upopb3AwYNv" } ], "x-zeroclick-services": [ "search" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per credit (credits, service search)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "search", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/companies/search": { "post": { "summary": "Search for companies", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref75", "type": "object", "nullable": true, "description": "Response info depends on specific endpoint." }, "metadata": { "type": "object", "description": "Request context: `recent_search_log_identifier`, echoed `parameters` and `filters`, an optional `profile` credit block, and `ignored_fields` (body keys the endpoint dropped)." } } }, "example": { "data": { "companies": [ { "x_url": null, "domain": "twitter.com", "emails": [ "..." ], "phones": [ "..." ], "contacts": [ "..." ], "industry": "Software Development", "location": "United States", "logo_url": "https://buckets.pubrio.com/company-logo/MjI0NDc1OTMxaWxqOXNzbmoxdHdpdHRlci5jb20=.jpg", "domain_id": 224475931, "domain_ids": [ 224475931, 1758889566, 368242865 ], "github_url": null, "company_url": "http://twitter.com", "saved_lists": null, "specialties": [ "Software Development" ], "twitter_url": "https://twitter.com/x", "youtube_url": null, "company_name": "Twitter", "company_size": 1500, "facebook_url": "http://facebook.com/twitterinc", "founded_year": 2006, "linkedin_url": "http://www.linkedin.com/company/twitter", "instagram_url": null, "linkedin_name": "twitter", "crunchbase_url": null, "company_ranking": null, "company_keywords": [ "realtime information", "social commerce", "online shopping", "classifieds", "craigslist killers", "e-commerce", "killers", "consumer internet", "internet", "information technology", "edp services", "technology", "software development", "microblogging", "social networking", "public conversation", "user engagement", "content sharing", "advertising solutions", "monetization", "community building", "digital wallet", "ai integration", "user safety" ], "domain_search_id": "61a73da7-2efc-41a5-a252-a8a8df29925a", "linkedin_company_id": 44005587, "company_size_printed": "1,500", "is_company_url_active": true }, "..." ], "pagination": { "page": 1, "per_page": 25, "total_pages": 1809388, "total_entries": 45234700 } } } } }, "description": "Successful response containing company search details." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref76", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "details" ], "properties": { "code": { "type": "integer", "example": 40001 }, "details": { "type": "object" }, "message": { "type": "string", "example": "Errors and codes will vary depending on the scenario, please see the documentation for information." } } } } }, "description": "Bad request. The request was malformed or contained invalid parameters. Check the error code and message for details." }, "402": { "description": "Payment required" }, "429": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref77", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "Request rate limit exceeded. Please wait and try again later." } } } } }, "description": "Rate limit exceeded. Too many requests were made in a given time period. Retry after the rate limit window resets." }, "500": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref78", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "An unexpected error occurred on the server." } } } } }, "description": "Internal server error. An unexpected error occurred on the server. Contact support if the error persists." } }, "description": "Search the Pubrio database for companies matching specified criteria such as industry, size, location, and technologies.", "operationId": "companies_search", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref53", "type": "integer", "default": 1, "example": 1, "description": "Page number, starting at 1. The ceiling is your subscription's `max_search_page` (`max_company_search_page` for company search), returned by [Profile](/en/api-reference/endpoint/profile/profile). Exceeding it returns **HTTP 416**." }, "query": { "type": "string", "example": "Food & Beverage companies in Singapore that recently expanded", "description": "Natural-language search. When provided, Pubrio interprets it into the company filters below: industry (and industries to leave out), specialty, technology (and tools to leave out), social profiles, HQ country, region or city, head-count, revenue, founded year, roles being hired and where, news events such as \"recently expanded\", advertising (platform, format, target country, ad counts, impressions, dates, rank in one country) and cloud hosting (provider, server countries and cities, host and server counts, overall or in one country). Values joined by \"or\" match any of them; tools or profiles joined by \"and\" (\"uses both Salesforce and HubSpot\") must all match. Any explicit filters you also pass take precedence over the interpreted ones. A part of the sentence no filter can express (for example ownership) comes back in `metadata.unmatched_criteria` rather than being dropped; a sentence with nothing searchable returns no results with `metadata.nl_no_intent: true`." }, "places": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref7", "type": "array", "items": { "type": "string" }, "example": [ "Tokyo" ], "description": "Place names (city, region) used to filter results. Accepts localized or English place names." }, "domains": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref2", "type": "array", "items": { "type": "string" }, "example": [ "pubrio.com" ], "description": "List of company domains used for company and people search operations. If we receive a URL such as `www.pubrio.com` or `https://docs.pubrio.com/`, the system will convert it to `pubrio.com` for processing." }, "sort_by": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref45", "type": "string", "example": "advertisement_country_rank", "description": "Result ordering. Omit for the default relevance order. `advertisement_country_rank` orders by the company's advertising rank inside the country named in `advertisement_country_activity` (rank 1 = biggest advertiser in that market) and is ignored unless that filter is present. Pair with `is_ascending_order: false` to list the smallest advertisers first. Not yet available: `name` (either direction) and `relevance` with `is_ascending_order: false` — those requests time out. Use the default relevance order, `number_of_employees` or `founded_year` instead. Allowed values: relevance, name, number_of_employees, founded_year, advertisement_country_rank." }, "keywords": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref20", "type": "array", "items": { "type": "string" }, "example": [ "ecommerce", "ai", "fintech" ], "description": "A list of keywords to filter companies by relevance, specialties, or descriptions." }, "per_page": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref52", "type": "integer", "default": 25, "example": 25, "description": "Records per page. Defaults to 25, which is also the ceiling on most plans — the limit is your subscription's `max_search_per_page`, returned by [Profile](/en/api-reference/endpoint/profile/profile). Exceeding it returns **HTTP 416** with code `41676` (or `41613` on company and people search), not a clamped result set." }, "revenues": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref18", "type": "array", "items": { "type": "integer" }, "example": [ 0, 100000 ], "description": "Minimum and maximum range of company revenue." }, "companies": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref1", "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A list of unique identifiers (domain_search_id) used for company and people search operations." }, "employees": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref17", "type": "array", "items": { "type": "array", "items": { "type": "string" } }, "example": [ [ 1, 10 ], [ 11, 20 ], [ 10001 ] ], "description": "The number range of employees working for the company. This enables you to find companies based on headcount. You can add multiple ranges to expand your search results. \n\n Check out `company size` endpoints under the Filters tab for more information." }, "locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref5", "type": "array", "items": { "type": "string" }, "example": [ "US", "SG", "CN" ], "description": "ISO 3166-1 alpha-2 (cca2) is used for filtering locations. Check out `location` endpoints under the Filters tab for more information." }, "verticals": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref12", "type": "array", "items": { "type": "integer" }, "description": "A list of `vertical_id` used to search for companies in a specific vertical or industry. To find the ID, call the `vertical` endpoint under the Filters tab.\n\nThis filter supports `is_enable_similarity_search`, once enabled you can enter any free text, e.g. `[\"AI\"]`." }, "categories": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref15", "type": "array", "items": { "type": "integer" }, "description": "A list of `category_id` used to search for specific categories of technology used by companies. To find the ID, call the `category` endpoint under the Filters tab.\n\nThis filter supports `is_enable_similarity_search`, once enabled you can enter any free text, e.g. `[\"CDN\"]`." }, "job_titles": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref11", "type": "array", "items": { "type": "string" }, "example": [ "sales manager", "marketing manager" ], "description": "Job titles associated with the individuals you aim to locate. \n\n The results will also encompass job titles that include similar terminology, even if they do not match exactly. For instance, searching for `software engineer` may yield results for individuals with the title `senior software engineer`." }, "company_name": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref0", "type": "string", "example": "pubrio", "description": "Filter search results to include a specific company name. \n \n If the value you enter for this parameter does not match with a company's name, the company will not appear in search results, even if it matches other parameters. Partial matches are accepted." }, "social_media": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref21", "type": "array", "items": { "type": "string", "description": "Allowed values: linkedin, facebook, instagram, tiktok, twitter, x, github, wantedly, rocketpunch." }, "example": [ "tiktok" ], "description": "Companies with a profile on any of: `linkedin`, `facebook`, `instagram`, `tiktok`, `twitter`, `x`, `github`, `wantedly`, `rocketpunch`. Promote to AND with `filter_conditions`." }, "technologies": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref16", "type": "array", "items": { "type": "integer" }, "description": "A list of `tag_id` used to search for specific technologies used by companies. To find the ID, call the `technology` endpoint under the Filters tab.\n\nThis filter supports `is_enable_similarity_search`, once enabled you can enter any free text, e.g. `[\"Shopify\"]`.\n\nA product name the technology list knows matches that product and its own products (`\"Salesforce\"` also matches Salesforce Desk and Salesforce Service Cloud), never look-alikes; other text matches by similarity." }, "founded_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref19", "type": "array", "items": { "type": "integer" }, "example": [ 2018, 2024 ], "description": "Years of company founded range. The maximum value founded is the current year." }, "job_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref5", "type": "array", "items": { "type": "string" }, "example": [ "US", "SG", "CN" ], "description": "ISO 3166-1 alpha-2 (cca2) is used for filtering locations. Check out `location` endpoints under the Filters tab for more information." }, "linkedin_urls": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref3", "type": "array", "items": { "type": "string" }, "example": [ "https://www.linkedin.com/company/pubrio" ], "description": "The fully formed URL of the LinkedIn company profile. URL begin with `http` and contain `linkedin.com/company/`" }, "company_groups": { "type": "array", "items": { "type": "integer" }, "description": "Restrict to members of these company groups (ids), such as a monitor's `source_group_id` or `excluded_group_id`; paginated like any search." }, "exclude_fields": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref49", "type": "array", "items": { "type": "string" }, "example": [ "emails", "phones", "contacts" ], "description": "List of fields to exclude from the response payload." }, "exclude_places": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref8", "type": "array", "items": { "type": "string" }, "example": [ "Tokyo" ], "description": "Place names (city, region) to exclude from results. Accepts localized or English place names." }, "company_filters": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref4", "type": "object", "example": { "technologies": [ 37, 152 ], "founded_dates": [ 2015, 2023 ], "company_locations": [ "US" ], "filter_conditions": [ { "key": "technologies", "operator": "and" } ] }, "description": "Wrapper object for company-level filters. Recommended grouping that visually separates which keys filter the *person* (top-level) from which filter the *company*. Accepts the same keys as the top-level company filters (e.g. `technologies`, `verticals`, `vertical_categories`, `vertical_sub_categories`, `categories`, `keywords`, `founded_dates`, `employees`, `revenues`, `company_locations`, `company_exclude_locations`, `company_places`, `company_exclude_places`, `companies`, `domains`, `company_linkedin_urls`, `is_enable_similarity_search`, `similarity_score`, plus `filter_conditions`). Engine flattens this object to the top level before processing — top-level keys win on conflict. Same shape used by Monitor `company_filters`. See the Filters Overview developer guide for examples." }, "news_categories": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref22", "type": "array", "items": { "type": "string" }, "example": [ "launches" ], "description": "List of `category slugs` for searching for specific news categories. To find a slug, call the `news categories` endpoint under the Filters tab." }, "job_posted_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref10", "type": "array", "items": { "type": "string" }, "example": [ "2025-01-01", "2025-01-10" ], "description": "Date range of the posted date. The maximum value is the current day. Day boundaries follow your workspace timezone." }, "similarity_score": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref48", "type": "number", "example": 0.7, "description": "It is used in conjunction with `is_enable_similarity_search`. This number is used to analyze whether a specific slug (e.g. vertical industry, technology) is similar to the user input, and the higher the number, the more stringent it is." }, "exclude_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref6", "type": "array", "items": { "type": "string" }, "example": [ "CN", "US", "RU", "CA" ], "description": "ISO 3166-1 alpha-2 (cca2) is used to filter out locations that does not need to be returned. Check out `location` endpoints under the Filters tab for more information." }, "filter_conditions": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref46", "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "keywords", "description": "The filter key specifying which property to apply the operator to. Allowed values: keywords, verticals, vertical_categories, vertical_sub_categories, technologies, categories, social_media, advertisement_target_locations, job_exclude_locations." }, "operator": { "type": "string", "example": "or", "description": "The logical operator to apply. Use 'or' to match any of the specified values, or 'and' to require all specified values. Allowed values: or, and." } } }, "description": "Advanced filtering options for company searches. Specify conditions combining keys and logical operators to refine search results." }, "is_ascending_order": { "type": "boolean", "example": true, "description": "Direction for `sort_by`. Defaults to ascending, which for `advertisement_country_rank` means the biggest advertisers first." }, "vertical_categories": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref13", "type": "array", "items": { "type": "integer" }, "description": "A list of `vertical_category_id` used to search for companies in a specific vertical category. To find the ID, call the `vertical category` endpoint under the Filters tab.\n\nThis filter supports `is_enable_similarity_search`, once enabled you can enter any free text, e.g. `[\"Information Technology\"]`." }, "advertisement_status": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref32", "type": "array", "items": { "type": "string", "description": "Allowed values: currently_running, active_last_30_min." }, "example": [ "currently_running" ], "description": "`currently_running`: companies with advertising on record. `active_last_30_min`: companies whose advertising changed in the last 30 minutes." }, "exclude_technologies": { "type": "array", "items": { "type": "string" }, "example": [ "Shopify" ], "description": "Technologies the company must not use, as `tag_id`s or, with `is_enable_similarity_search`, names such as `[\"Shopify\"]`. A company with no known technologies is kept." }, "news_published_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref23", "type": "array", "items": { "type": "string" }, "example": [ "2025-01-01", "2025-01-10" ], "description": "Date range of the published date. The maximum value is the current day. Day boundaries follow your workspace timezone." }, "advertisement_formats": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref37", "type": "array", "items": { "type": "string", "description": "Allowed values: image, video, text, carousel, dynamic_product, document, message, event, article, spotlight, follow, job, engagement." }, "example": [ "image", "video" ], "description": "Find companies with at least one advertisement in any of these creative formats." }, "job_exclude_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref9", "type": "array", "items": { "type": "string" }, "example": [ "CN", "US", "RU", "CA" ], "description": "Geographic locations to exclude from job posting results." }, "cloud_footprint_cities": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref60", "type": "array", "items": { "type": "string" }, "example": [ "Ashburn", "Frankfurt" ], "description": "Restrict results to footprint rows matching these cities. Scoped to this footprint row — one provider in one country." }, "advertisement_end_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref30", "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-25", "2025-12-25" ], "description": "End date range for advertisement filtering." }, "advertisement_headlines": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref33", "type": "array", "items": { "type": "string" }, "example": [ "limited time offer" ], "description": "Keywords to search for within advertisement headline text." }, "advertisement_platforms": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref34", "type": "array", "items": { "type": "string", "description": "Allowed values: linkedin, facebook, google, tiktok, apple." }, "example": [ "linkedin", "facebook" ], "description": "Filter by which ad library the advertisement was sourced from. Lowercase, case-insensitive. `meta` is accepted as an alias for `facebook`." }, "advertisement_total_ads": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref40", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 10, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum count of the company's total advertisements ever recorded, across all countries." }, "vertical_sub_categories": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref14", "type": "array", "items": { "type": "integer" }, "description": "A list of `vertical_sub_category_id` used to search for companies in a specific vertical sub-category. To find the ID, call the `vertical sub category` endpoint under the Filters tab.\n\nThis filter supports `is_enable_similarity_search`, once enabled you can enter any free text, e.g. `[\"Software\"]`." }, "advertisement_active_ads": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref38", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum count of the company's currently active advertisements, across all countries. Use `null` for an open-ended bound, e.g. `[1, null]` for \"at least one active ad\"." }, "advertisement_running_ads": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref39", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum count of the company's advertisements that are still running (no end date, or an end date in the future). Currently populated for LinkedIn ads only." }, "advertisement_start_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref29", "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-25", "2025-12-25" ], "description": "Start date range for advertisement filtering." }, "cloud_footprint_providers": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref54", "type": "array", "items": { "type": "string" }, "example": [ "AWS", "Cloudflare" ], "description": "Companies that use any of these providers anywhere. The unprefixed `providers` narrows the rows returned; this narrows the companies." }, "advertisement_active_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref31", "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2026-01-01", "2026-01-31" ], "description": "Find advertisements that were running at any point during this date range (overlap-based: includes ads that started before the range and are still running, not just ads that started inside it)." }, "advertisement_format_count": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref42", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 2, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum number of distinct advertisement creative formats the company is actively running." }, "advertisement_search_terms": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref24", "type": "array", "items": { "type": "string" }, "example": [ "asus" ], "description": "Keywords used to search within advertisement content or titles." }, "cloud_footprint_city_count": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref72", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum cities. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "cloud_footprint_host_count": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref65", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum hosts. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "is_enable_similarity_search": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref47", "type": "boolean", "description": "When enabled, the filters listed above that support similarity searches can be filled with free text for specific IDs." }, "advertisement_platform_count": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref41", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 2, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum number of distinct ad platforms (linkedin, facebook, google, tiktok, apple) the company is actively advertising on." }, "cloud_footprint_region_count": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref71", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum cloud regions. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "cloud_footprint_server_count": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref66", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum servers (distinct IP addresses). Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "cloud_footprint_cloud_regions": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref58", "type": "array", "items": { "type": "string" }, "example": [ "us-east-1", "eu-central-1" ], "description": "Restrict results to footprint rows matching these cloud regions. Scoped to this footprint row — one provider in one country." }, "cloud_footprint_country_count": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref69", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum countries the company hosts in. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "is_profile_metadata_available": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref51", "type": "boolean", "description": "Indicates whether profile metadata is available for the request." }, "advertisement_country_activity": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref44", "type": "object", "example": { "rank": [ null, 500 ], "country": "US" }, "properties": { "rank": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ null, 500 ], "maxItems": 2, "minItems": 2, "description": "Rank within that country by advertising volume. 1 is the biggest spender, and the number increases as advertising volume decreases. Use `[null, 500]` to find the top 500 biggest spenders in that country; use `[500, null]` to find everyone ranked 500th or lower." }, "country": { "type": "string", "example": "US", "description": "ISO 3166-1 alpha-2 country code to scope this filter to. Required." }, "last_seen": { "type": "array", "items": { "type": "string", "format": "date", "nullable": true }, "example": [ "2026-07-01", null ], "maxItems": 2, "minItems": 2, "description": "[from, to] window for when the company's most recent ad in this country ran, for the opposite question: who has gone quiet in a market." }, "total_ads": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 10, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum total advertisements, scoped to this country." }, "active_ads": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum active advertisements, scoped to this country." }, "first_seen": { "type": "array", "items": { "type": "string", "format": "date", "nullable": true }, "example": [ "2026-07-01", null ], "maxItems": 2, "minItems": 2, "description": "[from, to] window for when the company's earliest ad in this country ran — the \"newly entered this market\" filter. Either bound may be null for an open-ended window; dates use the request timezone. A company whose ads carry no start date has no first-seen value and is never reported as new." }, "percentile": { "type": "array", "items": { "type": "number", "nullable": true }, "example": [ 90, null ], "maxItems": 2, "minItems": 2, "description": "Percentile within that country by advertising volume, 0-100. Higher means a bigger spender. Use `[90, null]` for the top 10% of spenders in that country." }, "impressions": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1000, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum estimated impressions, scoped to this country." }, "running_ads": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum running advertisements, scoped to this country. Currently populated for LinkedIn ads only." }, "volume_score": { "type": "array", "items": { "type": "number", "nullable": true }, "example": [ 0.5, null ], "maxItems": 2, "minItems": 2, "description": "The underlying 0-1 advertising volume score that `rank` and `percentile` are both computed from." } }, "description": "Advertising activity for one specific country. `country` is required, and at least one other field must be set (a country by itself matches nothing). For an all-country total instead, use the top-level `advertisement_active_ads` / `advertisement_total_ads` / `advertisement_impressions_estimate` filters." }, "advertisement_target_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref25", "type": "array", "items": { "type": "string" }, "example": [ "TW", "AE", "NO" ], "description": "Target geographic locations for advertisements." }, "cloud_footprint_exclude_cities": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref61", "type": "array", "items": { "type": "string" }, "example": [ "Ashburn", "Frankfurt" ], "description": "Remove footprint rows matching these cities. Scoped to this footprint row — one provider in one country." }, "cloud_footprint_provider_count": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref68", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum distinct providers used by the company. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "cloud_footprint_last_seen_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref63", "type": "array", "items": { "type": "string", "nullable": true }, "example": [ "2026-01-01", null ], "maxItems": 2, "minItems": 2, "description": "Two ISO 8601 dates (YYYY-MM-DD) bounding when the footprint was last seen. Scoped to this footprint row — one provider in one country." }, "is_parameter_metadata_available": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref50", "type": "boolean", "description": "Indicates whether parameter metadata is available for the request." }, "cloud_footprint_country_activity": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref74", "type": "object", "properties": { "country": { "type": "string", "example": "DE", "description": "ISO 3166-1 alpha-2 country code." }, "last_seen": { "type": "array", "items": { "type": "string", "nullable": true }, "example": [ "2026-07-01", null ], "maxItems": 2, "minItems": 2 }, "city_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 100, null ], "maxItems": 2, "minItems": 2 }, "first_seen": { "type": "array", "items": { "type": "string", "nullable": true }, "example": [ "2026-07-01", null ], "maxItems": 2, "minItems": 2 }, "host_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 100, null ], "maxItems": 2, "minItems": 2 }, "region_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 100, null ], "maxItems": 2, "minItems": 2 }, "server_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 100, null ], "maxItems": 2, "minItems": 2 }, "shared_server_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 100, null ], "maxItems": 2, "minItems": 2 } }, "description": "Bounds scoped to one country: `{\"country\":\"DE\",\"host_count\":[100,null]}` finds companies running 100+ hosts in Germany specifically. The bare `cloud_footprint_host_count` is the company total across all countries, so the two cannot express this together. `country` alone is rejected." }, "cloud_footprint_first_seen_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref62", "type": "array", "items": { "type": "string", "nullable": true }, "example": [ "2026-01-01", null ], "maxItems": 2, "minItems": 2, "description": "Two ISO 8601 dates (YYYY-MM-DD) bounding when the footprint was first seen. Scoped to this footprint row — one provider in one country." }, "cloud_footprint_primary_provider": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref73", "type": "array", "items": { "type": "string" }, "example": [ "AWS" ], "description": "Companies whose single largest provider is one of these." }, "cloud_footprint_target_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref56", "type": "array", "items": { "type": "string" }, "example": [ "DE", "SG" ], "description": "Companies present in any of these countries anywhere in their footprint." }, "advertisement_publisher_platforms": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref35", "type": "array", "items": { "type": "string", "description": "Allowed values: facebook, instagram, messenger, threads, audience_network." }, "example": [ "facebook", "instagram" ], "description": "Filter Facebook/Meta ads by the platform surface they were delivered on. Lowercase and case-insensitive. Only applies to the `facebook` source (other sources are single-platform)." }, "cloud_footprint_exclude_providers": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref55", "type": "array", "items": { "type": "string" }, "example": [ "AWS", "Cloudflare", "Hetzner" ], "description": "Remove footprint rows matching these cloud or hosting providers. Scoped to this footprint row — one provider in one country." }, "advertisement_impressions_estimate": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref43", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1000, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum estimated advertisement impressions, summed across all countries. Only advertisements with a reported impression range are counted." }, "cloud_footprint_shared_server_count": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref67", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum servers shared with other companies. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." }, "cloud_footprint_is_cross_border_only": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref64", "type": "boolean", "example": true, "description": "When true, return only footprint rows outside the company's home market. Rows whose company has no known headquarters are excluded." }, "cloud_footprint_exclude_cloud_regions": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref59", "type": "array", "items": { "type": "string" }, "example": [ "us-east-1", "eu-central-1" ], "description": "Remove footprint rows matching these cloud regions. Scoped to this footprint row — one provider in one country." }, "advertisement_exclude_target_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref27", "type": "array", "items": { "type": "string" }, "example": [ "IS", "GB", "FR", "IE", "ES" ], "description": "Geographic locations to exclude from advertisement targeting." }, "cloud_footprint_exclude_target_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref57", "type": "array", "items": { "type": "string" }, "example": [ "DE", "US", "SG" ], "description": "Remove footprint rows matching these country codes the infrastructure sits in." }, "advertisement_exclude_publisher_platforms": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref36", "type": "array", "items": { "type": "string", "description": "Allowed values: facebook, instagram, messenger, threads, audience_network." }, "example": [ "audience_network" ], "description": "Exclude Facebook/Meta ads delivered on these platform surfaces." }, "cloud_footprint_cross_border_country_count": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7d41c59bd8ef55f0_ref70", "type": "array", "items": { "type": "integer", "nullable": true }, "example": [ 1, null ], "maxItems": 2, "minItems": 2, "description": "Minimum and maximum countries outside the company's home market. Use `null` for an open-ended bound. Counted for the whole company, across every provider and country." } } } } }, "required": true }, "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Bczf0ngsC6bcl6q0Du2IG", "authority": "official", "conflicts": [], "revisionId": "sdrn_4iDCRIPFDsZRmP0aGdw03" }, { "gaps": [], "pages": [], "sourceId": "sds_2u3p4yN9ciqx-ocEBGR74", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/similarity_score/format", "/requestBody/content/application/json/schema/properties/advertisement_country_activity/required", "/requestBody/content/application/json/schema/properties/cloud_footprint_country_activity/required" ], "revisionId": "sdrn_sF4Id8BIBdrnOh1M8jbor" }, { "gaps": [ "Missing request body schema and response schema details." ], "pages": [ 1 ], "sourceId": "sds__qoL1UlQ2hahHjRv-3RyA", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_8lrHjOTkOAWhpSD8DCe8p" }, { "gaps": [ "Missing specific schema for response body fields" ], "pages": [ 1 ], "sourceId": "sds_4QU1K-UtbB0JEFxtFT9j9", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/properties/per_page/maximum" ], "revisionId": "sdrn_YF3wEfhXeBDGcT4L2-sCE" }, { "gaps": [ "Missing explicit required field list in requestBody schema beyond company_name", "Missing detailed schema for filter_conditions items" ], "pages": [ 1 ], "sourceId": "sds_grMB3nvB3wDu55V_E2M1W", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/required", "/requestBody/content/application/json/schema/properties/page/description", "/requestBody/content/application/json/schema/properties/query/description", "/requestBody/content/application/json/schema/properties/places/description", "/requestBody/content/application/json/schema/properties/domains/description", "/requestBody/content/application/json/schema/properties/sort_by/enum", "/requestBody/content/application/json/schema/properties/sort_by/description", "/requestBody/content/application/json/schema/properties/keywords/description", "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/per_page/description", "/requestBody/content/application/json/schema/properties/employees/description", "/requestBody/content/application/json/schema/properties/locations/description", "/requestBody/content/application/json/schema/properties/verticals/description", "/requestBody/content/application/json/schema/properties/categories/description", "/requestBody/content/application/json/schema/properties/job_titles/description", "/requestBody/content/application/json/schema/properties/company_name/description", "/requestBody/content/application/json/schema/properties/social_media/items/enum", "/requestBody/content/application/json/schema/properties/social_media/description", "/requestBody/content/application/json/schema/properties/technologies/description", "/requestBody/content/application/json/schema/properties/founded_dates/description", "/requestBody/content/application/json/schema/properties/job_locations/description", "/requestBody/content/application/json/schema/properties/linkedin_urls/description", "/requestBody/content/application/json/schema/properties/company_groups/description", "/requestBody/content/application/json/schema/properties/exclude_fields/description", "/requestBody/content/application/json/schema/properties/exclude_places/description", "/requestBody/content/application/json/schema/properties/company_filters/description", "/requestBody/content/application/json/schema/properties/news_categories/description", "/requestBody/content/application/json/schema/properties/job_posted_dates/description", "/requestBody/content/application/json/schema/properties/similarity_score/description", "/requestBody/content/application/json/schema/properties/exclude_locations/description", "/requestBody/content/application/json/schema/properties/filter_conditions/description", "/requestBody/content/application/json/schema/properties/is_ascending_order/description", "/requestBody/content/application/json/schema/properties/vertical_categories/description", "/requestBody/content/application/json/schema/properties/advertisement_status/items/enum", "/requestBody/content/application/json/schema/properties/advertisement_status/description", "/requestBody/content/application/json/schema/properties/exclude_technologies/description", "/requestBody/content/application/json/schema/properties/news_published_dates/description", "/requestBody/content/application/json/schema/properties/advertisement_formats/items/enum", "/requestBody/content/application/json/schema/properties/advertisement_formats/description", "/requestBody/content/application/json/schema/properties/cloud_footprint_cities/description", "/requestBody/content/application/json/schema/properties/advertisement_platforms/items/enum", "/requestBody/content/application/json/schema/properties/advertisement_platforms/description", "/requestBody/content/application/json/schema/properties/advertisement_total_ads/description", "/requestBody/content/application/json/schema/properties/vertical_sub_categories/description", "/requestBody/content/application/json/schema/properties/advertisement_active_ads/description", "/requestBody/content/application/json/schema/properties/advertisement_running_ads/description", "/requestBody/content/application/json/schema/properties/cloud_footprint_providers/description", "/requestBody/content/application/json/schema/properties/advertisement_active_dates/description", "/requestBody/content/application/json/schema/properties/advertisement_format_count/description", "/requestBody/content/application/json/schema/properties/advertisement_search_terms/description", "/requestBody/content/application/json/schema/properties/cloud_footprint_city_count/description", "/requestBody/content/application/json/schema/properties/cloud_footprint_host_count/description", "/requestBody/content/application/json/schema/properties/is_enable_similarity_search/description", "/requestBody/content/application/json/schema/properties/advertisement_platform_count/description", "/requestBody/content/application/json/schema/properties/cloud_footprint_region_count/description", "/requestBody/content/application/json/schema/properties/cloud_footprint_server_count/description", "/requestBody/content/application/json/schema/properties/cloud_footprint_cloud_regions/description", "/requestBody/content/application/json/schema/properties/cloud_footprint_country_count/description", "/requestBody/content/application/json/schema/properties/advertisement_country_activity/required", "/requestBody/content/application/json/schema/properties/advertisement_country_activity/description", "/requestBody/content/application/json/schema/properties/cloud_footprint_exclude_cities/description", "/requestBody/content/application/json/schema/properties/cloud_footprint_provider_count/description", "/requestBody/content/application/json/schema/properties/cloud_footprint_last_seen_dates/description", "/requestBody/content/application/json/schema/properties/is_parameter_metadata_available/description", "/requestBody/content/application/json/schema/properties/cloud_footprint_country_activity/required", "/requestBody/content/application/json/schema/properties/cloud_footprint_country_activity/description", "/requestBody/content/application/json/schema/properties/cloud_footprint_first_seen_dates/description", "/requestBody/content/application/json/schema/properties/cloud_footprint_target_locations/description", "/requestBody/content/application/json/schema/properties/advertisement_publisher_platforms/items/enum", "/requestBody/content/application/json/schema/properties/advertisement_publisher_platforms/description", "/requestBody/content/application/json/schema/properties/cloud_footprint_exclude_providers/description", "/requestBody/content/application/json/schema/properties/advertisement_impressions_estimate/description", "/requestBody/content/application/json/schema/properties/cloud_footprint_shared_server_count/description", "/requestBody/content/application/json/schema/properties/cloud_footprint_is_cross_border_only/description", "/requestBody/content/application/json/schema/properties/cloud_footprint_exclude_cloud_regions/description", "/requestBody/content/application/json/schema/properties/cloud_footprint_exclude_target_locations/description", "/requestBody/content/application/json/schema/properties/advertisement_exclude_publisher_platforms/items/enum", "/requestBody/content/application/json/schema/properties/cloud_footprint_cross_border_country_count/description" ], "revisionId": "sdrn_igjwYkLWbyLOANYluK8nP" }, { "gaps": [], "pages": [], "sourceId": "sds_H53dAzk1aB4Z5eLGWJqyx", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/similarity_score/format", "/requestBody/content/application/json/schema/properties/advertisement_country_activity/required", "/requestBody/content/application/json/schema/properties/cloud_footprint_country_activity/required" ], "revisionId": "sdrn_8wqdTxRjS8JDhJzOPw2b8" }, { "gaps": [ "Missing full response schema", "Missing specific enum values for categories/verticals" ], "pages": [ 1, 2, 3 ], "sourceId": "sds_nn5ddYxGCUtV3V6ihXysQ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/verticals/items/type", "/requestBody/content/application/json/schema/properties/categories/items/type", "/requestBody/content/application/json/schema/properties/filter_conditions/items/required", "/requestBody/content/application/json/schema/properties/filter_conditions/items/properties/operator/enum", "/requestBody/content/application/json/schema/properties/vertical_categories/items/type", "/requestBody/content/application/json/schema/properties/vertical_sub_categories/items/type", "/requestBody/required" ], "revisionId": "sdrn_f2SngYKaqfb5GyGVv4DE5" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/properties/employees/items/items/type", "/requestBody/content/application/json/schema/properties/verticals/items/type" ], "revisionId": "sdrn_BPN1iHD5tCVT4d4YJh-Wj" }, { "gaps": [ "Missing request body schema and response details." ], "pages": [ 1 ], "sourceId": "sds_szyMKh2_p4dgcKv4HWc5U", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_MjFi5p9pj2Upopb3AwYNv" } ], "x-zeroclick-services": [ "search" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per credit (credits, service search)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "search", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/people/search": { "post": { "summary": "Search for people", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref35", "type": "object", "nullable": true, "description": "Response info depends on specific endpoint." }, "metadata": { "type": "object", "description": "Request context: echoed `filters` and `parameters`, an optional `profile` credit block, and `ignored_fields` (body keys the endpoint dropped)." } } }, "example": { "data": { "peoples": [ { "city": "Bentonville", "name": "Doug McMillon", "state": "Arkansas", "title": "President & CEO", "emails": null, "phones": null, "company": { "x_url": null, "domain": "walmart.com", "emails": [], "phones": null, "country": "United States", "contacts": [], "industry": "Retail", "location": "United States", "logo_url": "https://buckets.pubrio.com/company-logo/NzU3MDIzMjY3aWxqOXNzbmoxd2FsbWFydC5jb21saW5rZWRpbl8zMzMxOTgxMg==.jpg", "domain_id": 26067151, "domain_ids": [ 757023267, 368242703, 26067151 ], "github_url": null, "tiktok_url": null, "company_url": "http://walmart.com", "specialties": [ "Retail", "E-commerce" ], "tiktok_name": null, "twitter_url": "https://twitter.com/walmart", "youtube_url": "http://youtube.com/user/walmart", "company_name": "Walmart", "company_size": 466000, "country_code": "US", "facebook_url": "http://facebook.com/walmart", "founded_year": 1962, "linkedin_url": "http://www.linkedin.com/company/walmart", "wantedly_url": null, "instagram_url": "http://instagram.com/walmart", "wantedly_name": null, "crunchbase_url": null, "rocketpunch_url": null, "social_metadata": {}, "domain_search_id": "2a0d6cd7-cc10-44d6-94ec-41fd528a11b6", "rocketpunch_name": null, "company_size_printed": "466,000", "is_company_url_active": true }, "country": "United States", "tagline": null, "contacts": null, "headline": "President & CEO at Walmart Inc.", "keywords": null, "location": "United States", "functions": null, "last_name": "McMillon", "seniority": "c_suite", "sequences": null, "first_name": "Doug", "github_url": null, "departments": [ "c_suite" ], "description": null, "saved_lists": null, "twitter_url": null, "country_code": "US", "facebook_url": null, "introduction": null, "linkedin_url": "http://www.linkedin.com/in/dougmcmillon", "wantedly_url": null, "contact_types": [], "wantedly_name": null, "subdepartments": [ "executive" ], "rocketpunch_url": null, "social_metadata": {}, "people_search_id": "134591fb-f0fa-41ba-9c8c-f1eb8aab8946", "rocketpunch_name": null, "employment_history": [ { "title": "President & CEO", "current": true, "end_date": null, "start_date": "2014-02-01", "company_name": "Walmart" }, { "title": "President & CEO, Walmart International", "current": false, "end_date": "2014-01-01", "start_date": "2009-02-01", "company_name": "Walmart" }, { "title": "President & CEO", "current": false, "end_date": "2009-01-01", "start_date": "2005-08-01", "company_name": "Sam's Club" } ] }, "..." ], "pagination": { "page": 1, "per_page": 25, "is_timeout": false, "total_pages": 100, "total_entries": 199616132, "total_display_pages": 100 } }, "metadata": { "filters": { "management_levels": [ "c_suite" ] }, "profile": null } } } }, "description": "Successful response containing people search details." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref36", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "details" ], "properties": { "code": { "type": "integer", "example": 40001 }, "details": { "type": "object" }, "message": { "type": "string", "example": "Errors and codes will vary depending on the scenario, please see the documentation for information." } } } } }, "description": "Bad request. The request was malformed or contained invalid parameters. Check the error code and message for details." }, "402": { "description": "Payment required" }, "429": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref37", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "Request rate limit exceeded. Please wait and try again later." } } } } }, "description": "Rate limit exceeded. Too many requests were made in a given time period. Retry after the rate limit window resets." }, "500": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref38", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "An unexpected error occurred on the server." } } } } }, "description": "Internal server error. An unexpected error occurred on the server. Contact support if the error persists." } }, "description": "Search the Pubrio database for people matching specified criteria such as job title, location, company, and seniority.", "operationId": "people_search", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref24", "type": "integer", "default": 1, "example": 1, "description": "Page number, starting at 1. The ceiling is your subscription's `max_search_page` (`max_company_search_page` for company search), returned by [Profile](/en/api-reference/endpoint/profile/profile). Exceeding it returns **HTTP 416**." }, "query": { "type": "string", "example": "decision makers in marketing", "description": "Natural-language search. When provided, Pubrio interprets it into the person and company filters below (job role, seniority, department, location, industry, company size, and more). Any explicit filters you also pass take precedence over the interpreted ones. Leave empty to search purely by the structured filters." }, "domains": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref18", "type": "array", "items": { "type": "string" }, "example": [ "pubrio.com" ], "description": "List of company domains used for company and people search operations. If we receive a URL such as `www.pubrio.com` or `https://docs.pubrio.com/`, the system will convert it to `pubrio.com` for processing." }, "filters": { "type": "object" }, "peoples": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref4", "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A list of unique identifiers (people_search_id) used for people search operations." }, "keywords": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref30", "type": "array", "items": { "type": "string" }, "example": [ "ecommerce", "ai", "fintech" ], "description": "A list of keywords to filter companies by relevance, specialties, or descriptions." }, "per_page": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref23", "type": "integer", "default": 25, "example": 25, "description": "Records per page. Defaults to 25, which is also the ceiling on most plans — the limit is your subscription's `max_search_per_page`, returned by [Profile](/en/api-reference/endpoint/profile/profile). Exceeding it returns **HTTP 416** with code `41676` (or `41613` on company and people search), not a clamped result set." }, "revenues": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref32", "type": "array", "items": { "type": "integer" }, "example": [ 0, 100000 ], "description": "Minimum and maximum range of company revenue." }, "companies": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref17", "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A list of unique identifiers (domain_search_id) used for company and people search operations." }, "employees": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref10", "type": "array", "items": { "type": "array", "items": { "type": "string" } }, "example": [ [ 1, 10 ], [ 11, 20 ], [ 10001 ] ], "description": "The number range of employees working for the company. This enables you to find companies based on headcount. You can add multiple ranges to expand your search results. \n\n Check out `company size` endpoints under the Filters tab for more information." }, "verticals": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref27", "type": "array", "items": { "type": "integer" }, "description": "A list of `vertical_id` used to search for companies in a specific vertical or industry. To find the ID, call the `vertical` endpoint under the Filters tab.\n\nThis filter supports `is_enable_similarity_search`, once enabled you can enter any free text, e.g. `[\"AI\"]`." }, "categories": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref26", "type": "array", "items": { "type": "integer" }, "description": "A list of `category_id` used to search for specific categories of technology used by companies. To find the ID, call the `category` endpoint under the Filters tab.\n\nThis filter supports `is_enable_similarity_search`, once enabled you can enter any free text, e.g. `[\"CDN\"]`." }, "departments": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref6", "type": "array", "items": { "type": "string" }, "example": [ "master_human_resources" ], "description": "The department field can search for people in specific areas of expertise. \n\n Check out `department` endpoints under the Filters tab for more information." }, "people_name": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref1", "type": "string", "example": "king", "description": "Filter search results to include a specific people name." }, "search_term": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref0", "type": "string", "example": "pubrio", "description": "A string of words over which we want to filter the results." }, "social_media": { "type": "object" }, "technologies": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref25", "type": "array", "items": { "type": "integer" }, "description": "A list of `tag_id` used to search for specific technologies used by companies. To find the ID, call the `technology` endpoint under the Filters tab.\n\nThis filter supports `is_enable_similarity_search`, once enabled you can enter any free text, e.g. `[\"Shopify\"]`.\n\nA product name the technology list knows matches that product and its own products (`\"Salesforce\"` also matches Salesforce Desk and Salesforce Service Cloud), never look-alikes; other text matches by similarity." }, "founded_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref31", "type": "array", "items": { "type": "integer" }, "example": [ 2018, 2024 ], "description": "Years of company founded range. The maximum value founded is the current year." }, "linkedin_urls": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref16", "type": "array", "items": { "type": "string" }, "example": [ "http://www.linkedin.com/in/king-lai-605382b7" ], "description": "The fully formed URL of the LinkedIn user profile. URL begin with `http` and contain `linkedin.com/in/` or `linkedin.com/pub/`" }, "people_groups": { "type": "array", "items": { "type": "string" } }, "people_titles": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref2", "type": "array", "items": { "type": "string" }, "example": [ "sales manager", "marketing manager" ], "description": "Job titles associated with the individuals you aim to locate. \n\n The results will also encompass job titles that include similar terminology, even if they do not match exactly. For instance, searching for `software engineer` may yield results for individuals with the title `senior software engineer`." }, "company_places": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref33", "type": "array", "items": { "type": "string" }, "example": [ "Tokyo" ], "description": "Place names (city, region) used to filter results. Accepts localized or English place names." }, "company_filters": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref19", "type": "object", "example": { "technologies": [ 37, 152 ], "founded_dates": [ 2015, 2023 ], "company_locations": [ "US" ], "filter_conditions": [ { "key": "technologies", "operator": "and" } ] }, "properties": { "domains": { "type": "array", "items": { "type": "string" } }, "keywords": { "type": "array", "items": { "type": "string" } }, "revenues": { "type": "array", "items": { "type": "integer" } }, "companies": { "type": "array", "items": { "type": "string" } }, "employees": { "type": "array", "items": { "type": "array", "items": { "type": "integer" } } }, "verticals": { "type": "array", "items": { "type": "integer" } }, "categories": { "type": "array", "items": { "type": "integer" } }, "technologies": { "type": "array", "items": { "type": "integer" } }, "founded_dates": { "type": "array", "items": { "type": "integer" } }, "company_places": { "type": "array", "items": { "type": "string" } }, "company_locations": { "type": "array", "items": { "type": "string" } }, "filter_conditions": { "type": "array", "items": { "type": "object" } }, "vertical_categories": { "type": "array", "items": { "type": "integer" } }, "company_linkedin_urls": { "type": "array", "items": { "type": "string" } }, "company_exclude_places": { "type": "array", "items": { "type": "string" } }, "vertical_sub_categories": { "type": "array", "items": { "type": "integer" } }, "company_exclude_locations": { "type": "array", "items": { "type": "string" } }, "is_enable_similarity_search": { "type": "boolean" } }, "description": "Wrapper object for company-level filters. Recommended grouping that visually separates which keys filter the *person* (top-level) from which filter the *company*. Accepts the same keys as the top-level company filters (e.g. `technologies`, `verticals`, `vertical_categories`, `vertical_sub_categories`, `categories`, `keywords`, `founded_dates`, `employees`, `revenues`, `company_locations`, `company_exclude_locations`, `company_places`, `company_exclude_places`, `companies`, `domains`, `company_linkedin_urls`, `is_enable_similarity_search`, `similarity_score`, plus `filter_conditions`). Engine flattens this object to the top level before processing — top-level keys win on conflict. Same shape used by Monitor `company_filters`. See the Filters Overview developer guide for examples." }, "people_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref11", "type": "array", "items": { "type": "string" }, "example": [ "US", "SG", "CN" ], "description": "The location where people live. Check out `location` endpoints under the Filters tab for more information." }, "similarity_score": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref22", "type": "number", "example": 0.7, "description": "It is used in conjunction with `is_enable_similarity_search`. This number is used to analyze whether a specific slug (e.g. vertical industry, technology) is similar to the user input, and the higher the number, the more stringent it is." }, "company_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref13", "type": "array", "items": { "type": "string" }, "example": [ "US", "SG", "CN" ], "description": "The location of the company headquarters. Check out `location` endpoints under the Filters tab for more information." }, "filter_conditions": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref20", "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "technologies", "description": "The filter key specifying which property to apply the operator to. Allowed values: keywords, verticals, vertical_categories, vertical_sub_categories, technologies, categories, social_media." }, "operator": { "type": "string", "example": "and", "description": "The logical operator to apply. Use 'or' to match any of the specified values, or 'and' to require all specified values. Allowed values: or, and." } } }, "description": "Per-key AND/OR override for filters in /people/search. Defaults to OR when omitted. See the People + Company Filters developer guide for the full key-remap reference." }, "management_levels": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref5", "type": "array", "items": { "type": "string", "description": "Allowed values: c_suite, director, entry, founder, head, intern, manager, owner, partner, senior, vp." }, "example": [ "c_suite", "vp" ], "description": "Reporting tier of the person. The C-suite slug is `c_suite`, not `c_level`. An unknown slug matches nobody. Full list from the `management level` endpoint under Filters." }, "exclude_departments": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref7", "type": "array", "items": { "type": "string" }, "example": [ "master_human_resources" ], "description": "Department slugs to leave out. Same vocabulary as `departments`. People with no department recorded are kept." }, "vertical_categories": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref28", "type": "array", "items": { "type": "integer" }, "description": "A list of `vertical_category_id` used to search for companies in a specific vertical category. To find the ID, call the `vertical category` endpoint under the Filters tab.\n\nThis filter supports `is_enable_similarity_search`, once enabled you can enter any free text, e.g. `[\"Information Technology\"]`." }, "department_functions": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref8", "type": "array", "items": { "type": "string" }, "example": [ "human_resources" ], "description": "The filter field for job functions can specify particular roles or areas of expertise when searching for people. \n\n Check out `department functions` endpoints under the Filters tab for more information." }, "company_linkedin_urls": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref15", "type": "array", "items": { "type": "string" }, "example": [ "https://www.linkedin.com/company/pubrio" ], "description": "The fully formed URL of the LinkedIn company profile. URL begin with `http` and contain `linkedin.com/company/`" }, "exclude_people_titles": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref3", "type": "array", "items": { "type": "string" }, "example": [ "intern", "assistant" ], "description": "Job titles to leave out. Same word-level matching as `people_titles`, so `[\"senior\"]` removes every title containing that word. Applied after `people_titles`." }, "company_exclude_places": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref34", "type": "array", "items": { "type": "string" }, "example": [ "Tokyo" ], "description": "Place names (city, region) to exclude from results. Accepts localized or English place names." }, "vertical_sub_categories": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref29", "type": "array", "items": { "type": "integer" }, "description": "A list of `vertical_sub_category_id` used to search for companies in a specific vertical sub-category. To find the ID, call the `vertical sub category` endpoint under the Filters tab.\n\nThis filter supports `is_enable_similarity_search`, once enabled you can enter any free text, e.g. `[\"Software\"]`." }, "exclude_people_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref12", "type": "array", "items": { "type": "string" }, "example": [ "US" ], "description": "Countries the person must **not** live in (ISO 3166-1 alpha-2). Companion of `people_locations`." }, "company_exclude_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref14", "type": "array", "items": { "type": "string" }, "example": [ "CN" ], "description": "Headquarters countries to leave out (ISO 3166-1 alpha-2). Companion of `company_locations`; sending the same code in both returns nothing." }, "is_enable_similarity_search": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref21", "type": "boolean", "description": "When enabled, the filters listed above that support similarity searches can be filled with free text for specific IDs." }, "exclude_department_functions": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b77d8c39801aeb92_ref9", "type": "array", "items": { "type": "string" }, "example": [ "software_development" ], "description": "Function slugs to leave out. Same vocabulary as `department_functions`. People with no function recorded are kept." }, "people_title_similarity_score": { "type": "number", "format": "float", "example": 0.9, "description": "Used together with `is_include_similar_people_titles`. Controls how closely a title must match; the higher the number, the stricter the match." }, "is_include_similar_people_titles": { "type": "boolean", "default": true, "description": "Enabled by default. `people_titles` also matches close variants of each title (for example, `software engineer` matches `senior software engineer`). `metadata.filters.people_titles` returns the full list that was searched." } } } } }, "required": true }, "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Bczf0ngsC6bcl6q0Du2IG", "authority": "official", "conflicts": [], "revisionId": "sdrn_4iDCRIPFDsZRmP0aGdw03" }, { "gaps": [], "pages": [], "sourceId": "sds_2u3p4yN9ciqx-ocEBGR74", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/similarity_score/format" ], "revisionId": "sdrn_sF4Id8BIBdrnOh1M8jbor" }, { "gaps": [ "Full schema for filter_conditions", "Full schema for social_media", "Full schema for response object" ], "pages": [ 1, 2, 3 ], "sourceId": "sds__qoL1UlQ2hahHjRv-3RyA", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/properties/per_page/maximum" ], "revisionId": "sdrn_8lrHjOTkOAWhpSD8DCe8p" }, { "gaps": [ "Missing specific filter schema definitions" ], "pages": [ 1 ], "sourceId": "sds_4QU1K-UtbB0JEFxtFT9j9", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_YF3wEfhXeBDGcT4L2-sCE" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [ 1 ], "sourceId": "sds_AZfXwFa2sqqzS_CXWcAbB", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_DAYMeoUnqnqug8EfLpLrJ" }, { "gaps": [], "pages": [], "sourceId": "sds_H53dAzk1aB4Z5eLGWJqyx", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/similarity_score/format" ], "revisionId": "sdrn_8wqdTxRjS8JDhJzOPw2b8" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [], "sourceId": "sds_i8deqX6-Fp5gi7tUPGTPZ", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn__3FNTGpfBMjPTVVLytG7Z" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [ 1 ], "sourceId": "sds_iUXJyfBmCE_7260rzOdkp", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_hQQ-C8uEx2j76eTz0TPqt" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_LrGpRhi5-a5-RHjFMEhsh", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn__bR6EtgaNMMbyd-B4-j3A" }, { "gaps": [ "Full schema properties for people search not provided in documentation snippet." ], "pages": [ 1, 2 ], "sourceId": "sds_nn5ddYxGCUtV3V6ihXysQ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/filter_conditions/items/required", "/requestBody/content/application/json/schema/properties/filter_conditions/items/properties/key/description", "/requestBody/content/application/json/schema/properties/filter_conditions/items/properties/operator/enum", "/requestBody/content/application/json/schema/properties/filter_conditions/items/properties/operator/description", "/requestBody/required" ], "revisionId": "sdrn_f2SngYKaqfb5GyGVv4DE5" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_BPN1iHD5tCVT4d4YJh-Wj" }, { "gaps": [ "Missing detailed schema for company_filters and filter_conditions objects." ], "pages": [ 1 ], "sourceId": "sds_szyMKh2_p4dgcKv4HWc5U", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/similarity_score/format", "/requestBody/content/application/json/schema/properties/management_levels/items/enum" ], "revisionId": "sdrn_MjFi5p9pj2Upopb3AwYNv" } ], "x-zeroclick-services": [ "search" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": null, "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per credit (credits, service search)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "search", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } } }, "x-zeroclick-navigation-footer": { "instructions": [ "Use this spec if it contains the operation and details you need. Otherwise, search or open a relevant service spec using the links below.", "Find service slugs in x-zeroclick-services or x-payment-info.rates[].service; use them in serviceSpecTemplate, never as request values.", "URL-encode template values. Search is ranked; service, path, and method filters are exact. Filters combine.", "Pages contain up to 10 operations; follow info.x-next or the Link header if you need more results. Shared operations retain all selector values." ], "fullSpec": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/openapi.json", "services": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/services", "serviceSpecTemplate": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/services/{slug}/openapi.json", "searchTemplate": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/openapi.json?q={text}", "operationTemplate": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/openapi.json?path={path}&method={method}", "firstPage": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/openapi.json?page=1" } }