Retrieve form details

Request

Retrieve metadata and fields of the requested form

Security

SessionKey(Required scopes: customeradministrator)

Path

hostintegerrequired

Unique identifier of the requested host

formintegerrequired

Unique identifier of the requested form

curl -i -X GET \
  'https://docs.ticketingevents.com/_mock/openapi/hosts/{host}/forms/{form}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Metadata and fields of the requested form were successfully retrieved.

Bodyapplication/json

selfstring

URI of the form resource

namestring

Human-readable name that uniquely identifies the form

descriptionstring

Text describing the type of additional information the form is designed to collect.

fieldsArray of objects

Response

{
  "self": "/hosts/14271847571941/forms/1927471842571142",
  "name": "Meal Options",
  "description": "Collect meal options from our mas players to prepare appropriate amounts for breakfast.",
  "fields": [
    { … },
    { … },
    { … }
  ]
}