Skip to content
Admin API reference
/
v4 API
/
/
Retrieve Form

Retrieve Form

Request

Retrieves a single form.

Security
ZephrHmacHttp
Path
slugstringrequired

Unique Form identifier

cURL
curl -i -X GET \
  'https://demo.api.zephr.com/v3/forms/{slug}' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK

Headers
any
Bodyapplication/json
titlestring
Example:"Test"
internal-descriptionstring
Example:"This form is for testing"
public-descriptionstring
Example:"Please provide some info"
registrationboolean
Example:true
fieldsArray of objects(field)
Response
{
  "title": "Test",
  "internal-description": "This form is for testing",
  "public-description": "Please provide some info",
  "registration": true,
  "fields": [
    { … }
  ]
}