Passer au contenu principal
POST
/
v2
/
api
/
crm
/
companies
/
search
Search companies
curl --request POST \
  --url https://api.withallo.com/v2/api/crm/companies/search \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": {
    "name": "Acme",
    "industry": "Technology"
  },
  "sort": "NAME_ASC",
  "page": 1,
  "size": 20
}
'
import requests

url = "https://api.withallo.com/v2/api/crm/companies/search"

payload = {
"filters": {
"name": "Acme",
"industry": "Technology"
},
"sort": "NAME_ASC",
"page": 1,
"size": 20
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filters: {name: 'Acme', industry: 'Technology'},
sort: 'NAME_ASC',
page: 1,
size: 20
})
};

fetch('https://api.withallo.com/v2/api/crm/companies/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.withallo.com/v2/api/crm/companies/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([
'filters' => [
'name' => 'Acme',
'industry' => 'Technology'
],
'sort' => 'NAME_ASC',
'page' => 1,
'size' => 20
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.withallo.com/v2/api/crm/companies/search"

payload := strings.NewReader("{\n \"filters\": {\n \"name\": \"Acme\",\n \"industry\": \"Technology\"\n },\n \"sort\": \"NAME_ASC\",\n \"page\": 1,\n \"size\": 20\n}")

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

req.Header.Add("Authorization", "<api-key>")
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.withallo.com/v2/api/crm/companies/search")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"name\": \"Acme\",\n \"industry\": \"Technology\"\n },\n \"sort\": \"NAME_ASC\",\n \"page\": 1,\n \"size\": 20\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.withallo.com/v2/api/crm/companies/search")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filters\": {\n \"name\": \"Acme\",\n \"industry\": \"Technology\"\n },\n \"sort\": \"NAME_ASC\",\n \"page\": 1,\n \"size\": 20\n}"

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "id": "com-xyz789",
      "name": "Acme Corp",
      "website": "https://acme.com",
      "industry": "Technology",
      "person_count": 3,
      "interactions": 12,
      "last_activity_at": "2026-04-28T10:30:00",
      "created_at": "2026-04-01T09:00:00",
      "updated_at": "2026-04-28T10:30:00"
    }
  ],
  "pagination": {
    "page": 123,
    "size": 123,
    "total_count": 123,
    "total_pages": 123,
    "has_more": true
  }
}
{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}
{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}
{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}
Scope requis : CRM_READ
Cet endpoint est pagine. Utilisez page et size dans le corps de la requete pour controler les resultats. Voir Pagination.

Corps de la requete

ChampTypeDescription
filtersobjectFiltres nommes (voir ci-dessous)
sortstringOrdre de tri : DATE_DESC, DATE_ASC, NAME_ASC, NAME_DESC, CREATED_DESC, CREATED_ASC
pageintegerNumero de page (commence a 1)
sizeintegerResultats par page (max 100)

Filtres

Passez un objet avec des champs nommes. Tous les filtres fournis sont combines avec AND.
{
  "filters": {
    "name": "Acme",
    "industry": "Technology"
  },
  "sort": "NAME_ASC",
  "page": 1,
  "size": 20
}

Champs de filtre disponibles

ChampType de correspondanceDescription
namecontientNom de l’entreprise
websitecontientURL du site web
industrycontientSecteur d’activite

Autorisations

Authorization
string
header
requis

Corps

application/json

Request body for searching companies

filters
object | null

Named filters. All are combined with AND.

sort
enum<string> | null

Sort order (default: DATE_DESC)

Options disponibles:
DATE_DESC,
DATE_ASC,
NAME_ASC,
NAME_DESC,
CREATED_DESC,
CREATED_ASC
page
integer
défaut:1

Page number (1-indexed)

size
integer
défaut:20

Results per page

Plage requise: x <= 100

Réponse

Search results

data
object[]
pagination
object