Application custom-fields

GET 
/applications/:id/custom-fields

This endpoint retrieve and returns the custom fields value entered by the user during the application process.

The custom fields the user will have to fill in are defined in the settings section of your project.

Retrieving the custom fields requires the ID of the user application.

note

Custom fields that aren't required or that you added afterwards may not be present in the response.

Request

Path Parameters

id uuidrequired

Header Parameters

X-API-Key stringrequired

Responses

200

The request has succeeded.

application/json

Schema

Schema

• Array [

oneOf

InputField

slug stringrequired

Slug of the field.

type stringrequired

Possible values: [input]

value stringrequired

Value entered by the user.

TextAreaField

slug stringrequired

Slug of the field.

type stringrequired

Possible values: [textarea]

value stringrequired

Value entered by the user.

SelectField

slug stringrequired

Slug of the field.

type stringrequired

Possible values: [select]

choice stringrequired

Selected choice of the user.

CheckboxField

slug stringrequired

Slug of the field.

type stringrequired

Possible values: [checkbox]

checked booleanrequired

Whether the checkbox is checked.

CountrySelectField

slug stringrequired

Slug of the field.

type stringrequired

Possible values: [country-select]

country stringrequired

ISO 3166-1 alpha-3 country code.

UploadField

slug stringrequired

Slug of the field.

type stringrequired

Possible values: [upload]

url stringrequired

HTTP URL to the uploaded file.

• ]

Example (from schema)

[
  {},
  {},
  {},
  {},
  {},
  {}
]

Example

[
  {
    "slug": "name",
    "type": "input",
    "value": "John Doe"
  },
  {
    "slug": "description",
    "type": "textarea",
    "value": "This is a description."
  },
  {
    "slug": "fruits",
    "type": "select",
    "choice": "banana"
  },
  {
    "slug": "terms",
    "type": "checkbox",
    "checked": true
  },
  {
    "slug": "country",
    "type": "country-select",
    "country": "USA"
  },
  {
    "slug": "file",
    "type": "upload",
    "url": "https://example.com/file.pdf"
  }
]

404

The server cannot find the requested resource.