Skip to main content
GET
Get One Field

Authorizations

Authorization
string
header
required

OAuth 2.0 bearer token obtained from POST /oauth2/token. Tokens expire after 30 minutes. Include in the Authorization header as Bearer {access_token}.

Path Parameters

field_id
integer
required

integer - required - The ID of the field you want to get

Example:

1

Query Parameters

fields
string

string - optional - Comma separated list of fields you want to return

Example:

"id,attribute,name,s_hint,type,visible,required,sort,allow_html,s_url_display_format,s_button_text,s_url_image_id,s_max_links,s_link_collection_fields"

Response

Get Session Field

allow_html
boolean
Example:

false

attribute
string
Example:

"c_57"

choices
object[]
Example:
id
number
Example:

57

name
string
Example:

"dropdown list"

required
boolean
Example:

false

settings
unknown
sort
number
Example:

11

type
string
Example:

"dropDownList"

visible
boolean
Example:

true