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": "7d1276d6-322c-4432-8576-2befcef8556a",
      "type": "custom_forms",
      "attributes": {
        "slug": "quam-reprehenderit-dolore-aspernatur",
        "name": "Quam reprehenderit dolore aspernatur.",
        "description": "Qui non repudiandae omnis.",
        "enabled": true,
        "command": "quam-reprehenderit-dolore-aspernatur",
        "created_at": "2026-02-07T16:46:15.196-08:00",
        "updated_at": "2026-02-07T16:46:15.196-08:00"
      }
    },
    {
      "id": "d3917545-2fb5-463c-bf3f-9921afac51ef",
      "type": "custom_forms",
      "attributes": {
        "slug": "non-aut-similique-culpa",
        "name": "Non aut similique culpa.",
        "description": "Eos expedita aperiam ea.",
        "enabled": true,
        "command": "non-aut-similique-culpa",
        "created_at": "2026-02-07T16:46:15.193-08:00",
        "updated_at": "2026-02-07T16:46:15.193-08:00"
      }
    },
    {
      "id": "a49b0681-7bec-4c90-a9d5-5eb2fd18c6e7",
      "type": "custom_forms",
      "attributes": {
        "slug": "facilis-quas-fugiat-optio",
        "name": "Facilis quas fugiat optio.",
        "description": "Mollitia nihil quod molestiae.",
        "enabled": true,
        "command": "facilis-quas-fugiat-optio",
        "created_at": "2026-02-07T16:46:15.191-08:00",
        "updated_at": "2026-02-07T16:46:15.191-08:00"
      }
    },
    {
      "id": "04426770-286b-42a8-8f22-7f7575df6ab6",
      "type": "custom_forms",
      "attributes": {
        "slug": "dolorem-facilis-nostrum-aliquid",
        "name": "Dolorem facilis nostrum aliquid.",
        "description": "Ut hic quia culpa.",
        "enabled": true,
        "command": "dolorem-facilis-nostrum-aliquid",
        "created_at": "2026-02-07T16:46:15.188-08:00",
        "updated_at": "2026-02-07T16:46:15.188-08:00"
      }
    },
    {
      "id": "95dc3e77-48ca-4226-ba61-d877d678e84a",
      "type": "custom_forms",
      "attributes": {
        "slug": "quod-velit-ut-eum",
        "name": "Quod velit ut eum.",
        "description": "Non beatae totam maxime.",
        "enabled": true,
        "command": "quod-velit-ut-eum",
        "created_at": "2026-02-07T16:46:15.185-08:00",
        "updated_at": "2026-02-07T16:46:15.185-08:00"
      }
    },
    {
      "id": "f9e27ae1-bdff-4da9-9280-df3fe909bdc2",
      "type": "custom_forms",
      "attributes": {
        "slug": "cupiditate-nostrum-eos-vel",
        "name": "Cupiditate nostrum eos vel.",
        "description": "Aliquam et consequuntur soluta.",
        "enabled": true,
        "command": "cupiditate-nostrum-eos-vel",
        "created_at": "2026-02-07T16:46:15.183-08:00",
        "updated_at": "2026-02-07T16:46:15.183-08:00"
      }
    },
    {
      "id": "1f344284-4cab-4073-bac1-2ab879b87180",
      "type": "custom_forms",
      "attributes": {
        "slug": "ut-sed-et-quae",
        "name": "Ut sed et quae.",
        "description": "Veritatis alias consequatur iusto.",
        "enabled": true,
        "command": "ut-sed-et-quae",
        "created_at": "2026-02-07T16:46:15.180-08:00",
        "updated_at": "2026-02-07T16:46:15.180-08:00"
      }
    },
    {
      "id": "cb15a2da-20f0-4d57-b593-e6ded02e6258",
      "type": "custom_forms",
      "attributes": {
        "slug": "nam-rem-quis-odit",
        "name": "Nam rem quis odit.",
        "description": "Id fugiat et qui.",
        "enabled": true,
        "command": "nam-rem-quis-odit",
        "created_at": "2026-02-07T16:46:15.178-08:00",
        "updated_at": "2026-02-07T16:46:15.178-08:00"
      }
    },
    {
      "id": "7a5215ee-74d2-4f1e-a544-5259dce4eecb",
      "type": "custom_forms",
      "attributes": {
        "slug": "omnis-similique-inventore-est",
        "name": "Omnis similique inventore est.",
        "description": "Sed dolore aliquam ea.",
        "enabled": true,
        "command": "omnis-similique-inventore-est",
        "created_at": "2026-02-07T16:46:15.175-08:00",
        "updated_at": "2026-02-07T16:46:15.175-08:00"
      }
    },
    {
      "id": "dd75a86a-e5e7-451f-ade6-be998779346f",
      "type": "custom_forms",
      "attributes": {
        "slug": "quasi-consequuntur-in-facere",
        "name": "Quasi consequuntur in facere.",
        "description": "Et quaerat qui accusamus.",
        "enabled": true,
        "command": "quasi-consequuntur-in-facere",
        "created_at": "2026-02-07T16:46:15.172-08:00",
        "updated_at": "2026-02-07T16:46:15.172-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