List Form Fields

List form_fields

GET /v1/form_fields

List Form Fields

cURL

curl --request GET \
  --url https://api.rootly.com/v1/form_fields \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "<string>",
      "attributes": {
        "name": "<string>",
        "shown": [
          "<string>"
        ],
        "required": [
          "<string>"
        ],
        "default_values": [
          "<string>"
        ],
        "created_at": "<string>",
        "updated_at": "<string>",
        "value_kind_catalog_id": "<string>",
        "slug": "<string>",
        "description": "<string>",
        "show_on_incident_details": true,
        "enabled": true,
        "auto_set_by_catalog_property_id": "<string>"
      }
    }
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "prev": "<string>",
    "next": "<string>",
    "last": "<string>"
  },
  "meta": {
    "current_page": 123,
    "next_page": 123,
    "prev_page": 123,
    "total_count": 123,
    "total_pages": 123,
    "next_cursor": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

include · enum<string>

comma separated if needed. eg: options,positions

Available options: options, positions

page[number] · integer

page[size] · integer

filter[search] · string

filter[slug] · string

filter[name] · string

filter[kind] · string

filter[enabled] · boolean

filter[created_at][gt] · string

filter[created_at][gte] · string

filter[created_at][lt] · string

filter[created_at][lte] · string

Response

200 - application/vnd.api+json

success

data · object[] · required

Show child attributes

links · object · required

Show child attributes

meta · object · required

Show child attributes