Liste des organismes

Requête


GET https://api.helloasso.com/v3/organizations.json[?page=<page>&results_per_page=<results_per_page>]

Réponse

Une collection d’organismes.

Description

Cette ressource permet de lister l’ensemble des organismes enregistrés sur votre application.

Paramètres

Élément Description Requis Format
page Page qu’on veut retourner (1 par défaut) Non int
results_per_page Nombre de résultats par page (20 par défaut) Non int

Détail d'un organisme

Requête


GET https://api.helloasso.com/v3/organizations/<id>.json[?page=<page>&results_per_page=<results_per_page>]

Réponse

Un organisme.

Description

Cette url permet d’obtenir des informations détaillées sur un organisme enregistré sur votre application.

Paramètres

Élément Description Requis Format
id L'identifiant de l'organisme Oui string
page Page qu’on veut retourner (1 par défaut) Non int
results_per_page Nombre de résultats par page (20 par défaut) Non int

Liste des campagnes

Requête


GET https://api.helloasso.com/v3/[organizations/<organism-id>/]campaigns.json[?type=<EVENT|FORM|FUNDRAISER|MEMBERSHIP>&createdFrom=<createdFrom>&createdTo=<createdTo>&updatedFrom=<updatedFrom>&updatedTo=<updatedTo>&page=<page>&results_per_page=<results_per_page>]

Réponse

Une collection de campagnes.

Description

Cette url permet d’obtenir une liste des campagnes enregistrées sur l’application. Si un chemin d’organisme est précisé, la liste est réduite aux campagnes de l’organisme concerné. Le paramètre optionnel type permet de filtrer la recherche sur les campagnes d’un type donné.

Paramètres

Élément Description Requis Format
organism-id L’id de l’organisme détenteur des campagnes Non string
type Le type de campagnes à récupérer Non EVENT | FORM | FUNDRAISER | MEMBERSHIP
createdFrom Date de création minimum Non date
createdTo Date de création maximum Non date
updatedFrom Date de mise à jour minimum Non date
updatedTo Date de mise à jour maximum Non date
page Page qu’on veut retourner (1 par défaut) Non int
results_per_page Nombre de résultats par page (20 par défaut) Non int

Exemples

Récupérer la liste des événements enregistrés sur l’application :


GET https://api.helloasso.com/v3/campaigns.json?type=EVENT

Récupérer la liste des campagnes créées par l’organisme “mon association” :


GET https://api.helloasso.com/v3/organizations/00000000002/campaigns.json

Détail d'une campagne

Requête


GET https://api.helloasso.com/v3/campaigns/<id>.json

Réponse

Une campagne.

Description

Cette url permet d'obtenir des informations détaillées sur une campagne enregistrée sur votre application.

Paramètres

Élément Description Requis Format
id L'identifiant de la campagne Oui string

Liste des actions

Requête


GET https://api.helloasso.com/v3/[organizations/<organism-id>/][campaigns/<campaign-id>/]actions.json[?type=<DONATION|INSCRIPTION|SUBSCRIPTIONS>&from=<from>&to=<to>&page=<page>&results_per_page=<results_per_page>]

Réponse

Une collection d'actions.

Description

Cet appel permet de récupérer une collection d’action rattachée à votre application, et à l’éventuel organisme ou campagne spécifiée dans l’URL.

Paramètres

Élément Description Requis Format
organism-id L’id de l’organisme détenteur des campagnes Non string
campaign-id L’id de la campagne sur laquelle ont été effectuées les actions Non string
type Le type de campagnes à récupérer Non EVENT | FORM | FUNDRAISER | MEMBERSHIP
from Date de création minimum Non date
to Date de création maximum Non date
page Page qu’on veut retourner (1 par défaut) Non int
results_per_page Nombre de résultats par page (20 par défaut) Non int

Exemples

Récupérer la liste des actions enregistrés sur l’application :


GET https://api.helloasso.com/v3/actions.json

Récupérer la liste des actions enregistrées sur une association :


GET https://api.helloasso.com/v3/organizations/00000000002/actions.json

Récupérer la liste des actions enregistrées sur un événement depuis le premier janvier 2017 :


GET https://api.helloasso.com/v3/campaigns/00000000002/actions.json?from=2017-01-01T00:00:00

Détail d'une action

Requête


GET https://api.helloasso.com/v3/actions/<id>.json

Réponse

Une action.

Description

Cet appel retourne la représentation JSON d’une action dont l’identifiant est donné en paramètre.

Paramètres

Élément Description Requis Format
id L'identifiant de l'action Oui string

Liste des paiements

Requête


GET https://api.helloasso.com/v3/[organizations/<organism-id>/][campaigns/<campaign-id>/]payments.json[?type=<CREDIT>&from=<from>&to=<to>&page=<page>&results_per_page=<results_per_page>]

Réponse

Une collection de paiements.

Paramètres

Élément Description Requis Format
organism-id L’id de l’organisme bénéficiaire du paiement Non string
campaign-id L’id de la campagne sur laquelle le paiement a été réalisé Non string
type Le type de paiement à récupérer (CREDIT dans cette version) Non CREDIT
from Date de création minimum Non date
to Date de création maximum Non date
page Page qu’on veut retourner (1 par défaut) Non int
results_per_page Nombre de résultats par page (20 par défaut) Non int

Exemples

Récupérer la liste des paiements enregistrés sur l’application :


GET https://api.helloasso.com/v3/payments.json

Récupérer la liste des paiements enregistrés sur un événement :


GET https://api.helloasso.com/v3/campaigns/00000000002/payments.json

Récupérer la liste des paiements au profit d’une association entre le premier janvier et le premier février 2017 :


GET https://api.helloasso.com/v3/organizations/00000000002/payments.json?from=2017-01-01T00:00:00&to=2017-02-01T00:00:00

Détail d'un paiement

Requête


GET https://api.helloasso.com/v3/payments/<id>.json

Réponse

Un paiement.

Description

Cet appel retourne la représentation JSON d’un paiement dont l’identifiant est donné en paramètre.

Paramètres

Élément Description Requis Format
id L'identifiant du paiement Oui string

Retour