Devenez partenaire
API Reference
S'abonner aux nouveautés

Obtenir une liste d'articles vendus dans un formulaire

get
https://api.helloasso.com/v5/organizations//forms///items



Votre token doit avoir l'un de ces rôles :
FormAdmin
OrganizationAdmin

Si vous êtes une association, vous pouvez obtenir ces rôles avec votre client.
Si vous êtes un partenaire, vous pouvez obtenir ces rôles par le flux d'autorisation.

Votre clientId doit être autorisé à tous ces privilèges :
AccessTransactions

Path Params
string
required

The organization slug

string
required

The form slug

string
enum
required

The form type CrowdFunding, Membership, Event, Donation, PaymentForm, Checkout, Shop

Allowed:
Query Params
date-time

First Date Filter

date-time

End Date Filter (exclusive)

string

Filter results on user or payer first name, last name or email

int32
Defaults to 1

The page of results to retrieve

int32
Defaults to 20

The number of items per page

string

Continuation Token from which we wish to retrieve results

tierTypes
array of objects

The type of tiers

List<TierType>
itemStates
array of objects

The item states

Available values:

  • Processed - The item is paid and is valid
  • Registered - The item has been registered manually by the organization and is valid
  • Unknown
  • Canceled - The item has been canceled, and is no longer valid
List<ItemState>
string

The name of a tier

boolean
Defaults to false

Set to true to return CustomFields and Options

string
enum

Sort forms items by ascending or descending order. Default is descending

Allowed:
string
enum

Sort forms items by a specific field (Date or UpdateDate). Default is date

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 2 months ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 2 months ago