Field groups

>>>

GET /api/v2/field_groups
Get all field groups

Headers

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

Examples

// Successful request
GET /api/v2/field_groups
200
{
  "field_groups": [
    {
      "id": 1,
      "name": "test_group",
      "created_at": "2023-11-27T09:42:50.666Z",
      "updated_at": "2023-11-27T09:42:50.712Z",
      "group_type": "default",
      "open_by_default": false,
      "locked": false,
      "add_by_default_to_media_types": [],
      "order": null,
      "deleted": false,
      "fields": [
        {
          "id": 1,
          "field_group_id": 1,
          "name": "test_field_name",
          "field_type": "textbox",
          "dropdown_options": null,
          "created_at": "2023-11-27T09:42:50.708Z",
          "updated_at": "2023-11-27T09:42:50.708Z",
          "searchable": false,
          "read_only": false,
          "order": null,
          "deleted": false
        }
      ]
    }
  ]
}

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters
>>>

GET /api/v2/field_groups/:field_group_id
Get field group by ID

Headers

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

Params

Param name Description
field_group_id
required

Field group ID

Validations:

  • Must be a String

Examples

// Successful request
GET /api/v2/field_groups/2
200
{
  "id": 2,
  "name": "special_name",
  "created_at": "2023-11-27T09:42:50.848Z",
  "updated_at": "2023-11-27T09:42:50.859Z",
  "group_type": "default",
  "open_by_default": false,
  "locked": false,
  "add_by_default_to_media_types": [],
  "order": null,
  "deleted": false,
  "fields": [
    {
      "id": 2,
      "field_group_id": 2,
      "name": "test_field_name",
      "field_type": "textbox",
      "dropdown_options": null,
      "created_at": "2023-11-27T09:42:50.857Z",
      "updated_at": "2023-11-27T09:42:50.857Z",
      "searchable": false,
      "read_only": false,
      "order": null,
      "deleted": false
    }
  ]
}
// Field group not found
GET /api/v2/field_groups/1337
404
{
  "error": "Couldn't find FieldGroup with 'id'=1337"
}

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters
>>>

POST /api/v2/admin/field_groups
Create field group

Headers

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

Params

Param name Description
name
required

Field group name

Validations:

  • Must be a String
group_type
optional

Field group type

Validations:

  • Must be one of: default, complex.
open_by_default
optional

Open by default

Validations:

  • Must be one of: true, false.
locked
optional

Locked

Validations:

  • Must be one of: true, false.
add_by_default_to_media_types
optional

Add by default to media types

Validations:

  • Must be an array of [“article”, “audio”, “document”, “image”, “other”, “placeholder”, “project”, “video”]

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters
>>>

POST /api/v2/admin/field_groups/:field_group_id
Update field group

Headers

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

Params

Param name Description
field_group_id
required

Field group ID

Validations:

  • Must be a String
name
optional

Field group name

Validations:

  • Must be a String
open_by_default
optional

Open by default

Validations:

  • Must be one of: true, false.
locked
optional

Locked

Validations:

  • Must be one of: true, false.
add_by_default_to_media_types
optional

Add by default to media types

Validations:

  • Must be an array of [“article”, “audio”, “document”, “image”, “other”, “placeholder”, “project”, “video”]
order
optional

Field group display order

Validations:

  • Must be a Integer

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters
>>>

POST /api/v2/admin/field_groups/:field_group_id/fields
Add field to field group

Headers

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

Params

Param name Description
field_group_id
required

Field group ID

Validations:

  • Must be a String
name
required

Fields name

Validations:

  • Must be a String
field_type
required

Fields type

Validations:

  • Must be one of: date, textbox, textarea, rich_text, dropdown, boolean, datetime, integer.
dropdown_options
optional

Dropdown fields options

Validations:

  • Must be an array of Hash
searchable
optional

Is field searchable

Validations:

  • Must be one of: true, false.
read_only
optional

Is field read only

Validations:

  • Must be one of: true, false.

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters
>>>

DELETE /api/v2/admin/field_groups/:field_group_id
Delete field group

Headers

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

Params

Param name Description
field_group_id
required

Field group ID

Validations:

  • Must be a String

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters
>>>

DELETE /api/v2/admin/field_groups/:field_group_id/fields/:field_id
Delete field from field group

Headers

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

Params

Param name Description
field_group_id
required

Field group ID

Validations:

  • Must be a String
field_id
required

Field ID

Validations:

  • Must be a String

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters
>>>

POST /api/v2/admin/field_groups/:field_group_id/fields/:field_id
Update field

Headers

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

Params

Param name Description
field_group_id
required

Field group ID

Validations:

  • Must be a String
field_id
required

Field ID

Validations:

  • Must be a String
name
required

Field Name

Validations:

  • Must be a String
dropdown_options
optional

Dropdown menu options

Validations:

  • Must be an array of Hash
searchable
optional

Is the field searchable

Validations:

  • Must be one of: true, false.
read_only
optional

Is the field read only

Validations:

  • Must be one of: true, false.
order
optional

Field display order

Validations:

  • Must be a Integer

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters