Sign in

v1

latestOpenAPI 3.0.02026-07-2688129326.6 KB
Formulaires

Obtenir des données publiques détaillées sur un formulaire

Permet de récupérer toutes les informations publiques d'un formulaire, qu'il s'agisse de Crowdfunding, d'Adhésion, d'Événement, de Don...<br/><br/><b>Votre clientId doit être autorisé à tous ces privilèges : </b> <br/> AccessPublicData<br/><br/>

get/organizations/{organizationSlug}/forms/{formType}/{formSlug}/public

Path parameters

organizationSlugstring required
formType'CrowdFunding' | 'Membership' | 'Event' | 'Donation' | 'PaymentForm' | 'Checkout' | 'Shop' required
formSlugstring required

Response

Success

organizationLogostring nullable

Organization Logo

organizationNamestring nullable

Organization Name

activityTypestring nullable

Activity type of the event eg. "Atelier(s) / Stage(s)" matching one of the provided type values <a href="index#!/Values/Values_Get"> provided here</a> or a custom value is allowed.

activityTypeIdinteger

Activity type identifier

saleEndDatestring date-time nullable

The datetime (Inclusive) at which the sales end. If null the orders will be available until the end of the campaign.

saleStartDatestring date-time nullable

The datetime (Inclusive) at which the users can start placing orders. If null the orders will be available as soon as the campaign is published.

validityType'MovingYear' | 'Custom' | 'Illimited'

Enum which represents the membership validity type

personalizedMessagestring nullable

A message customized by the organization administrator.

currencystring nullable

Currency

descriptionstring nullable

Short description (one line)

startDatestring date-time nullable

The datetime of the activity start

endDatestring date-time nullable

The datetime of the activity end

state'Public' | 'Private' | 'Draft' | 'Deleted' | 'Disabled'
titlestring nullable

Title

privateTitlestring nullable

Private Title

widgetButtonUrlstring nullable

Url of the widget button

widgetFullUrlstring nullable

Url of the form widget

widgetVignetteHorizontalUrlstring nullable

Url of the horizontal vignette widget

widgetVignetteVerticalUrlstring nullable

Url of the vertical vignette widget

widgetCounterUrlstring nullable

Url of the counter widget

formSlugstring nullable

The form slug

formType'CrowdFunding' | 'Membership' | 'Event' | 'Donation' | 'PaymentForm' | 'Checkout' | 'Shop'
urlstring nullable

The form url

organizationSlugstring nullable

The organization slug