Rechercher des sociétés
boond_companies_searchSearch companies (clients, prospects, suppliers) in BoondManager using server-side filters like keywords, states, perimeters, and date ranges, with pagination and sorting.
Instructions
Recherche des sociétés (clients, prospects, fournisseurs…) dans BoondManager avec filtres serveur.
⚠️ Utilisez les filtres structurés plutôt que la pagination intégrale. Les noms de paramètres sont ceux exacts de l'API.
Cas d'usage courants :
• Mes comptes sans connaître son propre ID : perimeterDynamic: ["data"]. Pour "comptes gérés par X" : perimeterManagers: [<X_id>].
• États : states: [<id>] (dictionnaire setting.state.company). IDs entiers.
• Périmètre orga : perimeterAgencies, perimeterPoles, perimeterBusinessUnits. narrowPerimeter: true pour ET.
• Segmentation métier : expertiseAreas (dictionnaire setting.expertiseArea), origins, influencers.
• Période : period: "created"|"updated"|"withActions"|"withoutActions"|"noAction" + startDate/endDate.
• Recherche : keywords + keywordsType ('default' = nom/ville/pays/expertise/info, ou 'name', 'phones', 'emails', 'socialNetworks'). Pour cibler une société par ID : keywords: "CSOC<id>".
Pagination : page, pageSize (max 500). Tri : sort + order.
Note : il n'y a PAS de filtre typeOf pour les sociétés dans l'API search. Le type (client/prospect/fournisseur) doit être inféré via le détail de la société (boond_companies_get).
Returns : liste paginée des sociétés. Utiliser boond_companies_get ou les outils d'onglets pour le détail.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Numéro de page (défaut: 1, max: 100) | |
| sort | No | Champ de tri (ex: lastName, firstName, updateDate) | |
| flags | No | IDs de tags. | |
| order | No | Ordre de tri (asc/desc) | |
| fields | No | Projection côté client : liste d'attributs JSON:API à afficher pour chaque résultat (ex: ['title', 'updateDate', 'numberOfActiveProjects']). Réduit fortement la taille de la réponse. Absent = résumé standard (nom, email, ville, statut...). Les noms inconnus sont ignorés. | |
| period | No | Filtre temporel : 'created', 'updated', 'noAction'/'withActions'/'withoutActions'. À combiner avec `startDate` + `endDate`. | |
| states | No | IDs d'états de société (dictionnaire setting.state.company). | |
| endDate | No | Date de fin (YYYY-MM-DD), à utiliser avec `period`. | |
| origins | No | IDs d'origines (dictionnaire setting.origin). | |
| shields | No | Niveau de complétude. | |
| keywords | No | Mots-clés (défaut: nom + ville + pays + expertise + informations). Combinable avec `keywordsType`. | |
| pageSize | No | Nombre de résultats par page (max: 500, défaut: 30) | |
| startDate | No | Date de début (YYYY-MM-DD), à utiliser avec `period`. | |
| influencers | No | IDs d'influenceurs. | |
| keywordsType | No | Champ ciblé par `keywords`. Défaut: 'default'. | |
| expertiseAreas | No | IDs de domaines d'expertise (dictionnaire setting.expertiseArea). | |
| perimeterPoles | No | IDs de pôles. Conserve les entités dont le responsable appartient à ces pôles. | |
| narrowPerimeter | No | Si true, jointure ET entre les filtres `perimeter*` (au lieu de OU par défaut). | |
| perimeterDynamic | No | Périmètre dynamique relatif à l'utilisateur courant (raccourci sans avoir à connaître son propre ID). Valeurs : 'data' (mes propres données), 'managers' (mon équipe / mes N-1), 'agencies' (mes agences), 'poles' (mes pôles), 'businessUnits' (mes BU). Combinable. | |
| perimeterAgencies | No | IDs d'agences. Conserve les entités dont le responsable appartient à ces agences. | |
| perimeterManagers | No | IDs des managers (ressources). Conserve les entités dont le responsable est l'un de ces managers. Pour 'mon équipe / N-1 d'une personne X', passer [X_id]. Obtenir son propre ID via boond_application_current_user. | |
| perimeterBusinessUnits | No | IDs de business units. Conserve les entités dont le responsable appartient à ces BU. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | Nombre d'éléments retournés sur cette page | |
| items | Yes | ||
| total | No | Nombre total de résultats côté BoondManager |