The custom field schema

GET

/api/v1/fields

curl --request GET \
  --url http://localhost:3000/api/v1/fields \
  --header 'Authorization: Bearer <token>'

Scope: read.

Authorizations

• bearer
• session
• None

Responses

200

Fields

Media typeapplication/json

object

data

required

Array<object>

object

key

required

string

label

required

string

type

required

string

Allowed values: text number date boolean select

options

required

Array<string>

required

required

boolean

Example

{
  "data": [
    {
      "type": "text"
    }
  ]
}

default

An error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

detail

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}