---
updatedAt: 2026-09-15T13:43:53.000Z
agentTools:
  projectIndex: https://dev.helloasso.com/llms.txt
---

# Obtenir les commandes d'un formulaire

<br/><br/><b>Votre token doit avoir l'un de ces rôles : </b><br/>FormAdmin<br/>OrganizationAdmin<br/><br/>Si vous êtes une <b>association</b>, vous pouvez obtenir ces rôles avec votre client.<br/>Si vous êtes un <b>partenaire</b>, vous pouvez obtenir ces rôles par le flux d'autorisation.<br/><br/><b>Votre clientId doit être autorisé à tous ces privilèges : </b> <br/> AccessTransactions<br/><br/>

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "HelloAsso API",
    "description": "HelloAsso auto-generated SDK",
    "version": "public"
  },
  "servers": [
    {
      "url": "https://api.helloasso.com/v5"
    }
  ],
  "paths": {
    "/organizations/{organizationSlug}/forms/{formType}/{formSlug}/orders": {
      "get": {
        "tags": [
          "Commandes"
        ],
        "summary": "Obtenir les commandes d'un formulaire",
        "description": "<br/><br/><b>Votre token doit avoir l'un de ces rôles : </b><br/>FormAdmin<br/>OrganizationAdmin<br/><br/>Si vous êtes une <b>association</b>, vous pouvez obtenir ces rôles avec votre client.<br/>Si vous êtes un <b>partenaire</b>, vous pouvez obtenir ces rôles par le flux d'autorisation.<br/><br/><b>Votre clientId doit être autorisé à tous ces privilèges : </b> <br/> AccessTransactions<br/><br/>",
        "parameters": [
          {
            "name": "organizationSlug",
            "in": "path",
            "description": "The organization slug",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "formSlug",
            "in": "path",
            "description": "The form slug",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "formType",
            "in": "path",
            "description": "The form type CrowdFunding, Membership, Event, Donation, PaymentForm, Checkout, Shop",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Enums.FormType"
            }
          },
          {
            "name": "from",
            "in": "query",
            "description": "First Date Filter",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "to",
            "in": "query",
            "description": "End Date Filter (exclusive)",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "userSearchKey",
            "in": "query",
            "description": "Filter results on user or payer first name, last name or email",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "pageIndex",
            "in": "query",
            "description": "The page of results to retrieve",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 1
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "description": "The number of items per page",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 20
            }
          },
          {
            "name": "continuationToken",
            "in": "query",
            "description": "Continuation Token from which we wish to retrieve results",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "withDetails",
            "in": "query",
            "description": "Set to true to return CustomFields",
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "name": "sortOrder",
            "in": "query",
            "description": "Sort forms orders by ascending or descending order. Default is descending",
            "schema": {
              "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Enums.SortOrder"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Common.ResultsWithPaginationModel_Order"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Common.ResultsWithPaginationModel_Order"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Common.ResultsWithPaginationModel_Order"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized, you must add a valid JWT into Authorization Header with the format : `Bearer TOKEN`"
          },
          "403": {
            "description": "The JWT token hasn't the privileges or Roles for this action"
          }
        },
        "security": [
          {
            "OAuth2": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "HelloAsso.Api.V5.Common.Models.Common.MetaModel": {
        "type": "object",
        "properties": {
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          },
          "authorEmail": {
            "type": "string",
            "nullable": true
          },
          "expiresAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "HelloAsso.Api.V5.Common.Models.Common.PaginationModel": {
        "type": "object",
        "properties": {
          "pageSize": {
            "type": "integer",
            "description": "Page size",
            "format": "int32"
          },
          "totalCount": {
            "type": "integer",
            "description": "Total number of results available",
            "format": "int32"
          },
          "pageIndex": {
            "type": "integer",
            "description": "Current page index",
            "format": "int32"
          },
          "totalPages": {
            "type": "integer",
            "description": "Total number of pages of results with current page size",
            "format": "int32"
          },
          "continuationToken": {
            "type": "string",
            "description": "Continuation Token to get next results",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Pagination model class"
      },
      "HelloAsso.Api.V5.Common.Models.Common.ResultsWithPaginationModel_Order": {
        "title": "ResultsWithPaginationModel<Order>",
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Statistics.Order"
            },
            "description": "Data property",
            "nullable": true
          },
          "pagination": {
            "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Common.PaginationModel"
          }
        },
        "additionalProperties": false,
        "description": "ResultsWithPaginationModel class"
      },
      "HelloAsso.Api.V5.Common.Models.Enums.FieldType": {
        "enum": [
          "Date",
          "TextInput",
          "FreeText",
          "ChoiceList",
          "File",
          "YesNo",
          "Phone",
          "Zipcode",
          "Number"
        ],
        "type": "string"
      },
      "HelloAsso.Api.V5.Common.Models.Enums.FormType": {
        "enum": [
          "CrowdFunding",
          "Membership",
          "Event",
          "Donation",
          "PaymentForm",
          "Checkout",
          "Shop"
        ],
        "type": "string"
      },
      "HelloAsso.Api.V5.Common.Models.Enums.ItemState": {
        "enum": [
          "Waiting",
          "Processed",
          "Registered",
          "Deleted",
          "Unknown",
          "Canceled",
          "Refused",
          "Abandoned"
        ],
        "type": "string"
      },
      "HelloAsso.Api.V5.Common.Models.Enums.OperationState": {
        "enum": [
          "Unknown",
          "Init",
          "Processing",
          "Processed",
          "Error",
          "InternalError",
          "Refused",
          "Aborted",
          "Canceled"
        ],
        "type": "string"
      },
      "HelloAsso.Api.V5.Common.Models.Enums.OrganizationType": {
        "enum": [
          "Association1901Rig",
          "Association1901Rup",
          "Association1901",
          "FondationRup",
          "FondDotation",
          "FondationSousEgide",
          "FondationScientifique",
          "FondationPartenariale",
          "FondationUniversitaire",
          "FondationHospitaliere",
          "Association1905",
          "Association1905Rup",
          "Entreprise",
          "Cooperative",
          "Etablissement",
          "Association1908",
          "Association1908Rig",
          "Association1908Rup",
          "AssociationMilitaire",
          "AssociationProprietaire",
          "Collectivités",
          "ComiteEntreprise",
          "CSE",
          "FabriqueEglise",
          "FondsPerenite",
          "GIE",
          "GIP",
          "MenseCuriale",
          "SCIC",
          "SCOP",
          "Autres",
          "EPA"
        ],
        "type": "string"
      },
      "HelloAsso.Api.V5.Common.Models.Enums.PaymentCashOutState": {
        "enum": [
          "MoneyIn",
          "CantTransferReceiverFull",
          "Transfered",
          "Refunded",
          "Refunding",
          "WaitingForCashOutConfirmation",
          "CashedOut",
          "Unknown",
          "Contested",
          "TransferInProgress"
        ],
        "type": "string"
      },
      "HelloAsso.Api.V5.Common.Models.Enums.PaymentMeans": {
        "enum": [
          "None",
          "Card",
          "Sepa",
          "Check",
          "Cash",
          "BankTransfer",
          "Other"
        ],
        "type": "string"
      },
      "HelloAsso.Api.V5.Common.Models.Enums.PaymentState": {
        "enum": [
          "Pending",
          "Authorized",
          "Refused",
          "Unknown",
          "Registered",
          "Error",
          "Refunded",
          "Refunding",
          "Waiting",
          "Canceled",
          "Contested",
          "WaitingBankValidation",
          "WaitingBankWithdraw",
          "Abandoned",
          "WaitingAuthentication",
          "AuthorizedPreprod",
          "Corrected",
          "Deleted",
          "Inconsistent",
          "NoDonation",
          "Init"
        ],
        "type": "string"
      },
      "HelloAsso.Api.V5.Common.Models.Enums.PaymentType": {
        "enum": [
          "Offline",
          "Credit",
          "Debit"
        ],
        "type": "string"
      },
      "HelloAsso.Api.V5.Common.Models.Enums.PriceCategory": {
        "enum": [
          "Fixed",
          "Pwyw",
          "Free"
        ],
        "type": "string"
      },
      "HelloAsso.Api.V5.Common.Models.Enums.SortOrder": {
        "enum": [
          "Asc",
          "Desc"
        ],
        "type": "string"
      },
      "HelloAsso.Api.V5.Common.Models.Enums.TierType": {
        "enum": [
          "Donation",
          "Payment",
          "Registration",
          "Membership",
          "MonthlyDonation",
          "MonthlyPayment",
          "OfflineDonation",
          "Contribution",
          "Bonus",
          "Product"
        ],
        "type": "string"
      },
      "HelloAsso.Api.V5.Common.Models.Statistics.ItemCustomField": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "type": {
            "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Enums.FieldType"
          },
          "answer": {
            "type": "string",
            "description": "Participant or user answer",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Custom field associated with the item or option"
      },
      "HelloAsso.Api.V5.Common.Models.Statistics.ItemDiscount": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "The discount code applied on the item",
            "nullable": true
          },
          "amount": {
            "type": "integer",
            "description": "The discount amount in cents",
            "format": "int32"
          }
        },
        "additionalProperties": false
      },
      "HelloAsso.Api.V5.Common.Models.Statistics.ItemOption": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Name of the option",
            "nullable": true
          },
          "amount": {
            "type": "integer",
            "description": "Amount of the option in cents",
            "format": "int32"
          },
          "priceCategory": {
            "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Enums.PriceCategory"
          },
          "isRequired": {
            "type": "boolean",
            "description": "Option is required or optional"
          },
          "customFields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Statistics.ItemCustomField"
            },
            "description": "Custom fields related to this option",
            "nullable": true
          },
          "optionId": {
            "type": "integer",
            "format": "int32"
          }
        },
        "additionalProperties": false,
        "description": "ItemOption class"
      },
      "HelloAsso.Api.V5.Common.Models.Statistics.Order": {
        "type": "object",
        "properties": {
          "payer": {
            "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Statistics.Payer"
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Statistics.OrderItem"
            },
            "description": "All items of the order",
            "nullable": true
          },
          "payments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Statistics.OrderPayment"
            },
            "description": "All payments of the order",
            "nullable": true
          },
          "amount": {
            "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Statistics.OrderAmountModel"
          },
          "id": {
            "type": "integer",
            "description": "The ID of the Order",
            "format": "int32"
          },
          "date": {
            "type": "string",
            "description": "Order creation date",
            "format": "date-time"
          },
          "formSlug": {
            "type": "string",
            "description": "FormSlug (lowercase name of the form without special characters)",
            "nullable": true
          },
          "formType": {
            "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Enums.FormType"
          },
          "organizationName": {
            "type": "string",
            "description": "The organization name.",
            "nullable": true
          },
          "organizationSlug": {
            "type": "string",
            "description": "OrganizationSlug (lowercase name of the organization without special characters)",
            "nullable": true
          },
          "organizationType": {
            "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Enums.OrganizationType"
          },
          "organizationIsUnderColucheLaw": {
            "type": "boolean",
            "description": "Whether or not the organization is subject to the coluche law"
          },
          "checkoutIntentId": {
            "type": "integer",
            "description": "Checkout intent Id if available",
            "format": "int32",
            "nullable": true
          },
          "meta": {
            "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Common.MetaModel"
          }
        },
        "additionalProperties": false
      },
      "HelloAsso.Api.V5.Common.Models.Statistics.OrderAmountModel": {
        "type": "object",
        "properties": {
          "total": {
            "type": "integer",
            "description": "Total amount in cents",
            "format": "int32"
          },
          "vat": {
            "type": "integer",
            "description": "Vat amount in cents",
            "format": "int32"
          },
          "discount": {
            "type": "integer",
            "description": "Discount amount in cents",
            "format": "int32"
          }
        },
        "additionalProperties": false
      },
      "HelloAsso.Api.V5.Common.Models.Statistics.OrderItem": {
        "type": "object",
        "properties": {
          "payments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Statistics.SharePayment"
            },
            "description": "Payments linked to this item and each share between the item and the payment",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "user": {
            "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Statistics.User"
          },
          "priceCategory": {
            "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Enums.PriceCategory"
          },
          "minAmount": {
            "type": "integer",
            "description": "Minimum amount that was specified on the tier (in cents)",
            "format": "int32",
            "nullable": true
          },
          "discount": {
            "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Statistics.ItemDiscount"
          },
          "customFields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Statistics.ItemCustomField"
            },
            "description": "Custom fields related to this item",
            "nullable": true
          },
          "options": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Statistics.ItemOption"
            },
            "description": "Extra options taken with this item",
            "nullable": true
          },
          "ticketUrl": {
            "type": "string",
            "description": "The Ticket Url",
            "nullable": true
          },
          "qrCode": {
            "type": "string",
            "description": "The item QrCode (for ticket scanning only)",
            "nullable": true
          },
          "membershipCardUrl": {
            "type": "string",
            "description": "The Membership Card Url",
            "nullable": true
          },
          "dayOfLevy": {
            "type": "integer",
            "description": "The day of levy for monthly donation only",
            "format": "int32",
            "nullable": true
          },
          "tierDescription": {
            "type": "string",
            "description": "Tier description",
            "nullable": true
          },
          "tierId": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "comment": {
            "type": "string",
            "nullable": true
          },
          "id": {
            "type": "integer",
            "description": "ID of the Item",
            "format": "int32"
          },
          "amount": {
            "type": "integer",
            "description": "Total item Price in cents (after discount without extra options)",
            "format": "int32"
          },
          "type": {
            "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Enums.TierType"
          },
          "initialAmount": {
            "type": "integer",
            "description": "The raw amount (without reduction)",
            "format": "int32",
            "nullable": true
          },
          "state": {
            "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Enums.ItemState"
          }
        },
        "additionalProperties": false,
        "description": "Item on the order"
      },
      "HelloAsso.Api.V5.Common.Models.Statistics.OrderPayment": {
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Statistics.ShareItem"
            },
            "description": "Items linked to this payment and each share between the item and the payment",
            "nullable": true
          },
          "isRefundable": {
            "type": "boolean",
            "description": "Indicate if the payment is refundable or not",
            "nullable": true
          },
          "cashOutDate": {
            "type": "string",
            "description": "The date of the cash out",
            "format": "date-time",
            "nullable": true
          },
          "idCashOut": {
            "type": "integer",
            "description": "The id of the cash out",
            "format": "int32",
            "nullable": true
          },
          "cashOutState": {
            "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Enums.PaymentCashOutState"
          },
          "paymentReceiptUrl": {
            "type": "string",
            "description": "The Payment Receipt Url",
            "nullable": true
          },
          "fiscalReceiptUrl": {
            "type": "string",
            "description": "The Fiscal Receipt Url",
            "nullable": true
          },
          "id": {
            "type": "integer",
            "description": "The ID of the payment",
            "format": "int32"
          },
          "amount": {
            "type": "integer",
            "description": "Total Amount of the payment (in cents)",
            "format": "int32"
          },
          "amountTip": {
            "type": "integer",
            "description": "Tip Amount of the payment (in cents)",
            "format": "int32",
            "nullable": true
          },
          "date": {
            "type": "string",
            "description": "Date of the payment",
            "format": "date-time"
          },
          "paymentMeans": {
            "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Enums.PaymentMeans"
          },
          "installmentNumber": {
            "type": "integer",
            "description": "Indicates the payment number (useful in the case of an order comprising payments with installments)",
            "format": "int32",
            "nullable": true
          },
          "state": {
            "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Enums.PaymentState"
          },
          "type": {
            "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Enums.PaymentType"
          },
          "meta": {
            "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Common.MetaModel"
          },
          "paymentOffLineMean": {
            "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Enums.PaymentMeans"
          },
          "refundOperations": {
            "title": "List<RefundOperationLightModel>",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Statistics.RefundOperationLightModel"
            },
            "description": "The refund operations information for the specific payment.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Payment on the order"
      },
      "HelloAsso.Api.V5.Common.Models.Statistics.Payer": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "nullable": true
          },
          "address": {
            "type": "string",
            "description": "Gets or Sets Address",
            "nullable": true
          },
          "city": {
            "type": "string",
            "description": "Gets or Sets City",
            "nullable": true
          },
          "zipCode": {
            "type": "string",
            "description": "Gets or Sets ZipCode",
            "nullable": true
          },
          "country": {
            "type": "string",
            "description": "Gets or Sets Country",
            "nullable": true
          },
          "company": {
            "type": "string",
            "description": "Gets or Sets Company",
            "nullable": true
          },
          "dateOfBirth": {
            "type": "string",
            "description": "Gets or Sets date of birth",
            "format": "date-time",
            "nullable": true
          },
          "firstName": {
            "type": "string",
            "nullable": true
          },
          "lastName": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "HelloAsso.Api.V5.Common.Models.Statistics.RefundOperationLightModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The refund operation identifier.",
            "format": "int32"
          },
          "amount": {
            "type": "integer",
            "description": "The amount for this refund.",
            "format": "int32"
          },
          "amountTip": {
            "type": "integer",
            "description": "The amount tip for this refund.",
            "format": "int32"
          },
          "status": {
            "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Enums.OperationState"
          },
          "meta": {
            "$ref": "#/components/schemas/HelloAsso.Api.V5.Common.Models.Common.MetaModel"
          }
        },
        "additionalProperties": false,
        "description": "The refund operation with the Id, amount, amount tip and the status."
      },
      "HelloAsso.Api.V5.Common.Models.Statistics.ShareItem": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Id of the order item",
            "format": "int32"
          },
          "shareAmount": {
            "type": "integer",
            "description": "Amount of the payment assigned to the item and its options (in cents)",
            "format": "int32"
          },
          "shareItemAmount": {
            "type": "integer",
            "description": "Amount of the item payed on this payment term (in cents)",
            "format": "int32"
          },
          "shareOptionsAmount": {
            "type": "integer",
            "description": "Amount of all extra options linked to this item and payed on this payment (in cents)",
            "format": "int32",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "HelloAsso.Api.V5.Common.Models.Statistics.SharePayment": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Id of the payment",
            "format": "int32"
          },
          "shareAmount": {
            "type": "integer",
            "description": "Amount of the item payed on this payment term (in cents)",
            "format": "int32"
          }
        },
        "additionalProperties": false
      },
      "HelloAsso.Api.V5.Common.Models.Statistics.User": {
        "type": "object",
        "properties": {
          "firstName": {
            "type": "string",
            "nullable": true
          },
          "lastName": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      }
    },
    "securitySchemes": {
      "OAuth2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://api.helloasso.com/oauth2/token",
            "scopes": {}
          }
        }
      }
    }
  },
  "x-readme": {
    "samples-languages": [
      "shell",
      "php",
      "javascript",
      "python",
      "node"
    ]
  }
}
```