List Form Submissions

get/public/v1/form-submissions

get/public/v1/form-submissions

curl --request GET \
  --url 'https://api.app.astalty.com.au/public/v1/form-submissions' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Response

{
  "data": [
    {
      "id": "f0s1u2b3-a4b5-46c7-8d9e-0f1a2b3c4d5e",
      "submitted_url": "https://app.astalty.com.au/form/f1o2r3m4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
      "submitted_at": "2024-01-15T10:30:00+00:00",
      "archived_at": null,
      "created_at": "2024-01-15T10:30:00+00:00",
      "form": {
        "id": "f1o2r3m4-a5b6-47c8-9d0e-1f2a3b4c5d6e"
      },
      "submitted_by": {
        "id": "u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
        "first_name": "John",
        "last_name": "Doe"
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 0,
    "total": 0,
    "allowed_sorts": [
      "string"
    ]
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Query parameters

page[size]integer
Number of results per page. Minimum 1, maximum 100.
Default:25
page[number]integer
The page number to retrieve. Use the last_page value from the meta response to determine the total number of pages available.
Default:1

Response

200application/json

Paginated set of FormSubmissionResource

dataobject[]required
▶Show 7 child attributesHide child attributes
- idstringrequired
  Example:f0s1u2b3-a4b5-46c7-8d9e-0f1a2b3c4d5e
- submitted_urlstring | nullrequired
  Example:https://app.astalty.com.au/form/f1o2r3m4-a5b6-47c8-9d0e-1f2a3b4c5d6e
- submitted_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- archived_atstring | nullrequired
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- formobjectrequired
  ▶Show 1 child attributesHide child attributes
  idstringrequired
  Example:f1o2r3m4-a5b6-47c8-9d0e-1f2a3b4c5d6e
- submitted_byobject | nullrequired
  ▶Show 3 child attributesHide child attributes
  idstringrequired
  Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  first_namestringrequired
  Example:John
  last_namestringrequired
  Example:Doe
metaobjectrequired
▶Show 5 child attributesHide child attributes
- current_pageintegerrequired≥ 1
- last_pageintegerrequired≥ 1
- per_pageintegerrequired≥ 0
  Number of items shown per page.
- totalintegerrequired≥ 0
  Total number of items being paginated.
- allowed_sortsstring[]required
  The list of allowed sorts for this endpoint.

Errors

401Unauthenticated
403Authorization error

Command Palette

Authorization

Query parameters

Response

Errors