API Reference
  1. Teamworks AMS API
  2. Forms

(v3) Get Form Schema

get
https://{amsServer}/{amsAppName}/api/v3/forms//

Returns the full schema of a specific form, including form-level properties, section names, and all field definitions (types, options, validation rules, etc.).

Use this to discover the exact field names required when reading or writing data to a form.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

The type of form

Allowed:
integer
required

The unique form ID, returned by GET /api/v3/forms/summaries

Cookie Params
Headers
string
required

The current session token. Returned by most API calls and must be passed on all subsequent v2/v3 calls.

string

A unique identifier for your application. Helps Teamworks support staff identify your requests if you need assistance.

Responses
200

Form schema including all field definitions

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?