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.

Votre clientId doit être autorisé à tous ces privilèges :
OrganizationOpenDirectory

Query Params
int32
Defaults to 20

The number of items per page

string

Continuation Token from which we wish to retrieve results

Body Params

Body which contains the filters to apply

string | null

Textual search for organization name

string | null

Textual search for organization description

categories
array of strings | null

The categories of the organizations

categories
types
array of strings | null

The organization types

types
zipCodes
array of strings | null

The zip codes where the organizations are located

zipCodes
cities
array of strings | null

The cities where the organizations are located

cities
regions
array of strings | null

The regions where the organizations are located

regions
departments
array of strings | null

The departments where the organizations are located

departments
boolean | null

Allow only organization with a fiscal receipt eligibility

internalTags
array of strings | null

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

internalTags
tags
array of strings | null

Allow only Organization with public tags

tags
linkedPartners
array of strings | null

Allow only Organization with linked partners

linkedPartners
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

401

Unauthorized, you must add a valid JWT into Authorization Header with the format : Bearer TOKEN

403

The JWT token hasn't the privileges or Roles for this action

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json