v1

latestOpenAPI 3.0.02026-07-2688129326.6 KB

Annuaire

Récupérer les formulaires

Permet de récupérer une liste de tous les formulaires 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, seuls les formulaires avec une date de mise à jour de la visibilité API supérieure à la dernière forme envoyée sont retournés (toujours en utilisant le continuationToken). Cela concerne les nouveaux formulaires à insérer (souhaitant apparaître de l'annuaire) ainsi que les anciens à 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 : FormOpenDirectory

post/directory/forms

Query parameters

pageSizeinteger

The number of items per page

continuationTokenstring

Continuation Token from which we wish to retrieve results

Request body

formNamestring nullable

Textual search for form name

formDescriptionstring nullable

Textual search for form description

formZipCodesstring[] nullable

The zip codes where the forms are located

formCitiesstring[] nullable

The cities where the forms are located

formRegionsstring[] nullable

The regions where the forms are located

formDepartmentsstring[] nullable

The departments where the forms are located

formCountriesstring[] nullable

The countries where the forms are located

formTypesHelloAssoApiV5CommonModelsEnumsFormType[] nullable

The form types : CrowdFunding, Membership, Event, Donation, PaymentForm ...

formActivityTypestring[] nullable

The Activity Type of the form

formPublicationStartDateMinstring date-time nullable

The inclusive minimum publication date of the forms, format "yyyy-MM-ddTHH:mm:ss.fffK"

formPublicationStartDateMaxstring date-time nullable

The exclusive maximum publication date of the forms, format "yyyy-MM-ddTHH:mm:ss.fffK"

formStartDateMinstring date-time nullable

The inclusive minimum start date of the forms, format "yyyy-MM-ddTHH:mm:ss.fffK"

formStartDateMaxstring date-time nullable

The exclusive maximum start date of the forms, format "yyyy-MM-ddTHH:mm:ss.fffK"

formEndDateMaxstring date-time nullable

The exclusive maximum end date of the forms, format "yyyy-MM-ddTHH:mm:ss.fffK"

formEndDateMinstring date-time nullable

The inclusive minimum end date of the forms, format "yyyy-MM-ddTHH:mm:ss.fffK"

formIsFreeboolean nullable

Allow only free forms if true

formHasRemainingEntriesboolean nullable

Allow only forms with remaning entries if true

formInternalTagsstring[] nullable

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

formPublicTagsstring[] nullable

Allow only forms with public tags

organizationNamestring nullable

Textual search for organization name

organizationDescriptionstring nullable

Textual search for organization description

organizationCategoriesstring[] nullable

The categories of the forms

organizationTypesstring[] nullable

The organization types

organizationZipCodesstring[] nullable

The zip codes where the organizations are located

organizationCitiesstring[] nullable

The cities where the organizations are located

organizationRegionsstring[] nullable

The regions where the organizations are located

organizationDepartmentsstring[] nullable

The departments where the organizations are located

organizationFiscalReceiptEligibilityboolean nullable

Allow only organization with a fiscal receipt eligibility

organizationLinkedPartnersstring[] nullable

Organization linked partners

Response

Success