Search for Contacts

Search for contacts.

POST https://api.aisa.one/apis/v1/apollo/contacts/search

Search for Contacts

cURL

curl --request POST \
  --url https://api.aisa.one/apis/v1/apollo/contacts/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "q_keywords": "<string>",
  "contact_stage_ids": "<string>",
  "contact_label_ids": "<string>",
  "sort_by_field": "<string>",
  "sort_ascending": true,
  "per_page": 123,
  "page": 123
}
'

import requests

url = "https://api.aisa.one/apis/v1/apollo/contacts/search"

payload = {
    "q_keywords": "<string>",
    "contact_stage_ids": "<string>",
    "contact_label_ids": "<string>",
    "sort_by_field": "<string>",
    "sort_ascending": True,
    "per_page": 123,
    "page": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    q_keywords: '<string>',
    contact_stage_ids: '<string>',
    contact_label_ids: '<string>',
    sort_by_field: '<string>',
    sort_ascending: true,
    per_page: 123,
    page: 123
  })
};

fetch('https://api.aisa.one/apis/v1/apollo/contacts/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.aisa.one/apis/v1/apollo/contacts/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'q_keywords' => '<string>',
    'contact_stage_ids' => '<string>',
    'contact_label_ids' => '<string>',
    'sort_by_field' => '<string>',
    'sort_ascending' => true,
    'per_page' => 123,
    'page' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aisa.one/apis/v1/apollo/contacts/search"

	payload := strings.NewReader("{\n  \"q_keywords\": \"<string>\",\n  \"contact_stage_ids\": \"<string>\",\n  \"contact_label_ids\": \"<string>\",\n  \"sort_by_field\": \"<string>\",\n  \"sort_ascending\": true,\n  \"per_page\": 123,\n  \"page\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/apollo/contacts/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"q_keywords\": \"<string>\",\n  \"contact_stage_ids\": \"<string>\",\n  \"contact_label_ids\": \"<string>\",\n  \"sort_by_field\": \"<string>\",\n  \"sort_ascending\": true,\n  \"per_page\": 123,\n  \"page\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/apollo/contacts/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"q_keywords\": \"<string>\",\n  \"contact_stage_ids\": \"<string>\",\n  \"contact_label_ids\": \"<string>\",\n  \"sort_by_field\": \"<string>\",\n  \"sort_ascending\": true,\n  \"per_page\": 123,\n  \"page\": 123\n}"

response = http.request(request)
puts response.read_body

200

{
  "contacts": [
    {}
  ],
  "breadcrumbs": [
    {}
  ],
  "partial_results_only": true,
  "has_join": true,
  "disable_eu_prospecting": true,
  "partial_results_limit": 123,
  "pagination": {},
  "num_fetch_result": {}
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

q_keywords · string

Keyword query

contact_stage_ids · string

Filter by contact stage IDs

contact_label_ids · string

Filter by contact label IDs

sort_by_field · string

Sort field (e.g. contact_last_activity_date, contact_created_at, contact_updated_at)

sort_ascending · boolean

Sort ascending. Default false.

per_page · integer

Items per page

page · integer

Page number

Response

200

application/json

Successful response

contacts · object[]

Response array

breadcrumbs · object[]

Response array

partial_results_only · boolean

Response field

has_join · boolean

Response field

disable_eu_prospecting · boolean

Response field

partial_results_limit · integer

Response field

pagination · object

Pagination metadata

num_fetch_result · object | null

Fetch-result metadata