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": "895c5105-9be2-436f-8d50-b72480694b23",
      "type": "custom_forms",
      "attributes": {
        "slug": "ut-tempore-voluptatem-ea",
        "name": "Ut tempore voluptatem ea.",
        "description": "Illo voluptatem est a.",
        "enabled": true,
        "command": "ut-tempore-voluptatem-ea",
        "created_at": "2026-01-12T14:34:30.230-08:00",
        "updated_at": "2026-01-12T14:34:30.230-08:00"
      }
    },
    {
      "id": "a23ed64a-1863-4803-9924-6aa26fb505ed",
      "type": "custom_forms",
      "attributes": {
        "slug": "recusandae-id-et-dolores",
        "name": "Recusandae id et dolores.",
        "description": "Eos ut placeat repudiandae.",
        "enabled": true,
        "command": "recusandae-id-et-dolores",
        "created_at": "2026-01-12T14:34:30.225-08:00",
        "updated_at": "2026-01-12T14:34:30.225-08:00"
      }
    },
    {
      "id": "f3636771-a538-453e-b01b-0ca515d9316d",
      "type": "custom_forms",
      "attributes": {
        "slug": "nesciunt-minima-quo-facere",
        "name": "Nesciunt minima quo facere.",
        "description": "Voluptates nisi sed id.",
        "enabled": true,
        "command": "nesciunt-minima-quo-facere",
        "created_at": "2026-01-12T14:34:30.218-08:00",
        "updated_at": "2026-01-12T14:34:30.218-08:00"
      }
    },
    {
      "id": "7bf3726d-3f92-45f0-aacc-61832150c996",
      "type": "custom_forms",
      "attributes": {
        "slug": "repellat-ipsa-dignissimos-earum",
        "name": "Repellat ipsa dignissimos earum.",
        "description": "Pariatur ut laboriosam dolorem.",
        "enabled": true,
        "command": "repellat-ipsa-dignissimos-earum",
        "created_at": "2026-01-12T14:34:30.212-08:00",
        "updated_at": "2026-01-12T14:34:30.212-08:00"
      }
    },
    {
      "id": "721cf0d7-3317-4af0-977b-811ed058159d",
      "type": "custom_forms",
      "attributes": {
        "slug": "reprehenderit-consequatur-nostrum-eveniet",
        "name": "Reprehenderit consequatur nostrum eveniet.",
        "description": "Enim deserunt dolorem a.",
        "enabled": true,
        "command": "reprehenderit-consequatur-nostrum-eveniet",
        "created_at": "2026-01-12T14:34:30.206-08:00",
        "updated_at": "2026-01-12T14:34:30.206-08:00"
      }
    },
    {
      "id": "60975f4e-a608-458d-a859-43fb5087a517",
      "type": "custom_forms",
      "attributes": {
        "slug": "adipisci-qui-reprehenderit-consequatur",
        "name": "Adipisci qui reprehenderit consequatur.",
        "description": "Qui illum assumenda dolorem.",
        "enabled": true,
        "command": "adipisci-qui-reprehenderit-consequatur",
        "created_at": "2026-01-12T14:34:30.200-08:00",
        "updated_at": "2026-01-12T14:34:30.200-08:00"
      }
    },
    {
      "id": "a2e344b2-cfc8-4009-8db8-2ef49a56de42",
      "type": "custom_forms",
      "attributes": {
        "slug": "magnam-impedit-numquam-est",
        "name": "Magnam impedit numquam est.",
        "description": "Dolorem cupiditate molestiae et.",
        "enabled": true,
        "command": "magnam-impedit-numquam-est",
        "created_at": "2026-01-12T14:34:30.195-08:00",
        "updated_at": "2026-01-12T14:34:30.195-08:00"
      }
    },
    {
      "id": "48441782-58fe-4ebe-869f-8ad767e8d8e9",
      "type": "custom_forms",
      "attributes": {
        "slug": "facilis-qui-voluptatem-dolore",
        "name": "Facilis qui voluptatem dolore.",
        "description": "Voluptatem itaque culpa iure.",
        "enabled": true,
        "command": "facilis-qui-voluptatem-dolore",
        "created_at": "2026-01-12T14:34:30.190-08:00",
        "updated_at": "2026-01-12T14:34:30.190-08:00"
      }
    },
    {
      "id": "90210159-179c-456e-8ecc-bef68d9fefe5",
      "type": "custom_forms",
      "attributes": {
        "slug": "est-soluta-rerum-dolor",
        "name": "Est soluta rerum dolor.",
        "description": "Aut iusto quia sunt.",
        "enabled": true,
        "command": "est-soluta-rerum-dolor",
        "created_at": "2026-01-12T14:34:30.184-08:00",
        "updated_at": "2026-01-12T14:34:30.184-08:00"
      }
    },
    {
      "id": "5b2e5235-4c33-4b5c-9ac3-51a96cfba554",
      "type": "custom_forms",
      "attributes": {
        "slug": "qui-qui-dolores-et",
        "name": "Qui qui dolores et.",
        "description": "Sit ea nisi doloribus.",
        "enabled": true,
        "command": "qui-qui-dolores-et",
        "created_at": "2026-01-12T14:34:30.178-08:00",
        "updated_at": "2026-01-12T14:34:30.178-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