Skip to main content
GET
/
v1
/
custom_forms
List custom forms
curl --request GET \
  --url https://api.rootly.com/v1/custom_forms \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "a2943cb6-a911-487f-bb14-61440e865298",
      "type": "custom_forms",
      "attributes": {
        "slug": "magni-dignissimos-et-necessitatibus",
        "name": "Magni dignissimos et necessitatibus.",
        "description": "Aut soluta eos quidem.",
        "enabled": true,
        "command": "magni-dignissimos-et-necessitatibus",
        "created_at": "2026-02-05T01:45:51.062-08:00",
        "updated_at": "2026-02-05T01:45:51.062-08:00"
      }
    },
    {
      "id": "394363cf-baf9-422f-abef-5b4321350351",
      "type": "custom_forms",
      "attributes": {
        "slug": "distinctio-repudiandae-quia-fugiat",
        "name": "Distinctio repudiandae quia fugiat.",
        "description": "Est consequatur quam vitae.",
        "enabled": true,
        "command": "distinctio-repudiandae-quia-fugiat",
        "created_at": "2026-02-05T01:45:51.055-08:00",
        "updated_at": "2026-02-05T01:45:51.055-08:00"
      }
    },
    {
      "id": "64ac55d2-7e93-474c-9a5f-46eaf0c14cd1",
      "type": "custom_forms",
      "attributes": {
        "slug": "veritatis-pariatur-totam-tempore",
        "name": "Veritatis pariatur totam tempore.",
        "description": "Doloremque dolores architecto maiores.",
        "enabled": true,
        "command": "veritatis-pariatur-totam-tempore",
        "created_at": "2026-02-05T01:45:51.049-08:00",
        "updated_at": "2026-02-05T01:45:51.049-08:00"
      }
    },
    {
      "id": "40d4370c-1e7a-4202-95bc-47f856745311",
      "type": "custom_forms",
      "attributes": {
        "slug": "odio-est-repudiandae-facilis",
        "name": "Odio est repudiandae facilis.",
        "description": "Qui hic architecto maxime.",
        "enabled": true,
        "command": "odio-est-repudiandae-facilis",
        "created_at": "2026-02-05T01:45:51.041-08:00",
        "updated_at": "2026-02-05T01:45:51.041-08:00"
      }
    },
    {
      "id": "cafcd8e4-8084-4a47-aa31-8989612e7060",
      "type": "custom_forms",
      "attributes": {
        "slug": "ipsa-harum-nobis-eveniet",
        "name": "Ipsa harum nobis eveniet.",
        "description": "Earum facilis mollitia numquam.",
        "enabled": true,
        "command": "ipsa-harum-nobis-eveniet",
        "created_at": "2026-02-05T01:45:51.035-08:00",
        "updated_at": "2026-02-05T01:45:51.035-08:00"
      }
    },
    {
      "id": "bbc28e46-25ac-450a-bb40-0e5408c782a6",
      "type": "custom_forms",
      "attributes": {
        "slug": "ad-unde-blanditiis-molestiae",
        "name": "Ad unde blanditiis molestiae.",
        "description": "Omnis quae et rerum.",
        "enabled": true,
        "command": "ad-unde-blanditiis-molestiae",
        "created_at": "2026-02-05T01:45:51.029-08:00",
        "updated_at": "2026-02-05T01:45:51.029-08:00"
      }
    },
    {
      "id": "d9952825-c278-4356-a5dd-6b1ac8a16149",
      "type": "custom_forms",
      "attributes": {
        "slug": "occaecati-aut-sint-est",
        "name": "Occaecati aut sint est.",
        "description": "Dolor enim consectetur quia.",
        "enabled": true,
        "command": "occaecati-aut-sint-est",
        "created_at": "2026-02-05T01:45:51.024-08:00",
        "updated_at": "2026-02-05T01:45:51.024-08:00"
      }
    },
    {
      "id": "6cd0f02f-2789-4a23-b1e2-24e196317bf1",
      "type": "custom_forms",
      "attributes": {
        "slug": "dolor-tempora-labore-consequatur",
        "name": "Dolor tempora labore consequatur.",
        "description": "In ipsum a veritatis.",
        "enabled": true,
        "command": "dolor-tempora-labore-consequatur",
        "created_at": "2026-02-05T01:45:51.018-08:00",
        "updated_at": "2026-02-05T01:45:51.018-08:00"
      }
    },
    {
      "id": "d4cddb95-ebba-4347-928d-6978f77d8aa3",
      "type": "custom_forms",
      "attributes": {
        "slug": "aut-eligendi-et-enim",
        "name": "Aut eligendi et enim.",
        "description": "Aut ut sint qui.",
        "enabled": true,
        "command": "aut-eligendi-et-enim",
        "created_at": "2026-02-05T01:45:51.013-08:00",
        "updated_at": "2026-02-05T01:45:51.013-08:00"
      }
    },
    {
      "id": "a72b248c-fb3c-4104-9fc9-e50f48a5f0de",
      "type": "custom_forms",
      "attributes": {
        "slug": "voluptatibus-non-aliquid-recusandae",
        "name": "Voluptatibus non aliquid recusandae.",
        "description": "Id praesentium suscipit totam.",
        "enabled": true,
        "command": "voluptatibus-non-aliquid-recusandae",
        "created_at": "2026-02-05T01:45:51.007-08:00",
        "updated_at": "2026-02-05T01:45:51.007-08:00"
      }
    }
  ],
  "links": {
    "self": "http://www.example.com/v1/custom_forms?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "first": "http://www.example.com/v1/custom_forms?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "prev": null,
    "next": null,
    "last": "http://www.example.com/v1/custom_forms?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  },
  "meta": {
    "current_page": 1,
    "next_page": null,
    "prev_page": null,
    "total_count": 10,
    "total_pages": 1
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

page[number]
integer
page[size]
integer
filter[name]
string
filter[slug]
string
filter[command]
string
filter[created_at][gt]
string
filter[created_at][gte]
string
filter[created_at][lt]
string
filter[created_at][lte]
string
sort
string

Response

custom_form found

data
object[]
required
meta
object
required