---
title: "Récupérer les formulaires"
method: POST
path: "/directory/forms"
tags: ["Annuaire"]
---

# Récupérer les formulaires

`POST /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.<br/><br/><b>Votre clientId doit être autorisé à tous ces privilèges : </b> <br/> FormOpenDirectory<br/><br/>

## Query parameters

- `pageSize` integer
- `continuationToken` string

## Request body

- HelloAssoApiV5CommonModelsDirectoryListFormsRequest
  - `formName` string, nullable — Textual search for form name
  - `formDescription` string, nullable — Textual search for form description
  - `formZipCodes` string[], nullable — The zip codes where the forms are located
  - `formCities` string[], nullable — The cities where the forms are located
  - `formRegions` string[], nullable — The regions where the forms are located
  - `formDepartments` string[], nullable — The departments where the forms are located
  - `formCountries` string[], nullable — The countries where the forms are located
  - `formTypes` HelloAssoApiV5CommonModelsEnumsFormType[], nullable — The form types : CrowdFunding, Membership, Event, Donation, PaymentForm ...
  - `formActivityType` string[], nullable — The Activity Type of the form
  - `formPublicationStartDateMin` string, date-time, nullable — The inclusive minimum publication date of the forms, format "yyyy-MM-ddTHH:mm:ss.fffK"
  - `formPublicationStartDateMax` string, date-time, nullable — The exclusive maximum publication date of the forms, format "yyyy-MM-ddTHH:mm:ss.fffK"
  - `formStartDateMin` string, date-time, nullable — The inclusive minimum start date of the forms, format "yyyy-MM-ddTHH:mm:ss.fffK"
  - `formStartDateMax` string, date-time, nullable — The exclusive maximum start date of the forms, format "yyyy-MM-ddTHH:mm:ss.fffK"
  - `formEndDateMax` string, date-time, nullable — The exclusive maximum end date of the forms, format "yyyy-MM-ddTHH:mm:ss.fffK"
  - `formEndDateMin` string, date-time, nullable — The inclusive minimum end date of the forms, format "yyyy-MM-ddTHH:mm:ss.fffK"
  - `formIsFree` boolean, nullable — Allow only free forms if true
  - `formHasRemainingEntries` boolean, nullable — Allow only forms with remaning entries if true
  - `formInternalTags` string[], nullable — Allow only forms with internal tags this filter is for special operations only
  - `formPublicTags` string[], nullable — Allow only forms with public tags
  - `organizationName` string, nullable — Textual search for organization name
  - `organizationDescription` string, nullable — Textual search for organization description
  - `organizationCategories` string[], nullable — The categories of the forms
  - `organizationTypes` string[], nullable — The organization types
  - `organizationZipCodes` string[], nullable — The zip codes where the organizations are located
  - `organizationCities` string[], nullable — The cities where the organizations are located
  - `organizationRegions` string[], nullable — The regions where the organizations are located
  - `organizationDepartments` string[], nullable — The departments where the organizations are located
  - `organizationFiscalReceiptEligibility` boolean, nullable — Allow only organization with a fiscal receipt eligibility
  - `organizationLinkedPartners` string[], nullable — Organization linked partners

## Response `200`

Success

- HelloAssoApiV5CommonModelsCommonResultsWithPaginationModelSynchronizableFormModel — ResultsWithPaginationModel class
  - `data` HelloAssoApiV5CommonModelsDirectorySynchronizableFormModel[], nullable — Data property
    - `action` 'Insert' | 'Delete'
    - `record` HelloAssoApiV5CommonModelsFormsFormBasicModel — A basic form model
      - `formSlug` string, nullable — The form slug
      - `formType` 'CrowdFunding' | 'Membership' | 'Event' | 'Donation' | 'PaymentForm' | 'Checkout' | 'Shop'
      - `url` string, nullable — The form url
      - `organizationSlug` string, nullable — The organization slug
  - `pagination` HelloAssoApiV5CommonModelsCommonPaginationModel — Pagination model class
    - `pageSize` integer — Page size
    - `totalCount` integer — Total number of results available
    - `pageIndex` integer — Current page index
    - `totalPages` integer — Total number of pages of results with current page size
    - `continuationToken` string, nullable — Continuation Token to get next results

## Other 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

---

[API](https://skmtc.net/helloasso/apis/api-authentication-access-token.md) · [All operations](https://skmtc.net/helloasso/apis/api-authentication-access-token/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/helloasso/api-authentication-access-token/revisions/b8cd7d9ae24e/schema)