Skip to main content
POST
Buscar pessoas

Autorizações

pubrio-api-key
string
header
obrigatório

Um token de API exclusivo que representa as ações que você realiza por meio da API e as permissões e operações correspondentes. Você pode criá-lo na seção Configurações.

Corpo

application/json
search_term
string

Uma string de palavras pela qual queremos filtrar os resultados.

Exemplo:

"pubrio"

people_name
string

Filtra os resultados da busca para incluir um nome de pessoa específico.

Exemplo:

"king"

people_titles
string[]

Cargos associados aos indivíduos que você deseja localizar.

Os resultados também incluirão cargos que contenham terminologia semelhante, mesmo que não correspondam exatamente. Por exemplo, buscar por software engineer pode retornar resultados de indivíduos com o cargo senior software engineer.

Exemplo:
exclude_people_titles
string[]

Cargos a excluir. Mesma correspondência por palavra usada em people_titles, então ["senior"] remove todo cargo que contenha essa palavra. Aplicado após people_titles.

Exemplo:
peoples
string<uuid>[]

Uma lista de identificadores únicos (people_search_id) usada para operações de busca de pessoas.

management_levels
enum<string>[]

Nível hierárquico da pessoa. O slug para C-level é c_suite, não c_level. Slugs desconhecidos são descartados quando outros filtros de pessoas estão presentes, e falham com 40037 quando este é o único filtro. Lista completa disponível no endpoint management level na aba Filters.

Opções disponíveis:
c_suite,
director,
entry,
founder,
head,
intern,
manager,
owner,
partner,
senior,
vp
Exemplo:
departments
string[]

O campo de departamento permite buscar pessoas em áreas específicas de atuação.

Consulte os endpoints department na aba Filters para mais informações.

Exemplo:
exclude_departments
string[]

Slugs de departamento a excluir. Mesmo vocabulário de departments. Pessoas sem departamento registrado são mantidas.

Exemplo:
department_functions
string[]

O campo de filtro para funções de trabalho permite especificar cargos ou áreas de atuação específicas ao buscar pessoas.

Consulte os endpoints department functions na aba Filters para mais informações.

Exemplo:
exclude_department_functions
string[]

Slugs de função a excluir. Mesmo vocabulário de department_functions. Pessoas sem função registrada são mantidas.

Exemplo:
employees
string[][]

O intervalo numérico de funcionários que trabalham na empresa. Isso permite encontrar empresas com base no número de funcionários. Você pode adicionar múltiplos intervalos para expandir os resultados da busca.

Consulte os endpoints de company size na aba Filters para mais informações.

Exemplo:
people_locations
string[]

A localização onde as pessoas vivem. Consulte os endpoints de location na aba Filters para mais informações.

Exemplo:
exclude_people_locations
string[]

Países em que a pessoa não deve residir (ISO 3166-1 alfa-2). Complementar a people_locations.

Exemplo:
company_locations
string[]

A localização da sede da empresa. Consulte os endpoints de location na aba Filters para mais informações.

Exemplo:
company_exclude_locations
string[]

Países de sede a excluir (ISO 3166-1 alfa-2). Complementar a company_locations; enviar o mesmo código em ambos não retorna nada.

Exemplo:
company_linkedin_urls
string[]

A URL completa do perfil da empresa no LinkedIn. A URL começa com http e contém linkedin.com/company/

Exemplo:
linkedin_urls
string[]

A URL completa do perfil do usuário no LinkedIn. A URL começa com http e contém linkedin.com/in/ ou linkedin.com/pub/

Exemplo:
companies
string<uuid>[]

Uma lista de identificadores únicos (domain_search_id) usada para operações de busca de empresas e pessoas.

domains
string[]

Lista de domínios de empresas usada para operações de busca de empresas e pessoas. Se recebermos uma URL como www.pubrio.com ou https://docs.pubrio.com/, o sistema a converterá para pubrio.com para processamento.

Exemplo:
company_filters
object

Objeto wrapper para filtros em nível de empresa. Agrupamento recomendado que separa visualmente quais chaves filtram a pessoa (nível superior) das que filtram a empresa. Aceita as mesmas chaves dos filtros de empresa de nível superior (por exemplo, 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, além de filter_conditions). O mecanismo achata esse objeto para o nível superior antes de processar — as chaves de nível superior prevalecem em caso de conflito. Mesma estrutura usada pelo company_filters do Monitor. Consulte o guia do desenvolvedor Visão Geral dos Filtros para ver exemplos.

Exemplo:
filter_conditions
object[]

Substituição de AND/OR por chave para os filtros em /people/search. O padrão é OR quando omitido. Consulte o guia do desenvolvedor Filtros de Pessoas e Empresas para a referência completa de remapeamento de chaves.

Quando habilitado, os filtros listados acima que suportam buscas por similaridade podem ser preenchidos com texto livre para IDs específicos.

similarity_score
number<float>

Usado em conjunto com is_enable_similarity_search. Esse número é usado para analisar se um slug específico (por exemplo, setor vertical, tecnologia) é semelhante à entrada do usuário, e quanto maior o número, mais rigoroso é o critério.

Exemplo:

0.7

per_page
integer
padrão:25

Registros por página. O padrão é 25, que também é o teto na maioria dos planos — o limite é o max_search_per_page da sua assinatura, retornado por Profile. Excedê-lo retorna HTTP 416 com o código 41676 (ou 41613 na busca de empresas e pessoas), não um conjunto de resultados limitado.

Intervalo necessário: x <= 25
Exemplo:

25

page
integer
padrão:1

Número da página, começando em 1. O teto é o max_search_page da sua assinatura (max_company_search_page para busca de empresas), retornado por Profile. Excedê-lo retorna HTTP 416.

Exemplo:

1

query
string

Busca em linguagem natural. Quando fornecida, a Pubrio a interpreta nos filtros de pessoa e empresa abaixo (cargo, senioridade, departamento, localização, setor, tamanho da empresa e mais). Quaisquer filtros explícitos que você também informar têm prioridade sobre os interpretados. Deixe em branco para buscar apenas pelos filtros estruturados.

Exemplo:

"decision makers in marketing"

is_include_similar_people_titles
boolean

Quando habilitado, people_titles também corresponde a cargos intimamente relacionados (por exemplo, software engineer corresponde a senior software engineer) em vez de apenas correspondências exatas.

people_title_similarity_score
number<float>

Usado em conjunto com is_include_similar_people_titles. Controla o quão próxima a correspondência de um cargo deve ser; quanto maior o número, mais rigorosa a correspondência.

Exemplo:

0.9

Resposta

Resposta bem-sucedida contendo os detalhes da busca de pessoas.

metadata
object

Contexto da solicitação: os filters e parameters informados são retornados, um bloco opcional de créditos profile, e ignored_fields (chaves do corpo da requisição que o endpoint descartou).

data
object | null

As informações da resposta dependem do endpoint específico.