Get a Form

get/public/v1/forms/{form}

Returns the form's fields with the IDs and value formats a submission needs.

get/public/v1/forms/{form}

curl --request GET \
  --url 'https://api.app.astalty.com.au/public/v1/forms/{form}' \
  --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."
      }
    ]
  }
}

Authorization

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

Path parameters

formstringrequired
The form UUID

Response

200application/json

FormResource

dataobjectrequired
▶Show 10 child attributesHide child attributes
- idstringrequired
  Example:f1o2r3m4-a5b6-47c8-9d0e-1f2a3b4c5d6e
- namestringrequired
  Example:Intake Form
- descriptionstring | nullrequired
  Example:Initial client intake questionnaire
- statusstringrequired
  Example:published
- typestringrequired
  Example:internal
- usagestringrequired
  Example:general
- 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[]required
  ▶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
  typestringrequired
  Example:date
  fillablebooleanrequired
  Example:true
  requiredbooleanrequired
  Example:false
  optionsstring[]required
  repeater_fieldsobject[]required
  ▶Show 2 child attributesHide child attributes
  keystringrequired
  Example:name
  labelstringrequired
  Example:Full name
  conditionsobject[]required
  ▶Show 4 child attributesHide child attributes
  effectstringrequired
  Example:visibility
  source_field_idstringrequired
  Example:f1e2l3d4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  operatorstringrequired
  Example:equals
  valuestring | nullrequired
  Example:Yes
  value_formatstring | enum<string> | nullrequired
  Example:One of the strings in options. Not an option ID.

Errors

401Unauthenticated
403Authorization error
404Not found

Command Palette

Authorization

Path parameters

Response

Errors