Organismes

La représentation JSON d’un organisme est la suivante :


{
	"id": "string",
	"name": "string",
	"slug": "string",
	"type": "string",
	"funding": "decimal",
	"supporters": "int",
	"logo": "string",
	"thumbnail": "string",
	"profile": "string",
	"donate-form": "string"
}

Élément Description Exemple
id Identifiant de l’organisme 00000001234
name Nom de l’organisme, tel qu’il apparait sur la plateforme HelloAsso Le rire médecin
slug Le slug de l’organisme, utilisé dans les urls HelloAsso et sur l’api le-rire-medecin
type Le type de l’organisme, valorisé systématiquement à ORGANISM dans cette version ORGANISM
funding Le total collecté par l’organisme sur HelloAsso 3567.54
supporters Le nombre de contributeur total à cet organisme 105
logo L’url de logo de l’organisme https://www.helloasso.com/assets/img/logos/le-rire-medecin.jpg
thumbnail L’url de la minature de l’organisme https://www.helloasso.com/assets/img/logos/le-rire-medecin.jpg
profile L’url de la page de l’organisme sur HelloAsso https://www.helloasso.com/associations/le-rire-medecin
donate-form L’url du formulaire de don principal de l’organisme sur HelloAsso https://www.helloasso.com/don/associations/le-rire-medecin

Campagnes

La représentation JSON d'une campagne est la suivante :


{
	"id": "string",
	"name": "string",
	"slug": "string",
	"type": "string",
	"funding": "decimal",
	"supporters": "int",
	"url": "string",
	"id_organism": "string",
	"slug_organism": "string",
	"creation_date": "date",
	"last_update": "date",
	"place_name": "string",
	"place_address": "string",
	"place_city": "string",
	"place_zipcode": "string",
	"place_country": "string",
	"start_date": "date",
	"end_date": "date"
}

Élément Description Exemple
id Identifiant de la campagne 00000001234
name Nom de la campagne, tel qu’il apparait sur la plateforme HelloAsso Festival de la choucroute
slug Le slug de la campagne, utilisé dans les urls HelloAsso et sur l’api festival-de-la-choucroute
type Le type de la campagne EVENT|FORM|MEMBERSHIP|FUNDRAISER
funding Le total collecté par la campagne 3567.54
supporters Le nombre de contributeur total à cette campagne 105
url L’url de la campagne sur HelloAsso https://www.helloasso.com/associations/mon-asso/evenements/festival-de-la-choucroute
id_organism L’identifiant de l’organisme détenteur de la campagne 00000001234
slug_organism Le slug de l’organisme détenteur de la campagne le-rire-medecin
creation_date Date de création de la campagne 20150201T12:00:00
last_update Date de dernière mise à jour de la campagne 20150201T12:00:00
place_name Lieu de la campagne si applicable (uniquement pour les campagens de type EVENT) HelloAsso
place_address Addresse de la campagne si applicable (uniquement pour les campagens de type EVENT) 87 quai des queyries
place_city Ville de la campagne si applicable (uniquement pour les campagens de type EVENT) Bordeaux
place_zipcode Code postal de la campagne si applicable (uniquement pour les campagens de type EVENT) 33000
place_country Pays de la campagne si applicable (uniquement pour les campagens de type EVENT) France
start_date Date de début de la campagne 20150201T12:00:00
end_date Date de fin de la campagne 20150201T12:00:00

Actions

La représentation JSON d’une action est la suivante :


{
	"id": "string",
	"id_campaign": "string",
	"id_organism": "string",
	"id_payment": "string",
	"date": "date",
	"amount": "decimal",
	"type": "string",
	"first_name": "string",
	"last_name": "string",
	"address": "string",
	"zip_code": "string",
	"city": "string",
	"country": "string",
	"email": "string",
	"status": "string",
	"custom_infos": [
	  {
	    "label": "string",
	    "value": "string"
	  }
	  …
	]
}

Élément Description Exemple
id Identifiant de l’action 00000001234
id_campaign Identifiant de la campagne sur laquelle a été réalisée l’action 00000000045
id_organism Identifiant de l’organisme bénéficiaire de l’action 00000000067
id_payment Identifiant du paiement associé à l’action 00000000089
date La date à laquelle a été réalisée l’action 20150201T12:00:00
amount Le montant associé à l’action 100
type Le type de l’action : DONATION, INSCRIPTION, SUBSCRIPTION, RECURRENT_DONATION DONATION
first_name Le prénom de l’utilisateur associé à l’action Jean
last_name Le nom de l’utilisateur associé à l’action Dupont
address L’adresse de l’utilisateur associé à l’action 1 rue des lilas
zip_code Le code postal de l’utilisateur associé à l’action 75001
city La ville de l’utilisateur associé à l’action Paris
country Le pays de l’utilisateur associé à l’action France
email L'email de l’utilisateur associé à l’action jean.dupont@domaine.com
status Status de l'action PROCESSED
custom_infos La liste des réponses aux champs personnalisés renseignés par l’internaute {
 "label": "Antenne"
 "value": "Paris XIII"
}

Paiements

La représentation JSON d’un paiement est la suivante :


{
	"id": "string",
	"date": "date",
	"amount": "decimal",
	"type" : "string",
	"payer_first_name": "string",
	"payer_last_name": "string",
	"payer_address": "string",
	"payer_zip_code": "string",
	"payer_city": "string",
	"payer_country": "string",
	"payer_email": "string",
	"payer_birthdate": "date",
	"payer_citizenship": "string",
	"payer_society": "string",
	"payer_is_society": "bool",
	"url_receipt": "string",
	"url_tax_receipt": "string",
	"status": "string",
	"actions": [
	  {
	    "id": "string",
	    "type": "string",
	    "amount": "decimal"
	  }
	  …
	]
}

Élément Description Exemple
id Identifiant du paiement 00000001234
date La date à laquelle a été réalisé le paiement 20150201T12:00:00
amount Le montant associé au paiement 100
type Le type du paiement : CREDIT dans cette version CREDIT
payer_first_name Le prénom de l’utilisateur ayant effectué le paiement Jean
payer_last_name Le nom de l’utilisateur ayant effectué le paiement Dupont
payer_address L’adresse de l’utilisateur ayant effectué le paiement 1 rue des lilas
payer_zip_code Le code postal de l’utilisateur ayant effectué le paiement 75001
payer_city La ville de l’utilisateur ayant effectué le paiement Paris
payer_country Le pays de l’utilisateur ayant effectué le paiement France
payer_email L'email de l’utilisateur ayant effectué le paiement jean.dupont@domaine.com
payer_birthdate La date de naissance de l'utilisateur 19880104T12:00:00
payer_citizenship La nationalité de l'utilisateur Française
payer_society La société du payeur, si renseignée Company
payer_is_society Indique si le paiement est réalisé au nom de la société du payeur true
url_receipt L’url de l’attestation de paiement
url_tax_receipt L’url du reçu fiscal
status Status de l'action AUTHORIZED
actions Une collection de représentations condensées des actions associées au paiement. [
 {
  "id": "00000000123",
  "type": "INSCRIPTION",
  "amount": "50.00"
 },
 {
  "id": "00000000124",
  "type": "DONATION",
  "amount": "10.00"
 }
]

Campagnes basiques

La représentation JSON d’une campagne basique est la suivante :


{
	"name": "string",
	"slug": "string",
    "type": "string",
    "url": "string",
    "url_widget": "string",
    "url_bouton": "string",
    "name_organism": "string",
	"slug_organism": "string"
}

Élément Description Exemple
name Nom de la campagne, tel qu’il apparait sur la plateforme HelloAsso Festival de la choucroute
slug Le slug de la campagne, utilisé dans les urls HelloAsso et sur l’api festival-de-la-choucroute
type Le type de la campagne EVENT|FORM|MEMBERSHIP|FUNDRAISER
url L'url de la campagne sur HelloAsso https://www.helloasso.com/associations/mon-asso/evenements/festival-de-la-choucroute
url_widget L'url du widget de la campagne sur HelloAsso https://www.helloasso.com/associations/mon-asso/evenements/festival-de-la-choucroute/widget
url_bouton L'url du bouton de la campagne sur HelloAsso https://www.helloasso.com/associations/mon-asso/evenements/festival-de-la-choucroute/widget-bouton
name_organism Le nom de l’organisme détenteur de la campagne Le Rire Médecin
slug_organism Le slug de l’organisme détenteur de la campagne le-rire-medecin

Retour