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": "b6948fbb-fc82-45ae-873b-5ec7f42948a0",
      "type": "custom_forms",
      "attributes": {
        "slug": "harum-quod-quia-ex",
        "name": "Harum quod quia ex.",
        "description": "Rerum id cumque provident.",
        "enabled": true,
        "command": "harum-quod-quia-ex",
        "created_at": "2025-10-04T16:06:23.397-07:00",
        "updated_at": "2025-10-04T16:06:23.397-07:00"
      }
    },
    {
      "id": "3e0fcafd-a909-408d-a4f8-014552a5f145",
      "type": "custom_forms",
      "attributes": {
        "slug": "magni-aut-dolores-in",
        "name": "Magni aut dolores in.",
        "description": "Iste sit ex sint.",
        "enabled": true,
        "command": "magni-aut-dolores-in",
        "created_at": "2025-10-04T16:06:23.393-07:00",
        "updated_at": "2025-10-04T16:06:23.393-07:00"
      }
    },
    {
      "id": "71808566-a37d-44ad-bad5-3d1bd14df5ee",
      "type": "custom_forms",
      "attributes": {
        "slug": "possimus-voluptas-rerum-est",
        "name": "Possimus voluptas rerum est.",
        "description": "Quaerat veniam at nulla.",
        "enabled": true,
        "command": "possimus-voluptas-rerum-est",
        "created_at": "2025-10-04T16:06:23.389-07:00",
        "updated_at": "2025-10-04T16:06:23.389-07:00"
      }
    },
    {
      "id": "ae67824a-3fff-4f8d-abda-ba8b5d5d0dde",
      "type": "custom_forms",
      "attributes": {
        "slug": "consequatur-atque-ex-id",
        "name": "Consequatur atque ex id.",
        "description": "Sunt laborum culpa enim.",
        "enabled": true,
        "command": "consequatur-atque-ex-id",
        "created_at": "2025-10-04T16:06:23.384-07:00",
        "updated_at": "2025-10-04T16:06:23.384-07:00"
      }
    },
    {
      "id": "e92e119f-fab3-4866-a4f2-6b6c3f38aa68",
      "type": "custom_forms",
      "attributes": {
        "slug": "amet-rem-facilis-velit",
        "name": "Amet rem facilis velit.",
        "description": "Beatae quos unde rerum.",
        "enabled": true,
        "command": "amet-rem-facilis-velit",
        "created_at": "2025-10-04T16:06:23.380-07:00",
        "updated_at": "2025-10-04T16:06:23.380-07:00"
      }
    },
    {
      "id": "491ed7c6-8467-4bc3-9f2f-bdf04456f7bc",
      "type": "custom_forms",
      "attributes": {
        "slug": "distinctio-quasi-quaerat-repudiandae",
        "name": "Distinctio quasi quaerat repudiandae.",
        "description": "Velit et ab aut.",
        "enabled": true,
        "command": "distinctio-quasi-quaerat-repudiandae",
        "created_at": "2025-10-04T16:06:23.376-07:00",
        "updated_at": "2025-10-04T16:06:23.376-07:00"
      }
    },
    {
      "id": "9e89a859-d187-4cc7-8e36-f97fd1f8f185",
      "type": "custom_forms",
      "attributes": {
        "slug": "est-molestias-consequuntur-quo",
        "name": "Est molestias consequuntur quo.",
        "description": "Corporis repellat deserunt illo.",
        "enabled": true,
        "command": "est-molestias-consequuntur-quo",
        "created_at": "2025-10-04T16:06:23.372-07:00",
        "updated_at": "2025-10-04T16:06:23.372-07:00"
      }
    },
    {
      "id": "0f0faeef-6aff-4085-81b6-efa867bbe983",
      "type": "custom_forms",
      "attributes": {
        "slug": "sit-corrupti-est-error",
        "name": "Sit corrupti est error.",
        "description": "Eaque officiis est rerum.",
        "enabled": true,
        "command": "sit-corrupti-est-error",
        "created_at": "2025-10-04T16:06:23.368-07:00",
        "updated_at": "2025-10-04T16:06:23.368-07:00"
      }
    },
    {
      "id": "208fe8ff-e340-4ca4-93ff-7756a9395641",
      "type": "custom_forms",
      "attributes": {
        "slug": "omnis-consequatur-itaque-nihil",
        "name": "Omnis consequatur itaque nihil.",
        "description": "Harum vero ut eius.",
        "enabled": true,
        "command": "omnis-consequatur-itaque-nihil",
        "created_at": "2025-10-04T16:06:23.363-07:00",
        "updated_at": "2025-10-04T16:06:23.363-07:00"
      }
    },
    {
      "id": "3e015a8d-d830-4009-b875-10bcbfa5f79b",
      "type": "custom_forms",
      "attributes": {
        "slug": "ducimus-laboriosam-aliquam-occaecati",
        "name": "Ducimus laboriosam aliquam occaecati.",
        "description": "Nemo possimus et repellendus.",
        "enabled": true,
        "command": "ducimus-laboriosam-aliquam-occaecati",
        "created_at": "2025-10-04T16:06:23.358-07:00",
        "updated_at": "2025-10-04T16:06:23.358-07: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
I