Responses

List reached endings

GET/v1/submissions/endings

The endings this form's responses reached, including endings deleted from the form since. Pass an ending's id as endingId to filter GET /v1/submissions.

curl "$AYEFORM_API/v1/submissions/endings?formId=FORM_ID" \
  -H "Authorization: Bearer $AYEFORM_KEY"

200 Response

[
  {
    "id": "bm4j4jeah69krh1va4qkntnm4ctxytcx",
    "name": "Luigi's Pizza",
    "countsAsLead": true
  }
]

Query parameters

formIdstringrequired
The form.

Response

A list of objects. Up to 100 endings, one per id. Each shows the name and lead setting its latest response recorded. Endings reached only by responses older than the plan shows are left out.

idstringrequired
The ending's id in the form. Pass it as endingId to filter GET /v1/submissions.
namestringrequired
The ending's name at the time the response reached it, such as "Order placed".
countsAsLeadbooleanrequired
Whether reaching this ending counts as a lead for ad tracking. Reaching an ending that doesn't count means the person was disqualified.

Errors answer with a status and the error shape.