Get Form

Retrieve a form and its field definitions.

Settings:

URL

Method

https://online.99digital.co.il/api/v1/accounts/{account_id}/forms/{form_id}

JSON via GET

Authorization:

Header Parameter

Description

api_access_token

User API key; access depends on the user's permissions.

Path Parameters:

Parameter

Description

Required

account_id

Account identifier.

Yes

form_id

Form identifier in the path.

Yes

Request Example:

curl -s -H "api_access_token: $TOKEN" "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/forms/$FORM"

Response:

This abbreviated example shows two of the 16 fields in the supplied response.

{
  "id": "90",
  "name": "new form",
  "description": null,
  "status": "published",
  "created_at": "2026-09-23T11:06:05.330Z",
  "updated_at": "2026-09-23T11:06:05.330Z",
  "fields": [
    {"id": "text", "type": "text", "name": "text", "label": "Text field", "required": true},
    {"id": "email", "type": "email", "name": "email", "label": "Email", "required": false}
  ]
}

Response-Explain:

Parameter

Description

id

Form identifier (string).

name

Form name.

description

Form description.

status

Form status.

Enum: draft, published, archived.

created_at

Creation timestamp in ISO 8601 format.

updated_at

Last update timestamp in ISO 8601 format.

fields

Array of field definitions.

fields[].id

Field identifier; corresponds to answers[].field_id when the field is answered.

fields[].type

Field type.

Enum: text, email, phone, number, textarea, radio, checkbox, multi_select, select, date, time, datetime, number_rating, slider, file_upload, star_rating.

fields[].name

Field name.

fields[].label

Display label.

fields[].required

Boolean indicating whether the field is required.