{ "openapi": "3.1.0", "x-zeroclick-navigation": { "fullSpec": "https://agents.pubrio.com/zcj/eoliygaop6pu/openapi.json", "services": "https://agents.pubrio.com/zcj/eoliygaop6pu/services", "serviceSpecTemplate": "https://agents.pubrio.com/zcj/eoliygaop6pu/services/{slug}/openapi.json", "searchTemplate": "https://agents.pubrio.com/zcj/eoliygaop6pu/openapi.json?q={text}", "operationTemplate": "https://agents.pubrio.com/zcj/eoliygaop6pu/openapi.json?path={path}&method={method}", "firstPage": "https://agents.pubrio.com/zcj/eoliygaop6pu/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": "Start with the free seller advisor: POST https://agents.pubrio.com/zcj/eoliygaop6pu/zeroclick/agent/quote with your goal and known budget or requirements. This operation costs $0 and requires only an x402 or MPP wallet proof; it returns a guide and never executes a purchase. Without a wallet, GET https://agents.pubrio.com/zcj/eoliygaop6pu/zeroclick/agent/guide?goal=URL_ENCODED_TASK or POST to that guide. Other operations below are the direct API reference; their own prices and access requirements still apply. Call the operations listed in this document at https://agents.pubrio.com. Each service's full price matrix, plans, and how to buy are at https://agents.pubrio.com/zcj/eoliygaop6pu/services/{slug}; each operation's x-payment-info names the service it bills by slug (rates[].service). Slugs identify services in prices and usage reports and are never request values: when one operation serves several services, its request body schema lists the accepted values of the field that selects the service, so send one of those exactly as written. An unpaid call returns 402 Payment Required with a signed challenge; settle it with a supported payment method - x402 (Base USDC) or MPP (Tempo USDC) today - and retry with the proof attached. No upstream API key is needed, and an agent without a payment method can set one up instantly at no cost. Read GET https://agents.pubrio.com/zcj/eoliygaop6pu/manifest.json for the live services, meters, plans, prices, and any free included units, and https://agents.pubrio.com/zcj/eoliygaop6pu/llms-full.txt for the full agent guide, including how the free allowance works without funding (it requires an agent identity claimed by a human with a verified email)." }, "x-service-info": { "docs": { "homepage": "https://www.pubrio.com", "apiReference": "https://agents.pubrio.com/zcj/eoliygaop6pu/openapi.json", "llms": "https://agents.pubrio.com/zcj/eoliygaop6pu/llms.txt" } }, "externalDocs": { "url": "https://agents.pubrio.com/zcj/eoliygaop6pu/llms-full.txt", "description": "How to authenticate, pay, and call this API; links the upstream API reference." }, "servers": [ { "url": "https://agents.pubrio.com/zcj/eoliygaop6pu", "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_ba5395870fb570a1_ref0": { "type": "string", "format": "uuid", "description": "A unique identifier for the company search operation." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ba5395870fb570a1_ref1": { "type": "string", "format": "date", "example": "2026-01-01", "description": "Start of the date window (ISO 8601, YYYY-MM-DD). Use together with `date_to` to scope results to a specific range; omit both to use the default window." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ba5395870fb570a1_ref2": { "type": "string", "format": "date", "example": "2026-03-31", "description": "End of the date window (ISO 8601, YYYY-MM-DD). Ignored without `date_from`. If the window is invalid or reversed, the default window is used; check `window_days` in the response." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ba5395870fb570a1_ref3": { "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_ba5395870fb570a1_ref4": { "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_ba5395870fb570a1_ref5": { "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_b34505b84f92c9b8_ref0": { "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_b34505b84f92c9b8_ref1": { "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_b34505b84f92c9b8_ref2": { "type": "object", "nullable": true, "description": "Response info depends on specific endpoint." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b34505b84f92c9b8_ref3": { "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_b34505b84f92c9b8_ref4": { "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_b34505b84f92c9b8_ref5": { "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_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_a55d2d2ebc63ea64_ref0": { "type": "string", "format": "uuid", "example": "f28215e6-f6ed-40c2-ac9b-d8e70164c0be", "description": "Identifier of a single cloud footprint row." }, "sds_Bczf0ngsC6bcl6q0Du2IG_a55d2d2ebc63ea64_ref1": { "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_a55d2d2ebc63ea64_ref2": { "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_a55d2d2ebc63ea64_ref3": { "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_f7a13af0ec741c6a_ref0": { "type": "string", "format": "uuid", "example": "371d0c44-4c56-4c9c-98e2-ef6dd986b848", "description": "A unique identifier for the company job search operation." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f7a13af0ec741c6a_ref1": { "type": "object", "nullable": true, "description": "Response info depends on specific endpoint." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f7a13af0ec741c6a_ref2": { "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_f7a13af0ec741c6a_ref3": { "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_f7a13af0ec741c6a_ref4": { "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_107cb130a8966711_ref0": { "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_107cb130a8966711_ref1": { "type": "object", "nullable": true, "description": "Response info depends on specific endpoint." }, "sds_Bczf0ngsC6bcl6q0Du2IG_107cb130a8966711_ref2": { "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_107cb130a8966711_ref3": { "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_107cb130a8966711_ref4": { "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_f4de8479e87e2b03_ref0": { "type": "string", "format": "uuid", "description": "A unique identifier for the company search operation." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f4de8479e87e2b03_ref1": { "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_f4de8479e87e2b03_ref2": { "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_f4de8479e87e2b03_ref3": { "type": "object", "nullable": true, "description": "Response info depends on specific endpoint." }, "sds_Bczf0ngsC6bcl6q0Du2IG_f4de8479e87e2b03_ref4": { "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_f4de8479e87e2b03_ref5": { "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_f4de8479e87e2b03_ref6": { "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_4f25288a46df2e2e_ref0": { "type": "string", "format": "uuid", "example": "4110b929-17cd-42aa-a159-906ead0c9b56", "description": "A unique identifier for the company news search operation." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4f25288a46df2e2e_ref1": { "type": "object", "nullable": true, "description": "Response info depends on specific endpoint." }, "sds_Bczf0ngsC6bcl6q0Du2IG_4f25288a46df2e2e_ref2": { "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_4f25288a46df2e2e_ref3": { "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_4f25288a46df2e2e_ref4": { "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_ac4d1a20cd443ff2_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_ac4d1a20cd443ff2_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_ac4d1a20cd443ff2_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_ac4d1a20cd443ff2_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_ac4d1a20cd443ff2_ref4": { "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_ac4d1a20cd443ff2_ref5": { "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_ac4d1a20cd443ff2_ref6": { "type": "array", "items": { "type": "string" }, "example": [ "Tokyo" ], "description": "Place names (city, region) used to filter results. Accepts localized or English place names." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref7": { "type": "array", "items": { "type": "string" }, "example": [ "Tokyo" ], "description": "Place names (city, region) to exclude from results. Accepts localized or English place names." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref8": { "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref5" } ], "description": "Geographic locations to exclude from job posting results." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref9": { "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_ac4d1a20cd443ff2_ref10": { "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_ac4d1a20cd443ff2_ref11": { "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_ac4d1a20cd443ff2_ref12": { "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_ac4d1a20cd443ff2_ref13": { "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_ac4d1a20cd443ff2_ref14": { "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_ac4d1a20cd443ff2_ref15": { "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_ac4d1a20cd443ff2_ref16": { "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_ac4d1a20cd443ff2_ref17": { "type": "array", "items": { "type": "integer" }, "example": [ 0, 100000 ], "description": "Minimum and maximum range of company revenue." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref18": { "type": "array", "items": { "type": "integer" }, "example": [ 2018, 2024 ], "description": "Years of company founded range. The maximum value founded is the current year." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref19": { "type": "array", "items": { "type": "string" }, "example": [ "ecommerce", "ai", "fintech" ], "description": "A list of keywords to filter companies by relevance, specialties, or descriptions." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref20": { "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_ac4d1a20cd443ff2_ref21": { "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_ac4d1a20cd443ff2_ref22": { "type": "array", "items": { "type": "string" }, "example": [ "asus" ], "description": "Keywords used to search within advertisement content or titles." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref23": { "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref24" } ], "description": "Target geographic locations for advertisements." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref24": { "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_ac4d1a20cd443ff2_ref25": { "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref26" } ], "description": "Geographic locations to exclude from advertisement targeting." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref26": { "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_ac4d1a20cd443ff2_ref27": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-25", "2025-12-25" ], "description": "Start date range for advertisement filtering." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref28": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-25", "2025-12-25" ], "description": "End date range for advertisement filtering." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref29": { "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_ac4d1a20cd443ff2_ref30": { "type": "boolean", "description": "When enabled, the filters listed above that support similarity searches can be filled with free text for specific IDs." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref31": { "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_ac4d1a20cd443ff2_ref32": { "type": "array", "items": { "type": "string" }, "example": [ "emails", "phones", "contacts" ], "description": "List of fields to exclude from the response payload." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref33": { "type": "boolean", "description": "Indicates whether parameter metadata is available for the request." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref34": { "type": "boolean", "description": "Indicates whether profile metadata is available for the request." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref35": { "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_ac4d1a20cd443ff2_ref36": { "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_ac4d1a20cd443ff2_ref37": { "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_ac4d1a20cd443ff2_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_ac4d1a20cd443ff2_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_ac4d1a20cd443ff2_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_49333a7c6d50d1dc_ref0": { "type": "array", "items": { "type": "string" }, "example": [ "stripe.com", "https://www.linkedin.com/company/airbnb", "b7d92a56-31f8-4c0b-ae43-19c8e5f24b70" ], "description": "Scope to specific companies by any mix of `domain_search_id`, company domain, or a company social media profile URL. Domains and URLs resolve to their best-ranked company." }, "sds_Bczf0ngsC6bcl6q0Du2IG_49333a7c6d50d1dc_ref1": { "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_49333a7c6d50d1dc_ref2": { "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_49333a7c6d50d1dc_ref3": { "type": "integer", "example": 90, "description": "Optional. Size of the rolling window in days. Used when an explicit `transitioned_dates` range is not supplied; if both are omitted, a default window is used." }, "sds_Bczf0ngsC6bcl6q0Du2IG_49333a7c6d50d1dc_ref4": { "type": "boolean", "example": false, "description": "Include the `established` stage (long-standing operators with no active expansion signals). Defaults to false." }, "sds_Bczf0ngsC6bcl6q0Du2IG_49333a7c6d50d1dc_ref5": { "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_49333a7c6d50d1dc_ref6": { "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_49333a7c6d50d1dc_ref7": { "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_a22c41cd147c2829_ref0": { "type": "string", "example": "US", "description": "Target market as an ISO 3166-1 alpha-2 (cca2) country code. Omit to auto-pick the company's single most active market; set `is_all_markets` for a cross-market view of every market." }, "sds_Bczf0ngsC6bcl6q0Du2IG_a22c41cd147c2829_ref1": { "type": "boolean", "example": false, "description": "Return the company's entire expansion footprint across ALL markets in one call, rather than a single market. When `true`, `country_code` is ignored, the home market is excluded from the signal aggregates when it can be identified, `data` becomes a company-level rollup (dominant stage, total signals, date span, top expansion score), and `markets_summary` lists every market. Defaults to false." }, "sds_Bczf0ngsC6bcl6q0Du2IG_a22c41cd147c2829_ref2": { "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_a22c41cd147c2829_ref3": { "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_a22c41cd147c2829_ref4": { "type": "string", "format": "uuid", "description": "A unique identifier for the company search operation." }, "sds_Bczf0ngsC6bcl6q0Du2IG_a22c41cd147c2829_ref5": { "type": "boolean", "example": false, "description": "Include the `established` stage (long-standing operators with no active expansion signals). Defaults to false." }, "sds_Bczf0ngsC6bcl6q0Du2IG_a22c41cd147c2829_ref6": { "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_a22c41cd147c2829_ref7": { "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_a22c41cd147c2829_ref8": { "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_a22c41cd147c2829_ref9": { "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_a22c41cd147c2829_ref10": { "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_9e63ea9c999c76c1_ref0": { "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": [ "EXEC", "HIRE" ], "description": "Filter to specific signal types. See the Signal Types catalog in the knowledge base for definitions and tiers (`DNS` and `INFRA` are Premier-tier signals)." }, "sds_Bczf0ngsC6bcl6q0Du2IG_9e63ea9c999c76c1_ref1": { "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_9e63ea9c999c76c1_ref2": { "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_9e63ea9c999c76c1_ref3": { "type": "string", "format": "uuid", "description": "A unique identifier for the company search operation." }, "sds_Bczf0ngsC6bcl6q0Du2IG_9e63ea9c999c76c1_ref4": { "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_9e63ea9c999c76c1_ref5": { "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_9e63ea9c999c76c1_ref6": { "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_9e63ea9c999c76c1_ref7": { "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_9e63ea9c999c76c1_ref8": { "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_568a299ac7783f8b_ref0": { "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "Origin markets (ISO 3166-1 alpha-2). Where a company is expanding FROM — its home / HQ countries. Use alone to find companies growing out of these markets; combine with `tos` for a specific from→to corridor." }, "sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref1": { "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "Target markets (ISO 3166-1 alpha-2). Where a company is expanding TO. Use alone to find every company entering these markets; combine with `froms` for a specific from→to corridor." }, "sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref2": { "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "Origin markets to exclude (ISO 3166-1 alpha-2)." }, "sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref3": { "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "Target markets to exclude (ISO 3166-1 alpha-2)." }, "sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref4": { "type": "array", "items": { "enum": [ "exploring", "committing", "expanding", "scaling" ], "type": "string" }, "example": [ "committing", "expanding" ], "description": "Filter to one or more expansion stages. See the Expansion Signals knowledge base for stage definitions." }, "sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref5": { "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": [ "EXEC", "HIRE" ], "description": "Filter to specific signal types. See the Signal Types catalog in the knowledge base for definitions and tiers (`DNS` and `INFRA` are Premier-tier signals)." }, "sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref6": { "type": "array", "items": { "enum": [ "low", "medium", "high", "very_high" ], "type": "string" }, "example": [ "high" ], "description": "Filter by evidence-confidence bucket: `low`, `medium`, or `high`. Note this is distinct from the per-signal `signal_strength_slug` returned on signal records (which ranges `low` to `very_high`); any other value here matches nothing." }, "sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref7": { "type": "boolean", "example": false, "description": "When true, return only contraction-flagged expansions (companies scaling back)." }, "sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref8": { "type": "array", "items": { "type": "string" }, "example": [ "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c" ], "description": "Company identifiers (domain_search_id UUIDs) to include." }, "sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref9": { "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_568a299ac7783f8b_ref10": { "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_568a299ac7783f8b_ref11": { "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_568a299ac7783f8b_ref12": { "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_568a299ac7783f8b_ref13": { "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_568a299ac7783f8b_ref14": { "type": "array", "items": { "type": "integer" }, "example": [ 0, 100000 ], "description": "Minimum and maximum range of company revenue." }, "sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref15": { "type": "array", "items": { "type": "integer" }, "example": [ 2018, 2024 ], "description": "Years of company founded range. The maximum value founded is the current year." }, "sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref16": { "type": "array", "items": { "type": "string" }, "example": [ "ecommerce", "ai", "fintech" ], "description": "A list of keywords to filter companies by relevance, specialties, or descriptions." }, "sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref17": { "type": "array", "items": { "type": "string" }, "example": [ "stripe.com", "https://www.linkedin.com/company/airbnb", "b7d92a56-31f8-4c0b-ae43-19c8e5f24b70" ], "description": "Scope to specific companies by any mix of `domain_search_id`, company domain, or a company social media profile URL. Domains and URLs resolve to their best-ranked company." }, "sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref18": { "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_568a299ac7783f8b_ref19": { "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref20" } ], "description": "Geographic locations to exclude from job posting results." }, "sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref20": { "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_568a299ac7783f8b_ref21": { "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_568a299ac7783f8b_ref22": { "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_568a299ac7783f8b_ref23": { "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref24" } ], "description": "Target geographic locations for advertisements." }, "sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref24": { "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_568a299ac7783f8b_ref25": { "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref26" } ], "description": "Geographic locations to exclude from advertisement targeting." }, "sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref26": { "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_568a299ac7783f8b_ref27": { "type": "array", "items": { "type": "string" }, "example": [ "asus" ], "description": "Keywords used to search within advertisement content or titles." }, "sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref28": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-25", "2025-12-25" ], "description": "Start date range for advertisement filtering." }, "sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref29": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-25", "2025-12-25" ], "description": "End date range for advertisement filtering." }, "sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref30": { "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_568a299ac7783f8b_ref31": { "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_568a299ac7783f8b_ref32": { "type": "boolean", "example": false, "description": "Include the `established` stage (long-standing operators with no active expansion signals). Defaults to false." }, "sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref33": { "type": "integer", "example": 50, "description": "Maximum number of records to return. Capped by your plan." }, "sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref34": { "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_568a299ac7783f8b_ref35": { "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_568a299ac7783f8b_ref36": { "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_2073acb14089837f_ref0": { "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "Origin markets (ISO 3166-1 alpha-2). Where a company is expanding FROM — its home / HQ countries. Use alone to find companies growing out of these markets; combine with `tos` for a specific from→to corridor." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref1": { "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "Target markets (ISO 3166-1 alpha-2). Where a company is expanding TO. Use alone to find every company entering these markets; combine with `froms` for a specific from→to corridor." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref2": { "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "Origin markets to exclude (ISO 3166-1 alpha-2)." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref3": { "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "Target markets to exclude (ISO 3166-1 alpha-2)." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref4": { "type": "array", "items": { "enum": [ "exploring", "committing", "expanding", "scaling" ], "type": "string" }, "example": [ "committing", "expanding" ], "description": "Filter to one or more expansion stages. See the Expansion Signals knowledge base for stage definitions." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref5": { "type": "array", "items": { "enum": [ "advancing", "steady", "pulling_back" ], "type": "string" }, "example": [ "advancing", "steady" ], "description": "Trajectory to filter by. Only `advancing`, `steady` and `pulling_back` are accepted; the `directions` values in [Expansion Reference](/en/api-reference/endpoint/expansions/types) are response-side only." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref6": { "type": "array", "items": { "enum": [ "fresh", "cooling", "stale", "cold" ], "type": "string" }, "example": [ "fresh", "cooling" ], "description": "Filter by evidence recency: fresh (~30d), cooling (~30-60d), stale (~60-90d), cold (>90d)." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref7": { "type": "array", "items": { "enum": [ "entering_new_market", "expanding_within_presence", "established_only" ], "type": "string" }, "example": [ "entering_new_market" ], "description": "Filter by market-entry scope." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref8": { "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": [ "EXEC", "HIRE" ], "description": "Filter to specific signal types. See the Signal Types catalog in the knowledge base for definitions and tiers (`DNS` and `INFRA` are Premier-tier signals)." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref9": { "type": "array", "items": { "enum": [ "low", "medium", "high", "very_high" ], "type": "string" }, "example": [ "high" ], "description": "Filter by evidence-confidence bucket: `low`, `medium`, or `high`. Note this is distinct from the per-signal `signal_strength_slug` returned on signal records (which ranges `low` to `very_high`); any other value here matches nothing." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref10": { "type": "boolean", "example": false, "description": "When true, return only contraction-flagged expansions (companies scaling back)." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref11": { "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_2073acb14089837f_ref12": { "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_2073acb14089837f_ref13": { "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_2073acb14089837f_ref14": { "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_2073acb14089837f_ref15": { "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_2073acb14089837f_ref16": { "type": "array", "items": { "type": "integer" }, "example": [ 0, 100000 ], "description": "Minimum and maximum range of company revenue." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref17": { "type": "array", "items": { "type": "integer" }, "example": [ 2018, 2024 ], "description": "Years of company founded range. The maximum value founded is the current year." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref18": { "type": "array", "items": { "type": "string" }, "example": [ "ecommerce", "ai", "fintech" ], "description": "A list of keywords to filter companies by relevance, specialties, or descriptions." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref19": { "type": "array", "items": { "type": "string" }, "example": [ "stripe.com", "https://www.linkedin.com/company/airbnb", "b7d92a56-31f8-4c0b-ae43-19c8e5f24b70" ], "description": "Scope to specific companies by any mix of `domain_search_id`, company domain, or a company social media profile URL. Domains and URLs resolve to their best-ranked company." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref20": { "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_2073acb14089837f_ref21": { "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref22" } ], "description": "Geographic locations to exclude from job posting results." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref22": { "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_2073acb14089837f_ref23": { "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_2073acb14089837f_ref24": { "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_2073acb14089837f_ref25": { "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref26" } ], "description": "Target geographic locations for advertisements." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_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_2073acb14089837f_ref27": { "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref28" } ], "description": "Geographic locations to exclude from advertisement targeting." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_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_2073acb14089837f_ref29": { "type": "array", "items": { "type": "string" }, "example": [ "asus" ], "description": "Keywords used to search within advertisement content or titles." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref30": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-25", "2025-12-25" ], "description": "Start date range for advertisement filtering." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref31": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-25", "2025-12-25" ], "description": "End date range for advertisement filtering." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref32": { "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_2073acb14089837f_ref33": { "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_2073acb14089837f_ref34": { "type": "integer", "example": 90, "description": "Optional. Size of the rolling window in days. Used when an explicit `transitioned_dates` range is not supplied; if both are omitted, a default window is used." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref35": { "type": "array", "items": { "type": "string" }, "example": [ "software", "financial services" ], "description": "Filter by industry name (free-text match)." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref36": { "type": "array", "items": { "type": "string" }, "example": [ "tobacco" ], "description": "Industries to exclude (free-text match)." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref37": { "type": "boolean", "example": true, "description": "API-key responses are lean by default. Set true to include the full `metadata` block (aggregates, top origins/destinations, top industries, timeline) and per-company model detail." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_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_2073acb14089837f_ref39": { "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "details" ], "properties": { "code": { "type": "integer", "example": 40801 }, "details": { "type": "object" }, "message": { "type": "string", "example": "Request timeout" } } } } }, "description": "Request timeout. The request could not finish in time. Narrow the request and try again." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_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_2073acb14089837f_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_ff4fe63154bb1dfe_ref0": { "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "Origin markets (ISO 3166-1 alpha-2). Where a company is expanding FROM — its home / HQ countries. Use alone to find companies growing out of these markets; combine with `tos` for a specific from→to corridor." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref1": { "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "Target markets (ISO 3166-1 alpha-2). Where a company is expanding TO. Use alone to find every company entering these markets; combine with `froms` for a specific from→to corridor." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref2": { "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "Origin markets to exclude (ISO 3166-1 alpha-2)." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref3": { "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "Target markets to exclude (ISO 3166-1 alpha-2)." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref4": { "type": "array", "items": { "enum": [ "exploring", "committing", "expanding", "scaling" ], "type": "string" }, "example": [ "committing", "expanding" ], "description": "Filter to one or more expansion stages. See the Expansion Signals knowledge base for stage definitions." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref5": { "type": "array", "items": { "enum": [ "advancing", "steady", "pulling_back" ], "type": "string" }, "example": [ "advancing", "steady" ], "description": "Trajectory to filter by. Only `advancing`, `steady` and `pulling_back` are accepted; the `directions` values in [Expansion Reference](/en/api-reference/endpoint/expansions/types) are response-side only." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref6": { "type": "array", "items": { "enum": [ "fresh", "cooling", "stale", "cold" ], "type": "string" }, "example": [ "fresh", "cooling" ], "description": "Filter by evidence recency: fresh (~30d), cooling (~30-60d), stale (~60-90d), cold (>90d)." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref7": { "type": "array", "items": { "enum": [ "entering_new_market", "expanding_within_presence", "established_only" ], "type": "string" }, "example": [ "entering_new_market" ], "description": "Filter by market-entry scope." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref8": { "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": [ "EXEC", "HIRE" ], "description": "Filter to specific signal types. See the Signal Types catalog in the knowledge base for definitions and tiers (`DNS` and `INFRA` are Premier-tier signals)." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref9": { "type": "array", "items": { "enum": [ "low", "medium", "high", "very_high" ], "type": "string" }, "example": [ "high" ], "description": "Filter by evidence-confidence bucket: `low`, `medium`, or `high`. Note this is distinct from the per-signal `signal_strength_slug` returned on signal records (which ranges `low` to `very_high`); any other value here matches nothing." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref10": { "type": "boolean", "example": false, "description": "When true, return only contraction-flagged expansions (companies scaling back)." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref11": { "type": "array", "items": { "type": "string" }, "example": [ "software", "financial services" ], "description": "Filter by industry name (free-text match)." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref12": { "type": "array", "items": { "type": "string" }, "example": [ "tobacco" ], "description": "Industries to exclude (free-text match)." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref13": { "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_ff4fe63154bb1dfe_ref14": { "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_ff4fe63154bb1dfe_ref15": { "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_ff4fe63154bb1dfe_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_ff4fe63154bb1dfe_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_ff4fe63154bb1dfe_ref18": { "type": "array", "items": { "type": "integer" }, "example": [ 0, 100000 ], "description": "Minimum and maximum range of company revenue." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_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_ff4fe63154bb1dfe_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_ff4fe63154bb1dfe_ref21": { "type": "array", "items": { "type": "string" }, "example": [ "stripe.com", "https://www.linkedin.com/company/airbnb", "b7d92a56-31f8-4c0b-ae43-19c8e5f24b70" ], "description": "Scope to specific companies by any mix of `domain_search_id`, company domain, or a company social media profile URL. Domains and URLs resolve to their best-ranked company." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref22": { "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_ff4fe63154bb1dfe_ref23": { "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref24" } ], "description": "Geographic locations to exclude from job posting results." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref24": { "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_ff4fe63154bb1dfe_ref25": { "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_ff4fe63154bb1dfe_ref26": { "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_ff4fe63154bb1dfe_ref27": { "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref28" } ], "description": "Target geographic locations for advertisements." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref28": { "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_ff4fe63154bb1dfe_ref29": { "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref30" } ], "description": "Geographic locations to exclude from advertisement targeting." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref30": { "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_ff4fe63154bb1dfe_ref31": { "type": "array", "items": { "type": "string" }, "example": [ "asus" ], "description": "Keywords used to search within advertisement content or titles." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref32": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-25", "2025-12-25" ], "description": "Start date range for advertisement filtering." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref33": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-25", "2025-12-25" ], "description": "End date range for advertisement filtering." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref34": { "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_ff4fe63154bb1dfe_ref35": { "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_ff4fe63154bb1dfe_ref36": { "type": "integer", "example": 90, "description": "Optional. Size of the rolling window in days. Used when an explicit `transitioned_dates` range is not supplied; if both are omitted, a default window is used." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref37": { "enum": [ "recent", "expansion_score", "signal_count", "company_ranking" ], "type": "string", "example": "expansion_score", "description": "Result ordering. Omit for the default relevance order: corroborated pairs first (2+ distinct signal types), then repeated-evidence pairs (3+ signals), then the rest — most recently transitioned first within each tier. `recent` — pure recency (most recently transitioned first). `expansion_score` — highest expansion score first. `signal_count` — most signals in the pair first. `company_ranking` — Pubrio's overall company ranking (lower is more prominent), ascending." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref38": { "type": "boolean", "example": true, "description": "API-key responses are lean by default. Set true to include the full `metadata` block (aggregates, top origins/destinations, top industries, timeline) and per-company model detail." }, "sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref39": { "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_ff4fe63154bb1dfe_ref40": { "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_ff4fe63154bb1dfe_ref41": { "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_ff4fe63154bb1dfe_ref42": { "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_ff4fe63154bb1dfe_ref43": { "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_ff4fe63154bb1dfe_ref44": { "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_aa4b46e69c216dc9_ref0": { "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": [ "EXEC", "HIRE" ], "description": "Filter to specific signal types. See the Signal Types catalog in the knowledge base for definitions and tiers (`DNS` and `INFRA` are Premier-tier signals)." }, "sds_Bczf0ngsC6bcl6q0Du2IG_aa4b46e69c216dc9_ref1": { "type": "array", "items": { "enum": [ "marketing_pullback", "domain_dropped", "entity_dissolution", "exhibiting_booth", "speaking_breakout", "speaking_keynote", "sponsorship", "key_departure", "country_manager", "engineering", "freelancer", "hiring_freeze", "job_posting_removal", "legal_compliance", "local_employee", "operations", "regional_vp", "remote_sales_bd", "supply_chain", "ip_abandoned", "office_closure", "partnership_terminated", "product_withdrawal", "regulatory_surrender", "layoffs", "content_decay" ], "type": "string" }, "example": [ "country_manager", "local_employee" ] }, "sds_Bczf0ngsC6bcl6q0Du2IG_aa4b46e69c216dc9_ref2": { "type": "array", "items": { "enum": [ "low", "medium", "high", "very_high" ], "type": "string" }, "example": [ "high" ], "description": "Filter by evidence-confidence bucket: `low`, `medium`, or `high`. Note this is distinct from the per-signal `signal_strength_slug` returned on signal records (which ranges `low` to `very_high`); any other value here matches nothing." }, "sds_Bczf0ngsC6bcl6q0Du2IG_aa4b46e69c216dc9_ref3": { "type": "array", "items": { "type": "string" }, "example": [ "2026-06-01", "2026-06-30" ], "description": "Date range of the signal event date. The maximum value is the current day." }, "sds_Bczf0ngsC6bcl6q0Du2IG_aa4b46e69c216dc9_ref4": { "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_aa4b46e69c216dc9_ref5": { "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_aa4b46e69c216dc9_ref6": { "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_aa4b46e69c216dc9_ref7": { "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_aa4b46e69c216dc9_ref8": { "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_2b3e9520e29446af_ref0": { "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_2b3e9520e29446af_ref1": { "type": "object", "nullable": true, "description": "Response info depends on specific endpoint." }, "sds_Bczf0ngsC6bcl6q0Du2IG_2b3e9520e29446af_ref2": { "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_2b3e9520e29446af_ref3": { "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_2b3e9520e29446af_ref4": { "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_b9972eed7b9e3e47_ref0": { "type": "string", "format": "uuid", "description": "A unique identifier for the people search operation." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b9972eed7b9e3e47_ref1": { "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_b9972eed7b9e3e47_ref2": { "type": "object", "nullable": true, "description": "Response info depends on specific endpoint." }, "sds_Bczf0ngsC6bcl6q0Du2IG_b9972eed7b9e3e47_ref3": { "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_b9972eed7b9e3e47_ref4": { "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_b9972eed7b9e3e47_ref5": { "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." }, "sds_Bczf0ngsC6bcl6q0Du2IG_5b660ffce92faba2_ref0": { "type": "string", "example": "pubrio", "description": "A string of words over which we want to filter the results." }, "sds_Bczf0ngsC6bcl6q0Du2IG_5b660ffce92faba2_ref1": { "type": "string", "example": "king", "description": "Filter search results to include a specific people name." }, "sds_Bczf0ngsC6bcl6q0Du2IG_5b660ffce92faba2_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_5b660ffce92faba2_ref3": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A list of unique identifiers (people_search_id) used for people search operations." }, "sds_Bczf0ngsC6bcl6q0Du2IG_5b660ffce92faba2_ref4": { "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_5b660ffce92faba2_ref5": { "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_5b660ffce92faba2_ref6": { "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_5b660ffce92faba2_ref7": { "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_5b660ffce92faba2_ref8": { "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_5b660ffce92faba2_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_5b660ffce92faba2_ref10": { "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_5b660ffce92faba2_ref11": { "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_5b660ffce92faba2_ref12": { "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_5b660ffce92faba2_ref13": { "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_5b660ffce92faba2_ref14": { "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_5b660ffce92faba2_ref15": { "type": "boolean", "description": "When enabled, the filters listed above that support similarity searches can be filled with free text for specific IDs." }, "sds_Bczf0ngsC6bcl6q0Du2IG_5b660ffce92faba2_ref16": { "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_5b660ffce92faba2_ref17": { "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_5b660ffce92faba2_ref18": { "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_5b660ffce92faba2_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_5b660ffce92faba2_ref20": { "type": "object", "nullable": true, "description": "Response info depends on specific endpoint." }, "sds_Bczf0ngsC6bcl6q0Du2IG_5b660ffce92faba2_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_5b660ffce92faba2_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_5b660ffce92faba2_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_7e12527016858a4b_ref0": { "type": "string", "format": "uuid", "description": "A unique identifier for the people search operation." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7e12527016858a4b_ref1": { "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_7e12527016858a4b_ref2": { "type": "array", "items": { "enum": [ "email-work", "email-personal", "phone" ], "type": "string" }, "example": [ "email-work", "email-personal", "phone" ], "description": "Which contact details to redeem. Use exactly `email-work`, `email-personal` and/or `phone` — resolve the live list from the `people contact type` endpoint under the Filters tab.\n\n**Unrecognised values are not rejected.** A misspelling such as `work_email` returns HTTP 200 with `emails: null`, `phones: null` and `total_credit_cost: 0` — identical to a person genuinely having no contact data. If redemptions look universally empty, check these slugs first." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7e12527016858a4b_ref3": { "type": "object", "nullable": true, "description": "Response info depends on specific endpoint." }, "sds_Bczf0ngsC6bcl6q0Du2IG_7e12527016858a4b_ref4": { "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_7e12527016858a4b_ref5": { "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_7e12527016858a4b_ref6": { "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_bdf8a7fae97f9598_ref0": { "type": "string", "format": "email", "example": "person@example.com", "description": "Work or personal email address to look up. The system normalizes case and whitespace before matching." }, "sds_Bczf0ngsC6bcl6q0Du2IG_bdf8a7fae97f9598_ref1": { "type": "string", "example": "+15551234567", "description": "Phone number to look up. International (E.164) format is recommended." }, "sds_Bczf0ngsC6bcl6q0Du2IG_bdf8a7fae97f9598_ref2": { "type": "string", "example": "King", "description": "First name. With `last_name` and either `domain` or `company`, finds the person by name. A row with no `email` or `phone` is always searched this way." }, "sds_Bczf0ngsC6bcl6q0Du2IG_bdf8a7fae97f9598_ref3": { "type": "string", "example": "Lai", "description": "Last name. Used with `first_name` and either `domain` or `company` to find the person by name." }, "sds_Bczf0ngsC6bcl6q0Du2IG_bdf8a7fae97f9598_ref4": { "type": "string", "example": "pubrio.com", "description": "Company domain, such as `stripe.com`. A website such as `https://www.stripe.com/` is read as its domain. With `first_name` + `last_name`, finds the person by name at this company." }, "sds_Bczf0ngsC6bcl6q0Du2IG_bdf8a7fae97f9598_ref5": { "type": "string", "example": "Pubrio", "description": "Company name. With `first_name` + `last_name`, finds the person by name at this company when `domain` is not given." }, "sds_Bczf0ngsC6bcl6q0Du2IG_bdf8a7fae97f9598_ref6": { "type": "boolean", "default": false, "example": true, "description": "Only changes rows that have an `email` or `phone`. When `true`, a row whose email or phone finds nobody is then searched by name (`first_name`, `last_name`, and `domain` or `company`). A row with only a name and a company is always searched by name and does not need this." }, "sds_Bczf0ngsC6bcl6q0Du2IG_bdf8a7fae97f9598_ref7": { "type": "object", "nullable": true, "description": "Response info depends on specific endpoint." }, "sds_Bczf0ngsC6bcl6q0Du2IG_bdf8a7fae97f9598_ref8": { "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_bdf8a7fae97f9598_ref9": { "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_bdf8a7fae97f9598_ref10": { "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_82eb7463bd1e9efe_ref0": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "domain": { "type": "string" }, "company": { "type": "string" }, "last_name": { "type": "string" }, "first_name": { "type": "string" } } }, "example": [ { "email": "king.lai@pubrio.com" }, { "domain": "example.com", "last_name": "Smith", "first_name": "John" } ], "description": "Array of lookup specs. Each entry takes `email`, `phone`, or `first_name` + `last_name` + `domain`/`company`, the same as the single-lookup body. Capped by your subscription's bulk size limit. A request where no entry has any of these is refused with `400`." }, "sds_Bczf0ngsC6bcl6q0Du2IG_82eb7463bd1e9efe_ref1": { "type": "boolean", "default": false, "example": true, "description": "Only changes rows that have an `email` or `phone`. When `true`, a row whose email or phone finds nobody is then searched by name (`first_name`, `last_name`, and `domain` or `company`). A row with only a name and a company is always searched by name and does not need this." }, "sds_Bczf0ngsC6bcl6q0Du2IG_82eb7463bd1e9efe_ref2": { "type": "object", "nullable": true, "description": "Response info depends on specific endpoint." }, "sds_Bczf0ngsC6bcl6q0Du2IG_82eb7463bd1e9efe_ref3": { "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_82eb7463bd1e9efe_ref4": { "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_82eb7463bd1e9efe_ref5": { "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_af977ff435c1afd7_ref0": { "type": "string", "format": "uuid", "description": "A unique identifier for the company search operation." }, "sds_Bczf0ngsC6bcl6q0Du2IG_af977ff435c1afd7_ref1": { "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_af977ff435c1afd7_ref2": { "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_af977ff435c1afd7_ref3": { "type": "integer", "description": "A unique identifier for the domain search operation." }, "sds_Bczf0ngsC6bcl6q0Du2IG_af977ff435c1afd7_ref4": { "type": "object", "nullable": true, "description": "Response info depends on specific endpoint." }, "sds_Bczf0ngsC6bcl6q0Du2IG_af977ff435c1afd7_ref5": { "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_af977ff435c1afd7_ref6": { "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_af977ff435c1afd7_ref7": { "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/insights": { "post": { "summary": "Advertisement insights", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "postings": { "type": "array", "items": { "type": "object" }, "description": "Ad-volume rollup, grouped by reach tier, markets, channel and format. Keys are abbreviated to keep the payload small: `r` = reach tier slug (matches `reach_tiers[].slug`, `null` when the platform reports no reach), `m` = the ISO 3166-1 alpha-2 markets the ads were shown in, `ch` = source channel, `fo` = ad format, `n` = number of ads in this group." }, "creatives": { "type": "array", "items": { "type": "object" }, "description": "Recent ad creatives, image-led: creatives with a real image come first, then recent text or video ads so image-less advertisers still appear. `headline`, `body` and `cta` may each be `null`. Everything needed to render a creative gallery is here — no second call to Advertisement Search is required." }, "reach_tiers": { "type": "array", "items": { "type": "object" }, "description": "The reach-tier label catalog, ordered smallest to largest. This is a lookup table, not a distribution — it carries no counts. Join `postings[].r` to `slug` to get the human label, and read the per-tier volume from `postings[].n`. Ad reach is a text range at source, so tiers must never be summed into a single reach figure." } }, "description": "Insight bands for the requested company and window." } } }, "example": { "data": { "totals": { "total": 14, "active": 4, "markets": 46, "channels": 2, "launched": 4 }, "postings": [ { "m": [ "PE", "KR", "VE", "AR" ], "n": 1, "r": "10k_50k", "ch": "facebook", "fo": "video" } ], "creatives": [ { "cta": "Learn more", "body": "this video lives rent free in our minds", "format": "image", "headline": null, "has_video": false, "image_url": "https://buckets.pubrio.com/images/public/fHaGeJ1EMBzgz2o4TMwgsRptA17BMn8U.jpg", "advertiser": "YouTube", "destination_url": "https://www.instagram.com/youtube", "advertisement_url": "https://www.facebook.com/ads/library?id=1234567890", "advertisement_search_id": "29fbc4ec-d9f2-40dc-be00-c96856271f8c" } ], "reach_tiers": [ { "slug": "lt_1k", "label": "< 1K" }, { "slug": "1k_10k", "label": "1K–10K" }, { "slug": "10k_50k", "label": "10K–50K" }, { "slug": "50k_100k", "label": "50K–100K" }, { "slug": "100k_500k", "label": "100K–500K" } ], "window_days": 90, "placement_mix": [ { "key": "INSTAGRAM", "count": 10 } ], "weekly_series": [ { "count": 4, "week_start": "2026-05-25" } ] } } } }, "description": "Advertising insight bands for the company and window." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ba5395870fb570a1_ref3", "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_ba5395870fb570a1_ref4", "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_ba5395870fb570a1_ref5", "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": "Aggregated advertising-signal insights for a company over a date window: active and launched ad counts, channel and placement mix, creative samples, audience reach as a tier distribution, and a weekly time series. Reach is reported as a distribution across tiers, never as a single summed figure.", "operationId": "companies_advertisements_insights", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "domain_search_id" ], "properties": { "date_to": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ba5395870fb570a1_ref2", "type": "string", "example": "2026-03-31", "description": "End of the date window (ISO 8601, YYYY-MM-DD). Ignored without `date_from`. If the window is invalid or reversed, the default window is used; check `window_days` in the response." }, "filters": { "type": "object", "properties": { "reach_tiers": { "type": "array", "items": { "enum": [ "lt_1k", "1k_10k", "10k_50k", "50k_100k", "100k_500k", "500k_1m", "1m_plus" ], "type": "string" } }, "source_types": { "type": "array", "items": { "enum": [ "linkedin", "facebook", "google", "tiktok", "apple" ], "type": "string" } } } }, "end_date": { "type": "string" }, "companies": { "type": "array", "items": { "type": "string" } }, "date_from": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ba5395870fb570a1_ref1", "type": "string", "example": "2026-01-01", "description": "Start of the date window (ISO 8601, YYYY-MM-DD). Use together with `date_to` to scope results to a specific range; omit both to use the default window." }, "company_id": { "type": "string" }, "start_date": { "type": "string" }, "window_days": { "type": "integer" }, "domain_search_id": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ba5395870fb570a1_ref0", "type": "string", "description": "A unique identifier for the company search operation." }, "is_include_unlinked_companies": { "type": "boolean", "example": false, "description": "Include advertisements not yet linked to a verified company profile." } } } } }, "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/date_to/format", "/requestBody/content/application/json/schema/properties/date_from/format", "/requestBody/content/application/json/schema/properties/domain_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/required" ], "revisionId": "sdrn_YF3wEfhXeBDGcT4L2-sCE" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_ABUJfXq1JMkJ7W5CHK2Tv", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/date_to/format", "/requestBody/content/application/json/schema/properties/date_to/description", "/requestBody/content/application/json/schema/properties/date_from/format", "/requestBody/content/application/json/schema/properties/date_from/description", "/requestBody/content/application/json/schema/properties/domain_search_id/format" ], "revisionId": "sdrn_RY3e72kE4D1LdYKser1yn" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_GSpq9b1mCVzlyxet3sGTK", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_1rAnE6tkDcV8ucEOBvBz-" }, { "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": [], "pages": [], "sourceId": "sds_inV6EEJXoIsTyF9bb9ebH", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/date_to/format", "/requestBody/content/application/json/schema/properties/date_from/format", "/requestBody/content/application/json/schema/properties/domain_search_id/format" ], "revisionId": "sdrn_aD71gUcWqgSK_55vOztww" }, { "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" ], "revisionId": "sdrn_hQQ-C8uEx2j76eTz0TPqt" }, { "gaps": [ "Missing specific request/response schema details" ], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId", "/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" ], "revisionId": "sdrn_MjFi5p9pj2Upopb3AwYNv" } ], "x-zeroclick-services": [ "insights" ], "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 insights)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "insights", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/companies/advertisements/lookup": { "post": { "summary": "Look up company advertisements", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b34505b84f92c9b8_ref2", "type": "object", "nullable": true, "description": "Response info depends on specific endpoint." } } }, "example": { "data": { "cta": "Learn more", "title": "Thuraya-4 Satellite Solutions for Government", "poster": "Space42", "ended_at": "2026-03-02T00:00:00.000Z", "headline": "Thuraya-4 Satellite Solutions for Government", "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/qDf8TrjHJw9o8xFoQJv7vhnkLXNYKy1ThNVCWSHPmgHG5j7U4EroKtH4cYJcHCzTSh.jpg", "video_url": null, "created_at": "2026-03-03T01:01:31.134Z", "started_at": "2026-02-25T00:00:00.000Z", "description": "Thuraya-4 provides secure, always-on connectivity for vehicles, aircraft and command centers, ensuring mission continuity. \n\nLearn more about our satellite-powered government solutions.", "promoted_by": null, "source_type": "linkedin", "poster_title": "Promoted", "raw_link_url": null, "last_modified": "2026-03-03T13:01:22.805Z", "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": "a92643e8-9033-4029-aa65-ef929327cebb", "target_locations": [ "United Arab Emirates", "..." ], "total_impressions": "10k-20k", "publisher_platforms": null, "advertisement_format": "Single Image Ad", "impression_countries": [ { "country": "India", "impressions": "19%" }, "..." ], "target_country_codes": [ "MM", "..." ], "advertisement_search_id": "a92643e8-9033-4029-aa65-ef929327cebb" } } } }, "description": "Successful response containing company advertisement details." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b34505b84f92c9b8_ref3", "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_b34505b84f92c9b8_ref4", "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_b34505b84f92c9b8_ref5", "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": "Retrieve advertisement details for a specific company using an advertisement search ID. The response includes the resolved `destination_url`, the original `raw_link_url`, and, for Meta ads, `publisher_platforms`.", "operationId": "companies_lookup_advertisements", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "advertisement_search_id" ], "properties": { "companies": { "type": "array", "items": { "type": "string" } }, "company_id": { "type": "string" }, "advertisement_search_id": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b34505b84f92c9b8_ref0", "type": "string", "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." }, "is_include_unlinked_companies": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b34505b84f92c9b8_ref1", "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." } } } } }, "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/advertisement_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": [], "pages": [], "sourceId": "sds_2_zVRTPeLJMyYOBNe6hz9", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/advertisement_search_id/format" ], "revisionId": "sdrn_mEnAb35irWN-ghEVchmM5" }, { "gaps": [ "Missing specific schema for response body fields" ], "pages": [ 1 ], "sourceId": "sds_4QU1K-UtbB0JEFxtFT9j9", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_YF3wEfhXeBDGcT4L2-sCE" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_CqOUBhUxFNtmXnWyL9Tk6", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/advertisement_search_id/format" ], "revisionId": "sdrn_lXeFPkeWFt3g2DqsJupkP" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_GSpq9b1mCVzlyxet3sGTK", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_1rAnE6tkDcV8ucEOBvBz-" }, { "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/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": [ "lookup" ], "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 lookup)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "lookup", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/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/insights": { "post": { "summary": "Cloud footprint insights", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "flags": { "type": "object", "nullable": true, "properties": { "test_hosts": { "type": "array", "items": { "type": "object", "properties": { "host": { "type": "string", "description": "Host name." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Words in the host name that mark it as non-production, such as `dev` or `staging`." }, "is_poc": { "type": "boolean", "description": "`true` when the host name marks a proof of concept or pilot. These items are listed first." }, "places": { "type": "array", "items": { "type": "object", "properties": { "city": { "type": "string", "nullable": true, "description": "City; `null` when unknown." }, "provider": { "type": "string", "description": "Provider name." }, "region_name": { "type": "string", "nullable": true, "description": "Region name; `null` when unknown." }, "cloud_region": { "type": "string", "nullable": true, "description": "Cloud region code; `null` when unknown." }, "country_code": { "type": "string", "description": "ISO 3166-1 alpha-2 country code." } } }, "description": "Where the host is live now." }, "first_seen_at": { "type": "string", "format": "date-time", "description": "When the host was first seen." }, "primary_provider": { "type": "string", "description": "The company's primary provider." } } }, "nullable": true, "description": "New development, test, staging or proof-of-concept hosts on a cloud other than the company's primary one." }, "twin_hosts": { "type": "array", "items": { "type": "object", "properties": { "hosts": { "type": "array", "items": { "type": "object", "properties": { "city": { "type": "string", "nullable": true, "description": "City; `null` when unknown." }, "host": { "type": "string", "description": "Host name." }, "provider": { "type": "string", "description": "Provider name." }, "region_name": { "type": "string", "nullable": true, "description": "Region name; `null` when unknown." }, "cloud_region": { "type": "string", "nullable": true, "description": "Cloud region code; `null` when unknown." }, "country_code": { "type": "string", "description": "ISO 3166-1 alpha-2 country code." }, "first_seen_at": { "type": "string", "format": "date-time", "description": "When the host was first seen." } } }, "description": "One live host per cloud, up to 3." }, "service": { "type": "string", "description": "The service name the hosts share." }, "providers": { "type": "array", "items": { "type": "string" }, "description": "Clouds the service is live on, newest first." }, "new_provider": { "type": "string", "description": "The most recently added cloud." }, "first_seen_at": { "type": "string", "format": "date-time", "description": "When the service was first seen on any of these clouds." }, "new_provider_first_seen_at": { "type": "string", "format": "date-time", "description": "When the service was first seen on `new_provider`." } } }, "nullable": true, "description": "One service live on two or more clouds at once, with the newest cloud added inside the date window." }, "moved_hosts": { "type": "array", "items": { "type": "object", "properties": { "to": { "type": "object", "properties": { "city": { "type": "string", "nullable": true, "description": "City; `null` when unknown." }, "provider": { "type": "string", "description": "Provider name." }, "region_name": { "type": "string", "nullable": true, "description": "Region name; `null` when unknown." }, "cloud_region": { "type": "string", "nullable": true, "description": "Cloud region code; `null` when unknown." }, "country_code": { "type": "string", "description": "ISO 3166-1 alpha-2 country code." }, "last_seen_at": { "type": "string", "format": "date-time", "description": "When the host was last seen at this place." }, "first_seen_at": { "type": "string", "format": "date-time", "description": "When the host was first seen at this place." } }, "description": "Where the host answers now." }, "from": { "type": "object", "properties": { "city": { "type": "string", "nullable": true, "description": "City; `null` when unknown." }, "provider": { "type": "string", "description": "Provider name." }, "region_name": { "type": "string", "nullable": true, "description": "Region name; `null` when unknown." }, "cloud_region": { "type": "string", "nullable": true, "description": "Cloud region code; `null` when unknown." }, "country_code": { "type": "string", "description": "ISO 3166-1 alpha-2 country code." }, "last_seen_at": { "type": "string", "format": "date-time", "description": "When the host was last seen at this place." }, "first_seen_at": { "type": "string", "format": "date-time", "description": "When the host was first seen at this place." } }, "description": "Where the host answered before." }, "host": { "type": "string", "description": "Host name." }, "is_live_confirmed": { "type": "boolean", "description": "`true` when the host answers from `to` right now; `false` when it has left `from` but its new place could not be confirmed." }, "is_provider_change": { "type": "boolean", "description": "`true` when the provider changed; `false` when only the country or region changed." } } }, "nullable": true, "description": "Hosts that now answer from a different provider, country or region." }, "new_regions": { "type": "array", "items": { "type": "object", "properties": { "city": { "type": "string", "nullable": true, "description": "City; `null` when unknown." }, "hosts": { "type": "array", "items": { "type": "object", "properties": { "city": { "type": "string", "nullable": true, "description": "City; `null` when unknown." }, "host": { "type": "string", "description": "Host name." }, "provider": { "type": "string", "description": "Provider name." }, "region_name": { "type": "string", "nullable": true, "description": "Region name; `null` when unknown." }, "cloud_region": { "type": "string", "nullable": true, "description": "Cloud region code; `null` when unknown." }, "country_code": { "type": "string", "description": "ISO 3166-1 alpha-2 country code." }, "first_seen_at": { "type": "string", "format": "date-time", "description": "When the host was first seen." } } }, "description": "Up to 3 live hosts as proof." }, "provider": { "type": "string", "description": "Provider name." }, "host_count": { "type": "integer", "description": "Hosts the company has in this region now." }, "region_name": { "type": "string", "nullable": true, "description": "Region name; `null` when unknown." }, "cloud_region": { "type": "string", "nullable": true, "description": "Cloud region code; `null` when the flag is a new country on this provider." }, "country_code": { "type": "string", "description": "ISO 3166-1 alpha-2 country code." }, "first_seen_at": { "type": "string", "format": "date-time", "description": "When the company was first seen in this region." } } }, "nullable": true, "description": "New regions, or new countries, on a provider the company used before the date window." }, "is_spam_flood": { "type": "boolean", "description": "`true` when the company's host names are too noisy to flag; every list is then empty." }, "new_providers": { "type": "array", "items": { "type": "object", "properties": { "hosts": { "type": "array", "items": { "type": "object", "properties": { "city": { "type": "string", "nullable": true, "description": "City; `null` when unknown." }, "host": { "type": "string", "description": "Host name." }, "provider": { "type": "string", "description": "Provider name." }, "region_name": { "type": "string", "nullable": true, "description": "Region name; `null` when unknown." }, "cloud_region": { "type": "string", "nullable": true, "description": "Cloud region code; `null` when unknown." }, "country_code": { "type": "string", "description": "ISO 3166-1 alpha-2 country code." }, "first_seen_at": { "type": "string", "format": "date-time", "description": "When the host was first seen." } } }, "description": "Up to 3 live hosts as proof." }, "provider": { "type": "string", "description": "Provider name." }, "host_count": { "type": "integer", "description": "Hosts the company has on this provider now." }, "first_seen_at": { "type": "string", "format": "date-time", "description": "When the company was first seen on this provider." } } }, "nullable": true, "description": "Providers the company started using inside the date window." } }, "description": "Changes worth acting on. Each list holds up to 8 items, newest first. `null` when flags are not ready for this company yet; a single list is `null` when it could not be built on this call." }, "totals": { "type": "object", "properties": { "hosts": { "type": "integer", "description": "Hosts across every provider and country." }, "regions": { "type": "integer", "description": "Distinct cloud regions." }, "servers": { "type": "integer", "description": "Distinct IP addresses behind those hosts." }, "countries": { "type": "integer", "description": "Countries the company hosts in." }, "new_hosts": { "type": "integer", "description": "Hosts first seen inside the date window." }, "providers": { "type": "integer", "description": "Distinct providers." }, "cross_border_countries": { "type": "integer", "description": "Countries outside the company's home market." } }, "description": "Totals for the whole footprint. Only `new_hosts` follows the date window." }, "regions": { "type": "array", "items": { "type": "object", "properties": { "city": { "type": "string", "nullable": true, "description": "City; `null` when unknown." }, "hosts": { "type": "integer", "description": "Hosts in this region." }, "servers": { "type": "integer", "description": "Distinct IP addresses in this region." }, "provider": { "type": "string", "description": "Provider name." }, "region_code": { "type": "string", "description": "The provider's region code, such as `us-east-1`." }, "region_name": { "type": "string", "nullable": true, "description": "Region name; `null` when unknown." }, "country_code": { "type": "string", "description": "ISO 3166-1 alpha-2 country code." } } }, "description": "Top 8 cloud regions, sorted by servers, then hosts." }, "countries": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "ISO 3166-1 alpha-2 country code." }, "name": { "type": "string", "description": "Country name." }, "hosts": { "type": "integer", "description": "Hosts in this country." }, "servers": { "type": "integer", "description": "Distinct IP addresses in this country." }, "providers": { "type": "integer", "description": "Providers used in this country." }, "evidence_url": { "type": "string", "format": "uri", "nullable": true, "description": "Pubrio evidence page for this market; `null` for the home market." }, "is_cross_border": { "type": "boolean", "nullable": true, "description": "`true` when the country is outside the company's home market; `null` when the headquarters is unknown." } } }, "description": "Top 8 countries, sorted by servers, then hosts." }, "providers": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Provider name." }, "hosts": { "type": "integer", "description": "Hosts on this provider." }, "servers": { "type": "integer", "description": "Distinct IP addresses on this provider." }, "countries": { "type": "integer", "description": "Countries this provider is used in." } } }, "description": "Top 8 providers, sorted by servers, then hosts." }, "window_days": { "type": "integer", "description": "Days in the date window, counting both ends." }, "recent_hosts": { "type": "array", "items": { "type": "object", "properties": { "city": { "type": "string", "nullable": true, "description": "City; `null` when unknown." }, "provider": { "type": "string", "description": "Provider name." }, "cloud_region": { "type": "string", "nullable": true, "description": "Cloud region code; `null` when unknown." }, "country_code": { "type": "string", "description": "ISO 3166-1 alpha-2 country code." }, "last_seen_at": { "type": "string", "format": "date-time", "description": "When the host was last seen." }, "first_seen_at": { "type": "string", "format": "date-time", "description": "When the host was first seen." }, "is_cross_border": { "type": "boolean", "nullable": true, "description": "`true` when the country is outside the company's home market; `null` when the headquarters is unknown." } } }, "description": "Up to 12 hosts first seen inside the date window, newest first, one entry per host." }, "weekly_series": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "integer", "description": "Hosts first seen that week." }, "week_start": { "type": "string", "format": "date", "description": "First day of the week (YYYY-MM-DD)." } } }, "description": "Hosts first seen each week inside the date window. Weeks start on Monday in your workspace timezone." } }, "description": "Cloud footprint insights for the company." } } }, "example": { "data": { "flags": { "test_hosts": [], "twin_hosts": [], "moved_hosts": [ { "to": { "city": "Phoenix", "provider": "OCI", "region_name": "Phoenix", "cloud_region": "us-phoenix-1", "country_code": "US", "last_seen_at": "2026-09-14T09:41:19.500363", "first_seen_at": "2026-09-13T16:07:26.248556" }, "from": { "city": "Portland", "provider": "AWS", "region_name": "Oregon", "cloud_region": "us-west-2", "country_code": "US", "last_seen_at": "2026-07-22T12:19:41.499986", "first_seen_at": "2026-07-22T12:07:12.918787" }, "host": "onemindservices-new-jersey-prod.app.pcd.platform9.com", "is_live_confirmed": true, "is_provider_change": true }, { "to": { "city": "Toronto", "provider": "OCI", "region_name": null, "cloud_region": "ca-toronto-1", "country_code": "CA", "last_seen_at": "2026-09-13T04:58:57.154907", "first_seen_at": "2026-09-13T04:58:57.154907" }, "from": { "city": "Montreal", "provider": "AWS", "region_name": "Montreal", "cloud_region": "ca-central-1", "country_code": "CA", "last_seen_at": "2026-08-18T14:09:30.236743", "first_seen_at": "2026-08-18T14:09:30.236743" }, "host": "computer-talk-canary.app.pcd.platform9.com", "is_live_confirmed": true, "is_provider_change": true } ], "new_regions": [], "is_spam_flood": false, "new_providers": [] }, "totals": { "hosts": 1080, "regions": 11, "servers": 31, "countries": 6, "new_hosts": 1080, "providers": 3, "cross_border_countries": 5 }, "regions": [ { "city": "Portland", "hosts": 162, "servers": 8, "provider": "AWS", "region_code": "us-west-2", "region_name": "Oregon", "country_code": "US" }, { "city": "Phoenix", "hosts": 827, "servers": 6, "provider": "OCI", "region_code": "us-phoenix-1", "region_name": "Phoenix", "country_code": "US" }, { "city": "Montreal", "hosts": 14, "servers": 4, "provider": "AWS", "region_code": "ca-central-1", "region_name": "Montreal", "country_code": "CA" } ], "countries": [ { "key": "US", "name": "United States", "hosts": 993, "servers": 15, "providers": 3, "evidence_url": null, "is_cross_border": false }, { "key": "CA", "name": "Canada", "hosts": 23, "servers": 6, "providers": 2, "evidence_url": "https://www.pubrio.com/evidence/37471facc35d4ceef1036b32c645682d", "is_cross_border": true }, { "key": "DE", "name": "Germany", "hosts": 33, "servers": 3, "providers": 2, "evidence_url": "https://www.pubrio.com/evidence/93a7dba47d9a4ddd5776ec49f4444fa1", "is_cross_border": true } ], "providers": [ { "key": "AWS", "hosts": 231, "servers": 19, "countries": 5 }, { "key": "OCI", "hosts": 866, "servers": 11, "countries": 5 }, { "key": "GCP", "hosts": 4, "servers": 1, "countries": 1 } ], "window_days": 90, "recent_hosts": [ { "city": null, "provider": "OCI", "cloud_region": "us-phoenix-1", "country_code": "US", "last_seen_at": "2026-09-14T13:24:51.520776", "first_seen_at": "2026-09-14T13:24:51.520776", "is_cross_border": false }, { "city": null, "provider": "OCI", "cloud_region": "us-phoenix-1", "country_code": "US", "last_seen_at": "2026-09-14T04:41:13.649993", "first_seen_at": "2026-09-14T04:41:13.649993", "is_cross_border": false } ], "weekly_series": [ { "count": 58, "week_start": "2026-08-24" }, { "count": 86, "week_start": "2026-08-31" }, { "count": 233, "week_start": "2026-09-07" }, { "count": 9, "week_start": "2026-09-14" } ] } } } }, "description": "The company's cloud footprint and change flags." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ba5395870fb570a1_ref3", "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_ba5395870fb570a1_ref4", "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_ba5395870fb570a1_ref5", "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": "One company's cloud footprint in a single call: totals, top providers, countries and regions, weekly new hosts, the latest hosts, and flags for changes worth acting on. See the [Cloud Footprint Insights guide](/en/developer-guides/search/cloud-footprint-insights).", "operationId": "companies_cloud_footprint_insights", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "domain_search_id" ], "properties": { "date_to": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ba5395870fb570a1_ref2", "type": "string", "example": "2026-03-31", "description": "End of the date window (ISO 8601, YYYY-MM-DD). Ignored without `date_from`. If the window is invalid or reversed, the default window is used; check `window_days` in the response." }, "companies": { "type": "array", "items": { "type": "string" } }, "date_from": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ba5395870fb570a1_ref1", "type": "string", "example": "2026-01-01", "description": "Start of the date window (ISO 8601, YYYY-MM-DD). Use together with `date_to` to scope results to a specific range; omit both to use the default window." }, "company_id": { "type": "string" }, "domain_search_id": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ba5395870fb570a1_ref0", "type": "string", "description": "A unique identifier for the company search operation." } } } } }, "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/date_to/format", "/requestBody/content/application/json/schema/properties/date_from/format", "/requestBody/content/application/json/schema/properties/domain_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/required" ], "revisionId": "sdrn_YF3wEfhXeBDGcT4L2-sCE" }, { "gaps": [ "Full response schema details" ], "pages": [ 1 ], "sourceId": "sds_5KELJHy5vSYxbie9pGw-G", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_5WVjJI2L97MfQxH4KYS2N" }, { "gaps": [ "Response schema details for nested objects like totals, providers, and flags are described in text but not provided as a full JSON schema." ], "pages": [ 1 ], "sourceId": "sds_fBJBcOyJbglYnC8Al3wzc", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/properties/date_to/description", "/requestBody/content/application/json/schema/properties/date_from/description", "/requestBody/content/application/json/schema/properties/domain_search_id/description" ], "revisionId": "sdrn_ghJ0l1KhZOYza-FJxWJXl" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_GSpq9b1mCVzlyxet3sGTK", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_1rAnE6tkDcV8ucEOBvBz-" }, { "gaps": [], "pages": [], "sourceId": "sds_inV6EEJXoIsTyF9bb9ebH", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/date_to/format", "/requestBody/content/application/json/schema/properties/date_from/format", "/requestBody/content/application/json/schema/properties/domain_search_id/format" ], "revisionId": "sdrn_aD71gUcWqgSK_55vOztww" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_m5cwcNloYCmEz03qRftBq", "authority": "supplemental", "conflicts": [ "/description", "/requestBody/content/application/json/schema/properties/date_to/format", "/requestBody/content/application/json/schema/properties/date_to/description", "/requestBody/content/application/json/schema/properties/date_from/format", "/requestBody/content/application/json/schema/properties/date_from/description", "/requestBody/content/application/json/schema/properties/domain_search_id/format" ], "revisionId": "sdrn_ldr-ZouvFgByIxDXNfbac" }, { "gaps": [ "Missing specific request/response schema details" ], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId", "/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": [ "insights" ], "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 insights)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "insights", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/companies/cloud_footprints/lookup": { "post": { "summary": "Look up a company cloud footprint", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": { "hosts": [ { "city": "Chicago", "cloud_region": null, "last_seen_at": "2026-09-03T23:09:52.811787", "first_seen_at": "2026-09-03T23:09:52.811787" }, { "city": "Chicago", "cloud_region": null, "last_seen_at": "2026-07-28T16:23:24.323615", "first_seen_at": "2026-07-28T16:23:24.323615" } ], "cities": [ "Chicago" ], "regions": [], "provider": "Linode", "companies": { "domain": "bhopalservicecentre.com", "logo_url": "https://buckets.pubrio.com/company-logo/OTg2Mzk1MjVpbGo5c3NuajFiaG9wYWxzZXJ2aWNlY2VudHJlLmNvbQ==.jpg", "company_url": "http://www.bhopalservicecentre.com", "company_name": "bhopalservicecentre.com", "country_code": "IN", "linkedin_name": null, "domain_search_id": "01604baf-ab2d-4930-a867-2fced349f4f4" }, "city_count": 1, "host_count": 2, "country_code": "US", "country_name": "United States", "evidence_url": "https://www.pubrio.com/evidence/9c6ae876b7bf39f0a5beed66a7ad689e", "last_seen_at": "2026-09-03T23:09:52.811Z", "region_count": 0, "server_count": 3, "cloud_regions": null, "first_seen_at": "2026-07-28T16:23:24.323Z", "last_modified": "2026-09-04T09:30:52.103Z", "is_home_market": false, "domain_search_id": "01604baf-ab2d-4930-a867-2fced349f4f4", "cloud_footprint_id": "e82b2bd0-9971-41da-809b-ee4f2cf3305e", "shared_server_count": 3, "company_country_code": "IN" } } } }, "description": "One cloud footprint row with its regions, cities and host sample." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_a55d2d2ebc63ea64_ref1", "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_a55d2d2ebc63ea64_ref2", "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_a55d2d2ebc63ea64_ref3", "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": "Return a single cloud footprint row by its identifier, with its cloud regions, cities and a recent sample of the infrastructure behind it. See the [Cloud Footprint Search guide](/en/developer-guides/search/cloud-footprint-search).", "operationId": "companies_lookup_cloud_footprint", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "cloud_footprint_id" ], "properties": { "companies": { "type": "array", "items": { "type": "string" } }, "company_id": { "type": "string" }, "cloud_footprint_id": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_a55d2d2ebc63ea64_ref0", "type": "string", "example": "f28215e6-f6ed-40c2-ac9b-d8e70164c0be", "description": "Identifier of a single cloud footprint row." } } } } }, "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/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": [], "pages": [], "sourceId": "sds_2_zVRTPeLJMyYOBNe6hz9", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/cloud_footprint_id/format" ], "revisionId": "sdrn_mEnAb35irWN-ghEVchmM5" }, { "gaps": [ "Missing specific schema for response body fields" ], "pages": [ 1 ], "sourceId": "sds_4QU1K-UtbB0JEFxtFT9j9", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_YF3wEfhXeBDGcT4L2-sCE" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_DBU5uQW22WyA0kBe2CAWP", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/cloud_footprint_id/format" ], "revisionId": "sdrn_JLH64n4Sm70QqHC7tkCqA" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_GSpq9b1mCVzlyxet3sGTK", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_1rAnE6tkDcV8ucEOBvBz-" }, { "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/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": [ "lookup" ], "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 lookup)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "lookup", "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/insights": { "post": { "summary": "Job posting insights", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "Insight bands for the requested company and window." } } }, "example": { "data": { "totals": { "open": 3746, "functions": 18, "locations": 20, "new_in_window": 690 }, "postings": [ { "c": "CA", "f": [ "product_management" ], "s": 3, "w": "2026-08-10" }, { "c": "US", "f": null, "s": 0, "w": "2026-08-10" } ], "seniority": { "tiers": [ { "key": "junior", "rank": 1, "count": 55 }, { "key": "senior", "rank": 2, "count": 5 }, { "key": "manager", "rank": 3, "count": 58 }, { "key": "director", "rank": 4, "count": 12 }, { "key": "executive", "rank": 5, "count": 8 } ], "classified": 138, "leadership": 12 }, "window_days": 31, "weekly_series": [ { "count": 10, "week_start": "2026-07-27" }, { "count": 109, "week_start": "2026-08-03" } ], "breakdown_function": [ { "key": "marketing", "count": 31 }, { "key": "sales", "count": 19 } ], "breakdown_location": [ { "key": "US", "count": 402 }, { "key": "CA", "count": 59 } ], "breakdown_department": [ { "key": "master_engineering_technical", "count": 38 }, { "key": "master_marketing", "count": 35 } ] } } } }, "description": "Hiring insight bands for the company and window." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ba5395870fb570a1_ref3", "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_ba5395870fb570a1_ref4", "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_ba5395870fb570a1_ref5", "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": "Aggregated hiring-signal insights for a company over a date window: posting volume, seniority distribution, top functions/departments/locations, and a weekly time series.", "operationId": "companies_jobs_insights", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "domain_search_id" ], "properties": { "date_to": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ba5395870fb570a1_ref2", "type": "string", "example": "2026-03-31", "description": "End of the date window (ISO 8601, YYYY-MM-DD). Ignored without `date_from`. If the window is invalid or reversed, the default window is used; check `window_days` in the response." }, "companies": { "type": "array", "items": { "type": "string" } }, "date_from": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ba5395870fb570a1_ref1", "type": "string", "example": "2026-01-01", "description": "Start of the date window (ISO 8601, YYYY-MM-DD). Use together with `date_to` to scope results to a specific range; omit both to use the default window." }, "company_id": { "type": "string" }, "domain_search_id": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ba5395870fb570a1_ref0", "type": "string", "description": "A unique identifier for the company search operation." } } } } }, "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/date_to/format", "/requestBody/content/application/json/schema/properties/date_from/format", "/requestBody/content/application/json/schema/properties/domain_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/required" ], "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/required" ], "revisionId": "sdrn_1rAnE6tkDcV8ucEOBvBz-" }, { "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": [], "pages": [], "sourceId": "sds_inV6EEJXoIsTyF9bb9ebH", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/date_to/format", "/requestBody/content/application/json/schema/properties/date_from/format", "/requestBody/content/application/json/schema/properties/domain_search_id/format" ], "revisionId": "sdrn_aD71gUcWqgSK_55vOztww" }, { "gaps": [ "Missing specific request/response schema details" ], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId", "/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" ], "revisionId": "sdrn_MjFi5p9pj2Upopb3AwYNv" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_tsWM1bpk8oPCJdrVqIbfs", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/date_to/format", "/requestBody/content/application/json/schema/properties/date_to/description", "/requestBody/content/application/json/schema/properties/date_from/format", "/requestBody/content/application/json/schema/properties/date_from/description", "/requestBody/content/application/json/schema/properties/domain_search_id/format" ], "revisionId": "sdrn_PNm8hHoxNc9NlTw7OAe2L" } ], "x-zeroclick-services": [ "insights" ], "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 insights)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "insights", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/companies/jobs/lookup": { "post": { "summary": "Look up company job postings", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f7a13af0ec741c6a_ref1", "type": "object", "nullable": true, "description": "Response info depends on specific endpoint." } } }, "example": { "data": { "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" }, "location_id": 491, "country_code": "KR", "posting_date": "2025-05-31", "job_search_id": "371d0c44-4c56-4c9c-98e2-ef6dd986b848", "last_modified": "2025-05-31T20:41:27.894Z" } } } }, "description": "Successful response containing company job details." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f7a13af0ec741c6a_ref2", "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_f7a13af0ec741c6a_ref3", "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_f7a13af0ec741c6a_ref4", "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": "Retrieve job posting details for a specific company using a job search ID.", "operationId": "companies_lookup_jobs", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "job_search_id" ], "properties": { "companies": { "type": "array", "items": { "type": "string" } }, "company_id": { "type": "string" }, "job_search_id": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f7a13af0ec741c6a_ref0", "type": "string", "example": "371d0c44-4c56-4c9c-98e2-ef6dd986b848", "description": "A unique identifier for the company job search operation." } } } } }, "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/job_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": [], "pages": [], "sourceId": "sds_2_zVRTPeLJMyYOBNe6hz9", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/job_search_id/format" ], "revisionId": "sdrn_mEnAb35irWN-ghEVchmM5" }, { "gaps": [ "Missing specific schema for response body fields" ], "pages": [ 1 ], "sourceId": "sds_4QU1K-UtbB0JEFxtFT9j9", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "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/required" ], "revisionId": "sdrn_1rAnE6tkDcV8ucEOBvBz-" }, { "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/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": [], "pages": [ 1 ], "sourceId": "sds_u8f0RxXKjD6Q0DeTdlOXR", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/job_search_id/format" ], "revisionId": "sdrn_GiZY0C3-sq2EJjPcR3lig" } ], "x-zeroclick-services": [ "lookup" ], "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 lookup)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "lookup", "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/linkedin/lookup": { "post": { "summary": "Look up a company by LinkedIn URL", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_107cb130a8966711_ref1", "type": "object", "nullable": true, "description": "Response info depends on specific endpoint." } } }, "example": { "data": { "title": "Help increase the GDP of the internet.", "alumni": null, "domain": "stripe.com", "people": [ { "name": "Krishnan Rajagopalan", "logo_url": "https://media.licdn.com/dms/image/v2/C5603AQFZAI0yL2gFMg/profile-displayphoto-shrink_100_100/profile-displayphoto-shrink_100_100/0/1604036687597?e=2147483647&v=beta&t=4XvEQpAzyC6VkTwjEJoipu-RzjVZlghMKRJ9T-bq7gg", "linkedin_url": "https://www.linkedin.com/in/krishnanrajagopalan?trk=org-employees" }, "..." ], "industry": "Technology, Information And Internet", "logo_url": "https://media.licdn.com/dms/image/v2/D4E0BAQFqiwiSMcKk6A/company-logo_200_200/company-logo_200_200/0/1724937022726/stripe_logo?e=2147483647&v=beta&t=--CED0oRQUupcr1Q2MktzOErO8NMpjCjxa4-JiqrGzU", "image_url": "https://media.licdn.com/dms/image/v2/C561BAQEd_16iHeIr1Q/company-background_10000/company-background_10000/0/1594068230381/stripe_cover?e=2147483647&v=beta&t=o62bVF0Z15cf0OFikrsuge1xW-iQR4Td6cSOXrMip6I", "created_at": "2025-06-01T10:13:03.994Z", "company_url": "https://stripe.com/", "description": "Stripe builds programmable financial services. Millions of companies—from the world’s largest enterprises to the most ambitious startups—use Stripe to accept payments, grow their revenue, and accelerate new business opportunities. Headquartered in San Francisco and Dublin, the company aims to increase the GDP of the internet.", "company_name": "Stripe", "company_size": 11833, "company_type": "Privately Held", "country_code": "US", "founded_year": 2010, "headquarters": "South San Francisco, California", "linkedin_uid": "2135371", "linkedin_url": "https://www.linkedin.com/company/stripe", "country_codes": [ "US", "..." ], "follower_size": 1045523, "linkedin_name": "stripe", "unique_domain": "stripe.com", "company_address": "South San Francisco, California", "affiliated_pages": [ { "title": "Stripe Partner Ecosystem", "location": "South San Francisco, California", "subtitle": "Internet Publishing", "linkedin_url": "https://www.linkedin.com/showcase/stripe-partner-ecosystem/?trk=affiliated-pages" } ], "company_addresses": [ "515 N State St, Chicago, Illinois 60610, US", "..." ], "recent_activities": [ { "date": "2025-06-03T10:13:03.854Z", "text": "For businesses, sending payouts can be slow, costly, and error-prone. One of the hardest parts about sending money is accurately collecting recipient information like bank account details. Global Payouts allows you to send money to third parties with only their email address. Recipients can instantly authenticate their bank details, decreasing failed payouts by 88%: https://lnkd.in/gCfPBKPH .", "time": "5d", "title": "Stacey Wong", "images": [ "https://media.licdn.com/dms/image/sync/v2/D4D27AQG-wcPKYC6OSw/articleshare-shrink_800/B4DZcxj37wGcAM-/0/1748883180077?e=2147483647&v=beta&t=qf6nEEODJRERCfkaegnnDuc0zqIg7NOZX5SXzGsr9Pw" ], "repost": { "images": null, "videos": null, "repost_id": null, "repost_url": null, "repost_date": null, "repost_text": null, "repost_title": null, "tagged_users": null, "external_links": null, "repost_hangtags": null, "repost_followers": null, "tagged_companies": null }, "post_id": "7335388680838152194", "post_url": "https://www.linkedin.com/posts/stripe_activity-7335388680838152194-vzX3", "likes_count": 229, "tagged_people": null, "comments_count": 14, "tagged_companies": null }, "..." ], "similar_companies": [ { "industry": "Software Development", "location": "San Francisco, CA", "company_name": "Square", "linkedin_url": "https://www.linkedin.com/company/joinsquare?trk=similar-pages" }, "..." ], "alumni_information": null, "company_size_printed": "11,900+", "additional_information": "Additional jobs info: Stripe (2,886 open jobs). Analyst (694,057 open jobs). Engineer (555,845 open jobs). Manager (1,880,925 open jobs). Account Executive (71,457 open jobs). Associate (1,091,945 open jobs). Director (1,220,357 open jobs). Marketing Manager (106,879 open jobs). Scientist (48,969 open jobs). Project Manager (253,048 open jobs). Account Manager (121,519 open jobs). Developer (258,935 open jobs). Software Engineer (300,699 open jobs). Product Manager (199,941 open jobs). Intern (71,196 open jobs). Specialist (768,666 open jobs). Vice President (235,270 open jobs). Executive (690,514 open jobs). Senior Software Engineer (78,145 open jobs). Solutions Architect (100,488 open jobs)", "unformatted_description": "\n Stripe builds programmable financial services. Millions of companies—from the world’s largest enterprises to the most ambitious startups—use Stripe to accept payments, grow their revenue, and accelerate new business opportunities. Headquartered in San Francisco and Dublin, the company aims to increase the GDP of the internet.\n ", "unformatted_company_size": "5,001-10,000 employees", "company_address_directions": [ { "directions_url": "https://www.bing.com/maps?where=354+Oyster+Point+Blvd+South+San+Francisco+94080+California+US&trk=org-locations_url" }, "..." ], "unformatted_company_addresses": [ "515 N State St Chicago, Illinois 60610, US", "..." ] } } } }, "description": "Successful response containing real-time linkedin details." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_107cb130a8966711_ref2", "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_107cb130a8966711_ref3", "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_107cb130a8966711_ref4", "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": "Retrieve company details using a LinkedIn company page URL. Provides real-time data retrieval.", "operationId": "companies_lookup_linkedin", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "linkedin_url" ], "properties": { "companies": { "type": "array", "items": { "type": "string" } }, "linkedin_url": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_107cb130a8966711_ref0", "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/`" } } } } }, "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": [], "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" ], "revisionId": "sdrn_YF3wEfhXeBDGcT4L2-sCE" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_GSpq9b1mCVzlyxet3sGTK", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1rAnE6tkDcV8ucEOBvBz-" }, { "gaps": [], "pages": [], "sourceId": "sds_IPv6UWBYPyNKT9NMyTwea", "authority": "supplemental", "conflicts": [], "revisionId": "sdrn_a0YRW8YuTdXiXKjCUxebY" }, { "gaps": [ "The response schema for 'data' is generic in the OpenAPI; specific fields like linkedin_name, company_name, etc., are shown in the example but not explicitly defined in the schema." ], "pages": [ 1 ], "sourceId": "sds_s8ysI1XTJH14elgD8nV06", "authority": "supplemental", "conflicts": [], "revisionId": "sdrn_iYYOfLzmgXffScG_lq-_4" }, { "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/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": [ "linkedin" ], "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 linkedin)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "linkedin", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/companies/lookup": { "post": { "summary": "Look up a company by ID", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f4de8479e87e2b03_ref3", "type": "object", "nullable": true, "description": "Response info depends on specific endpoint." }, "metadata": { "type": "object", "description": "Request context: `is_enrichment_available` (whether realtime enrichment ran), the echoed `parameters` and `filters`, and a `profile` block with `credit`, `topup_credit` and `total_credit_cost`." } } }, "example": { "data": { "title": "Netflix - Watch TV Shows Online, Watch Movies Online", "x_url": null, "domain": "netflix.com", "emails": [ "..." ], "phones": [ "..." ], "contacts": [ "..." ], "industry": "Entertainment", "location": "United States", "logo_url": "https://buckets.pubrio.com/company-logo/NzMwNTQzMzkzaWxqOXNzbmoxbmV0ZmxpeC5jb21saW5rZWRpbl8zMzMxMjk0OQ==.jpg", "domain_id": 70635725, "domain_ids": [ 585935484, 730543393, 368242675, 70635725 ], "github_url": null, "company_url": "http://netflix.com", "description": "Netflix is one of the world's leading entertainment services with over 247 million paid memberships in over 190 countries enjoying TV series, films and games across a wide variety of genres and languages. Members can play, pause and resume watching as much as they want, anytime, anywhere, and can change their plans at any time.", "saved_lists": null, "specialties": [ "Entertainment", "Entertainment Providers", "Telecommunications", "Media Production" ], "twitter_url": "https://twitter.com/netflix", "youtube_url": null, "company_name": "Netflix", "company_size": 16000, "country_code": "US", "facebook_url": "http://facebook.com/netflixus", "founded_year": 1997, "linkedin_url": "http://www.linkedin.com/company/netflix", "instagram_url": "http://instagram.com/netflix", "crunchbase_url": null, "company_address": "100 Winchester Circle, Los Gatos, Ca, Us", "company_ranking": 232, "company_keywords": [ "consumer electronics", "games", "entertainment", "consumer internet", "hardware", "information technology", "internet", "revolutionizing the way people watch tv shows & movies" ], "domain_search_id": "575463e2-474d-4f0a-acc3-fdc2be51e07e", "company_addresses": [ "100 Winchester Circle Los Gatos, CA, US", "5808 W Sunset Blvd Los Angeles, CA 90028, US", "Alameda Xingu, 350 Barueri, SP 06455-030, BR", "245 W 17th St New York, 10011, US", "Stadhouderskade 55 Amsterdam, North Holland 1072 AB, NL", "9 Straits Vw Marina South, 01, SG", "Av. Paseo De La Reforma 483 Torre Reforma, Floor 37 Mexico City, Cuauhtémoc 06500, MX" ], "estimated_revenue": 38900000000, "linkedin_company_id": 33312949, "company_size_printed": "16,000", "publicly_traded_symbol": "NFLX", "publicly_traded_exchange": "nasdaq" } } } }, "description": "Successful response containing company details." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f4de8479e87e2b03_ref4", "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_f4de8479e87e2b03_ref5", "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_f4de8479e87e2b03_ref6", "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": "Retrieve detailed information about a specific company using their Pubrio search ID, domain, or LinkedIn URL.", "operationId": "companies_lookup", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "title": "Domain Search ID", "required": [ "domain_search_id" ] }, { "title": "Domain", "required": [ "domain" ] }, { "title": "LinkedIn URL", "required": [ "linkedin_url" ] } ], "properties": { "domain": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f4de8479e87e2b03_ref1", "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." }, "companies": { "type": "array", "items": { "type": "string" }, "description": "List of domains or LinkedIn URLs." }, "tw104_url": { "type": "string", "description": "104 (Taiwan) profile URL for the company." }, "company_id": { "type": "string" }, "tiktok_url": { "type": "string", "description": "TikTok profile URL for the company." }, "linkedin_url": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f4de8479e87e2b03_ref2", "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/`" }, "remember_url": { "type": "string", "description": "Remember profile URL for the company." }, "wantedly_url": { "type": "string", "description": "Wantedly profile URL for the company." }, "youtrust_url": { "type": "string", "description": "YOUTRUST profile URL for the company." }, "rocketpunch_url": { "type": "string", "description": "RocketPunch profile URL for the company." }, "domain_search_id": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f4de8479e87e2b03_ref0", "type": "string", "description": "A unique identifier for the company search operation." }, "is_enrichment_available": { "type": "boolean", "example": true, "description": "Run realtime enrichment when the stored record is incomplete. Consumes credits. The response echoes whether it ran in `metadata.is_enrichment_available`." } }, "description": "Provide at least one of the following: Domain Search ID (domain_search_id); Domain (domain); LinkedIn URL (linkedin_url)." } } }, "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/domain_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": [], "pages": [], "sourceId": "sds_2_zVRTPeLJMyYOBNe6hz9", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/domain_search_id/format" ], "revisionId": "sdrn_mEnAb35irWN-ghEVchmM5" }, { "gaps": [ "Missing specific schema for response body fields" ], "pages": [ 1 ], "sourceId": "sds_4QU1K-UtbB0JEFxtFT9j9", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_YF3wEfhXeBDGcT4L2-sCE" }, { "gaps": [ "The documentation includes an is_enrichment_available field in the request schema, but the extraction instructions explicitly forbid its inclusion." ], "pages": [ 1 ], "sourceId": "sds_LrGpRhi5-a5-RHjFMEhsh", "authority": "supplemental", "conflicts": [ "/responses/400/description", "/responses/429/description", "/responses/500/description", "/requestBody/content/application/json/schema/properties/domain_search_id/format" ], "revisionId": "sdrn__bR6EtgaNMMbyd-B4-j3A" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/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" ], "revisionId": "sdrn_MjFi5p9pj2Upopb3AwYNv" } ], "x-zeroclick-services": [ "lookup" ], "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 lookup)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "lookup", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/companies/lookup/enrich": { "post": { "summary": "Enrich a company record", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f4de8479e87e2b03_ref3", "type": "object", "nullable": true, "description": "Response info depends on specific endpoint." }, "jobs": { "type": "array", "items": { "type": "object" }, "description": "Recent job postings for the company, returned inline so you do not need a separate Job Search call." }, "news": { "type": "array", "items": { "type": "object" }, "description": "Recent news mentions for the company, returned inline so you do not need a separate News Search call." }, "metadata": { "type": "object", "description": "Request context — echoed `filters` and `parameters`, plus a `profile` block with `credit`, `topup_credit` and `total_credit_cost` when credit accounting is requested." }, "advertisements": { "type": "array", "items": { "type": "object" }, "description": "Recent advertisements for the company, returned inline so you do not need a separate Advertisement Search call." }, "similar_companies": { "type": "array", "items": { "type": "object" }, "description": "Companies similar to this one. Empty when no close match is found." } } }, "example": { "data": { "title": "Help increase the GDP of the internet.", "x_url": null, "domain": "stripe.com", "emails": [ "..." ], "phones": [ "..." ], "country": "United States", "domains": [ "stripe.com" ], "contacts": [ "..." ], "industry": "Technology, Information And Internet", "location": "United States", "logo_url": "https://buckets.pubrio.com/company-logo/MTA4NjI1MTNzdHJpcGUuY29tbGlua2VkaW5fcF9sb2dvMTU=.jpg", "domain_id": 10862513, "locations": [ "US" ], "parent_id": null, "sequences": null, "verticals": [ "24076059", "24096599", "69085143", "69107205" ], "categories": [ "1", "26", "28", "33", "37", "38", "39", "43", "56", "60", "64", "69", "71", "81", "116", "129", "147", "254", "979", "3014", "707847256" ], "domain_ids": [ 10862513, 3254042745, 2617941789, 953909397, 368243151 ], "github_url": null, "company_url": "https://stripe.com/", "description": "Stripe is a financial infrastructure platform for businesses. Millions of companies—from the world’s largest enterprises to the most ambitious startups—use Stripe to accept payments, grow their revenue, and accelerate new business opportunities. Headquartered in San Francisco and Dublin, the company aims to increase the GDP of the internet.", "saved_lists": null, "specialties": [ "Technology, Information And Internet", "Financial Services", "E-commerce", "Information Technology & Services" ], "twitter_url": "http://twitter.com/stripe", "youtube_url": null, "company_name": "Stripe", "company_size": 11300, "company_type": "Privately Held", "country_code": "US", "facebook_url": "https://facebook.com/stripehq", "founded_year": 2010, "linkedin_uid": "2135371", "linkedin_url": "https://www.linkedin.com/company/stripe", "instagram_url": null, "linkedin_name": "stripe", "crunchbase_url": null, "company_address": "South San Francisco, California", "company_ranking": 221, "company_keywords": [ "payments", "developer tools", "cloud infrastructure", "credit cards", "consumer internet", "enterprise software", "software", "internet", "information technology", "technology, information & internet", "global payments", "online payments", "payment links", "checkout solutions", "subscription billing", "invoicing", "fraud prevention", "identity verification", "financial automation", "business financing", "virtual cards", "embedded finance", "transaction monitoring", "data analytics", "payment methods" ], "domain_search_id": "5378845d-7726-4817-aba9-ced8c5f41dee", "company_addresses": [ "354 Oyster Point Blvd South San Francisco, California 94080, US", "1 Grand Canal Street Lower Dublin, County Dublin, IE", "920 5th Ave Seattle, Washington 98104, US", "211 Old Street London, England EC1V 9NR, GB", "10, Boulevard Haussmann Paris, Ile-de-France 75009, FR", "89 Neil Rd Central Business District, Singapore 088894, SG", "1-5-8 Jingumae Tokyo, Shibuya-ku 150-0001, JP", "515 N State St Chicago, Illinois 60610, US", "11 Park Pl New York, NY 10301, US", "Singel 542 Amsterdam, North Holland 1017, NL", "Avenida Paseo De La Reforma 296 Ciudad De Mexico, Colonia Juarez 06600, MX", "222 Exhibition St Melbourne, Victoria 3000, AU", "Avenida Paulista 1374 Paulínia, São Paulo 13140-000, BR", "Church Street Haridevpur, Shanthala Nagar, Ashok Nagar Bengaluru, Karnataka 560001, IN" ], "estimated_revenue": 14400000000, "linkedin_company_id": 1407685, "vertical_categories": [ "9", "16", "18" ], "company_size_printed": "11,300+", "is_company_url_active": true, "publicly_traded_symbol": null, "vertical_sub_categories": [ "74", "103", "120" ], "publicly_traded_exchange": null }, "jobs": [ { "title": "Program Lead, Stripe Startups", "job_id": "e4077f8d-2b3d-4a9b-935e-123faae6f9a2", "country": "Canada", "job_url": "https://ca.linkedin.com/jobs/view/program-lead-stripe-startups-at-stripe-4244851093?position=9&pageNum=0&refId=dSWk2H9vKbZkQFgUb0YAqA%3D%3D&trackingId=tU1BYodLertdWt%2F7NIn4Tw%3D%3D", "location": "Toronto, Ontario, Canada", "companies": { "domain": "stripe.com", "logo_url": "https://buckets.pubrio.com/company-logo/MTA4NjI1MTNzdHJpcGUuY29tbGlua2VkaW5fcF9sb2dvMTU=.jpg", "company_name": "Stripe", "country_code": "US", "linkedin_name": "stripe", "domain_search_id": "5378845d-7726-4817-aba9-ced8c5f41dee" }, "location_id": 395, "country_code": "CA", "posting_date": "2025-06-04", "job_search_id": "e4077f8d-2b3d-4a9b-935e-123faae6f9a2", "last_modified": "2025-06-05T08:04:00.294Z" }, "..." ], "news": [ { "url": "https://analyticsindiamag.com/ai-features/llm-companies-vs-saas-giants-whos-winning-in-ai-monetisation/", "title": "LLM companies vs SaaS giants: AI monetization race", "source": "analyticsindiamag.com", "domains": [ "openai.com", "microsoft.com", "anthropic.com", "perplexity.ai", "stripe.com", "github.com", "salesforce.com", "canva.com", "adobe.com", "atlassian.com", "zoom.us" ], "news_id": "032606ce-46b6-4bf5-9aa9-8ecc96f126bc", "summary": "LLM companies show rapid growth but struggle with profitability, while SaaS giants integrate AI cautiously into existing services, leveraging their large user base.", "category": "launches", "language": "en", "companies": [ { "domain": "atlassian.com", "logo_url": "https://buckets.pubrio.com/company-logo/MzA2MTI3NThhdGxhc3NpYW4uY29tbGlua2VkaW5fcF9sb2dvMTU=.jpg", "company_name": "Atlassian", "country_code": "AU", "linkedin_name": "atlassian", "domain_search_id": "1437c841-a4b8-48c1-9be3-3dafb68dfd41" }, { "domain": "anthropic.com", "logo_url": "https://buckets.pubrio.com/company-logo/NTU1MDU5MDdhbnRocm9waWMuY29tbGlua2VkaW5fcF9sb2dvMTU=.jpg", "company_name": "Anthropic", "country_code": "US", "linkedin_name": "anthropicresearch", "domain_search_id": "15dd54c6-12b4-494a-84f4-9fff676ac7e0" }, { "domain": "adobe.com", "logo_url": "https://buckets.pubrio.com/company-logo/MjMzNDM2OTQxYWRvYmUuY29tbGlua2VkaW5fcF9sb2dvMTU=.jpg", "company_name": "Adobe", "country_code": "US", "linkedin_name": "adobe", "domain_search_id": "1fda6cfb-dacd-40a9-bb77-21ebc81c79e2" }, { "domain": "salesforce.com", "logo_url": "https://buckets.pubrio.com/company-logo/MjY5OTUyODdzYWxlc2ZvcmNlLmNvbWxpbmtlZGluX3BfbG9nbzE1.jpg", "company_name": "Salesforce", "country_code": "US", "linkedin_name": "salesforce", "domain_search_id": "29437edb-9d9a-45a3-8f43-481cbfaab1bf" }, { "domain": "stripe.com", "logo_url": "https://buckets.pubrio.com/company-logo/MTA4NjI1MTNzdHJpcGUuY29tbGlua2VkaW5fcF9sb2dvMTU=.jpg", "company_name": "Stripe", "country_code": "US", "linkedin_name": "stripe", "domain_search_id": "5378845d-7726-4817-aba9-ced8c5f41dee" }, { "domain": "openai.com", "logo_url": "https://buckets.pubrio.com/company-logo/MzA2MTIzNTVvcGVuYWkuY29tbGlua2VkaW5fcF9sb2dvMTU=.jpg", "company_name": "Openai", "country_code": "US", "linkedin_name": "openai", "domain_search_id": "67c4696b-b7b0-46b5-b2af-9f434543661e" }, { "domain": "github.com", "logo_url": "https://buckets.pubrio.com/company-logo/MzY4MjQyNzQ4aWxqOXNzbmoxZ2l0aHViLmNvbWxpbmtlZGluXzE0MDY4NDg=.jpg", "company_name": "Github", "country_code": "US", "linkedin_name": "github", "domain_search_id": "838c52f2-ab18-4258-b37c-e00bc568f747" }, { "domain": "zoom.us", "logo_url": "https://buckets.pubrio.com/company-logo/MTU0MDk4MjAxMHpvb20udXNsaW5rZWRpbl9wX2xvZ28xNQ==.jpg", "company_name": "Zoom", "country_code": "US", "linkedin_name": "zoom", "domain_search_id": "a90c7f40-ed1a-4675-b348-f36cbcf94481" }, { "domain": "canva.com", "logo_url": "https://buckets.pubrio.com/company-logo/MzA2MTIyODdjYW52YS5jb21saW5rZWRpbl9wX2xvZ28xNQ==.jpg", "company_name": "Canva", "country_code": "AU", "linkedin_name": "canva", "domain_search_id": "b5405a6c-81a7-4f86-bd09-ebf728b667bf" }, { "domain": "microsoft.com", "logo_url": "https://buckets.pubrio.com/company-logo/MTQyMjQxMjk4bWljcm9zb2Z0LmNvbWxpbmtlZGluX3BfbG9nbzE1.jpg", "company_name": "Microsoft", "country_code": "US", "linkedin_name": "microsoft", "domain_search_id": "dd225537-283f-46bf-ba1c-cb0c6a1311bb" }, { "domain": "perplexity.ai", "logo_url": "https://buckets.pubrio.com/company-logo/MTU0MDk4MjEyNnBlcnBsZXhpdHkuYWlsaW5rZWRpbl9wX2xvZ28xNQ==.jpg", "company_name": "Perplexity", "country_code": "US", "linkedin_name": "perplexity-ai", "domain_search_id": "fe169c45-f426-4ec4-985e-c88b2d78d044" } ], "image_url": "https://analyticsindiamag.com/wp-content/uploads/2025/06/ai-monetisation-llm.jpg", "locations": [ "China" ], "published_at": "2025-06-04T07:03:49.000000Z", "last_modified": "2025-06-04T07:43:14.260Z", "news_galleries": [ { "name": "Technology", "slug": "technology", "news_gallery_id": "9536114f-231a-489c-8a8a-1cbf82a327a4" } ], "news_search_id": "15872966-7b73-4361-be8f-2415bf4c72d9", "news_category_name": "Launches" }, "..." ], "metadata": { "parameters": null, "is_enrichment_available": false }, "similar_companies": [ { "title": "We're building the Internet of Value.", "x_url": "https://x.com/ripple", "domain": "ripple.com", "emails": [ "..." ], "phones": [ "..." ], "country": "United States", "domains": [ "ripple.com" ], "contacts": [ "..." ], "industry": "Technology, Information And Internet", "location": "United States", "logo_url": "https://buckets.pubrio.com/company-logo/MzY4MjQzODc3cmlwcGxlLmNvbWxpbmtlZGluX3BfbG9nbzE1.jpg", "domain_id": 368243877, "locations": [ "US" ], "parent_id": null, "sequences": null, "verticals": [ "69086483", "24076059", "69085537", "69107205" ], "categories": null, "domain_ids": [ 368243877, 3252571626, 1758856012, 2617948464 ], "github_url": null, "company_url": "https://www.ripple.com/", "description": "Using proven crypto and blockchain technology honed over a decade, Ripple’s enterprise-grade solutions are faster, more transparent, and more cost-effective than traditional financial services. Our customers use these solutions to source crypto, facilitate instant payments, empower their treasury, engage new audiences, lower capital requirements, and drive new revenue. Founded in 2012, Ripple's vision is to enable a world where value moves as seamlessly as information flows today—an Internet of Value. Ripple is the only enterprise blockchain company today with products in commercial use. Ripple’s global payments network includes over 300 customers across 40+ countries and six continents.", "saved_lists": null, "specialties": [ "Technology", "Technology, Information And Internet", "Financial Services", "Blockchain" ], "twitter_url": "https://twitter.com/ripple", "youtube_url": null, "company_name": "Ripple", "company_size": 1400, "company_type": "Privately Held", "country_code": "US", "facebook_url": null, "founded_year": 2012, "linkedin_uid": "3249443", "linkedin_url": "https://www.linkedin.com/company/rippleofficial", "instagram_url": null, "linkedin_name": "rippleofficial", "crunchbase_url": null, "company_address": "San Francisco, CA", "company_ranking": 8133, "company_keywords": [ "crossborder payments", "financial technology", "cryptography", "distributed ledgers", "fintech", "finance", "blockchain", "payments", "cryptocurrency", "fin tech", "blockchains", "blockchain / cryptocurrency", "technology, information & internet", "digital asset custody", "blockchain technology", "real-time settlement", "liquidity management", "stablecoin issuance", "enterprise blockchain", "xrp ledger", "secure custody solutions", "digital asset management", "financial institutions", "tokenization" ], "domain_search_id": "eac9e802-d574-4f5f-b7d9-4daadbdcd630", "similarity_score": 0.6540610253955462, "company_addresses": [ "San Francisco, CA 94104, US" ], "estimated_revenue": 500000000, "linkedin_company_id": 1408892, "vertical_categories": [ "16", "18" ], "company_size_printed": "1,400+", "is_company_url_active": true, "publicly_traded_symbol": null, "vertical_sub_categories": [ "103", "120" ], "publicly_traded_exchange": null }, "..." ] } } }, "description": "Successful response containing company enrichment details." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f4de8479e87e2b03_ref4", "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_f4de8479e87e2b03_ref5", "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_f4de8479e87e2b03_ref6", "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": "Realtime company enrichment. Returns the company record plus its recent hiring, media, advertising and similar-company signals in one call.\n\n**The first call for a company can be slow.** When the record has to be enriched from scratch, expect tens of seconds — a measured cold call took 45 seconds. Once enriched, the same company returns in well under a second. Set your HTTP client timeout to at least 90 seconds: many clients default to 30 and will abort a cold call that would have succeeded. If you only ever need the stored record, call [Company Lookup](/en/api-reference/endpoint/companies/lookup) instead, which is always fast.", "operationId": "companies_enrich", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "title": "Domain Search ID", "required": [ "domain_search_id" ] }, { "title": "Domain", "required": [ "domain" ] }, { "title": "LinkedIn URL", "required": [ "linkedin_url" ] } ], "properties": { "domain": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f4de8479e87e2b03_ref1", "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." }, "companies": { "type": "array", "items": { "type": "string" } }, "company_id": { "type": "string" }, "linkedin_url": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f4de8479e87e2b03_ref2", "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/`" }, "domain_search_id": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_f4de8479e87e2b03_ref0", "type": "string", "description": "A unique identifier for the company search operation." } }, "description": "Provide at least one of the following: Domain Search ID (domain_search_id); Domain (domain); LinkedIn URL (linkedin_url)." } } }, "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/domain_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": [], "pages": [], "sourceId": "sds_4qoQ1QXNZRBcuOtdvGCcN", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/domain_search_id/format" ], "revisionId": "sdrn_1filp_ZxFxYlPmVWGldqE" }, { "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/required" ], "revisionId": "sdrn_YF3wEfhXeBDGcT4L2-sCE" }, { "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": [ "The response schema for 'data', 'jobs', 'news', 'advertisements', and 'similar_companies' items is not fully defined in the provided OpenAPI snippet." ], "pages": [ 1 ], "sourceId": "sds_NByNGLDh7IKYMAovWPDF4", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/domain_search_id/format" ], "revisionId": "sdrn_ClUILGgic9UDUYANL2_d_" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/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": [ "enrichment" ], "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 enrichment)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "enrichment", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/companies/news/insights": { "post": { "summary": "News insights", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "totals": { "type": "object", "description": "Headline counts for the window. `mentions` is the number of articles, `topics` and `sources` are counts of *distinct* categories and publishers (integers, not lists), and `top_source` is the publisher domain with the most mentions. The per-topic and per-market lists are `category_breakdown` and `market_breakdown`." } }, "description": "Insight bands for the requested company and window." } } }, "example": { "data": { "totals": { "topics": 27, "sources": 140, "mentions": 1785, "top_source": "shazoo.ru" }, "window_days": 90, "weekly_series": [ { "count": 31, "week_start": "2026-05-18" } ], "market_breakdown": [ { "key": "US", "count": 297 } ], "category_breakdown": [ { "key": "launches", "count": 681 } ] } } } }, "description": "News insight bands for the company and window." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ba5395870fb570a1_ref3", "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_ba5395870fb570a1_ref4", "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_ba5395870fb570a1_ref5", "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": "Aggregated news-signal insights for a company over a date window: mention volume, top topics and sources, category and market breakdowns, and a weekly time series.", "operationId": "companies_news_insights", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "domain_search_id" ], "properties": { "date_to": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ba5395870fb570a1_ref2", "type": "string", "example": "2026-03-31", "description": "End of the date window (ISO 8601, YYYY-MM-DD). Ignored without `date_from`. If the window is invalid or reversed, the default window is used; check `window_days` in the response." }, "companies": { "type": "array", "items": { "type": "string" } }, "date_from": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ba5395870fb570a1_ref1", "type": "string", "example": "2026-01-01", "description": "Start of the date window (ISO 8601, YYYY-MM-DD). Use together with `date_to` to scope results to a specific range; omit both to use the default window." }, "company_id": { "type": "string" }, "domain_search_id": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ba5395870fb570a1_ref0", "type": "string", "description": "A unique identifier for the company search operation." } } } } }, "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/date_to/format", "/requestBody/content/application/json/schema/properties/date_from/format", "/requestBody/content/application/json/schema/properties/domain_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/required" ], "revisionId": "sdrn_YF3wEfhXeBDGcT4L2-sCE" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_f6JuR0XJ7b---v9n-qgRd", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/date_to/format", "/requestBody/content/application/json/schema/properties/date_from/format", "/requestBody/content/application/json/schema/properties/domain_search_id/format" ], "revisionId": "sdrn_O7GYYEZBhV1VFKmVQ262F" }, { "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": [], "pages": [], "sourceId": "sds_inV6EEJXoIsTyF9bb9ebH", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/date_to/format", "/requestBody/content/application/json/schema/properties/date_from/format", "/requestBody/content/application/json/schema/properties/domain_search_id/format" ], "revisionId": "sdrn_aD71gUcWqgSK_55vOztww" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/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" ], "revisionId": "sdrn_MjFi5p9pj2Upopb3AwYNv" } ], "x-zeroclick-services": [ "insights" ], "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 insights)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "insights", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/companies/news/lookup": { "post": { "summary": "Look up company news", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4f25288a46df2e2e_ref1", "type": "object", "nullable": true, "description": "Response info depends on specific endpoint." } } }, "example": { "data": { "url": "http://enold.prnasia.com/p/asia-story-125304015-0.shtml", "title": "Digital China's AI-driven transformation showcased at INSEAD", "amount": null, "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", "keywords": [ "AI", "Digital China", "INSEAD", "manajemen perusahaan", "transformasi digital", "studi kasus", "Guo Wei", "proses bisnis", "komputasi awan", "integrasi data" ], "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" } ], "headcount": null, "image_url": null, "job_title": "Chairman", "locations": [ "Singapore", "China" ], "published_at": "2025-06-01T08:00:00.000Z", "country_codes": [ "CN", "SG" ], "last_modified": "2025-06-01T10:12:25.284Z", "financing_type": null, "job_title_tags": [ "executive", "leadership" ], "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", "title_original": "Digital China membahas manajemen perusahaan era AI di INSEAD", "news_gallery_ids": [ "7c8ec9cc-66c5-4153-82da-9c8f356c6c99" ], "summary_original": "Guo Wei, Chairman Digital China, memaparkan tentang manajemen perusahaan era AI di INSEAD 2025 Asia AI Conference, serta meluncurkan studi kasus tentang perjalanan transformasi AI Digital China.", "amount_normalized": null, "news_category_name": "Launches", "financing_type_tags": null, "company_country_codes": [ "CN", "FR" ], "financing_type_normalized": null } } } }, "description": "Successful response containing company news details." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4f25288a46df2e2e_ref2", "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_4f25288a46df2e2e_ref3", "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_4f25288a46df2e2e_ref4", "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": "Retrieve news article details for a specific company using a news search ID.", "operationId": "companies_lookup_news", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "news_search_id" ], "properties": { "companies": { "type": "array", "items": { "type": "string" } }, "news_search_id": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_4f25288a46df2e2e_ref0", "type": "string", "example": "4110b929-17cd-42aa-a159-906ead0c9b56", "description": "A unique identifier for the company news search operation." } } } } }, "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/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": [], "pages": [], "sourceId": "sds_2_zVRTPeLJMyYOBNe6hz9", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/news_search_id/format" ], "revisionId": "sdrn_mEnAb35irWN-ghEVchmM5" }, { "gaps": [ "Missing specific schema for response body fields" ], "pages": [ 1 ], "sourceId": "sds_4QU1K-UtbB0JEFxtFT9j9", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_YF3wEfhXeBDGcT4L2-sCE" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_FPWlqDb6_PoqCNZmVXy9z", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/news_search_id/format" ], "revisionId": "sdrn_urMPHHlvSlO7GG14ifWmi" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/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": [ "lookup" ], "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 lookup)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "lookup", "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 } ] } } }, "/companies/search/similar": { "post": { "summary": "Search for similar companies", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" }, "description": "The similar companies, each with a `similarity_score`. This endpoint returns a bare array — unlike the other search endpoints, there is no `pagination` wrapper inside `data`. Page with `page` and `per_page`." }, "metadata": { "type": "object", "description": "Request context. Carries the echoed `filters` and `parameters`, and a `profile` block with `credit`, `topup_credit` and `total_credit_cost` — the only per-call credit accounting the API returns." } } }, "example": { "data": [ { "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", "similarity_score": 0.87, "linkedin_company_id": 44005587, "company_size_printed": "1,500", "is_company_url_active": true }, "..." ] } } }, "description": "Successful response containing company search details." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_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_ac4d1a20cd443ff2_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_ac4d1a20cd443ff2_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": "Find companies similar to a reference company. Supply exactly one singular identifier (`domain_search_id`, `domain`, `linkedin_url` or another `*_url`). Each row carries a `similarity_score` between 0 and 1.", "operationId": "companies_search_similar", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "title": "domain_search_id", "required": [ "domain_search_id" ] }, { "title": "domain", "required": [ "domain" ] }, { "title": "linkedin_url", "required": [ "linkedin_url" ] }, { "title": "tiktok_url", "required": [ "tiktok_url" ] }, { "title": "wantedly_url", "required": [ "wantedly_url" ] }, { "title": "tw104_url", "required": [ "tw104_url" ] }, { "title": "rocketpunch_url", "required": [ "rocketpunch_url" ] }, { "title": "remember_url", "required": [ "remember_url" ] }, { "title": "youtrust_url", "required": [ "youtrust_url" ] } ], "properties": { "page": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref36", "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**." }, "domain": { "type": "string", "example": "stripe.com", "description": "The company's primary domain, for example `stripe.com`." }, "places": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref6", "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_ac4d1a20cd443ff2_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." }, "keywords": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref19", "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_ac4d1a20cd443ff2_ref35", "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_ac4d1a20cd443ff2_ref17", "type": "array", "items": { "type": "integer" }, "example": [ 0, 100000 ], "description": "Minimum and maximum range of company revenue." }, "companies": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_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_ac4d1a20cd443ff2_ref16", "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_ac4d1a20cd443ff2_ref4", "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." }, "tw104_url": { "type": "string", "description": "104 (Taiwan) profile URL for the company." }, "verticals": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref11", "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_ac4d1a20cd443ff2_ref14", "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\"]`." }, "company_id": { "type": "string" }, "job_titles": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref10", "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`." }, "tiktok_url": { "type": "string", "description": "TikTok profile URL for the company." }, "company_name": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_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." }, "linkedin_url": { "type": "string", "description": "LinkedIn company URL." }, "remember_url": { "type": "string", "description": "Remember profile URL for the company." }, "technologies": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref15", "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." }, "wantedly_url": { "type": "string", "description": "Wantedly profile URL for the company." }, "youtrust_url": { "type": "string", "description": "YOUTRUST profile URL for the company." }, "founded_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref18", "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_ac4d1a20cd443ff2_ref4", "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_ac4d1a20cd443ff2_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/`" }, "exclude_fields": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref32", "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_ac4d1a20cd443ff2_ref7", "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_ac4d1a20cd443ff2_ref37", "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_ac4d1a20cd443ff2_ref20", "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." }, "rocketpunch_url": { "type": "string", "description": "RocketPunch profile URL for the company." }, "domain_search_id": { "type": "string", "description": "Pubrio company identifier." }, "job_posted_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref9", "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_ac4d1a20cd443ff2_ref31", "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_ac4d1a20cd443ff2_ref5", "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_ac4d1a20cd443ff2_ref29", "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." }, "vertical_categories": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref12", "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\"]`." }, "news_published_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref21", "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." }, "job_exclude_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref8", "type": "array", "items": { "type": "string" }, "example": [ "CN", "US", "RU", "CA" ], "description": "Geographic locations to exclude from job posting results." }, "advertisement_end_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref28", "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-25", "2025-12-25" ], "description": "End date range for advertisement filtering." }, "vertical_sub_categories": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref13", "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_start_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref27", "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-25", "2025-12-25" ], "description": "Start date range for advertisement filtering." }, "advertisement_search_terms": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref22", "type": "array", "items": { "type": "string" }, "example": [ "asus" ], "description": "Keywords used to search within advertisement content or titles." }, "is_enable_similarity_search": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref30", "type": "boolean", "description": "When enabled, the filters listed above that support similarity searches can be filled with free text for specific IDs." }, "is_profile_metadata_available": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref34", "type": "boolean", "description": "Indicates whether profile metadata is available for the request." }, "advertisement_target_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref23", "type": "array", "items": { "type": "string" }, "example": [ "TW", "AE", "NO" ], "description": "Target geographic locations for advertisements." }, "is_parameter_metadata_available": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref33", "type": "boolean", "description": "Indicates whether parameter metadata is available for the request." }, "advertisement_exclude_target_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ac4d1a20cd443ff2_ref25", "type": "array", "items": { "type": "string" }, "example": [ "IS", "GB", "FR", "IE", "ES" ], "description": "Geographic locations to exclude from advertisement targeting." } }, "description": "Provide at least one of the following: domain_search_id (domain_search_id); domain (domain); linkedin_url (linkedin_url); tiktok_url (tiktok_url); wantedly_url (wantedly_url); tw104_url (tw104_url); rocketpunch_url (rocketpunch_url); remember_url (remember_url); youtrust_url (youtrust_url)." } } }, "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": [ "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/required", "/requestBody/content/application/json/schema/properties/per_page/maximum" ], "revisionId": "sdrn_YF3wEfhXeBDGcT4L2-sCE" }, { "gaps": [ "Full schema definitions for all filter parameters were omitted for brevity as per instructions to focus on the specific operation contract." ], "pages": [ 1 ], "sourceId": "sds_8mrf4aGS5ydFU9BziaujE", "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" ], "revisionId": "sdrn_nYIdUh3IQnFRKmM8KuIwR" }, { "gaps": [], "pages": [], "sourceId": "sds_h08SQfWpyH2nTeBVcHCm2", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/similarity_score/format" ], "revisionId": "sdrn_b8WRnQj-2PksT0RYh9jPN" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/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" ], "revisionId": "sdrn_MjFi5p9pj2Upopb3AwYNv" } ], "x-zeroclick-services": [ "lookalike" ], "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 lookalike)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "lookalike", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/expansions/companies/compare": { "post": { "summary": "Compare company expansions", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "companies": { "type": "array", "items": { "type": "object" }, "description": "One entry per company compared, in the order requested." } } }, "metadata": { "type": "object", "properties": { "peer_cap": { "type": "integer", "nullable": true, "description": "Maximum peers your plan may benchmark, or `null` when unlimited." }, "seeded_peers": { "type": "array", "items": { "type": "string" }, "description": "The peers selected for `seed_target`, best match first. Empty when `seed_target` is omitted." }, "peers_available": { "type": "integer", "description": "How many peers had signals in the window, before `peer_cap` was applied." } } } } }, "example": { "data": { "companies": [ { "firmographics": { "industry": "Software Development", "company_name": "Example Corp", "company_size": 350, "country_code": "SG", "founded_year": 2015, "estimated_revenue": 25000000, "publicly_traded_symbol": null }, "markets_summary": [ { "signals": [ { "event_date": "2026-06-20T14:00:00.000Z", "display_label": "Hired Regional VP for North America", "signal_type_slug": "EXEC", "signal_subtype_slug": "country_manager" } ], "stage_slug": "committing", "country_code": "US", "signal_count": 12, "expansion_score": 0.685, "first_signal_at": "2026-04-02T08:00:00.000Z", "latest_signal_at": "2026-06-28T10:15:22.000Z", "last_transition_at": "2026-06-25T14:30:00.000Z", "distinct_type_count": 4 } ], "domain_search_id": "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c", "home_country_code": "SG" } ] }, "metadata": { "seeded_peers": [ "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c" ] } } } }, "description": "Per-company comparison, keyed by domain_search_id." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_49333a7c6d50d1dc_ref5", "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_49333a7c6d50d1dc_ref6", "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_49333a7c6d50d1dc_ref7", "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": "Compare the expansion footprint of several companies side by side, with optional comparable peers for a target company.", "operationId": "expansions_company_compare", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "domains": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_49333a7c6d50d1dc_ref1", "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." }, "companies": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_49333a7c6d50d1dc_ref0", "type": "array", "items": { "type": "string" }, "example": [ "stripe.com", "https://www.linkedin.com/company/airbnb", "b7d92a56-31f8-4c0b-ae43-19c8e5f24b70" ], "description": "Scope to specific companies by any mix of `domain_search_id`, company domain, or a company social media profile URL. Domains and URLs resolve to their best-ranked company." }, "company_ids": { "type": "array", "items": { "type": "string" } }, "seed_target": { "type": "string", "example": "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c", "description": "The company in `companies` to treat as the benchmark target. The rest are ranked by signal volume and confidence, and the top peers are returned in `metadata.seeded_peers`. It selects from the list you send; it does not find new companies." }, "window_days": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_49333a7c6d50d1dc_ref3", "type": "integer", "example": 90, "description": "Optional. Size of the rolling window in days. Used when an explicit `transitioned_dates` range is not supplied; if both are omitted, a default window is used." }, "linkedin_urls": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_49333a7c6d50d1dc_ref2", "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/`" }, "transitioned_dates": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2026-04-01", "2026-06-29" ], "description": "ISO `[from, to]` date range for the signal/transition window. Takes precedence over `window_days` when both are supplied." }, "is_include_metadata": { "type": "boolean", "example": true, "description": "Return the full detail payload. API-key traffic is lean by default: the `model` block, the confidence figures (`stage.confidence` on Company Expansion Detail, `confidence_score` on `other_markets[]` and on Rankings `markers[]`) and the `established_min` / `share_of_detected` / `has_known_office` fields are all omitted unless this is `true`." }, "is_include_established": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_49333a7c6d50d1dc_ref4", "type": "boolean", "example": false, "description": "Include the `established` stage (long-standing operators with no active expansion signals). Defaults to false." } } } } }, "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": [], "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/required" ], "revisionId": "sdrn_YF3wEfhXeBDGcT4L2-sCE" }, { "gaps": [ "The schema references components not fully defined in the provided snippet (e.g., expansion_companies, domains, etc.), but these are inlined based on the provided OpenAPI structure." ], "pages": [ 1 ], "sourceId": "sds_CnuaJGcKnS6vI9NMkcwBo", "authority": "supplemental", "conflicts": [ "/responses/400/description", "/responses/429/description", "/responses/500/description", "/requestBody/content/application/json/schema/properties/domains/description", "/requestBody/content/application/json/schema/properties/companies/description", "/requestBody/content/application/json/schema/properties/seed_target/description", "/requestBody/content/application/json/schema/properties/window_days/description", "/requestBody/content/application/json/schema/properties/linkedin_urls/description", "/requestBody/content/application/json/schema/properties/transitioned_dates/description", "/requestBody/content/application/json/schema/properties/is_include_metadata/description", "/requestBody/content/application/json/schema/properties/is_include_established/description" ], "revisionId": "sdrn_DeseHZ1sk6Oc0huiqc3UA" }, { "gaps": [], "pages": [], "sourceId": "sds_k5xT0yiL8Ir6VR05kyEBF", "authority": "supplemental", "conflicts": [], "revisionId": "sdrn_-4yhPKLXO0w7ci0VnZLfS" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/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": [ "expansion" ], "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 expansion)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "expansion", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/expansions/companies/lookup": { "post": { "summary": "Company expansion detail", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "read": { "type": "object", "description": "Read status for this record." }, "stage": { "type": "object", "description": "Stage detail — score, scope, direction, freshness and signal counts." }, "presence": { "type": "object", "properties": { "level": { "enum": [ "established", "emerging", "none", "no_data" ], "type": "string", "description": "How settled the company's footprint in this market is: `established`, `emerging`, `none`, or `no_data`. This is the footprint, not the expansion stage." }, "matched_rule": { "type": "string", "nullable": true, "description": "Which signal established the level — for example `office`, `headcount` or `share`. `null` when no rule matched." }, "local_people_count": { "type": "integer", "description": "Employees located in the target market." } }, "description": "In-market footprint: how settled the company already is, independent of its expansion stage." }, "stage_name": { "type": "string", "description": "Display name of the stage." }, "stage_rank": { "type": "integer", "description": "Numeric rank of the stage, higher is further along." }, "country_code": { "type": "string", "description": "Target market, ISO 3166-1 alpha-2." }, "country_name": { "type": "string", "description": "Target market name." }, "domain_search_id": { "type": "string", "description": "Pubrio company identifier." }, "local_people_count": { "type": "integer", "description": "Employees located in the target market." }, "local_people_coverage": { "type": "boolean", "description": "Whether headcount coverage is sufficient to trust the count." } }, "description": "Result container." }, "company": { "type": "object", "description": "Company chrome — name, domain, logo and social URLs. First page only." }, "signals": { "type": "array", "items": { "type": "object" }, "description": "The paginated signal rows behind this company/market pair — the evidence list. Page size and totals come from `metadata.pagination`." }, "summary": { "type": "object", "description": "One-line stage summary for the pair. First page only." }, "metadata": { "type": "object" }, "presence": { "type": "array", "items": { "type": "object" }, "description": "Observed physical and digital presence for the company in this market. First page only." }, "timeline": { "type": "array", "items": { "type": "object" }, "description": "Stage-transition history for this company/market pair. First page only." }, "suppressions": { "type": "array", "items": { "type": "object" }, "description": "Signals suppressed from the stage calculation, with the reason for each. First page only." }, "other_markets": { "type": "array", "items": { "type": "object" }, "description": "The company's other active markets. Capped on limited plans — see `other_markets_locked_count`. First page only." }, "markets_summary": { "type": "array", "items": { "type": "object" }, "description": "Full ranked market set for this company. Returned only when `markets_summary_full` is `true`, on the first page." }, "evidence_breakdown": { "type": "object", "description": "Evidence roll-up by source type, computed from the returned (redacted) signals. First page only." }, "signal_type_totals": { "type": "object", "description": "All-time signal totals per signal type. First page only.", "additionalProperties": { "type": "integer" } }, "signal_group_totals": { "type": "object", "description": "Signal counts per type, bucketed by day in your timezone. First page only.", "additionalProperties": { "type": "integer" } }, "signal_weekly_totals": { "type": "array", "items": { "type": "object" }, "description": "Weekly signal counts for the heatmap, same window as `signal_type_recent_totals`. First page only." }, "signal_type_recent_totals": { "type": "object", "description": "Signal totals per type over the trailing 12 weeks. First page only.", "additionalProperties": { "type": "integer" } }, "other_markets_locked_count": { "type": "integer", "description": "How many additional markets your plan did not return in `other_markets`. `0` when nothing was withheld." } } }, "example": { "data": { "stage": { "slug": "expanding", "scope": "entering_new_market", "direction": "advancing", "freshness": "fresh", "signal_count": 5, "expansion_score": 0.721, "first_signal_at": "2026-05-30T09:00:00.000Z", "contraction_flag": null, "latest_signal_at": "2026-06-20T14:00:00.000Z", "mode_change_flag": false, "has_known_presence": false, "last_transition_at": "2026-06-15T09:30:00.000Z", "distinct_type_count": 3 }, "stage_name": "Expanding", "stage_rank": 3, "country_code": "US", "country_name": "United States", "domain_search_id": "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c" }, "signals": [ { "polarity": "expansion", "event_date": "2026-06-20T14:00:00.000Z", "source_type": "linkedin", "evidence_url": "https://linkedin.com/company/example-corp", "display_label": "Hired Regional VP for North America", "lead_time_days": 0, "signal_type_slug": "EXEC", "signal_subtype_slug": "country_manager", "source_published_at": "2026-06-20T14:00:00.000Z", "signal_strength_slug": "high" } ], "metadata": { "filters": { "country_code": "US", "domain_search_id": "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c" }, "pagination": { "page": 1, "per_page": 25, "is_timeout": false, "total_pages": 1, "total_entries": 12, "total_display_pages": 1 }, "country_code_auto_picked": false }, "presence": [ { "address": "123 Market St, San Francisco, CA", "known_since": "2026-03-15T00:00:00.000Z", "presence_type": "office", "presence_strength": "high" } ], "timeline": [ { "stage_slug": "expanding", "transition_kind": "advance", "transitioned_at": "2026-06-15T09:30:00.000Z" } ], "other_markets": [ { "stage_slug": "committing", "country_code": "CA", "signal_count": 8, "first_signal_at": "2026-04-10T00:00:00.000Z", "latest_signal_at": "2026-06-22T16:45:00.000Z", "last_transition_at": "2026-06-18T00:00:00.000Z" } ] } } }, "description": "Company-in-market detail." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_a22c41cd147c2829_ref8", "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_a22c41cd147c2829_ref9", "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_a22c41cd147c2829_ref10", "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": "In-depth expansion profile for a single company — current stage, signals, market presence, and stage-transition history — for one market or aggregated across all markets.", "operationId": "expansions_company_lookup", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "title": "Domain Search ID", "required": [ "domain_search_id" ] }, { "title": "Domain", "required": [ "domain" ] }, { "title": "LinkedIn URL", "required": [ "linkedin_url" ] } ], "properties": { "page": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_a22c41cd147c2829_ref6", "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": "We sell Employer-of-Record and local payroll; best-fit buyers hire in a new market before setting up a legal entity.", "description": "Plain-language description of what you sell, or the buyer profile you're evaluating this company against. Used only to ground the AI `summary` (see `is_explain_match`); unlike the company search, it is NOT interpreted into filters here." }, "domain": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_a22c41cd147c2829_ref2", "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." }, "per_page": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_a22c41cd147c2829_ref7", "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": { "type": "array", "items": { "type": "string" } }, "company_id": { "type": "string" }, "signal_type": { "enum": [ "AD", "AUDIENCE", "DNS", "ENTITY", "EVENT", "EVENT_PLUS", "EXEC", "HIRE", "INFRA", "IP", "NEWS", "OFFICE", "PARTNER", "PRODUCT", "REG", "SCALE", "TECH" ], "type": "string", "example": "EXEC", "description": "Filter the returned signals to a single type." }, "window_days": { "type": "integer", "default": 90, "example": 90, "description": "Optional. Rolling window (in days) that bounds the AI `summary` feed. Defaults to **90** when neither this nor `transitioned_dates` is supplied. Does not affect the paginated `signals` list (full history)." }, "country_code": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_a22c41cd147c2829_ref0", "type": "string", "example": "US", "description": "Target market as an ISO 3166-1 alpha-2 (cca2) country code. Omit to auto-pick the company's single most active market; set `is_all_markets` for a cross-market view of every market." }, "linkedin_url": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_a22c41cd147c2829_ref3", "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/`" }, "summary_only": { "type": "boolean", "example": true, "description": "Return the stage summary block (`data`, `company`, `markets_summary`, `signal_weekly_totals`, `recent_signals`, `expansion_score`, `summary`) and skip the paginated signal list and its aggregates." }, "is_all_markets": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_a22c41cd147c2829_ref1", "type": "boolean", "example": false, "description": "Return the company's entire expansion footprint across ALL markets in one call, rather than a single market. When `true`, `country_code` is ignored, the home market is excluded from the signal aggregates when it can be identified, `data` becomes a company-level rollup (dominant stage, total signals, date span, top expansion score), and `markets_summary` lists every market. Defaults to false." }, "domain_search_id": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_a22c41cd147c2829_ref4", "type": "string", "description": "A unique identifier for the company search operation." }, "is_explain_match": { "type": "boolean", "example": true, "description": "When true and a `query` is supplied, `summary` returns a single AI summary of this company's expansion activity in the current scope (the selected market, or all foreign markets when `is_all_markets` is true), read against your `query` and grounded in the company's real signals with `[n]` citations." }, "transitioned_dates": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2026-04-01", "2026-06-29" ], "description": "ISO `[from, to]` date range for the signal/transition window. Takes precedence over `window_days` when both are supplied." }, "is_include_metadata": { "type": "boolean", "example": true, "description": "Return the full detail payload. API-key traffic is lean by default: the `model` block, the confidence figures (`stage.confidence` on Company Expansion Detail, `confidence_score` on `other_markets[]` and on Rankings `markers[]`) and the `established_min` / `share_of_detected` / `has_known_office` fields are all omitted unless this is `true`." }, "markets_summary_full": { "type": "boolean", "example": true, "description": "Include the full ranked market set as `markets_summary` alongside the capped `other_markets` list." }, "is_include_established": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_a22c41cd147c2829_ref5", "type": "boolean", "example": false, "description": "Include the `established` stage (long-standing operators with no active expansion signals). Defaults to false." } }, "description": "Provide at least one of the following: Domain Search ID (domain_search_id); Domain (domain); LinkedIn URL (linkedin_url)." } } }, "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": [ "/responses/200/content/application/json/schema/properties/data/properties/presence/properties/level/description", "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/signal_type/description", "/requestBody/content/application/json/schema/properties/domain_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": [], "pages": [ 1 ], "sourceId": "sds_11Pa-_UIF7gDIYPj-hCss", "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/window_days/description", "/requestBody/content/application/json/schema/properties/summary_only/description", "/requestBody/content/application/json/schema/properties/domain_search_id/format", "/requestBody/content/application/json/schema/properties/is_include_metadata/description" ], "revisionId": "sdrn_xhPVCRTxG9aYakoXCNkvT" }, { "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/required" ], "revisionId": "sdrn_YF3wEfhXeBDGcT4L2-sCE" }, { "gaps": [], "pages": [], "sourceId": "sds_k5xT0yiL8Ir6VR05kyEBF", "authority": "supplemental", "conflicts": [ "/responses/200/content/application/json/schema/properties/data/properties/presence/properties/level/description", "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/signal_type/description", "/requestBody/content/application/json/schema/properties/domain_search_id/format" ], "revisionId": "sdrn_-4yhPKLXO0w7ci0VnZLfS" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/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": [], "pages": [ 1 ], "sourceId": "sds_WofXWScXBS03A0AmlffYg", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_b95LqjeM1YjkAqHXnFpvm" } ], "x-zeroclick-services": [ "expansion" ], "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 expansion)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "expansion", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/expansions/companies/pulse_events": { "post": { "summary": "Company Signal Events", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "events": { "type": "array", "items": { "type": "object" }, "description": "Signal events for this company, newest first." }, "summary": { "type": "object", "nullable": true, "description": "Optional roll-up of the events on this page; `null` when not computed." }, "pagination": { "type": "object", "description": "Page, per-page, total entries and total pages." } }, "description": "Result container." }, "metadata": { "type": "object" } } }, "example": { "data": { "events": [ { "polarity": "expansion", "event_date": "2026-06-20T14:00:00.000Z", "stage_slug": "expanding", "source_type": "linkedin", "country_code": "US", "evidence_url": "https://linkedin.com/company/example-corp", "display_label": "Hired Country Manager", "signal_type_slug": "EXEC", "signal_subtype_slug": "country_manager" } ], "summary": { "text": "Example Corp is hiring across Tokyo[1] and just added a Japan Country Manager[2], yet has no legal entity on file — it is staffing the market before incorporating, which is exactly your window.", "citations": [ { "n": 1, "url": null, "date": "2026-06", "type": "HIRE", "label": "Tokyo software & field-ops roles", "country": "JP" }, { "n": 2, "url": "https://linkedin.com/in/example", "date": "2026-06", "type": "EXEC", "label": "Country Manager, Japan", "country": "JP" } ] }, "pagination": { "page": 1, "per_page": 25, "is_timeout": false, "total_pages": 2, "total_entries": 42, "total_display_pages": 2 } }, "metadata": { "filters": { "domain_search_id": "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c" } } } } }, "description": "Paginated signal events. When `is_explain_match` is true and a `query` is supplied, `data.summary` holds an AI summary (`{ text, citations }`) of the company's full-feed activity read against the query; it is `null` otherwise." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_9e63ea9c999c76c1_ref6", "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_9e63ea9c999c76c1_ref7", "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_9e63ea9c999c76c1_ref8", "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": "Enriched, paginated drill-down into the signal events driving a single company's expansion.", "operationId": "expansions_company_pulse_events", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "title": "Domain Search ID", "required": [ "domain_search_id" ] }, { "title": "Domain", "required": [ "domain" ] }, { "title": "LinkedIn URL", "required": [ "linkedin_url" ] } ], "properties": { "page": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_9e63ea9c999c76c1_ref4", "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": "We sell Employer-of-Record and local payroll; best-fit buyers hire in a new market before setting up a legal entity.", "description": "Plain-language description of what you sell, or the buyer profile you're evaluating this company against. Used only to ground the AI `summary` (see `is_explain_match`); unlike the company search, it is NOT interpreted into filters here." }, "domain": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_9e63ea9c999c76c1_ref1", "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." }, "per_page": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_9e63ea9c999c76c1_ref5", "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": { "type": "array", "items": { "type": "string" } }, "company_id": { "type": "string" }, "window_days": { "type": "integer", "default": 90, "example": 90, "description": "Optional. Size of the rolling events window in days. Defaults to **90** (the standard display window) when neither this nor `transitioned_dates` is supplied. `transitioned_dates` takes precedence when both are sent." }, "linkedin_url": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_9e63ea9c999c76c1_ref2", "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/`" }, "signal_types": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_9e63ea9c999c76c1_ref0", "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": [ "EXEC", "HIRE" ], "description": "Filter to specific signal types. See the Signal Types catalog in the knowledge base for definitions and tiers (`DNS` and `INFRA` are Premier-tier signals)." }, "country_codes": { "type": "array", "items": { "type": "string" }, "example": [ "JP", "SG" ], "description": "Optional. Scope the feed to one or more foreign markets (ISO 3166-1 alpha-2, e.g. `[\"JP\",\"SG\"]`). Omitted → all foreign markets (the home market is always excluded)." }, "domain_search_id": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_9e63ea9c999c76c1_ref3", "type": "string", "description": "A unique identifier for the company search operation." }, "is_explain_match": { "type": "boolean", "example": true, "description": "When true and a `query` is supplied, `data.summary` returns a single AI summary of this company's expansion activity read against your `query`, grounded in the company's real signals with `[n]` citations. Unlike the company search's per-company `match_summary`, this summary is built from the company's ENTIRE feed for the window (all markets, every signal), so it is stable regardless of `page` / `per_page`." }, "transitioned_dates": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2026-04-01", "2026-06-29" ], "description": "ISO `[from, to]` date range for the signal/transition window. Takes precedence over `window_days` when both are supplied." } }, "description": "Provide at least one of the following: Domain Search ID (domain_search_id); Domain (domain); LinkedIn URL (linkedin_url)." } } }, "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" ], "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": [ "/responses/200/description", "/operationId", "/requestBody/content/application/json/schema/required", "/requestBody/content/application/json/schema/properties/per_page/maximum" ], "revisionId": "sdrn_YF3wEfhXeBDGcT4L2-sCE" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_HfMn3FGMhqoS-UW5w5ZNT", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/requestBody/content/application/json/schema/properties/page/description", "/requestBody/content/application/json/schema/properties/query/description", "/requestBody/content/application/json/schema/properties/domain/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/window_days/description", "/requestBody/content/application/json/schema/properties/linkedin_url/description", "/requestBody/content/application/json/schema/properties/signal_types/items/enum", "/requestBody/content/application/json/schema/properties/country_codes/description", "/requestBody/content/application/json/schema/properties/domain_search_id/format", "/requestBody/content/application/json/schema/properties/is_explain_match/description", "/requestBody/content/application/json/schema/properties/transitioned_dates/description" ], "revisionId": "sdrn_scL1X42OO3BDIBkLHqgZT" }, { "gaps": [], "pages": [], "sourceId": "sds_k5xT0yiL8Ir6VR05kyEBF", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/domain_search_id/format" ], "revisionId": "sdrn_-4yhPKLXO0w7ci0VnZLfS" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/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": [], "pages": [ 1 ], "sourceId": "sds_WofXWScXBS03A0AmlffYg", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_b95LqjeM1YjkAqHXnFpvm" } ], "x-zeroclick-services": [ "expansion" ], "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 expansion)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "expansion", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/expansions/companies/rankings": { "post": { "summary": "Expansion Rankings", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "markers": { "type": "array", "items": { "type": "object", "properties": { "direction": { "type": "string", "description": "Trajectory of the stage." }, "freshness": { "type": "string", "description": "How recent the underlying signals are." }, "stage_slug": { "type": "string", "description": "Current expansion stage." }, "country_code": { "type": "string", "description": "Target market, ISO 3166-1 alpha-2." }, "expansion_score": { "type": "integer", "description": "Expansion score for this company/market pair." }, "domain_search_id": { "type": "string", "description": "Pubrio company identifier." } } }, "description": "One row per company/market pair, ranked by expansion score." } }, "description": "Result container." }, "metadata": { "type": "object" } } }, "example": { "data": { "markers": [ { "direction": "advancing", "freshness": "fresh", "stage_slug": "expanding", "country_code": "US", "expansion_score": 0.721, "domain_search_id": "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c" } ] }, "metadata": { "count": 1, "filters": { "tos": [ "GB" ], "froms": [ "CN" ] }, "select_size": 250 } } } }, "description": "Ranked company/market markers." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref34", "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_568a299ac7783f8b_ref35", "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_568a299ac7783f8b_ref36", "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": "Lightweight ranked list of company/market pairs by expansion score — suited to map or heatmap rendering.", "operationId": "expansions_company_rankings", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "tos": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref1", "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "Target markets (ISO 3166-1 alpha-2). Where a company is expanding TO. Use alone to find every company entering these markets; combine with `froms` for a specific from→to corridor." }, "froms": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref0", "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "Origin markets (ISO 3166-1 alpha-2). Where a company is expanding FROM — its home / HQ countries. Use alone to find companies growing out of these markets; combine with `tos` for a specific from→to corridor." }, "stages": { "type": "array", "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref4" } ], "items": { "type": "string", "description": "Allowed values: exploring, committing, expanding, scaling." }, "example": [ "committing", "expanding" ], "description": "Values are case-sensitive and are **not validated**. An unrecognised value is silently discarded rather than rejected: on `stages`, `freshness`, `scopes` and `momentum` the whole filter is dropped and you get *unfiltered* results, while on `signal_types` and `signal_strengths` the filter is applied and matches *nothing*. Either way the response looks normal. Resolve valid slugs from [Expansion Reference](/en/api-reference/endpoint/expansions/types) and compare `data.pagination.total_entries` against an unfiltered call if a result set looks wrong." }, "filters": { "type": "object" }, "keywords": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref16", "type": "array", "items": { "type": "string" }, "example": [ "ecommerce", "ai", "fintech" ], "description": "A list of keywords to filter companies by relevance, specialties, or descriptions." }, "revenues": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref14", "type": "array", "items": { "type": "integer" }, "example": [ 0, 100000 ], "description": "Minimum and maximum range of company revenue." }, "companies": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref17", "type": "array", "items": { "type": "string" }, "example": [ "stripe.com", "https://www.linkedin.com/company/airbnb", "b7d92a56-31f8-4c0b-ae43-19c8e5f24b70" ], "description": "Scope to specific companies by any mix of `domain_search_id`, company domain, or a company social media profile URL. Domains and URLs resolve to their best-ranked company." }, "employees": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref13", "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_568a299ac7783f8b_ref9", "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\"]`." }, "job_titles": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref22", "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`." }, "exclude_tos": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref3", "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "Target markets to exclude (ISO 3166-1 alpha-2)." }, "select_size": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref33", "type": "integer", "example": 50, "description": "Maximum number of records to return. Capped by your plan." }, "signal_types": { "type": "array", "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref5" } ], "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": [ "EXEC", "HIRE" ], "description": "Values are case-sensitive and are **not validated**. An unrecognised value is silently discarded rather than rejected: on `stages`, `freshness`, `scopes` and `momentum` the whole filter is dropped and you get *unfiltered* results, while on `signal_types` and `signal_strengths` the filter is applied and matches *nothing*. Either way the response looks normal. Resolve valid slugs from [Expansion Reference](/en/api-reference/endpoint/expansions/types) and compare `data.pagination.total_entries` against an unfiltered call if a result set looks wrong." }, "technologies": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref12", "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." }, "exclude_froms": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref2", "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "Origin markets to exclude (ISO 3166-1 alpha-2)." }, "founded_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref15", "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_568a299ac7783f8b_ref18", "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." }, "news_categories": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref30", "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_568a299ac7783f8b_ref21", "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." }, "min_signal_count": { "type": "integer", "example": 3, "description": "Minimum number of expansion signals a company must have in the window — \"very active / heavy footprint\"." }, "only_contraction": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref7", "type": "boolean", "example": false, "description": "When true, return only contraction-flagged expansions (companies scaling back)." }, "signal_strengths": { "type": "array", "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref6" } ], "items": { "type": "string", "description": "Allowed values: low, medium, high, very_high." }, "example": [ "high" ], "description": "Values are case-sensitive and are **not validated**. An unrecognised value is silently discarded rather than rejected: on `stages`, `freshness`, `scopes` and `momentum` the whole filter is dropped and you get *unfiltered* results, while on `signal_types` and `signal_strengths` the filter is applied and matches *nothing*. Either way the response looks normal. Resolve valid slugs from [Expansion Reference](/en/api-reference/endpoint/expansions/types) and compare `data.pagination.total_entries` against an unfiltered call if a result set looks wrong." }, "domain_search_ids": { "type": "array", "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref8" } ], "items": { "type": "string" }, "example": [ "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c" ], "description": "Companies to restrict to, by `domain_search_id`." }, "is_include_metadata": { "type": "boolean", "example": true, "description": "Return the full detail payload. API-key traffic is lean by default: the `model` block, the confidence figures (`stage.confidence` on Company Expansion Detail, `confidence_score` on `other_markets[]` and on Rankings `markers[]`) and the `established_min` / `share_of_detected` / `has_known_office` fields are all omitted unless this is `true`." }, "vertical_categories": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref10", "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\"]`." }, "news_published_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref31", "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." }, "job_exclude_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref19", "type": "array", "items": { "type": "string" }, "example": [ "CN", "US", "RU", "CA" ], "description": "Geographic locations to exclude from job posting results." }, "is_include_established": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref32", "type": "boolean", "example": false, "description": "Include the `established` stage (long-standing operators with no active expansion signals). Defaults to false." }, "advertisement_end_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref29", "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-25", "2025-12-25" ], "description": "End date range for advertisement filtering." }, "vertical_sub_categories": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref11", "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_start_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref28", "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-25", "2025-12-25" ], "description": "Start date range for advertisement filtering." }, "advertisement_search_terms": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref27", "type": "array", "items": { "type": "string" }, "example": [ "asus" ], "description": "Keywords used to search within advertisement content or titles." }, "is_enable_similarity_search": { "type": "boolean", "example": true, "description": "Enable free-text matching for `verticals`, `vertical_categories`, `vertical_sub_categories` and `technologies`; those filters are dropped unless this is `true`." }, "advertisement_target_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref23", "type": "array", "items": { "type": "string" }, "example": [ "TW", "AE", "NO" ], "description": "Target geographic locations for advertisements." }, "advertisement_exclude_target_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_568a299ac7783f8b_ref25", "type": "array", "items": { "type": "string" }, "example": [ "IS", "GB", "FR", "IE", "ES" ], "description": "Geographic locations to exclude from advertisement targeting." } } } } }, "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": [], "revisionId": "sdrn_sF4Id8BIBdrnOh1M8jbor" }, { "gaps": [ "Missing request body schema and parameter definitions." ], "pages": [ 1 ], "sourceId": "sds__jGNe1xgzZjIl2HiJCgCx", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_BxGuvsEio3diUZthn74zf" }, { "gaps": [ "Missing explicit required field list in requestBody schema." ], "pages": [ 1 ], "sourceId": "sds_2HGj2EtLxrjc6DbUDtvRL", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/stages/items/enum", "/requestBody/content/application/json/schema/properties/signal_types/items/enum", "/requestBody/content/application/json/schema/properties/signal_strengths/items/enum" ], "revisionId": "sdrn__3fyGzEuvD9qCXxle2Kcr" }, { "gaps": [ "Missing request body schema details" ], "pages": [ 44 ], "sourceId": "sds_4QU1K-UtbB0JEFxtFT9j9", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "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": [ "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": [], "pages": [], "sourceId": "sds_k5xT0yiL8Ir6VR05kyEBF", "authority": "supplemental", "conflicts": [], "revisionId": "sdrn_-4yhPKLXO0w7ci0VnZLfS" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_LrGpRhi5-a5-RHjFMEhsh", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn__bR6EtgaNMMbyd-B4-j3A" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/properties/verticals/items/type", "/requestBody/required" ], "revisionId": "sdrn_BPN1iHD5tCVT4d4YJh-Wj" } ], "x-zeroclick-services": [ "expansion" ], "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 expansion)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "expansion", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/expansions/companies/summaries": { "post": { "summary": "Batch company expansion summaries", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "companies": { "type": "array", "items": { "type": "object" }, "description": "One ready-to-render summary per company requested." } } }, "metadata": { "type": "object" } } }, "example": { "data": { "companies": [ { "summary": { "scaling": 0, "pipeline": 1, "top_market": { "stage": "committing", "country": null, "country_code": "US" }, "new_markets": 1, "momentum_pct": 22, "signal_count": 12, "newest_market": { "stage": "committing", "country": null, "country_code": "US" }, "total_markets": 1, "active_markets": 1, "activity_weekly": [ 3, 5, 4 ], "window_expansion_score": 69 }, "firmographics": { "domain": "example.com", "industry": "Software Development", "logo_url": "https://logo.pubrio.com/example.com.png", "company_name": "Example Corp", "company_size": null, "country_code": "SG", "founded_year": 2015, "employees_count": 350, "domain_search_id": "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c", "estimated_revenue": 25000000, "is_employees_locked": false, "company_size_printed": "351+", "publicly_traded_symbol": null }, "expansion_score": 82, "markets_summary": [ { "signals": [ { "event_date": "2026-06-20T14:00:00.000Z", "display_label": "Hired Regional VP for North America", "signal_type_slug": "EXEC", "signal_subtype_slug": "country_manager" } ], "stage_slug": "committing", "country_code": "US", "signal_count": 12, "expansion_score": 0.685, "first_signal_at": "2026-04-02T08:00:00.000Z", "latest_signal_at": "2026-06-28T10:15:22.000Z", "last_transition_at": "2026-06-25T14:30:00.000Z", "distinct_type_count": 4 } ], "domain_search_id": "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c", "home_country_code": "SG", "signal_weekly_totals": [ { "count": 5, "week_start": "2026-06-22", "signal_type_slug": "HIRE" } ] } ] }, "metadata": {} } } }, "description": "Array of per-company expansion summaries. Two scores: top-level `expansion_score` is the overall current posture across all markets (stable); `summary.window_expansion_score` is the same measure scoped to the selected window. Both are on a 0-100 scale here (unlike the 0-1 `stage.expansion_score` on search results). When your plan does not include employee counts, `firmographics` returns `company_size`, `employees_count`, and `company_size_printed` as null and sets `is_employees_locked: true`." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_49333a7c6d50d1dc_ref5", "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_49333a7c6d50d1dc_ref6", "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_49333a7c6d50d1dc_ref7", "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": "Ready-to-render expansion summaries for a batch of companies, prepared for side-by-side comparison without client-side aggregation.", "operationId": "expansions_company_summaries", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "domains": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_49333a7c6d50d1dc_ref1", "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." }, "companies": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_49333a7c6d50d1dc_ref0", "type": "array", "items": { "type": "string" }, "example": [ "stripe.com", "https://www.linkedin.com/company/airbnb", "b7d92a56-31f8-4c0b-ae43-19c8e5f24b70" ], "description": "Scope to specific companies by any mix of `domain_search_id`, company domain, or a company social media profile URL. Domains and URLs resolve to their best-ranked company." }, "company_ids": { "type": "array", "items": { "type": "string" } }, "window_days": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_49333a7c6d50d1dc_ref3", "type": "integer", "example": 90, "description": "Optional. Size of the rolling window in days. Used when an explicit `transitioned_dates` range is not supplied; if both are omitted, a default window is used." }, "linkedin_urls": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_49333a7c6d50d1dc_ref2", "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/`" }, "transitioned_dates": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2026-04-01", "2026-06-29" ], "description": "ISO `[from, to]` date range for the signal/transition window. Takes precedence over `window_days` when both are supplied." }, "is_include_metadata": { "type": "boolean", "example": true, "description": "Return the full detail payload. API-key traffic is lean by default: the `model` block, the confidence figures (`stage.confidence` on Company Expansion Detail, `confidence_score` on `other_markets[]` and on Rankings `markers[]`) and the `established_min` / `share_of_detected` / `has_known_office` fields are all omitted unless this is `true`." }, "is_include_established": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_49333a7c6d50d1dc_ref4", "type": "boolean", "example": false, "description": "Include the `established` stage (long-standing operators with no active expansion signals). Defaults to false." } }, "description": "Scope companies with a single `companies` array of mixed identifiers — `domain_search_id`, company domain, or LinkedIn URL — matched as a union (not intersected). The legacy `domain_search_ids`, `domains`, and `linkedin_urls` keys remain accepted for backward compatibility. Up to 25 resolved companies per request." } } }, "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": [], "revisionId": "sdrn_sF4Id8BIBdrnOh1M8jbor" }, { "gaps": [ "Missing specific field names in request body." ], "pages": [ 1 ], "sourceId": "sds__jGNe1xgzZjIl2HiJCgCx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/properties/companies/description" ], "revisionId": "sdrn_BxGuvsEio3diUZthn74zf" }, { "gaps": [], "pages": [ 44 ], "sourceId": "sds_4QU1K-UtbB0JEFxtFT9j9", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/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": [ "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": [], "pages": [], "sourceId": "sds_k5xT0yiL8Ir6VR05kyEBF", "authority": "supplemental", "conflicts": [], "revisionId": "sdrn_-4yhPKLXO0w7ci0VnZLfS" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_LrGpRhi5-a5-RHjFMEhsh", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn__bR6EtgaNMMbyd-B4-j3A" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_OBk7QJkQFsMJU3pqh2VBT", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/responses/400/description", "/responses/429/description", "/responses/500/description", "/requestBody/content/application/json/schema/properties/domains/description", "/requestBody/content/application/json/schema/properties/companies/description", "/requestBody/content/application/json/schema/properties/window_days/description", "/requestBody/content/application/json/schema/properties/linkedin_urls/description", "/requestBody/content/application/json/schema/properties/transitioned_dates/description", "/requestBody/content/application/json/schema/properties/is_include_metadata/description", "/requestBody/content/application/json/schema/properties/is_include_established/description" ], "revisionId": "sdrn_yTToXka-AHBSQ46QoESrf" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_BPN1iHD5tCVT4d4YJh-Wj" } ], "x-zeroclick-services": [ "expansion" ], "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 expansion)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "expansion", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/expansions/dashboard": { "post": { "summary": "Expansion Overview", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "countries": { "type": "array", "items": { "type": "object" }, "description": "Ranked markets with per-market signal counts." }, "top_flows": { "type": "array", "items": { "type": "object" }, "description": "Largest cross-border expansion flows, busiest first." }, "picks_aggregate": { "type": "array", "items": { "type": "object" }, "description": "Aggregate roll-up across the markets matched by the current filters." }, "watchlist_markets": { "type": "array", "items": { "type": "object" }, "description": "Per-market stage counts limited to the companies saved in your workspace." }, "watchlist_timeline": { "type": "array", "items": { "type": "object" }, "description": "Stage-transition events for the companies saved in your workspace, newest first." } }, "description": "Dashboard container: ranked markets plus the top corridor flows. Deprecated legacy mirror. Every container inside `data` is also emitted at the top level (`countries`, `top_flows`, `picks_aggregate`, `watchlist_markets`, `watchlist_timeline`) for older clients. Read them from `data` — the top-level copies will be removed." }, "metadata": { "type": "object" } }, "x-legacy-root-keys": [ "countries", "top_flows", "picks_aggregate", "watchlist_markets", "watchlist_timeline" ] }, "example": { "data": { "countries": [ { "country_code": "US", "inbound_count": 18, "scaling_count": 1, "outbound_count": 5, "expanding_count": 4, "exploring_count": 8, "committing_count": 10, "new_transitions_30d": 3, "freshest_transition_at": "2026-06-27T14:32:10.000Z", "pairs_ahead_of_pace_30d": 1, "total_companies_with_signals": 23 } ], "top_flows": [ { "country_code": "US", "company_count": 5, "home_country_code": "SG", "new_transitions_30d": 1 } ] }, "metadata": { "filters": { "tos": [ "GB" ], "froms": [ "CN" ] }, "flows_size": 50, "select_size": 250, "transitioned_dates": [ "2026-06-01", "2026-06-29" ] } } } }, "description": "Market dashboard aggregates." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_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" }, "408": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref39", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "details" ], "properties": { "code": { "type": "integer", "example": 40801 }, "details": { "type": "object" }, "message": { "type": "string", "example": "Request timeout" } } } } }, "description": "Request timeout. The request could not finish in time. Narrow the request and try again." }, "429": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_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_2073acb14089837f_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": "Market-level expansion KPIs — per-market stage counts and top cross-border flows. Aggregated, not paginated. Answers `408` when the request cannot finish in time.", "operationId": "expansions_dashboard", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "tos": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref1", "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "Target markets (ISO 3166-1 alpha-2). Where a company is expanding TO. Use alone to find every company entering these markets; combine with `froms` for a specific from→to corridor." }, "froms": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref0", "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "Origin markets (ISO 3166-1 alpha-2). Where a company is expanding FROM — its home / HQ countries. Use alone to find companies growing out of these markets; combine with `tos` for a specific from→to corridor." }, "scopes": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref7", "type": "array", "items": { "type": "string", "description": "Allowed values: entering_new_market, expanding_within_presence, established_only." }, "example": [ "entering_new_market" ], "description": "Filter by market-entry scope." }, "stages": { "type": "array", "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref4" } ], "items": { "type": "string", "description": "Allowed values: exploring, committing, expanding, scaling." }, "example": [ "committing", "expanding" ], "description": "Values are case-sensitive and are **not validated**. An unrecognised value is silently discarded rather than rejected: on `stages`, `freshness`, `scopes` and `momentum` the whole filter is dropped and you get *unfiltered* results, while on `signal_types` and `signal_strengths` the filter is applied and matches *nothing*. Either way the response looks normal. Resolve valid slugs from [Expansion Reference](/en/api-reference/endpoint/expansions/types) and compare `data.pagination.total_entries` against an unfiltered call if a result set looks wrong." }, "keywords": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref18", "type": "array", "items": { "type": "string" }, "example": [ "ecommerce", "ai", "fintech" ], "description": "A list of keywords to filter companies by relevance, specialties, or descriptions." }, "momentum": { "type": "array", "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref5" } ], "items": { "type": "string", "description": "Allowed values: advancing, steady, pulling_back." }, "example": [ "advancing", "steady" ], "description": "Trajectory of the company's movement in the market. `advancing` is gaining ground, `steady` is holding, `pulling_back` covers retreat and contraction.\n\nDo **not** use the values from `directions` in [Expansion Reference](/en/api-reference/endpoint/expansions/types) here. Those (`advancing`, `steady`, `retreating`, `new`) are the *response* values you get back on `stage.direction`; only the three listed above are accepted as a *filter*. Sending `retreating` or `new` silently disables the filter and returns unfiltered results." }, "revenues": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref16", "type": "array", "items": { "type": "integer" }, "example": [ 0, 100000 ], "description": "Minimum and maximum range of company revenue." }, "companies": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref19", "type": "array", "items": { "type": "string" }, "example": [ "stripe.com", "https://www.linkedin.com/company/airbnb", "b7d92a56-31f8-4c0b-ae43-19c8e5f24b70" ], "description": "Scope to specific companies by any mix of `domain_search_id`, company domain, or a company social media profile URL. Domains and URLs resolve to their best-ranked company." }, "employees": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref15", "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." }, "freshness": { "type": "array", "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref6" } ], "items": { "type": "string", "description": "Allowed values: fresh, cooling, stale, cold." }, "example": [ "fresh", "cooling" ], "description": "Values are case-sensitive and are **not validated**. An unrecognised value is silently discarded rather than rejected: on `stages`, `freshness`, `scopes` and `momentum` the whole filter is dropped and you get *unfiltered* results, while on `signal_types` and `signal_strengths` the filter is applied and matches *nothing*. Either way the response looks normal. Resolve valid slugs from [Expansion Reference](/en/api-reference/endpoint/expansions/types) and compare `data.pagination.total_entries` against an unfiltered call if a result set looks wrong." }, "verticals": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref11", "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\"]`." }, "flows_size": { "type": "integer", "example": 50, "description": "Max cross-border flows to return (plan-capped)." }, "industries": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref35", "type": "array", "items": { "type": "string" }, "example": [ "software", "financial services" ], "description": "Filter by industry name (free-text match)." }, "job_titles": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref24", "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`." }, "exclude_tos": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref3", "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "Target markets to exclude (ISO 3166-1 alpha-2)." }, "min_markets": { "type": "integer", "example": 3, "description": "Minimum number of new markets a company must have entered in the window (wide expanders)." }, "select_size": { "type": "integer", "example": 250, "description": "Max markets to return (plan-capped)." }, "window_days": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref34", "type": "integer", "example": 90, "description": "Optional. Size of the rolling window in days. Used when an explicit `transitioned_dates` range is not supplied; if both are omitted, a default window is used." }, "signal_types": { "type": "array", "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref8" } ], "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": [ "EXEC", "HIRE" ], "description": "Values are case-sensitive and are **not validated**. An unrecognised value is silently discarded rather than rejected: on `stages`, `freshness`, `scopes` and `momentum` the whole filter is dropped and you get *unfiltered* results, while on `signal_types` and `signal_strengths` the filter is applied and matches *nothing*. Either way the response looks normal. Resolve valid slugs from [Expansion Reference](/en/api-reference/endpoint/expansions/types) and compare `data.pagination.total_entries` against an unfiltered call if a result set looks wrong." }, "technologies": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref14", "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." }, "ahead_of_pace": { "type": "boolean", "example": false, "description": "Limit to company/market pairs moving faster than the typical pace for that market." }, "exclude_froms": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref2", "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "Origin markets to exclude (ISO 3166-1 alpha-2)." }, "founded_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref17", "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_2073acb14089837f_ref20", "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." }, "news_categories": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref32", "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_2073acb14089837f_ref23", "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." }, "min_signal_count": { "type": "integer", "example": 3, "description": "Minimum number of expansion signals a company must have in the window — \"very active / heavy footprint\"." }, "only_contraction": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref10", "type": "boolean", "example": false, "description": "When true, return only contraction-flagged expansions (companies scaling back)." }, "signal_strengths": { "type": "array", "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref9" } ], "items": { "type": "string", "description": "Allowed values: low, medium, high, very_high." }, "example": [ "high" ], "description": "Values are case-sensitive and are **not validated**. An unrecognised value is silently discarded rather than rejected: on `stages`, `freshness`, `scopes` and `momentum` the whole filter is dropped and you get *unfiltered* results, while on `signal_types` and `signal_strengths` the filter is applied and matches *nothing*. Either way the response looks normal. Resolve valid slugs from [Expansion Reference](/en/api-reference/endpoint/expansions/types) and compare `data.pagination.total_entries` against an unfiltered call if a result set looks wrong." }, "home_country_code": { "type": "array", "items": { "type": "string" }, "example": [ "SG" ], "description": "Filter by company home country (ISO 3166-1 alpha-2). Intersects with `froms` when both are supplied." }, "exclude_industries": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref36", "type": "array", "items": { "type": "string" }, "example": [ "tobacco" ], "description": "Industries to exclude (free-text match)." }, "transitioned_dates": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2026-06-01", "2026-06-29" ], "description": "ISO date range [start, end] for the display window (map, flows, and watchlist timeline). Defaults to the last 90 days. The `new_transitions_30d` KPI always uses its own fixed 30-day window regardless of this range." }, "is_include_metadata": { "type": "boolean", "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref37" } ], "example": true, "description": "Return the full detail payload. API-key traffic is lean by default: the `model` block, the confidence figures (`stage.confidence` on Company Expansion Detail, `confidence_score` on `other_markets[]` and on Rankings `markers[]`) and the `established_min` / `share_of_detected` / `has_known_office` fields are all omitted unless this is `true`." }, "vertical_categories": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref12", "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\"]`." }, "news_published_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref33", "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." }, "job_exclude_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref21", "type": "array", "items": { "type": "string" }, "example": [ "CN", "US", "RU", "CA" ], "description": "Geographic locations to exclude from job posting results." }, "advertisement_end_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref31", "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-25", "2025-12-25" ], "description": "End date range for advertisement filtering." }, "vertical_sub_categories": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref13", "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_start_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref30", "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-25", "2025-12-25" ], "description": "Start date range for advertisement filtering." }, "advertisement_search_terms": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref29", "type": "array", "items": { "type": "string" }, "example": [ "asus" ], "description": "Keywords used to search within advertisement content or titles." }, "is_enable_similarity_search": { "type": "boolean", "example": true, "description": "Enable free-text matching for `verticals`, `vertical_categories`, `vertical_sub_categories` and `technologies`; those filters are dropped unless this is `true`." }, "advertisement_target_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref25", "type": "array", "items": { "type": "string" }, "example": [ "TW", "AE", "NO" ], "description": "Target geographic locations for advertisements." }, "advertisement_exclude_target_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2073acb14089837f_ref27", "type": "array", "items": { "type": "string" }, "example": [ "IS", "GB", "FR", "IE", "ES" ], "description": "Geographic locations to exclude from advertisement targeting." } } } } }, "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": [], "revisionId": "sdrn_sF4Id8BIBdrnOh1M8jbor" }, { "gaps": [ "Missing request body schema." ], "pages": [ 1 ], "sourceId": "sds__jGNe1xgzZjIl2HiJCgCx", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_BxGuvsEio3diUZthn74zf" }, { "gaps": [], "pages": [ 43 ], "sourceId": "sds_4QU1K-UtbB0JEFxtFT9j9", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/responses/408/description", "/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": [ "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": [], "pages": [], "sourceId": "sds_k5xT0yiL8Ir6VR05kyEBF", "authority": "supplemental", "conflicts": [], "revisionId": "sdrn_-4yhPKLXO0w7ci0VnZLfS" }, { "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": [], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_BPN1iHD5tCVT4d4YJh-Wj" }, { "gaps": [ "Missing explicit required field list in requestBody schema." ], "pages": [ 1 ], "sourceId": "sds_xhAGipUvLUb3w5-vTO0uy", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/tos/description", "/requestBody/content/application/json/schema/properties/froms/description", "/requestBody/content/application/json/schema/properties/scopes/items/enum", "/requestBody/content/application/json/schema/properties/stages/items/enum", "/requestBody/content/application/json/schema/properties/stages/description", "/requestBody/content/application/json/schema/properties/momentum/items/enum", "/requestBody/content/application/json/schema/properties/momentum/description", "/requestBody/content/application/json/schema/properties/freshness/items/enum", "/requestBody/content/application/json/schema/properties/freshness/description", "/requestBody/content/application/json/schema/properties/signal_types/items/enum", "/requestBody/content/application/json/schema/properties/signal_types/description", "/requestBody/content/application/json/schema/properties/min_signal_count/description", "/requestBody/content/application/json/schema/properties/only_contraction/description", "/requestBody/content/application/json/schema/properties/signal_strengths/items/enum", "/requestBody/content/application/json/schema/properties/signal_strengths/description", "/requestBody/content/application/json/schema/properties/transitioned_dates/description" ], "revisionId": "sdrn_aySsn0nezIK-rtWKgGbr0" } ], "x-zeroclick-services": [ "expansion" ], "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 expansion)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "expansion", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/expansions/search": { "post": { "summary": "Expansion Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "companies": { "type": "array", "items": { "type": "object" }, "description": "The company list. Each item carries a nested `stage`; `match_summary` is included when `is_explain_match` is true. API-key responses also include `presence` (`level`: established | emerging | none | no_data; `matched_rule`: office | headcount | share) and a `read` object whose `code` is scaling | deepening | active | establishing (null when there is no local presence to read)." }, "pagination": { "type": "object", "description": "Page, per-page, total entries and total pages." } }, "description": "Result container (standard search envelope): the company list plus pagination." }, "metadata": { "type": "object", "properties": { "filters": { "type": "object", "description": "The filters as received. With `query`, the interpreted filters, where `country_codes` with `direction: inbound` corresponds to `tos`." }, "nl_note": { "type": "string", "description": "Human-readable note when a natural-language query expressed no recognizable criteria; the list is empty in that case." }, "is_multi": { "type": "boolean" }, "timeline": { "type": "array", "items": { "type": "object" } }, "aggregate": { "type": "object", "description": "Market-level rollup. Present when metadata is requested." }, "direction": { "type": "string" }, "is_global": { "type": "boolean" }, "top_origins": { "type": "array", "items": { "type": "object" } }, "country_code": { "type": "string" }, "nl_note_code": { "type": "string", "description": "Machine-readable code for nl_note (e.g. expansion.search.no_criteria)." }, "country_codes": { "type": "array", "items": { "type": "string" } }, "top_industries": { "type": "array", "items": { "type": "object" } }, "relaxed_filters": { "type": "array", "items": { "type": "string" }, "description": "Soft filters auto-dropped when a natural-language query matched nothing; null otherwise." }, "top_destinations": { "type": "array", "items": { "type": "object" } }, "transitioned_dates": { "type": "array", "items": { "type": "string" } } }, "description": "Search metadata: the filters actually applied, plus the market rollup (aggregate, geo scope, top origins/destinations/industries, timeline). API-key responses include the rollup only when `is_include_metadata` is true." } } }, "example": { "data": { "companies": [ { "read": { "code": "establishing" }, "stage": { "slug": "expanding", "scope": "entering_new_market", "direction": "advancing", "freshness": "fresh", "signal_count": 27, "expansion_score": 0.72, "last_transition_at": "2026-06-27T14:32:10.000Z", "distinct_type_count": 3 }, "domain": "example.com", "industry": "Consumer Electronics", "presence": { "level": "established", "matched_rule": "headcount", "established_min": 10, "has_known_office": true, "share_of_detected": 0.54, "local_people_count": 12 }, "company_name": "Example Corp", "country_code": "GB", "expansion_id": "6845525", "founded_year": 2015, "employees_count": 320, "domain_search_id": "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c", "home_country_code": "CN", "target_country_code": "GB" } ], "pagination": { "page": 1, "per_page": 25, "is_timeout": false, "total_pages": 4, "total_entries": 87, "total_display_pages": 4 } }, "metadata": { "filters": { "tos": [ "GB" ], "verticals": [ "Financial Services" ] } } } } }, "description": "Paginated list of companies expanding in the market(s). `filters` echoes the applied (or natural-language-interpreted) criteria; each company includes a `match_summary` when `is_explain_match` is true." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref42", "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_ff4fe63154bb1dfe_ref43", "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_ff4fe63154bb1dfe_ref44", "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": "Find companies expanding into one or more markets using firmographic and signal filters or a plain-language query, with optional AI match explanations grounded in each company's real signals. Send at least one of `tos`, `froms`, `companies` or `query`.", "operationId": "expansions_search", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "title": "From Markets", "required": [ "froms" ] }, { "title": "To Markets", "required": [ "tos" ] }, { "title": "Plain-language Query", "required": [ "query" ] }, { "title": "Companies", "required": [ "companies" ] } ], "properties": { "tos": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref1", "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "Target markets (ISO 3166-1 alpha-2). Where a company is expanding TO. Use alone to find every company entering these markets; combine with `froms` for a specific from→to corridor." }, "page": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref39", "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**." }, "froms": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref0", "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "Origin markets (ISO 3166-1 alpha-2). Where a company is expanding FROM — its home / HQ countries. Use alone to find companies growing out of these markets; combine with `tos` for a specific from→to corridor." }, "query": { "type": "string", "example": "fintech companies expanding into the UK", "description": "Natural-language query that Pubrio interprets into expansion + company filters." }, "scopes": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref7", "type": "array", "items": { "type": "string", "description": "Allowed values: entering_new_market, expanding_within_presence, established_only." }, "example": [ "entering_new_market" ], "description": "Filter by market-entry scope." }, "stages": { "type": "array", "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref4" } ], "items": { "type": "string", "description": "Allowed values: exploring, committing, expanding, scaling." }, "example": [ "committing", "expanding" ], "description": "Values are case-sensitive and are **not validated**. An unrecognised value is silently discarded rather than rejected: on `stages`, `freshness`, `scopes` and `momentum` the whole filter is dropped and you get *unfiltered* results, while on `signal_types` and `signal_strengths` the filter is applied and matches *nothing*. Either way the response looks normal. Resolve valid slugs from [Expansion Reference](/en/api-reference/endpoint/expansions/types) and compare `data.pagination.total_entries` against an unfiltered call if a result set looks wrong." }, "sort_by": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref37", "type": "string", "example": "expansion_score", "description": "Result ordering. Omit for the default relevance order: corroborated pairs first (2+ distinct signal types), then repeated-evidence pairs (3+ signals), then the rest — most recently transitioned first within each tier. `recent` — pure recency (most recently transitioned first). `expansion_score` — highest expansion score first. `signal_count` — most signals in the pair first. `company_ranking` — Pubrio's overall company ranking (lower is more prominent), ascending. Allowed values: recent, expansion_score, signal_count, company_ranking." }, "keywords": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref20", "type": "array", "items": { "type": "string" }, "example": [ "ecommerce", "ai", "fintech" ], "description": "A list of keywords to filter companies by relevance, specialties, or descriptions." }, "momentum": { "type": "array", "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref5" } ], "items": { "type": "string", "description": "Allowed values: advancing, steady, pulling_back." }, "example": [ "advancing", "steady" ], "description": "Trajectory of the company's movement in the market. `advancing` is gaining ground, `steady` is holding, `pulling_back` covers retreat and contraction.\n\nDo **not** use the values from `directions` in [Expansion Reference](/en/api-reference/endpoint/expansions/types) here. Those (`advancing`, `steady`, `retreating`, `new`) are the *response* values you get back on `stage.direction`; only the three listed above are accepted as a *filter*. Sending `retreating` or `new` silently disables the filter and returns unfiltered results." }, "per_page": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref40", "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_ff4fe63154bb1dfe_ref18", "type": "array", "items": { "type": "integer" }, "example": [ 0, 100000 ], "description": "Minimum and maximum range of company revenue." }, "companies": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref21", "type": "array", "items": { "type": "string" }, "example": [ "stripe.com", "https://www.linkedin.com/company/airbnb", "b7d92a56-31f8-4c0b-ae43-19c8e5f24b70" ], "description": "Scope to specific companies by any mix of `domain_search_id`, company domain, or a company social media profile URL. Domains and URLs resolve to their best-ranked company." }, "employees": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_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." }, "freshness": { "type": "array", "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref6" } ], "items": { "type": "string", "description": "Allowed values: fresh, cooling, stale, cold." }, "example": [ "fresh", "cooling" ], "description": "Values are case-sensitive and are **not validated**. An unrecognised value is silently discarded rather than rejected: on `stages`, `freshness`, `scopes` and `momentum` the whole filter is dropped and you get *unfiltered* results, while on `signal_types` and `signal_strengths` the filter is applied and matches *nothing*. Either way the response looks normal. Resolve valid slugs from [Expansion Reference](/en/api-reference/endpoint/expansions/types) and compare `data.pagination.total_entries` against an unfiltered call if a result set looks wrong." }, "verticals": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref13", "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\"]`." }, "industries": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref11", "type": "array", "items": { "type": "string" }, "example": [ "software", "financial services" ], "description": "Filter by industry name (free-text match)." }, "job_titles": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref26", "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`." }, "exclude_tos": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref3", "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "Target markets to exclude (ISO 3166-1 alpha-2)." }, "min_markets": { "type": "integer", "example": 3, "description": "Minimum number of new markets a company must have entered in the window." }, "window_days": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref36", "type": "integer", "example": 90, "description": "Optional. Size of the rolling window in days. Used when an explicit `transitioned_dates` range is not supplied; if both are omitted, a default window is used." }, "signal_types": { "type": "array", "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref8" } ], "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": [ "EXEC", "HIRE" ], "description": "Values are case-sensitive and are **not validated**. An unrecognised value is silently discarded rather than rejected: on `stages`, `freshness`, `scopes` and `momentum` the whole filter is dropped and you get *unfiltered* results, while on `signal_types` and `signal_strengths` the filter is applied and matches *nothing*. Either way the response looks normal. Resolve valid slugs from [Expansion Reference](/en/api-reference/endpoint/expansions/types) and compare `data.pagination.total_entries` against an unfiltered call if a result set looks wrong." }, "technologies": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_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." }, "ahead_of_pace": { "type": "boolean", "example": false, "description": "Limit to pairs moving faster than the typical pace for that market." }, "exclude_froms": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref2", "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "Origin markets to exclude (ISO 3166-1 alpha-2)." }, "founded_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_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_ff4fe63154bb1dfe_ref22", "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." }, "news_categories": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref34", "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." }, "is_explain_match": { "type": "boolean", "example": true, "description": "Include AI-generated explanations of why each company matches the search, grounded in the company's real signals. Best paired with a natural-language query. The number of signals cited and the batch size both scale with `per_page`; high-volume sources (job postings, ad campaigns) are summarized as a window-scoped count (e.g. \"12 job postings\") rather than listed individually." }, "job_posted_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref25", "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." }, "min_signal_count": { "type": "integer", "example": 3, "description": "Minimum number of expansion signals a company must have in the window — \"very active / heavy footprint\"." }, "only_contraction": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref10", "type": "boolean", "example": false, "description": "When true, return only contraction-flagged expansions (companies scaling back)." }, "signal_strengths": { "type": "array", "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref9" } ], "items": { "type": "string", "description": "Allowed values: low, medium, high, very_high." }, "example": [ "high" ], "description": "Values are case-sensitive and are **not validated**. An unrecognised value is silently discarded rather than rejected: on `stages`, `freshness`, `scopes` and `momentum` the whole filter is dropped and you get *unfiltered* results, while on `signal_types` and `signal_strengths` the filter is applied and matches *nothing*. Either way the response looks normal. Resolve valid slugs from [Expansion Reference](/en/api-reference/endpoint/expansions/types) and compare `data.pagination.total_entries` against an unfiltered call if a result set looks wrong." }, "filter_conditions": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref41", "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." }, "home_country_code": { "type": "array", "items": { "type": "string" }, "example": [ "SG" ], "description": "Filter by company home country (ISO 3166-1 alpha-2). Intersects with `froms` when both are supplied." }, "exclude_industries": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref12", "type": "array", "items": { "type": "string" }, "example": [ "tobacco" ], "description": "Industries to exclude (free-text match)." }, "transitioned_dates": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2026-04-01", "2026-06-29" ], "description": "ISO date range for the timeline window. Defaults to the last 90 days. A natural-language `query` may also set this from calendar phrases (\"this year\", \"last year\", \"Q2 2026\")." }, "is_include_metadata": { "type": "boolean", "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref38" } ], "example": true, "description": "Return the full detail payload. API-key traffic is lean by default: the `model` block, the confidence figures (`stage.confidence` on Company Expansion Detail, `confidence_score` on `other_markets[]` and on Rankings `markers[]`) and the `established_min` / `share_of_detected` / `has_known_office` fields are all omitted unless this is `true`." }, "vertical_categories": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref14", "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\"]`." }, "news_published_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref35", "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." }, "job_exclude_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref23", "type": "array", "items": { "type": "string" }, "example": [ "CN", "US", "RU", "CA" ], "description": "Geographic locations to exclude from job posting results." }, "advertisement_end_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref33", "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-25", "2025-12-25" ], "description": "End date range for advertisement filtering." }, "vertical_sub_categories": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref15", "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_start_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref32", "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-25", "2025-12-25" ], "description": "Start date range for advertisement filtering." }, "advertisement_search_terms": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref31", "type": "array", "items": { "type": "string" }, "example": [ "asus" ], "description": "Keywords used to search within advertisement content or titles." }, "is_enable_similarity_search": { "type": "boolean", "example": true, "description": "Enable free-text matching for `verticals`, `vertical_categories`, `vertical_sub_categories` and `technologies`. Without it, free-text values in those filters match nothing." }, "advertisement_target_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref27", "type": "array", "items": { "type": "string" }, "example": [ "TW", "AE", "NO" ], "description": "Target geographic locations for advertisements." }, "advertisement_exclude_target_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_ff4fe63154bb1dfe_ref29", "type": "array", "items": { "type": "string" }, "example": [ "IS", "GB", "FR", "IE", "ES" ], "description": "Geographic locations to exclude from advertisement targeting." } }, "description": "Provide at least one of the following: From Markets (froms); To Markets (tos); Plain-language Query (query); Companies (companies)." } } }, "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" ], "revisionId": "sdrn_sF4Id8BIBdrnOh1M8jbor" }, { "gaps": [ "Missing full filter schema definitions." ], "pages": [ 1 ], "sourceId": "sds__jGNe1xgzZjIl2HiJCgCx", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_BxGuvsEio3diUZthn74zf" }, { "gaps": [], "pages": [ 43 ], "sourceId": "sds_4QU1K-UtbB0JEFxtFT9j9", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "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": [ "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": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_hQQ-C8uEx2j76eTz0TPqt" }, { "gaps": [], "pages": [], "sourceId": "sds_k5xT0yiL8Ir6VR05kyEBF", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/per_page/maximum" ], "revisionId": "sdrn_-4yhPKLXO0w7ci0VnZLfS" }, { "gaps": [ "Missing request body schema", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_LrGpRhi5-a5-RHjFMEhsh", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description" ], "revisionId": "sdrn__bR6EtgaNMMbyd-B4-j3A" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_OX1BMv-Y_4LP_SD9wd9KJ", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/responses/400/description", "/responses/429/description", "/responses/500/description", "/requestBody/content/application/json/schema/required", "/requestBody/content/application/json/schema/properties/scopes/items/enum", "/requestBody/content/application/json/schema/properties/stages/items/enum", "/requestBody/content/application/json/schema/properties/sort_by/enum", "/requestBody/content/application/json/schema/properties/momentum/items/enum", "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/freshness/items/enum", "/requestBody/content/application/json/schema/properties/signal_types/items/enum", "/requestBody/content/application/json/schema/properties/signal_strengths/items/enum" ], "revisionId": "sdrn_WAEqeQbf-SWlWgdm6fzeO" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/properties/revenues/items/type", "/requestBody/content/application/json/schema/properties/employees/items/items/type", "/requestBody/content/application/json/schema/properties/verticals/items/type", "/requestBody/content/application/json/schema/properties/technologies/items/type", "/requestBody/content/application/json/schema/properties/founded_dates/items/type", "/requestBody/required" ], "revisionId": "sdrn_BPN1iHD5tCVT4d4YJh-Wj" }, { "gaps": [ "Missing explicit enum values for freshness, stages, momentum, scopes, and signal_types." ], "pages": [ 1 ], "sourceId": "sds_WofXWScXBS03A0AmlffYg", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_b95LqjeM1YjkAqHXnFpvm" } ], "x-zeroclick-services": [ "expansion" ], "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 expansion)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "expansion", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/expansions/signals/search": { "post": { "summary": "Expansion Signal Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "signals": { "type": "array", "items": { "type": "object", "properties": { "audit": { "type": "object", "properties": { "user_id": { "type": "string", "format": "uuid", "nullable": true }, "import_id": { "type": "string", "nullable": true }, "profile_id": { "type": "integer", "nullable": true }, "is_backfill": { "type": "boolean" } }, "description": "Provenance of the row: `profile_id` and `user_id` are set for user-imported signals, `import_id` groups a bulk import, and `is_backfill` marks rows added by a historical backfill." }, "notes": { "type": "string", "nullable": true, "description": "Free-text annotation. Usually `null`." }, "metadata": { "type": "object", "description": "Source-specific detail. Its keys vary by `source_type` — job rows carry `departments`, `seniority`, `top_titles`, `active_postings`; ad rows carry `advertisement_format`, `headline`, `share_pct`." }, "polarity": { "type": "string", "description": "Signal direction: `expansion`, or one of the three `contraction_*` values." }, "is_active": { "type": "boolean", "description": "`true` for live signals, `false` once a signal has been retracted." }, "occurs_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Start of the window the signal covers, for signals that span a period." }, "created_at": { "type": "string", "format": "date-time", "description": "When the signal row was created." }, "event_date": { "type": "string", "format": "date-time", "description": "When the underlying event happened. Read together with `event_date_precision`." }, "source_type": { "type": "string", "description": "Where the signal came from. Observed values: `jobs`, `ads`, `linkedin`, `news`, `pubrio`." }, "country_code": { "type": "string", "description": "Target market this signal was observed in, as an ISO 3166-1 alpha-2 code." }, "evidence_url": { "type": "string", "nullable": true, "description": "Link to the supporting evidence. Frequently `null` — most rows are derived from structured sources rather than a citable page." }, "occurs_until": { "type": "string", "format": "date-time", "nullable": true, "description": "End of the window the signal covers, for signals that span a period." }, "display_label": { "type": "string", "description": "Human-readable one-line summary of the signal." }, "last_modified": { "type": "string", "format": "date-time", "description": "When the signal row was last updated." }, "lead_time_days": { "type": "integer", "nullable": true, "description": "Days between the source being published and the event date, when both are known." }, "domain_search_id": { "type": "string", "format": "uuid", "description": "The company this signal belongs to. Use it with [Company Expansion Detail](/en/api-reference/endpoint/expansions/company_lookup)." }, "extraction_model": { "type": "string", "nullable": true, "description": "Name of the extracting model, when one was used." }, "signal_type_slug": { "type": "string", "description": "Signal type. One of the 17 slugs returned by [Expansion Reference](/en/api-reference/endpoint/expansions/types)." }, "source_record_id": { "type": "string", "nullable": true, "description": "Identifier of the source record the signal was derived from, when one exists." }, "expansion_signal_id": { "type": "integer", "description": "Unique identifier for this signal row." }, "signal_subtype_slug": { "type": "string", "nullable": true, "description": "Finer-grained subtype, or `null` when the type has no subtype. About 44% of rows are `null`." }, "source_published_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Publication time of the source document, when known." }, "event_date_precision": { "type": "string", "description": "How precise `event_date` is: `day`, `month`, `quarter`, `year` or `unknown`." }, "signal_strength_slug": { "type": "string", "description": "Signal strength: `low`, `medium`, `high` or `very_high`." }, "extraction_confidence": { "type": "number", "nullable": true, "description": "Model confidence for signals extracted by a model, otherwise `null`." } } }, "description": "The matching signal rows, newest first." }, "pagination": { "type": "object", "description": "Page, per-page, total entries and total pages." } }, "description": "Result container." }, "metadata": { "type": "object", "description": "Echo of the filters applied to this request." } } }, "example": { "data": { "signals": [ { "audit": { "user_id": null, "import_id": null, "profile_id": null, "is_backfill": false }, "notes": null, "metadata": { "city": "Austin", "seniority": [ "director" ], "top_titles": [ "Country Manager, US" ], "departments": [ "sales" ], "window_days": 90, "country_code": "US", "active_postings": 3 }, "polarity": "expansion", "is_active": true, "occurs_at": null, "created_at": "2026-06-20T15:02:11.004Z", "event_date": "2026-06-20T14:00:00.000Z", "source_type": "jobs", "country_code": "US", "evidence_url": "https://www.linkedin.com/jobs/view/4224659596", "occurs_until": null, "display_label": "Hired Country Manager", "last_modified": "2026-06-20T15:02:11.004Z", "lead_time_days": 1, "domain_search_id": "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c", "extraction_model": null, "signal_type_slug": "HIRE", "source_record_id": "4224659596", "expansion_signal_id": 580965556, "signal_subtype_slug": "country_manager", "source_published_at": "2026-06-19T08:00:00.000Z", "event_date_precision": "day", "signal_strength_slug": "very_high", "extraction_confidence": 0.91 }, { "audit": { "user_id": null, "import_id": null, "profile_id": null, "is_backfill": false }, "notes": null, "metadata": { "ended_at": null, "headline": "Full-Stack Observability: 7 Tools Engineers Are Switching To in 2026", "share_pct": null, "started_at": null, "share_basis": "declared", "source_type": "linkedin", "advertisement_format": "Single Image Ad" }, "polarity": "expansion", "is_active": true, "occurs_at": null, "created_at": "2026-06-18T08:12:25.883Z", "event_date": "2026-06-18T08:12:25.866Z", "source_type": "ads", "country_code": "US", "evidence_url": null, "occurs_until": null, "display_label": "Full-Stack Observability: 7 Tools Engineers Are Switching To in 2026", "last_modified": "2026-06-18T08:12:25.883Z", "lead_time_days": null, "domain_search_id": "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c", "extraction_model": null, "signal_type_slug": "AD", "source_record_id": "3569a83d-6e96-4bc9-b1a7-abbfa8f4b1ad", "expansion_signal_id": 580965557, "signal_subtype_slug": null, "source_published_at": null, "event_date_precision": "day", "signal_strength_slug": "low", "extraction_confidence": null } ], "pagination": { "page": 1, "per_page": 25, "total_pages": 120, "total_entries": 2990 } }, "metadata": { "filters": { "signal_types": [ "HIRE", "AD" ], "country_codes": [ "US" ], "domain_search_ids": [ "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c" ] } } } } }, "description": "Expansion Signal Search" }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_aa4b46e69c216dc9_ref6", "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_aa4b46e69c216dc9_ref7", "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_aa4b46e69c216dc9_ref8", "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": "Raw, paginated expansion signal rows — the dated evidence behind each company's stage, with source and evidence URL.", "operationId": "expansions_signals_search", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_aa4b46e69c216dc9_ref4", "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**." }, "cities": { "type": "array", "items": { "type": "string" }, "description": "Data-centre cities of DNS signals." }, "per_page": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_aa4b46e69c216dc9_ref5", "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." }, "is_active": { "type": "boolean", "default": true, "example": true, "description": "`true` (the default) returns live signals only; `false` returns retracted signals only." }, "providers": { "type": "array", "items": { "type": "string" }, "description": "Hosting or cloud providers of DNS signals, as named by Cloud Footprint Search." }, "polarities": { "type": "array", "items": { "enum": [ "expansion", "contraction_leading", "contraction_confirming", "contraction_lagging" ], "type": "string", "description": "Allowed values: expansion, contraction_leading, contraction_confirming, contraction_lagging." }, "example": [ "expansion" ], "description": "Signal directions to include. `expansion` marks entry and growth; the `contraction_*` values mark retreat." }, "event_dates": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_aa4b46e69c216dc9_ref3", "type": "array", "items": { "type": "string" }, "example": [ "2026-06-01", "2026-06-30" ], "description": "Date range of the signal event date. The maximum value is the current day." }, "signal_types": { "type": "array", "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_aa4b46e69c216dc9_ref0" } ], "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": [ "EXEC", "HIRE" ], "description": "Signal types to restrict to. Unknown values match nothing." }, "source_types": { "type": "array", "items": { "type": "string" }, "example": [ "jobs", "ads" ], "description": "Source types to restrict to: `jobs`, `ads`, `linkedin`, `news`, `pubrio`." }, "cloud_regions": { "type": "array", "items": { "type": "string" }, "description": "Provider region codes of DNS signals, e.g. eu-central-1." }, "country_codes": { "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "Target markets to restrict to, as ISO 3166-1 alpha-2 codes." }, "exclude_cities": { "type": "array", "items": { "type": "string" }, "description": "Cities to leave out." }, "signal_subtypes": { "type": "array", "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_aa4b46e69c216dc9_ref1" } ], "items": { "type": "string", "description": "Allowed values: marketing_pullback, domain_dropped, entity_dissolution, exhibiting_booth, speaking_breakout, speaking_keynote, sponsorship, key_departure, country_manager, engineering, freelancer, hiring_freeze, job_posting_removal, legal_compliance, local_employee, operations, regional_vp, remote_sales_bd, supply_chain, ip_abandoned, office_closure, partnership_terminated, product_withdrawal, regulatory_surrender, layoffs, content_decay." }, "example": [ "country_manager", "local_employee" ], "description": "Signal subtypes to restrict to. Unknown values match nothing." }, "signal_strengths": { "type": "array", "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_aa4b46e69c216dc9_ref2" } ], "items": { "type": "string", "description": "Allowed values: low, medium, high, very_high." }, "example": [ "high" ], "description": "Signal strengths to restrict to. Unknown values match nothing." }, "domain_search_ids": { "type": "array", "items": { "type": "string" }, "example": [ "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c" ], "description": "Companies to restrict to, by `domain_search_id`." }, "exclude_providers": { "type": "array", "items": { "type": "string" }, "description": "Providers to leave out." }, "exclude_cloud_regions": { "type": "array", "items": { "type": "string" }, "description": "Region codes to leave out." } } } } }, "required": false }, "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Bczf0ngsC6bcl6q0Du2IG", "authority": "official", "conflicts": [], "revisionId": "sdrn_4iDCRIPFDsZRmP0aGdw03" }, { "gaps": [], "pages": [], "sourceId": "sds_2u3p4yN9ciqx-ocEBGR74", "authority": "supplemental", "conflicts": [ "/description", "/requestBody/content/application/json/schema/properties/per_page/maximum" ], "revisionId": "sdrn_sF4Id8BIBdrnOh1M8jbor" }, { "gaps": [ "Missing request body schema." ], "pages": [ 1 ], "sourceId": "sds__jGNe1xgzZjIl2HiJCgCx", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_BxGuvsEio3diUZthn74zf" }, { "gaps": [ "Missing filter parameters" ], "pages": [ 44 ], "sourceId": "sds_4QU1K-UtbB0JEFxtFT9j9", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/properties/per_page/maximum", "/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": [ 1 ], "sourceId": "sds_guN9xfft4HIFSKap1DQ-2", "authority": "supplemental", "conflicts": [ "/responses/400/description", "/responses/429/description", "/responses/500/description", "/requestBody/content/application/json/schema/properties/per_page/maximum" ], "revisionId": "sdrn_mvrUgoaypO60_9wjXWvj9" }, { "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": [], "pages": [], "sourceId": "sds_k5xT0yiL8Ir6VR05kyEBF", "authority": "supplemental", "conflicts": [ "/description", "/requestBody/content/application/json/schema/properties/per_page/maximum" ], "revisionId": "sdrn_-4yhPKLXO0w7ci0VnZLfS" }, { "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": [], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_BPN1iHD5tCVT4d4YJh-Wj" } ], "x-zeroclick-services": [ "expansion" ], "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 expansion)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "expansion", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/people/linkedin/lookup": { "post": { "summary": "Look up a person by LinkedIn URL", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2b3e9520e29446af_ref1", "type": "object", "nullable": true, "description": "Response info depends on specific endpoint." } } }, "example": { "data": { "bio": [ { "url": "http://www.linkedin.com/", "title": "Company Website" }, "..." ], "city": "United States", "name": "Jeff Weiner", "company": { "location": null, "company_name": "LinkedIn", "linkedin_url": "https://www.linkedin.com/company/linkedin", "linkedin_name": "linkedin" }, "headline": "Executive Chairman at LinkedIn / Founding Partner Next Play Ventures", "location": null, "logo_url": "https://media.licdn.com/dms/image/v2/C4D03AQFM3Y2r-OEStw/profile-displayphoto-shrink_200_200/profile-displayphoto-shrink_200_200/0/1515623804978?e=2147483647&v=beta&t=8gxxYGav4qEN7hXdbULm_h_JbZKg9lreAZ7HPXDUbF0", "education": null, "image_url": "https://media.licdn.com/dms/image/v2/C4D16AQFJHyicpAYHXQ/profile-displaybackgroundimage-shrink_200_800/profile-displaybackgroundimage-shrink_200_800/0/1515797967677?e=2147483647&v=beta&t=bAdvQ-o7JZ1b7OKSKau1vB3DMZIHPtefC40_43yzasI", "created_at": "2025-06-08T16:58:16.145Z", "description": "Jeff Weiner is the executive chairman of LinkedIn, where he continues to help LinkedIn realize its vision of creating economic opportunity for every member of the global workforce through mentorship, coaching and advising current leadership. \n\nPrior to becoming executive chairman in June 2020, Jeff was the CEO of LinkedIn. During his 11-year tenure, LinkedIn grew its membership base from 33M to more than 690M, increased its revenue from $78M to over $7.9B and expanded the team from 338 employees to over 16,000.\n\nIn addition to his ongoing work at LinkedIn, Jeff is the founding partner of Next Play Ventures, where he’s focused on investing in and coaching early stage start-ups and growth stage companies. \n\nHe is also a founding LP and serves on the Investment Committee of Concrete Rose Capital, an early stage venture fund focused on investing in diverse founders, start-ups serving underserved communities and/or building diverse teams. \n\nJeff is also the co-founder of The Compassion Project, whose mission is to ensure compassion is taught in every elementary school in the U.S.\n\nHe presently resides on the board of directors of Donorschoose.org. \n\nPrior to LinkedIn, Jeff was an Executive in Residence at Accel Partners and Greylock Partners, primarily focused on advising the leadership teams of the firm's existing consumer technology portfolio companies while also working closely with the firm’s partners to evaluate new investment opportunities.\n\nPreviously, he served in key leadership roles at Yahoo! for over seven years, including Executive Vice President of Yahoo!'s Network Division managing Yahoo's consumer web product portfolio, including Yahoo's Front Page, Mail, Search, and Media products.", "country_code": "US", "linkedin_uid": "22330283", "linkedin_url": "https://www.linkedin.com/in/jeffweiner08", "follower_size": 10410599, "linkedin_name": "jeffweiner08", "connection_size": 500, "recommendations": [ "Akosua Boadi-Agyemang “Personally, Jeff, has impacted my journey so much during his tenure as CEO of LinkedIn. In so doing, he has shown me the true personification of servant leadership. Jeff has showed up for me in ways that have changed the trajectory of my career and life, and he did so without knowing me, initially. While I was searching for an internship in 2017, Jeff showed up (commented on my LinkedIn post) and said “Akosua, would be surprised if something doesn’t materialize.” This played a massive part in where I am in my career at Microsoft today. He showed up to support my first LinkedIn Live stream as a beta tester for the feature. I told him the day and time. I was nervous, had never beta tested anything before. I asked the audience “can anyone see and hear me?” and he showed up, saying, “can hear and see you perfectly”. His support is incredible. When I wrote my first article documenting #theBOLDjourney, Jeff showed up - “This is just the beginning.” Again with the encouragement. To say the least, Jeff has used his power and platform as CEO of LinkedIn to not only empower me but, to uplift millions, globally. In addition, through the #plusonepledge he initiated during his tenure, he ensured that others show up for one another, as well. Jeff, thank you for always showing up. And for embodying the true meaning of the Ngoni Bantu word, “Ubuntu” (I am, because we are).”", "Derek E. Baird, M.Ed. “While I was at Yahoo!, I had the honor of working for Jeff on the Yahoo! Teachers social networking product. Jeff was our executive sponsor on this project and he was our strongest and most passionate advocate. His knowledge of the consumer Internet and youth media space was invaluable and his strategic eye was instrumental in moving our product from a hack day idea into a full beta. On this project Jeff also demonstrated his deep and unwavering commitment to social responsibility. Jeff is a doer. Throughout his tenure on this project he was always more than willing to channel the many resources at Yahoo!, as well as his many connections, to help improve public education in this country. Jeff is a truly exceptional, visionary and inspiring leader. It was a true pleasure to have had the opportunity to work for Jeff Weiner. It was, and continues to be, a highlight of my career.”" ], "similar_profiles": [ { "name": "Rob Coppedge", "headline": null, "linkedin_url": "https://www.linkedin.com/in/coppedge" }, "..." ], "honors_and_awards": null, "recent_activities": [ { "id": "7328934302337945608", "title": "“Next play!” —A mindset I picked up from Jeff, and I believe he got it from Coach K. Doesn’t matter if you just crushed it or slipped up — keep…", "image_url": "https://media.licdn.com/dms/image/v2/D5605AQFsD_LNcQzcKA/videocover-high/B56ZbWa0QpH0B4-/0/1747354093631?e=2147483647&v=beta&t=cqAOZlz3UZdpiX7O-HSMwAROHRS_R8KzIbsp7nAUyfE", "interaction": "Liked by Jeff Weiner", "linkedin_url": "https://www.linkedin.com/posts/akothari_next-play-a-mindset-i-picked-up-from-activity-7328934302337945608-hfLO" }, "..." ], "employment_history": [ { "title": "LinkedIn", "duration": "16 years 7 months", "logo_url": null, "positions": [ { "meta": "Jul 2020 - Present 5 years", "title": "Executive Chairman", "end_date": "Present", "location": null, "subtitle": "LinkedIn", "start_date": "Jul 2020", "description_html": null }, { "meta": "Dec 2008 - Jun 2020 11 years 7 months", "title": "CEO", "end_date": "Jun 2020", "location": null, "subtitle": "LinkedIn", "start_date": "Dec 2008", "description_html": null } ], "company_name": "LinkedIn", "linkedin_url": "https://www.linkedin.com/company/linkedin?trk=public_profile_experience-group-header", "linkedin_name": "linkedin", "unformatted_description": null }, "..." ], "people_also_viewed": [ { "name": "Rob Coppedge", "headline": null, "location": "Portland, Oregon Metropolitan Area", "linkedin_url": "https://www.linkedin.com/in/coppedge?trk=public_profile_browsemap-profile" }, "..." ] } } } }, "description": "Successful response containing real-time linkedin details." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2b3e9520e29446af_ref2", "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_2b3e9520e29446af_ref3", "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_2b3e9520e29446af_ref4", "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": "Retrieve person details using a LinkedIn profile URL. Provides real-time data retrieval.", "operationId": "people_lookup_linkedin", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "linkedin_url" ], "properties": { "linkedin_url": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_2b3e9520e29446af_ref0", "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/`" }, "linkedin_urls": { "type": "array", "items": { "type": "string" } } } } } }, "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": [], "revisionId": "sdrn_sF4Id8BIBdrnOh1M8jbor" }, { "gaps": [], "pages": [ 46 ], "sourceId": "sds_4QU1K-UtbB0JEFxtFT9j9", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "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": [ "Missing request body schema", "Missing response schema" ], "pages": [], "sourceId": "sds_i8deqX6-Fp5gi7tUPGTPZ", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn__3FNTGpfBMjPTVVLytG7Z" }, { "gaps": [], "pages": [], "sourceId": "sds_IPv6UWBYPyNKT9NMyTwea", "authority": "supplemental", "conflicts": [], "revisionId": "sdrn_a0YRW8YuTdXiXKjCUxebY" }, { "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", "/operationId" ], "revisionId": "sdrn__bR6EtgaNMMbyd-B4-j3A" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_LVHP6L9DTeiWEhM-Xw--p", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/linkedin_url/description" ], "revisionId": "sdrn_rdbgFFRhwn5K3ge7vk2Mi" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_BPN1iHD5tCVT4d4YJh-Wj" } ], "x-zeroclick-services": [ "linkedin" ], "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 linkedin)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "linkedin", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/people/lookup": { "post": { "summary": "Look up a person by ID", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b9972eed7b9e3e47_ref2", "type": "object", "nullable": true, "description": "Response info depends on specific endpoint." }, "metadata": { "type": "object", "description": "Request context — `is_enrichment_available`, `parameters`, `filters`, and (when requested) a `profile` block with `credit`, `topup_credit` and `total_credit_cost`." } } }, "example": { "data": { "city": "Bentonville", "name": "Doug McMillon", "state": "Arkansas", "title": "President & CEO", "emails": null, "phones": null, "company": { "phones": null, "industry": "Retail", "location": "United States", "logo_url": "https://buckets.pubrio.com/company-logo/NzU3MDIzMjY3aWxqOXNzbmoxd2FsbWFydC5jb21saW5rZWRpbl8zMzMxOTgxMg==.jpg", "domain_id": 26067151, "domain_ids": [ 757023267, 368242703, 26067151 ], "company_url": "http://walmart.com", "twitter_url": "https://twitter.com/walmart", "youtube_url": "http://youtube.com/user/walmart", "company_name": "Walmart", "company_size": 466000, "facebook_url": "http://facebook.com/walmart", "founded_year": 1962, "linkedin_url": "http://www.linkedin.com/company/walmart", "instagram_url": "http://instagram.com/walmart", "crunchbase_url": null, "domain_search_id": "2a0d6cd7-cc10-44d6-94ec-41fd528a11b6", "company_size_printed": "466,000" }, "contacts": null, "headline": "President & CEO at Walmart Inc.", "keywords": null, "location": "United States", "functions": null, "last_name": "McMillon", "seniority": "c_suite", "first_name": "Doug", "github_url": null, "departments": [ "c_suite" ], "saved_lists": null, "twitter_url": null, "facebook_url": null, "linkedin_url": "http://www.linkedin.com/in/dougmcmillon", "subdepartments": [ "executive" ], "people_search_id": "134591fb-f0fa-41ba-9c8c-f1eb8aab8946", "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" } ] } } } }, "description": "Successful response containing company details." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b9972eed7b9e3e47_ref3", "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_b9972eed7b9e3e47_ref4", "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_b9972eed7b9e3e47_ref5", "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": "Retrieve detailed information about a specific person using their Pubrio search ID or LinkedIn URL.", "operationId": "people_lookup", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "title": "People Search ID", "required": [ "people_search_id" ] }, { "title": "LinkedIn URL", "required": [ "linkedin_url" ] }, { "title": "Wantedly URL", "required": [ "wantedly_url" ] }, { "title": "104 URL", "required": [ "tw104_url" ] }, { "title": "RocketPunch URL", "required": [ "rocketpunch_url" ] }, { "title": "Remember URL", "required": [ "remember_url" ] }, { "title": "YOUTRUST URL", "required": [ "youtrust_url" ] } ], "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "tw104_url": { "type": "string", "description": "104 (Taiwan) profile URL for the person." }, "linkedin_url": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b9972eed7b9e3e47_ref1", "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/`" }, "remember_url": { "type": "string", "description": "Remember profile URL for the person." }, "wantedly_url": { "type": "string", "description": "Wantedly profile URL for the person." }, "youtrust_url": { "type": "string", "description": "YOUTRUST profile URL for the person." }, "exclude_fields": { "type": "array", "items": { "type": "string" }, "description": "Field slugs to omit from the returned record." }, "rocketpunch_url": { "type": "string", "description": "RocketPunch profile URL for the person." }, "people_search_id": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_b9972eed7b9e3e47_ref0", "type": "string", "description": "A unique identifier for the people search operation." }, "is_enrichment_available": { "type": "boolean", "example": true, "description": "Run realtime enrichment when the stored record is incomplete — fills in contact details, employment history and social profiles. Consumes credits. Leave unset for a cache-only read." }, "is_profile_metadata_available": { "type": "boolean", "example": true, "description": "Include your workspace credit accounting for this call under `metadata.profile`." } }, "description": "Provide at least one of the following: People Search ID (people_search_id); LinkedIn URL (linkedin_url); Wantedly URL (wantedly_url); 104 URL (tw104_url); RocketPunch URL (rocketpunch_url); Remember URL (remember_url); YOUTRUST URL (youtrust_url)." } } }, "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/people_search_id/format" ], "revisionId": "sdrn_sF4Id8BIBdrnOh1M8jbor" }, { "gaps": [], "pages": [], "sourceId": "sds_2_zVRTPeLJMyYOBNe6hz9", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/people_search_id/format" ], "revisionId": "sdrn_mEnAb35irWN-ghEVchmM5" }, { "gaps": [], "pages": [ 36 ], "sourceId": "sds_4QU1K-UtbB0JEFxtFT9j9", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "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": [ "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": [ "The documentation includes fields is_enrichment_available and is_profile_metadata_available in the schema, but these are explicitly forbidden by extraction instructions." ], "pages": [ 1 ], "sourceId": "sds_QvXxrXiDgyQUsbX0lTf0-", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/linkedin_url/description", "/requestBody/content/application/json/schema/properties/people_search_id/format" ], "revisionId": "sdrn_t4izOJVtXBkNh7j7LykZA" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_BPN1iHD5tCVT4d4YJh-Wj" } ], "x-zeroclick-services": [ "lookup" ], "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 lookup)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "lookup", "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 } ] } } }, "/people/search/similar": { "post": { "summary": "Search for similar people", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_5b660ffce92faba2_ref20", "type": "object", "nullable": true, "description": "Response info depends on specific endpoint." }, "metadata": { "type": "object", "description": "Request context — echoed `filters` and `parameters`, plus a `profile` block with `credit`, `topup_credit` and `total_credit_cost` when credit accounting is requested." } } }, "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, "similarity_score": 0.97, "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": 1, "total_entries": 25, "total_display_pages": 1 } }, "metadata": { "filters": { "people_titles": [ "chief executive officer" ] }, "profile": null } } } }, "description": "Successful response containing people search details." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_5b660ffce92faba2_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_5b660ffce92faba2_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_5b660ffce92faba2_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": "Find people similar to a reference person or title. Supply one reference (`people_search_id`, `linkedin_url`, `linkedin_urls`, `peoples` or `people_titles`). Each person carries a `similarity_score` between 0 and 1. The reference only sets what similar means; every other filter narrows the results.", "operationId": "people_search_similar", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "title": "peoples", "required": [ "peoples" ] }, { "title": "people_search_id", "required": [ "people_search_id" ] }, { "title": "people_titles", "required": [ "people_titles" ] }, { "title": "linkedin_url", "required": [ "linkedin_url" ] }, { "title": "linkedin_urls", "required": [ "linkedin_urls" ] } ], "properties": { "page": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_5b660ffce92faba2_ref18", "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**." }, "domains": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_5b660ffce92faba2_ref13", "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." }, "peoples": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_5b660ffce92faba2_ref3", "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A list of unique identifiers (people_search_id) used for people search operations." }, "per_page": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_5b660ffce92faba2_ref17", "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_5b660ffce92faba2_ref12", "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_5b660ffce92faba2_ref7", "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." }, "person_id": { "type": "string" }, "departments": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_5b660ffce92faba2_ref5", "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_5b660ffce92faba2_ref1", "type": "string", "example": "king", "description": "Filter search results to include a specific people name." }, "search_term": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_5b660ffce92faba2_ref0", "type": "string", "example": "pubrio", "description": "A string of words over which we want to filter the results." }, "linkedin_url": { "type": "string", "description": "A single LinkedIn profile URL to use as the reference." }, "linkedin_urls": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_5b660ffce92faba2_ref11", "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_titles": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_5b660ffce92faba2_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_filters": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_5b660ffce92faba2_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." }, "people_locations": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_5b660ffce92faba2_ref8", "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." }, "people_search_id": { "type": "string", "description": "Pubrio person id to use as the reference." }, "similarity_score": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_5b660ffce92faba2_ref16", "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_5b660ffce92faba2_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_5b660ffce92faba2_ref14", "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_5b660ffce92faba2_ref4", "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." }, "department_functions": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_5b660ffce92faba2_ref6", "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_5b660ffce92faba2_ref10", "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/`" }, "is_enable_similarity_search": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_5b660ffce92faba2_ref15", "type": "boolean", "description": "When enabled, the filters listed above that support similarity searches can be filled with free text for specific IDs." } }, "description": "Provide at least one of the following: peoples (peoples); people_search_id (people_search_id); people_titles (people_titles); linkedin_url (linkedin_url); linkedin_urls (linkedin_urls)." } } }, "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": [ "Missing full list of reference identifiers" ], "pages": [ 1 ], "sourceId": "sds_4QU1K-UtbB0JEFxtFT9j9", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/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": [ "The documentation references several schema components (e.g., management_levels, departments, functions) that are not fully defined in the provided snippet but are referenced as existing in the Filters section." ], "pages": [ 1 ], "sourceId": "sds_EPNYatFHa8-9XTHbavXl2", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/linkedin_urls/description", "/requestBody/content/application/json/schema/properties/people_titles/description" ], "revisionId": "sdrn_UIg0fVKWY2846QPdEV5Ws" }, { "gaps": [], "pages": [], "sourceId": "sds_h08SQfWpyH2nTeBVcHCm2", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/per_page/maximum", "/requestBody/content/application/json/schema/properties/similarity_score/format" ], "revisionId": "sdrn_b8WRnQj-2PksT0RYh9jPN" }, { "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": [], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_BPN1iHD5tCVT4d4YJh-Wj" } ], "x-zeroclick-services": [ "lookalike" ], "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 lookalike)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "lookalike", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/redeem/people": { "post": { "summary": "Redeem a person's contact details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7e12527016858a4b_ref3" } ], "nullable": true, "properties": { "peoples": { "type": "array", "items": { "type": "object" }, "description": "The redeemed people. `emails` and `phones` are `null` — not `[]` — when nothing is found for that person, so guard before iterating. `total_credit_cost` reflects only successful matches and is `0` when nothing was redeemed; cost scales with how many contact types you request." }, "profile": { "type": "object", "properties": { "credit": { "type": "integer" }, "topup_credit": { "type": "integer" }, "total_credit_cost": { "type": "integer" } } } }, "description": "Response info depends on specific endpoint." } } }, "example": { "data": { "peoples": [ { "emails": [ { "type": "email-personal", "value": "example@gmail.com", "status": null }, { "type": "email-work", "value": "example@pubrio.com", "status": "Verified" } ], "phones": [ { "type": "phone", "value": "+1123456789", "status": null } ], "people_search_id": "e37ccf38-ea8f-422e-9874-cb23b15e8fe4" } ], "profile": { "credit": 450376, "topup_credit": 235237, "total_credit_cost": 45 } } } } }, "description": "Successful response containing redeem people details." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7e12527016858a4b_ref4", "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_7e12527016858a4b_ref5", "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_7e12527016858a4b_ref6", "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": "Spend credits to unlock full contact details (email, phone) for a specific person.", "operationId": "redeem_people", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "title": "People Search ID", "required": [ "people_search_id", "people_contact_types" ] }, { "title": "LinkedIn URL", "required": [ "linkedin_url", "people_contact_types" ] } ], "properties": { "person_id": { "type": "string" }, "linkedin_url": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7e12527016858a4b_ref1", "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_search_id": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7e12527016858a4b_ref0", "type": "string", "description": "A unique identifier for the people search operation." }, "people_contact_types": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_7e12527016858a4b_ref2", "type": "array", "items": { "type": "string", "description": "Allowed values: email-work, email-personal, phone." }, "example": [ "email-work", "email-personal", "phone" ], "description": "Which contact details to redeem. Use exactly `email-work`, `email-personal` and/or `phone` — resolve the live list from the `people contact type` endpoint under the Filters tab.\n\n**Unrecognised values are not rejected.** A misspelling such as `work_email` returns HTTP 200 with `emails: null`, `phones: null` and `total_credit_cost: 0` — identical to a person genuinely having no contact data. If redemptions look universally empty, check these slugs first." } }, "description": "Provide at least one of the following: People Search ID (people_search_id, people_contact_types); LinkedIn URL (linkedin_url, people_contact_types)." } } }, "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/people_search_id/format" ], "revisionId": "sdrn_sF4Id8BIBdrnOh1M8jbor" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_4QU1K-UtbB0JEFxtFT9j9", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId", "/requestBody/content/application/json/schema/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": [ "The schema for the response body is partially defined in the OpenAPI snippet; full structure relies on the provided example." ], "pages": [ 1 ], "sourceId": "sds_fe7ACz5SChoQEe5fzalOz", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/anyOf", "/requestBody/content/application/json/schema/properties/linkedin_url/description", "/requestBody/content/application/json/schema/properties/people_search_id/format", "/requestBody/content/application/json/schema/properties/people_contact_types/items/enum", "/requestBody/content/application/json/schema/properties/people_contact_types/description" ], "revisionId": "sdrn_UhtA7XlU8cxq8oJsLiqyv" }, { "gaps": [ "Exact schema for items in peoples array response", "Validation logic for mutual exclusivity of people_search_id and linkedin_url" ], "pages": [ 1 ], "sourceId": "sds_GSpq9b1mCVzlyxet3sGTK", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required", "/requestBody/content/application/json/schema/properties/linkedin_url/description", "/requestBody/content/application/json/schema/properties/people_search_id/description", "/requestBody/content/application/json/schema/properties/people_contact_types/items/enum" ], "revisionId": "sdrn_1rAnE6tkDcV8ucEOBvBz-" }, { "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": [], "pages": [], "sourceId": "sds_LqxsLzdRIRs629kd5zGoP", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/people_search_id/format" ], "revisionId": "sdrn_ZbpOKpeJ2ZAqc1F1Dcjzs" }, { "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": [], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_BPN1iHD5tCVT4d4YJh-Wj" } ], "x-zeroclick-services": [ "contacts" ], "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 contacts)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "contacts", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/redeem/people/contact/lookup": { "post": { "summary": "Look up a person by contact identifier", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_bdf8a7fae97f9598_ref7" } ], "nullable": true, "properties": { "peoples": { "type": "array", "items": { "type": "object" }, "description": "The redeemed people. `emails` and `phones` are `null` — not `[]` — when nothing is found for that person, so guard before iterating. `total_credit_cost` reflects only successful matches and is `0` when nothing was redeemed; cost scales with how many contact types you request." } }, "description": "Response info depends on specific endpoint." } } }, "example": { "data": { "peoples": [ { "match": { "input": { "type": "email-work", "value": "king.lai@pubrio.com" }, "confidence": "exact", "input_index": 0, "is_duplicate_input": false }, "domain": "pubrio.com", "last_name": "Lai", "first_name": "King", "people_name": "King Lai", "company_name": "Pubrio", "people_search_id": "e37ccf38-ea8f-422e-9874-cb23b15e8fe4" } ], "profile": { "credit": 450375, "topup_credit": 235236, "total_credit_cost": 1 } } } } }, "description": "Successful response containing the matched person and match metadata." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_bdf8a7fae97f9598_ref8", "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_bdf8a7fae97f9598_ref9", "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_bdf8a7fae97f9598_ref10", "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": "Reverse-lookup a person by email, phone, or first and last name plus domain or company. Returns the matched person's `people_search_id` and base details, plus `match` metadata describing how the match was made. Charges 1 credit per billable match.", "operationId": "redeem_people_contact_lookup", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "title": "Email", "required": [ "email" ] }, { "title": "Phone", "required": [ "phone" ] }, { "title": "Name + Domain", "required": [ "first_name", "last_name", "domain" ] }, { "title": "Name + Company", "required": [ "first_name", "last_name", "company" ] } ], "properties": { "email": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_bdf8a7fae97f9598_ref0", "type": "string", "example": "person@example.com", "description": "Work or personal email address to look up. The system normalizes case and whitespace before matching." }, "phone": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_bdf8a7fae97f9598_ref1", "type": "string", "example": "+15551234567", "description": "Phone number to look up. International (E.164) format is recommended." }, "domain": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_bdf8a7fae97f9598_ref4", "type": "string", "example": "pubrio.com", "description": "Company domain, such as `stripe.com`. A website such as `https://www.stripe.com/` is read as its domain. With `first_name` + `last_name`, finds the person by name at this company." }, "company": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_bdf8a7fae97f9598_ref5", "type": "string", "example": "Pubrio", "description": "Company name. With `first_name` + `last_name`, finds the person by name at this company when `domain` is not given." }, "last_name": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_bdf8a7fae97f9598_ref3", "type": "string", "example": "Lai", "description": "Last name. Used with `first_name` and either `domain` or `company` to find the person by name." }, "person_id": { "type": "string" }, "first_name": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_bdf8a7fae97f9598_ref2", "type": "string", "example": "King", "description": "First name. With `last_name` and either `domain` or `company`, finds the person by name. A row with no `email` or `phone` is always searched this way." }, "company_name": { "type": "string" }, "is_enable_similarity_search": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_bdf8a7fae97f9598_ref6", "type": "boolean", "default": false, "example": true, "description": "Only changes rows that have an `email` or `phone`. When `true`, a row whose email or phone finds nobody is then searched by name (`first_name`, `last_name`, and `domain` or `company`). A row with only a name and a company is always searched by name and does not need this." } }, "description": "Provide at least one of the following: Email (email); Phone (phone); Name + Domain (first_name, last_name, domain); Name + Company (first_name, last_name, company)." } } }, "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/email/format" ], "revisionId": "sdrn_sF4Id8BIBdrnOh1M8jbor" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_4QU1K-UtbB0JEFxtFT9j9", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "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": [ "Exact schema for response object not fully defined in text", "Full list of error codes" ], "pages": [ 1 ], "sourceId": "sds_eyD0ZhESXIOzPe7q1otPe", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fdpIoGThvrQIxAVYo-QDz" }, { "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": [], "pages": [], "sourceId": "sds_LqxsLzdRIRs629kd5zGoP", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/email/format" ], "revisionId": "sdrn_ZbpOKpeJ2ZAqc1F1Dcjzs" }, { "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": [], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_BPN1iHD5tCVT4d4YJh-Wj" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_uizKMGF_mEAnCLTtPQm4v", "authority": "supplemental", "conflicts": [ "/description", "/requestBody/content/application/json/schema/properties/email/format", "/requestBody/content/application/json/schema/properties/domain/description", "/requestBody/content/application/json/schema/properties/company/description", "/requestBody/content/application/json/schema/properties/last_name/description", "/requestBody/content/application/json/schema/properties/first_name/description", "/requestBody/content/application/json/schema/properties/is_enable_similarity_search/description" ], "revisionId": "sdrn_lsMnN3uq99rY3_2eeuG5-" } ], "x-zeroclick-services": [ "contacts" ], "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 contacts)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "contacts", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/redeem/people/contact/lookup/batch": { "post": { "summary": "Bulk-look up people by contact identifier", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_82eb7463bd1e9efe_ref2" } ], "nullable": true, "properties": { "peoples": { "type": "array", "items": { "type": "object" }, "description": "The redeemed people. `emails` and `phones` are `null` — not `[]` — when nothing is found for that person, so guard before iterating. `total_credit_cost` reflects only successful matches and is `0` when nothing was redeemed; cost scales with how many contact types you request." } }, "description": "Response info depends on specific endpoint." } } }, "example": { "data": { "peoples": [ { "match": { "input": { "type": "email-work", "value": "king.lai@pubrio.com" }, "confidence": "exact", "input_index": 0, "is_duplicate_input": false }, "domain": "pubrio.com", "people_name": "King Lai", "company_name": "Pubrio", "people_search_id": "e37ccf38-ea8f-422e-9874-cb23b15e8fe4" }, { "match": { "input": { "type": "domain", "value": "example.com" }, "confidence": "similarity_domain", "input_index": 1, "is_duplicate_input": false }, "domain": "example.com", "people_name": "John Smith", "company_name": "Example", "people_search_id": "1c4f0a9d-9a8e-4ab0-9b07-2cd09c4a3a6b" } ], "profile": { "credit": 450374, "topup_credit": 235236, "total_credit_cost": 2 } } } } }, "description": "Successful response containing matched people and per-record match metadata." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_82eb7463bd1e9efe_ref3", "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_82eb7463bd1e9efe_ref4", "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_82eb7463bd1e9efe_ref5", "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": "Batch version of `/redeem/people/contact/lookup`. Submit up to your subscription's bulk size limit in a single request. Each entry in `peoples` accepts the same identifiers as the single-lookup body. Charges 1 credit per billable match. Duplicate inputs (the same email, phone, or name + company sent again) and unmatched entries are not charged.", "operationId": "redeem_people_contact_lookup_batch", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "peoples" ], "properties": { "peoples": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_82eb7463bd1e9efe_ref0", "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "domain": { "type": "string" }, "company": { "type": "string" }, "last_name": { "type": "string" }, "first_name": { "type": "string" }, "company_name": { "type": "string" } } }, "example": [ { "email": "king.lai@pubrio.com" }, { "domain": "example.com", "last_name": "Smith", "first_name": "John" } ], "maxItems": 50, "description": "Array of lookup specs. Each entry takes `email`, `phone`, or `first_name` + `last_name` + `domain`/`company`, the same as the single-lookup body. Capped by your subscription's bulk size limit. A request where no entry has any of these is refused with `400`." }, "person_ids": { "type": "array", "items": { "type": "string" } }, "is_enable_similarity_search": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_82eb7463bd1e9efe_ref1", "type": "boolean", "default": false, "example": true, "description": "Only changes rows that have an `email` or `phone`. When `true`, a row whose email or phone finds nobody is then searched by name (`first_name`, `last_name`, and `domain` or `company`). A row with only a name and a company is always searched by name and does not need this." } } } } }, "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": [], "revisionId": "sdrn_sF4Id8BIBdrnOh1M8jbor" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_4QU1K-UtbB0JEFxtFT9j9", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "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": [ "Exact schema for response object not fully defined in text", "Full list of error codes" ], "pages": [ 1 ], "sourceId": "sds_eyD0ZhESXIOzPe7q1otPe", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fdpIoGThvrQIxAVYo-QDz" }, { "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": [], "pages": [], "sourceId": "sds_LqxsLzdRIRs629kd5zGoP", "authority": "supplemental", "conflicts": [], "revisionId": "sdrn_ZbpOKpeJ2ZAqc1F1Dcjzs" }, { "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": [ "The exact bulk size limit is documented as 50 in instructions, but the schema description refers to subscription limits." ], "pages": [ 1 ], "sourceId": "sds_q45oZD6EpG93xfWhUBxJx", "authority": "supplemental", "conflicts": [ "/responses/400/description", "/responses/429/description", "/responses/500/description", "/description", "/requestBody/content/application/json/schema/properties/peoples/description", "/requestBody/content/application/json/schema/properties/is_enable_similarity_search/description" ], "revisionId": "sdrn_0582QM6nf43ocXt4CuiUG" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_BPN1iHD5tCVT4d4YJh-Wj" } ], "x-zeroclick-services": [ "contacts" ], "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 contacts)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "dynamic", "currency": "USD", "min": "0.010000" }, "rates": [ { "service": "contacts", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/technologies/lookup": { "post": { "summary": "Look up a technology", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_af977ff435c1afd7_ref4", "type": "object", "nullable": true, "description": "Response info depends on specific endpoint." }, "metadata": { "type": "object", "description": "Request context: `is_enrichment_available` indicates whether realtime enrichment ran for this lookup." } } }, "example": { "data": [ { "category_id": 1, "technologies": [ { "icon": "Google Ads.svg", "name": "Google Ads", "tag_id": 4580, "version": null, "website": "https://ads.google.com/", "location": "pubrio.com", "logo_url": "https://buckets.pubrio.com/technology-logo/NDU4MGIyOXNtYjhheGdvb2dsZS1hZHM=.jpg", "last_detected": null, "first_detected": "2023-01-07T06:40:56.597287" } ], "category_name": "Advertising" }, "..." ] } } }, "description": "Successful response containing company technology details." }, "400": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_af977ff435c1afd7_ref5", "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_af977ff435c1afd7_ref6", "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_af977ff435c1afd7_ref7", "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": "Retrieve detailed information about a specific technology used by companies.", "operationId": "technologies_lookup", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "title": "Domain Search ID", "required": [ "domain_search_id" ] }, { "title": "Domain", "required": [ "domain" ] }, { "title": "LinkedIn URL", "required": [ "linkedin_url" ] }, { "title": "Domain ID", "required": [ "domain_id" ] } ], "properties": { "domain": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_af977ff435c1afd7_ref1", "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." }, "domain_id": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_af977ff435c1afd7_ref3", "type": "integer", "description": "A unique identifier for the domain search operation." }, "tw104_url": { "type": "string", "description": "104 (Taiwan) profile URL for the company." }, "tiktok_url": { "type": "string", "description": "TikTok profile URL for the company." }, "linkedin_url": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_af977ff435c1afd7_ref2", "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/`" }, "remember_url": { "type": "string", "description": "Remember profile URL for the company." }, "wantedly_url": { "type": "string", "description": "Wantedly profile URL for the company." }, "youtrust_url": { "type": "string", "description": "YOUTRUST profile URL for the company." }, "technology_id": { "type": "string" }, "technology_ids": { "type": "array", "items": { "type": "string" } }, "rocketpunch_url": { "type": "string", "description": "RocketPunch profile URL for the company." }, "domain_search_id": { "$ref": "#/components/schemas/sds_Bczf0ngsC6bcl6q0Du2IG_af977ff435c1afd7_ref0", "type": "string", "description": "A unique identifier for the company search operation." }, "is_enrichment_available": { "type": "boolean", "example": true, "description": "Run realtime enrichment when the stored record is incomplete. Consumes credits. The response echoes whether it ran in `metadata.is_enrichment_available`." } }, "description": "Provide at least one of the following: Domain Search ID (domain_search_id); Domain (domain); LinkedIn URL (linkedin_url); Domain ID (domain_id)." } } }, "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/domain_search_id/format" ], "revisionId": "sdrn_sF4Id8BIBdrnOh1M8jbor" }, { "gaps": [], "pages": [], "sourceId": "sds_2_zVRTPeLJMyYOBNe6hz9", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/domain_search_id/format" ], "revisionId": "sdrn_mEnAb35irWN-ghEVchmM5" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_4QU1K-UtbB0JEFxtFT9j9", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId", "/requestBody/content/application/json/schema/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": [ "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": [ "The documentation includes is_enrichment_available in the schema, but instructions explicitly forbid its inclusion." ], "pages": [ 1 ], "sourceId": "sds_qaGzc3fzPpJesRSKe95GP", "authority": "supplemental", "conflicts": [ "/requestBody/content/application/json/schema/properties/domain/description", "/requestBody/content/application/json/schema/properties/linkedin_url/description", "/requestBody/content/application/json/schema/properties/domain_search_id/format" ], "revisionId": "sdrn_fyqru7YlnFyoaOqwAtF6m" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_SoF6ZSAFkXhf4AW0Sf1Tr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_BPN1iHD5tCVT4d4YJh-Wj" } ], "x-zeroclick-services": [ "lookup" ], "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 lookup)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "lookup", "meter": "credits", "unit": "credit", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ] } } }, "/zeroclick/agent/quote": { "post": { "operationId": "sellerAgentQuote", "summary": "Get a free seller API quote and purchase guide", "description": "Describe your task to get the matching API contract, prices, prerequisites and next steps. This is a $0 wallet-proof lookup, not the seller's paid service. No purchase is executed. Without a wallet, use /zeroclick/agent/guide.", "servers": [ { "url": "https://agents.pubrio.com/zcj/eoliygaop6pu" } ], "security": [ { "sellerAgentX402": [] }, { "sellerAgentMpp": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "goal": { "type": "string", "minLength": 1, "maxLength": 2000, "description": "Describe the task and known inputs. Do not include credentials." }, "quantity": { "description": "Number of API calls, not returned items. Omit when unknown; describe desired output in goal.", "type": "integer", "minimum": 1, "maximum": 1000000 }, "budgetUsd": { "description": "Total cash budget in USD. A quote does not authorize spending.", "type": "string", "pattern": "^(0|[1-9]\\d{0,8})(\\.\\d{1,6})?$" }, "budgetExclusive": { "type": "boolean" }, "reviewAfterCalls": { "type": "integer", "minimum": 1, "maximum": 1000000 }, "requirements": { "type": "string", "minLength": 1, "maxLength": 300 }, "humanAvailable": { "description": "Whether a human is in the loop. False recommends anonymous auth for a new autonomous identity; omit when unknown. Executing a human's request without further interruptions does not by itself mean false.", "type": "boolean" }, "payment": { "description": "Known payment method for the eventual purchase, independent of this free lookup's wallet proof.", "type": "string", "enum": [ "x402", "mpp", "card" ] } }, "required": [ "goal" ], "additionalProperties": false }, "example": { "goal": "Find the available services, prices and purchase steps" } } } }, "responses": { "200": { "description": "Task guidance; inspect status before executing anything", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "status": { "type": "string", "enum": [ "quoted", "ready", "needs_input", "blocked", "unknown", "unsupported", "unavailable" ] }, "priceUsd": { "type": "string", "const": "0" }, "guide": { "type": "string", "description": "Markdown guidance containing the task result, exact contract, pricing and next steps when available. No purchase is executed." }, "guideUrl": { "type": "string", "format": "uri", "description": "Wallet-free advisor endpoint for further planning or recovery." } }, "required": [ "status", "priceUsd", "guide", "guideUrl" ], "additionalProperties": false } } } }, "402": { "description": "$0 x402 or MPP wallet proof required; sign and retry the same request. No funds are transferred." }, "503": { "description": "Advisor unavailable; use the wallet-free guide or direct storefront references" } }, "x-payment-info": { "access": "payg", "price": { "mode": "fixed", "currency": "USD", "amount": "0" }, "protocols": [ { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } }, { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "method": "tempo", "intent": "charge", "description": "Free seller advisor lookup" } ] } } } }, "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/eoliygaop6pu/openapi.json", "services": "https://agents.pubrio.com/zcj/eoliygaop6pu/services", "serviceSpecTemplate": "https://agents.pubrio.com/zcj/eoliygaop6pu/services/{slug}/openapi.json", "searchTemplate": "https://agents.pubrio.com/zcj/eoliygaop6pu/openapi.json?q={text}", "operationTemplate": "https://agents.pubrio.com/zcj/eoliygaop6pu/openapi.json?path={path}&method={method}", "firstPage": "https://agents.pubrio.com/zcj/eoliygaop6pu/openapi.json?page=1" } }