Obtenir les commandes d'un formulaire

get

https://api.helloasso.com/v5/organizations/{organizationSlug}/forms/{formType}/{formSlug}/orders

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

organizationSlug

string

required

The organization slug

formSlug

string

required

The form slug

formType

string

enum

required

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

Allowed:

Query Params

from

date-time

First Date Filter

date-time

End Date Filter (exclusive)

userSearchKey

string

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

pageIndex

int32

Defaults to 1

The page of results to retrieve

pageSize

int32

Defaults to 20

The number of items per page

continuationToken

string

Continuation Token from which we wish to retrieve results

withDetails

boolean

Defaults to false

Set to true to return CustomFields

sortOrder

string

enum

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

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

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

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200Success