{ "openapi": "3.1.0", "x-zeroclick-navigation": { "fullSpec": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/openapi.json", "services": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/services", "serviceSpecTemplate": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/services/{slug}/openapi.json", "searchTemplate": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/openapi.json?q={text}", "operationTemplate": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/openapi.json?path={path}&method={method}", "firstPage": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/openapi.json?page=1", "instructions": [ "Use this spec if it contains the operation and details you need. Otherwise, search or open a relevant service spec using the links below.", "Find service slugs in x-zeroclick-services or x-payment-info.rates[].service; use them in serviceSpecTemplate, never as request values.", "URL-encode template values. Search is ranked; service, path, and method filters are exact. Filters combine.", "Pages contain up to 10 operations; follow info.x-next or the Link header if you need more results. Shared operations retain all selector values." ] }, "info": { "title": "Pubrio", "version": "1.0.0", "description": "Pubrio detects when companies enter new markets and returns the company and people data behind each move. Expansion signals (local hiring, new offices and entities, localized ads, news, cloud hosting) are typed, dated and tied to evidence across 200+ markets, with strong coverage of Asia-Pacific and other markets that Western-built datasets miss. The graph covers 800M+ companies and 560M+ contacts from 50+ local data sources, refreshed daily. Search companies, people, job postings, news, ads and cloud footprints with filters or a plain-language query; look up records by domain, LinkedIn URL or Pubrio id; find lookalike companies and people; read hiring, news, advertising and cloud insights for one company; and reveal verified work emails, personal emails and phone numbers. Each call costs the number of credits listed on its endpoint. This server is a pay-per-use, transparent proxy in front of Pubrio's own API: it handles identity, payment, and proxying. Agents can purchase autonomously or with their human's approval. The complete verified paid surface is listed at /openapi.json, the source of truth for available operations. Each operation here carries its live price in x-payment-info. Use the operations and details here when they meet your needs. Filtered specs contain only matching operations; if you cannot find what you need here, use search or the service catalog. The live catalog at /manifest.json is authoritative for prices and any free included units (prices[].includedUnits) - some meters include free usage per account before any charge, reserved for agents claimed by a human with a verified email.", "contact": { "email": "support@pubrio.com" }, "x-guidance": "This is a filtered API reference. Request and response schemas are preserved. Shared operations retain selector values and prices for all their services; service slugs are pricing labels, never request values. If this spec lacks what you need, use the navigation links to search or open a relevant service spec." }, "x-service-info": { "docs": { "homepage": "https://www.pubrio.com", "apiReference": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/openapi.json", "llms": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/llms.txt" } }, "externalDocs": { "url": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/llms-full.txt", "description": "How to authenticate, pay, and call this API; links the upstream API reference." }, "servers": [ { "url": "https://agents.pubrio.com/zcj/1a9mcogbgy5u", "description": "Pay-per-use access to Pubrio's API" } ], "security": [ { "payPerUse": [] } ], "components": { "securitySchemes": { "payPerUse": { "type": "apiKey", "in": "header", "name": "x-payment", "description": "Pay-per-use access. An unpaid call returns 402 Payment Required with a signed challenge; settle it with a supported payment method (x402 or MPP today) and retry with the proof in this header (x402) or as Authorization: Payment (MPP; use ZC-Agent-Authorization for a separate buyer bearer). No upstream API key is needed, and an agent without a payment method can set one up instantly at no cost." }, "sellerAgentX402": { "type": "apiKey", "in": "header", "name": "Payment-Signature", "description": "Signed $0 x402 proof from the 402 challenge" }, "sellerAgentMpp": { "type": "http", "scheme": "Payment", "description": "Signed $0 MPP proof from the 402 challenge" } }, "schemas": { "sds_Bczf0ngsC6bcl6q0Du2IG_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_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." } } }, "paths": { "/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 } ] } } }, "/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 } ] } } } }, "x-zeroclick-navigation-footer": { "instructions": [ "Use this spec if it contains the operation and details you need. Otherwise, search or open a relevant service spec using the links below.", "Find service slugs in x-zeroclick-services or x-payment-info.rates[].service; use them in serviceSpecTemplate, never as request values.", "URL-encode template values. Search is ranked; service, path, and method filters are exact. Filters combine.", "Pages contain up to 10 operations; follow info.x-next or the Link header if you need more results. Shared operations retain all selector values." ], "fullSpec": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/openapi.json", "services": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/services", "serviceSpecTemplate": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/services/{slug}/openapi.json", "searchTemplate": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/openapi.json?q={text}", "operationTemplate": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/openapi.json?path={path}&method={method}", "firstPage": "https://agents.pubrio.com/zcj/1a9mcogbgy5u/openapi.json?page=1" } }