List Forms

get/public/v1/forms

get/public/v1/forms

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

Response

{
  "data": [
    {
      "id": "f1o2r3m4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
      "name": "Intake Form",
      "description": "Initial client intake questionnaire",
      "status": "published",
      "type": "internal",
      "usage": "general",
      "hosted_url": "https://app.astalty.com.au/form/f1o2r3m4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
      "archived_at": "2024-01-15T10:30:00+00:00",
      "created_at": "2024-01-15T10:30:00+00:00",
      "fields": [
        {
          "id": "f1e2l3d4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
          "label": "Date of birth",
          "content": "Section heading or rich text content",
          "type": "date",
          "fillable": true,
          "required": false,
          "options": [
            "Yes",
            "No"
          ],
          "repeater_fields": [
            {
              "key": "name",
              "label": "Full name"
            }
          ],
          "conditions": [
            {
              "effect": "visibility",
              "source_field_id": "f1e2l3d4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
              "operator": "equals",
              "value": "Yes"
            }
          ],
          "value_format": "One of the strings in options. Not an option ID."
        }
      ]
    }
  ],
  "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 FormResource

dataobject[]required
▶Show 10 child attributesHide child attributes
- idstringrequired
  Example:f1o2r3m4-a5b6-47c8-9d0e-1f2a3b4c5d6e
- namestringrequired
  Example:Intake Form
- descriptionstring | nullrequired
  Example:Initial client intake questionnaire
- statusenum<string>required
  Available options:archivedpublishedunpublished
- typeenum<string>required
  Available options:externalinternal
- usageenum<string>required
  Available options:feedbackgeneraljob_applicationparticipant_incidentreferralregisterstaff_incident
- hosted_urlstringrequired
  Example:https://app.astalty.com.au/form/f1o2r3m4-a5b6-47c8-9d0e-1f2a3b4c5d6e
- archived_atstring | nullrequired
  Example:2024-01-15T10:30:00+00:00
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- fieldsobject[]
  ▶Show 10 child attributesHide child attributes
  idstringrequired
  Example:f1e2l3d4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  labelstring | nullrequired
  Example:Date of birth
  contentstring | nullrequired
  Example:Section heading or rich text content
  typeenum<string>required
  Available options:addressannotated_imagecheckboxdatedatetimedivideremailfileheaderimagelinear_scalemobile_phonemoneymultiselectnumberparticipant_selectradiorepeaterrich_textselectsite_selecttexttextareauser_select
  fillablebooleanrequired
  Example:true
  requiredbooleanrequired
  Example:false
  optionsstring[]required
  repeater_fieldsobject[]required
  ▶Show 2 child attributesHide child attributes
  keyenum<string>required
  Available options:contactname
  labelstringrequired
  Example:Full name
  conditionsobject[]required
  ▶Show 4 child attributesHide child attributes
  effectenum<string>required
  Available options:requiredvisibility
  source_field_idstringrequired
  Example:f1e2l3d4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  operatorenum<string>required
  Available options:afterbeforecontainsequalsgreater_thanis_checkedis_emptyis_not_checkedis_not_emptyless_thannot_equals
  valuestring | nullrequired
  Example:Yes
  value_formatstring | enum<string> | nullrequired
  Example:One of the strings in options. Not an option ID.
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