v1

latestOpenAPI 3.0.02026-07-2688129326.6 KB
Annuaire

Récupérer les organisations

Permet de récupérer une liste de toutes les organisations visibles correspondant à tous les filtres de l'annuaire jusqu'à ce qu'il soit synchronisé (en utilisant le continuationToken). Si aucun filtre n'est spécifié, aucun filtre n'est appliqué. Les résultats sont classés par date de mise à jour de la visibilité API en ordre croissant. Une fois la liste synchronisée, seules les organisations avec une date de mise à jour de la visibilité API supérieure à la dernière organisation envoyée sont retournées (toujours en utilisant le continuationToken). Cela concerne les nouvelles organisations à insérer (souhaitant apparaître dans l'annuaire) ainsi que les anciennes à supprimer (ne souhaitant plus apparaître dans l'annuaire). Le nombre total de résultats (ou de pages) n'est pas récupérable, donc les informations de pagination retournées indiqueront toujours -1.<br/><br/><b>Votre clientId doit être autorisé à tous ces privilèges : </b> <br/> OrganizationOpenDirectory<br/><br/>

post/directory/organizations

Query parameters

pageSizeinteger

The number of items per page

continuationTokenstring

Continuation Token from which we wish to retrieve results

Request body

namestring nullable

Textual search for organization name

descriptionstring nullable

Textual search for organization description

categoriesstring[] nullable

The categories of the organizations

typesstring[] nullable

The organization types

zipCodesstring[] nullable

The zip codes where the organizations are located

citiesstring[] nullable

The cities where the organizations are located

regionsstring[] nullable

The regions where the organizations are located

departmentsstring[] nullable

The departments where the organizations are located

fiscalReceiptEligibilityboolean nullable

Allow only organization with a fiscal receipt eligibility

internalTagsstring[] nullable

Allow only Organization with internal tags this filter is for special operations only

tagsstring[] nullable

Allow only Organization with public tags

linkedPartnersstring[] nullable

Allow only Organization with linked partners

Response

Success