Get CustomField - Gofive OpenAPI

Request

Header Params

Ocp-Apim-Subscription-Key

string

optional

Example:

WPe123a9RKbcfLQNSztr45

Authorization

string

optional

Example:

bearer {your token}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

Body

status

object

optional

code

string

required

description

string

required

data

array [object {7}]

optional

fieldName

string

optional

customFieldsType

enum<integer>

optional

Allowed values:

Text SingleSelection MultiSelection DropdownList DatePicker Paragraph

fieldTypeName

null

optional

textBoxType

enum<integer>

optional

Allowed values:

None Letter Number Email Custom

textBoxTypeName

null

optional

regularExpression

string

optional

options

array [object {2}] | null

optional

Example

{
  "status": {
    "code": "1000",
    "description": "Success"
  },
  "data": [
    {
      "fieldName": "Paragraph",
      "customFieldsType": 20006,
      "textBoxType": 2
    },
    {
      "fieldName": "Single Selection",
      "customFieldsType": 20002,
      "textBoxType": 1,
      "options": [
        {
          "sequence": "1",
          "option": "Option 1"
        },
        {
          "sequence": "2",
          "option": "Option 2"
        },
        {
          "sequence": "3",
          "option": "Option 3"
        }
      ]
    },
    {
      "fieldName": "Multi Selection",
      "customFieldsType": 20003,
      "textBoxType": 1,
      "options": [
        {
          "sequence": "1",
          "option": "Option 1"
        },
        {
          "sequence": "2",
          "option": "Option 2"
        },
        {
          "sequence": "3",
          "option": "Option 3"
        }
      ]
    },
    {
      "fieldName": "Drop down List",
      "customFieldsType": 20004,
      "textBoxType": 1,
      "options": [
        {
          "sequence": "1",
          "option": "Option 1"
        },
        {
          "sequence": "2",
          "option": "Option 2"
        },
        {
          "sequence": "3",
          "option": "Option 3"
        },
        {
          "sequence": "4",
          "option": "Option 4"
        }
      ]
    },
    {
      "fieldName": "Date Picker",
      "customFieldsType": 20005,
      "textBoxType": 1
    },
    {
      "fieldName": "Text - none",
      "customFieldsType": 20001,
      "textBoxType": 1
    },
    {
      "fieldName": "Text - Letter",
      "customFieldsType": 20001,
      "textBoxType": 2
    },
    {
      "fieldName": "Text - Number",
      "customFieldsType": 20001,
      "textBoxType": 3
    },
    {
      "fieldName": "Text - Email",
      "customFieldsType": 20001,
      "textBoxType": 4
    },
    {
      "fieldName": "Text - Custom",
      "customFieldsType": 20001,
      "textBoxType": 5,
      "regularExpression": "^[a-z]$"
    }
  ]
}

🟠401User authentication required V2.