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": "bcd23e92-b8dd-4c80-99a5-d789af848219",
      "type": "custom_forms",
      "attributes": {
        "slug": "accusamus-illo-nesciunt-autem",
        "name": "Accusamus illo nesciunt autem.",
        "description": "Numquam voluptatem omnis veniam.",
        "enabled": true,
        "command": "accusamus-illo-nesciunt-autem",
        "created_at": "2026-02-11T23:37:06.601-08:00",
        "updated_at": "2026-02-11T23:37:06.601-08:00"
      }
    },
    {
      "id": "54ff87c7-d3e6-4615-bcc7-97dee60dd4ef",
      "type": "custom_forms",
      "attributes": {
        "slug": "distinctio-amet-voluptatum-dicta",
        "name": "Distinctio amet voluptatum dicta.",
        "description": "Consequatur magnam fuga excepturi.",
        "enabled": true,
        "command": "distinctio-amet-voluptatum-dicta",
        "created_at": "2026-02-11T23:37:06.597-08:00",
        "updated_at": "2026-02-11T23:37:06.597-08:00"
      }
    },
    {
      "id": "60d2ef67-711e-456d-948f-b9b801f59f91",
      "type": "custom_forms",
      "attributes": {
        "slug": "iste-numquam-eos-et",
        "name": "Iste numquam eos et.",
        "description": "Architecto doloremque ab officiis.",
        "enabled": true,
        "command": "iste-numquam-eos-et",
        "created_at": "2026-02-11T23:37:06.593-08:00",
        "updated_at": "2026-02-11T23:37:06.593-08:00"
      }
    },
    {
      "id": "dfd53816-b42a-45a6-aef3-2733a10eb0c9",
      "type": "custom_forms",
      "attributes": {
        "slug": "aliquid-hic-illum-eius",
        "name": "Aliquid hic illum eius.",
        "description": "Sit et aut est.",
        "enabled": true,
        "command": "aliquid-hic-illum-eius",
        "created_at": "2026-02-11T23:37:06.589-08:00",
        "updated_at": "2026-02-11T23:37:06.589-08:00"
      }
    },
    {
      "id": "cdef7f99-a73d-4047-bb4a-30ba1ef689f5",
      "type": "custom_forms",
      "attributes": {
        "slug": "omnis-ut-aliquam-iusto",
        "name": "Omnis ut aliquam iusto.",
        "description": "Illum itaque ut aperiam.",
        "enabled": true,
        "command": "omnis-ut-aliquam-iusto",
        "created_at": "2026-02-11T23:37:06.584-08:00",
        "updated_at": "2026-02-11T23:37:06.584-08:00"
      }
    },
    {
      "id": "62279073-cab8-46b6-9064-20dc45c9131d",
      "type": "custom_forms",
      "attributes": {
        "slug": "asperiores-atque-culpa-velit",
        "name": "Asperiores atque culpa velit.",
        "description": "Excepturi est quaerat est.",
        "enabled": true,
        "command": "asperiores-atque-culpa-velit",
        "created_at": "2026-02-11T23:37:06.579-08:00",
        "updated_at": "2026-02-11T23:37:06.579-08:00"
      }
    },
    {
      "id": "c403e3ee-aec8-4a8d-addc-fb073ef61cdb",
      "type": "custom_forms",
      "attributes": {
        "slug": "est-porro-blanditiis-delectus",
        "name": "Est porro blanditiis delectus.",
        "description": "Provident non sed cumque.",
        "enabled": true,
        "command": "est-porro-blanditiis-delectus",
        "created_at": "2026-02-11T23:37:06.574-08:00",
        "updated_at": "2026-02-11T23:37:06.574-08:00"
      }
    },
    {
      "id": "c833dd80-c956-4c1f-a5db-b893461df7a8",
      "type": "custom_forms",
      "attributes": {
        "slug": "quisquam-rerum-ducimus-dolorum",
        "name": "Quisquam rerum ducimus dolorum.",
        "description": "Tempore iure quisquam aut.",
        "enabled": true,
        "command": "quisquam-rerum-ducimus-dolorum",
        "created_at": "2026-02-11T23:37:06.569-08:00",
        "updated_at": "2026-02-11T23:37:06.569-08:00"
      }
    },
    {
      "id": "3e3367c0-fe14-4c47-8f08-d075293ca89d",
      "type": "custom_forms",
      "attributes": {
        "slug": "qui-illo-aut-beatae",
        "name": "Qui illo aut beatae.",
        "description": "Et corporis repudiandae consequuntur.",
        "enabled": true,
        "command": "qui-illo-aut-beatae",
        "created_at": "2026-02-11T23:37:06.564-08:00",
        "updated_at": "2026-02-11T23:37:06.564-08:00"
      }
    },
    {
      "id": "0744ae13-826d-4d9e-931b-d810bb05eed1",
      "type": "custom_forms",
      "attributes": {
        "slug": "ullam-ipsum-sequi-illo",
        "name": "Ullam ipsum sequi illo.",
        "description": "Officia vero id voluptatibus.",
        "enabled": true,
        "command": "ullam-ipsum-sequi-illo",
        "created_at": "2026-02-11T23:37:06.559-08:00",
        "updated_at": "2026-02-11T23:37:06.559-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