Skip to content

List forms

Request

Retrieve a list of all forms used by the host to collect additional information on ticket purchases.

Security
SessionKey(Required scopes: customeradministrator)
Path
hostintegerrequired

Unique identifier of the requested host

Query
recordsinteger

The number of records per page that should be returned

Default:25
pageinteger

The number of the results page to return

Default:1
curl -i -X GET \
  'https://docs.ticketingevents.com/_mock/openapi/hosts/{host}/forms?records=25&page=1' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The list of the specified host's forms was successfully retrieved.

Bodyapplication/json
totalinteger

The total number of results available

pageinteger

The number of the results page returned

recordsinteger

The maximum number of results returned per page

entriesArray of objects(response-12)
Response
{
  "page": 1,
  "records": 25,
  "entries": [
    { … },
    { … }
  ]
}