GET /api/v2/field_groups
Get all field groups

Errors

Code Description
401 Unauthorized
500 Internal Server Error
422 Missing parameters

Examples

GET /api/v2/field_groups
200
{
  "field_groups": [
    {
      "id": 37,
      "name": "test_group",
      "created_at": "2021-10-05T09:02:11.199Z",
      "updated_at": "2021-10-05T09:02:11.216Z",
      "group_type": "default",
      "fields": [
        {
          "id": 28,
          "field_group_id": 37,
          "name": "test_field_name",
          "field_type": "textbox",
          "dropdown_options": null,
          "created_at": "2021-10-05T09:02:11.212Z",
          "updated_at": "2021-10-05T09:02:11.212Z",
          "searchable": false,
          "read_only": false
        }
      ]
    },
    {
      "id": 38,
      "name": "test_group2",
      "created_at": "2021-10-05T09:02:11.223Z",
      "updated_at": "2021-10-05T09:02:11.223Z",
      "group_type": "default",
      "fields": []
    }
  ]
}
GET /api/v2/field_groups
401

Headers

Header name Description
Content-Type
required
application/json
X-API-KEY
required
YOUR_API_KEY

GET /api/v2/fields_group/:field_group_id
Get field group by id

Errors

Code Description
401 Unauthorized
500 Internal Server Error
422 Missing parameters

Examples

GET /api/v2/field_groups/39
200
{
  "id": 39,
  "name": "special_name",
  "created_at": "2021-10-05T09:02:14.781Z",
  "updated_at": "2021-10-05T09:02:14.796Z",
  "group_type": "default",
  "fields": [
    {
      "id": 29,
      "field_group_id": 39,
      "name": "test_field_name",
      "field_type": "textbox",
      "dropdown_options": null,
      "created_at": "2021-10-05T09:02:14.792Z",
      "updated_at": "2021-10-05T09:02:14.792Z",
      "searchable": false,
      "read_only": false
    }
  ]
}
GET /api/v2/field_groups/1337
404
{
  "error": "Field group not found"
}
GET /api/v2/field_groups/1
401

Params

Param name Description
field_group_id
required

Field group ID

Validations:

  • Must be a String

Headers

Header name Description
Content-Type
required
application/json
X-API-KEY
required
YOUR_API_KEY