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
}
'
{
  "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
  }
}

Documentation Index

Fetch the complete documentation index at: https://help.withallo.com/llms.txt

Use this file to discover all available pages before exploring further.

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

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