Récupérer les formulaires

post https://api.helloasso.com/v5/directory/forms

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

Query Params

pageSize

int32

Defaults to 20

The number of items per page

continuationToken

string

Continuation Token from which we wish to retrieve results

Body Params

Body which contains the filters to apply

formName

string | null

Textual search for form name

formDescription

string | null

Textual search for form description

formZipCodes

array of strings | null

The zip codes where the forms are located

formZipCodes

formCities

array of strings | null

The cities where the forms are located

formCities

formRegions

array of strings | null

The regions where the forms are located

formRegions

formDepartments

array of strings | null

The departments where the forms are located

formDepartments

formCountries

array of strings | null

The countries where the forms are located

formCountries

formTypes

array of strings | null

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

formTypes

formActivityType

array of strings | null

The Activity Type of the form

formActivityType

formPublicationStartDateMin

date-time | null

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

formPublicationStartDateMax

date-time | null

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

formStartDateMin

date-time | null

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

formStartDateMax

date-time | null

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

formEndDateMax

date-time | null

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

formEndDateMin

date-time | null

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

formIsFree

boolean | null

Allow only free forms if true

formHasRemainingEntries

boolean | null

Allow only forms with remaning entries if true

formInternalTags

array of strings | null

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

formInternalTags

formPublicTags

array of strings | null

Allow only forms with public tags

formPublicTags

organizationName

string | null

Textual search for organization name

organizationDescription

string | null

Textual search for organization description

organizationCategories

array of strings | null

The categories of the forms

organizationCategories

organizationTypes

array of strings | null

The organization types

organizationTypes

organizationZipCodes

array of strings | null

The zip codes where the organizations are located

organizationZipCodes

organizationCities

array of strings | null

The cities where the organizations are located

organizationCities

organizationRegions

array of strings | null

The regions where the organizations are located

organizationRegions

organizationDepartments

array of strings | null

The departments where the organizations are located

organizationDepartments

organizationFiscalReceiptEligibility

boolean | null

Allow only organization with a fiscal receipt eligibility

organizationLinkedPartners

array of strings | null

Organization linked partners

organizationLinkedPartners

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


xxxxxxxxxx
1
curl --request POST \
2
     --url 'https://api.helloasso.com/v5/directory/forms?pageSize=20' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/*+json'

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200Success