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": "5b1675a0-a000-4396-ab5d-f4adbfb55600",
      "type": "custom_forms",
      "attributes": {
        "slug": "ut-ab-minima-ex",
        "name": "Ut ab minima ex.",
        "description": "Mollitia est libero aliquid.",
        "enabled": true,
        "command": "ut-ab-minima-ex",
        "created_at": "2025-12-08T12:45:23.839-08:00",
        "updated_at": "2025-12-08T12:45:23.839-08:00"
      }
    },
    {
      "id": "b270d953-d62b-473e-9e51-22bbbff146b5",
      "type": "custom_forms",
      "attributes": {
        "slug": "sed-sit-magnam-ratione",
        "name": "Sed sit magnam ratione.",
        "description": "Dolorum eveniet eum recusandae.",
        "enabled": true,
        "command": "sed-sit-magnam-ratione",
        "created_at": "2025-12-08T12:45:23.834-08:00",
        "updated_at": "2025-12-08T12:45:23.834-08:00"
      }
    },
    {
      "id": "e11798e2-c686-466a-af2d-9a49e505de4a",
      "type": "custom_forms",
      "attributes": {
        "slug": "in-sapiente-ut-enim",
        "name": "In sapiente ut enim.",
        "description": "Laboriosam velit facere alias.",
        "enabled": true,
        "command": "in-sapiente-ut-enim",
        "created_at": "2025-12-08T12:45:23.830-08:00",
        "updated_at": "2025-12-08T12:45:23.830-08:00"
      }
    },
    {
      "id": "80deff41-aa51-464d-b065-f6ab6057afe1",
      "type": "custom_forms",
      "attributes": {
        "slug": "ut-sapiente-est-omnis",
        "name": "Ut sapiente est omnis.",
        "description": "Laudantium quaerat et id.",
        "enabled": true,
        "command": "ut-sapiente-est-omnis",
        "created_at": "2025-12-08T12:45:23.825-08:00",
        "updated_at": "2025-12-08T12:45:23.825-08:00"
      }
    },
    {
      "id": "9e345a00-de6d-4588-a186-ace510939e54",
      "type": "custom_forms",
      "attributes": {
        "slug": "et-aut-voluptatem-esse",
        "name": "Et aut voluptatem esse.",
        "description": "Facilis dolor enim reiciendis.",
        "enabled": true,
        "command": "et-aut-voluptatem-esse",
        "created_at": "2025-12-08T12:45:23.820-08:00",
        "updated_at": "2025-12-08T12:45:23.820-08:00"
      }
    },
    {
      "id": "97238e40-45cc-4d1f-ad61-d692228d463c",
      "type": "custom_forms",
      "attributes": {
        "slug": "qui-inventore-rerum-ipsam",
        "name": "Qui inventore rerum ipsam.",
        "description": "Et occaecati est praesentium.",
        "enabled": true,
        "command": "qui-inventore-rerum-ipsam",
        "created_at": "2025-12-08T12:45:23.815-08:00",
        "updated_at": "2025-12-08T12:45:23.815-08:00"
      }
    },
    {
      "id": "ce618100-e343-4281-9330-2ae082e6032d",
      "type": "custom_forms",
      "attributes": {
        "slug": "facilis-adipisci-voluptatibus-occaecati",
        "name": "Facilis adipisci voluptatibus occaecati.",
        "description": "Necessitatibus modi accusantium molestiae.",
        "enabled": true,
        "command": "facilis-adipisci-voluptatibus-occaecati",
        "created_at": "2025-12-08T12:45:23.811-08:00",
        "updated_at": "2025-12-08T12:45:23.811-08:00"
      }
    },
    {
      "id": "9edea562-a1fa-4112-9f6a-246938a7cc7a",
      "type": "custom_forms",
      "attributes": {
        "slug": "aut-tenetur-nihil-rerum",
        "name": "Aut tenetur nihil rerum.",
        "description": "Velit itaque dolorem impedit.",
        "enabled": true,
        "command": "aut-tenetur-nihil-rerum",
        "created_at": "2025-12-08T12:45:23.806-08:00",
        "updated_at": "2025-12-08T12:45:23.806-08:00"
      }
    },
    {
      "id": "ce054074-df96-422d-bd34-a7c8e32a1c3b",
      "type": "custom_forms",
      "attributes": {
        "slug": "distinctio-qui-ipsa-officiis",
        "name": "Distinctio qui ipsa officiis.",
        "description": "Dolorem quos nam quia.",
        "enabled": true,
        "command": "distinctio-qui-ipsa-officiis",
        "created_at": "2025-12-08T12:45:23.802-08:00",
        "updated_at": "2025-12-08T12:45:23.802-08:00"
      }
    },
    {
      "id": "27357df8-810b-40e8-aca1-c5e1470d35b3",
      "type": "custom_forms",
      "attributes": {
        "slug": "omnis-quo-libero-eaque",
        "name": "Omnis quo libero eaque.",
        "description": "Velit quisquam dolor ipsam.",
        "enabled": true,
        "command": "omnis-quo-libero-eaque",
        "created_at": "2025-12-08T12:45:23.797-08:00",
        "updated_at": "2025-12-08T12:45:23.797-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