Skip to main content
GET
/
sponsors
/
field
/
{field_id}
Get One Field
curl --request GET \
  --url https://api.swoogo.com/api/v1/sponsors/field/{field_id} \
  --header 'Authorization: Bearer <token>'
{
  "allow_html": false,
  "attribute": "level",
  "choices": [
    {
      "id": 47,
      "name": "Gold",
      "sort": 0
    },
    {
      "id": 48,
      "name": "update choice name",
      "sort": 1
    },
    {
      "id": 49,
      "name": "Bronze",
      "sort": 2
    },
    {
      "id": 68,
      "name": "Platinum",
      "sort": 4
    },
    {
      "id": 137,
      "name": "new choices of level",
      "sort": 6
    },
    {
      "id": 138,
      "name": "new choices of level",
      "sort": 7
    },
    {
      "id": 139,
      "name": "new choices of level",
      "sort": 8
    },
    {
      "id": 140,
      "name": "new choices of level",
      "sort": 9
    },
    {
      "id": 141,
      "name": "new choices of level",
      "sort": 10
    },
    {
      "id": 142,
      "name": "new choices of level",
      "sort": 11
    }
  ],
  "id": 27,
  "name": "new level of sponsorship 1",
  "required": false,
  "settings": null,
  "sort": 4,
  "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 Sponsor Field

​
allow_html
boolean
Example:

false

​
attribute
string
Example:

"level"

​
choices
object[]
Example:
[
  { "id": 47, "name": "Gold", "sort": 0 },
  {
    "id": 48,
    "name": "update choice name",
    "sort": 1
  },
  { "id": 49, "name": "Bronze", "sort": 2 },
  { "id": 68, "name": "Platinum", "sort": 4 },
  {
    "id": 137,
    "name": "new choices of level",
    "sort": 6
  },
  {
    "id": 138,
    "name": "new choices of level",
    "sort": 7
  },
  {
    "id": 139,
    "name": "new choices of level",
    "sort": 8
  },
  {
    "id": 140,
    "name": "new choices of level",
    "sort": 9
  },
  {
    "id": 141,
    "name": "new choices of level",
    "sort": 10
  },
  {
    "id": 142,
    "name": "new choices of level",
    "sort": 11
  }
]
​
id
number
Example:

27

​
name
string
Example:

"new level of sponsorship 1"

​
required
boolean
Example:

false

​
settings
unknown
​
sort
number
Example:

4

​
type
string
Example:

"dropDownList"

​
visible
boolean
Example:

true