Realiza a busca de pessoas

Busca pessoas na API externa utilizando os critérios fornecidos e armazena os resultados no banco de dados.

Corpo da Solicitação

  • q_keywords (str): Palavras-chave para busca (opcional).
  • q_organization_domains (str): Domínios da organização para filtrar a busca (opcional).
  • person_titles (List[str]): Títulos das pessoas para filtrar a busca (opcional).
  • person_locations (List[str]): Localizações das pessoas para filtrar a busca (opcional).
  • person_seniorities (List[str]): Senioridades das pessoas para filtrar a busca (opcional).
  • organization_ids (List[str]): IDs das organizações para filtrar a busca (opcional).
  • organization_locations (List[str]): Localizações das organizações para filtrar a busca (opcional).
  • organization_num_employees_ranges (List[str]): Faixas de número de empregados das organizações para filtrar a busca (opcional).
  • contact_email_status (List[str]): Status de e-mail de contato para filtrar a busca (opcional).
  • prospected_by_current_team (List[str]): Filtra por membros da equipe atual que prospectaram (opcional).
  • page (PositiveInt): Número da página para paginação.
  • per_page (PositiveInt): Número de itens por página para paginação.

Exemplo de Corpo da Solicitação

{
  "q_keywords": "engineer",
  "q_organization_domains": "example.com",
  "person_titles": ["Senior Engineer", "Lead Engineer"],
  "person_locations": ["New York", "San Francisco"],
  "person_seniorities": ["Senior", "Lead"],
  "organization_ids": ["123", "456"],
  "organization_locations": ["New York", "California"],
  "organization_num_employees_ranges": ["100-500", "500-1000"],
  "contact_email_status": ["verified", "unverified"],
  "prospected_by_current_team": ["team1", "team2"],
  "page": 1,
  "per_page": 10
}

Respostas Possíveis

  • 200: Busca realizada com sucesso. Retorna os resultados da busca incluindo contatos, pessoas e paginação.
  • 204: Nenhum conteúdo retornado da API externa.
  • 500: Erro ao chamar a API externa ou ao operar no banco de dados.

Exemplo de Resposta

{
  "breadcrumbs": {
    "q_keywords": "engineer",
    "q_organization_domains": "example.com",
    "person_titles": ["Senior Engineer", "Lead Engineer"],
    "person_locations": ["New York", "San Francisco"],
    "person_seniorities": ["Senior", "Lead"],
    "organization_ids": ["123", "456"],
    "organization_locations": ["New York", "California"],
    "organization_num_employees_ranges": ["100-500", "500-1000"],
    "contact_email_status": ["verified", "unverified"],
    "prospected_by_current_team": ["team1", "team2"],
    "contacts": [],
    "people": [
      {"name": "John Doe", "title": "Senior Engineer", "location": "New York"}
    ],
    "pagination": {"page": 1, "total_pages": 10},
    "requested_by": ["customer123"]
  },
  "response": {"id": 1, "field": "value"}
}
Language
Authorization
Bearer
Click Try It! to start a request and see the response here!