Skip to main content
GET
/
sessions
/
field
/
{field_id}
Get One Field
curl --request GET \
  --url https://api.swoogo.com/api/v1/sessions/field/{field_id} \
  --header 'Authorization: Bearer <token>'
{
  "allow_html": false,
  "attribute": "c_57",
  "choices": [
    {
      "id": 109,
      "name": "Basic: 0-1 years of experience with the topic/product; looking for a basic introduction",
      "sort": 0
    },
    {
      "id": 110,
      "name": "Intermediate: 1-3 years of experience with the topic/product: comfortable with basic functions; looking to dive deeper",
      "sort": 1
    },
    {
      "id": 111,
      "name": "Advanced: 3+ years of experience with the topic/product; well-versed in all functions‚ looking to learn complexities and new trends",
      "sort": 2
    }
  ],
  "id": 57,
  "name": "dropdown list",
  "required": false,
  "settings": null,
  "sort": 11,
  "type": "dropDownList",
  "visible": true
}

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": 109,
    "name": "Basic: 0-1 years of experience with the topic/product; looking for a basic introduction",
    "sort": 0
  },
  {
    "id": 110,
    "name": "Intermediate: 1-3 years of experience with the topic/product: comfortable with basic functions; looking to dive deeper",
    "sort": 1
  },
  {
    "id": 111,
    "name": "Advanced: 3+ years of experience with the topic/product; well-versed in all functions‚ looking to learn complexities and new trends",
    "sort": 2
  }
]
​
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