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": "9f676a44-6382-4199-96e3-08caac18d798",
      "type": "custom_forms",
      "attributes": {
        "slug": "aliquid-dicta-rerum-ipsa",
        "name": "Aliquid dicta rerum ipsa.",
        "description": "Consequatur cum quam consequatur.",
        "enabled": true,
        "command": "aliquid-dicta-rerum-ipsa",
        "created_at": "2025-10-17T17:28:14.673-07:00",
        "updated_at": "2025-10-17T17:28:14.673-07:00"
      }
    },
    {
      "id": "3b50688d-c152-4633-a2da-19683702269a",
      "type": "custom_forms",
      "attributes": {
        "slug": "ducimus-et-sed-provident",
        "name": "Ducimus et sed provident.",
        "description": "Nihil itaque laboriosam sunt.",
        "enabled": true,
        "command": "ducimus-et-sed-provident",
        "created_at": "2025-10-17T17:28:14.667-07:00",
        "updated_at": "2025-10-17T17:28:14.667-07:00"
      }
    },
    {
      "id": "aa4afe30-68bb-4c4a-80b9-6114fa5afac1",
      "type": "custom_forms",
      "attributes": {
        "slug": "sed-autem-id-sequi",
        "name": "Sed autem id sequi.",
        "description": "Natus at aut ut.",
        "enabled": true,
        "command": "sed-autem-id-sequi",
        "created_at": "2025-10-17T17:28:14.661-07:00",
        "updated_at": "2025-10-17T17:28:14.661-07:00"
      }
    },
    {
      "id": "7194935a-35d9-467d-ab39-f30c95b20ee1",
      "type": "custom_forms",
      "attributes": {
        "slug": "harum-quia-vero-eos",
        "name": "Harum quia vero eos.",
        "description": "Molestias sed necessitatibus non.",
        "enabled": true,
        "command": "harum-quia-vero-eos",
        "created_at": "2025-10-17T17:28:14.656-07:00",
        "updated_at": "2025-10-17T17:28:14.656-07:00"
      }
    },
    {
      "id": "d4083930-0d27-4a89-99fa-b9c498faf110",
      "type": "custom_forms",
      "attributes": {
        "slug": "provident-excepturi-libero-aut",
        "name": "Provident excepturi libero aut.",
        "description": "Laboriosam modi voluptas asperiores.",
        "enabled": true,
        "command": "provident-excepturi-libero-aut",
        "created_at": "2025-10-17T17:28:14.650-07:00",
        "updated_at": "2025-10-17T17:28:14.650-07:00"
      }
    },
    {
      "id": "fc431d60-c500-4288-b35e-e6f9a38bb323",
      "type": "custom_forms",
      "attributes": {
        "slug": "sequi-est-optio-qui",
        "name": "Sequi est optio qui.",
        "description": "Possimus modi nesciunt tempora.",
        "enabled": true,
        "command": "sequi-est-optio-qui",
        "created_at": "2025-10-17T17:28:14.644-07:00",
        "updated_at": "2025-10-17T17:28:14.644-07:00"
      }
    },
    {
      "id": "da7d9caf-1bc8-4837-a994-c98152f11f37",
      "type": "custom_forms",
      "attributes": {
        "slug": "aut-laborum-praesentium-qui",
        "name": "Aut laborum praesentium qui.",
        "description": "Sint eaque ullam quisquam.",
        "enabled": true,
        "command": "aut-laborum-praesentium-qui",
        "created_at": "2025-10-17T17:28:14.639-07:00",
        "updated_at": "2025-10-17T17:28:14.639-07:00"
      }
    },
    {
      "id": "e80c9639-9a36-4ad0-a0b5-d73ed8e58e83",
      "type": "custom_forms",
      "attributes": {
        "slug": "voluptatem-adipisci-eveniet-consequatur",
        "name": "Voluptatem adipisci eveniet consequatur.",
        "description": "Animi repellendus vitae perspiciatis.",
        "enabled": true,
        "command": "voluptatem-adipisci-eveniet-consequatur",
        "created_at": "2025-10-17T17:28:14.633-07:00",
        "updated_at": "2025-10-17T17:28:14.633-07:00"
      }
    },
    {
      "id": "a5cde57e-21f9-4060-9ab4-d8ba90054a5d",
      "type": "custom_forms",
      "attributes": {
        "slug": "unde-omnis-ea-dolor",
        "name": "Unde omnis ea dolor.",
        "description": "Et quia et ab.",
        "enabled": true,
        "command": "unde-omnis-ea-dolor",
        "created_at": "2025-10-17T17:28:14.627-07:00",
        "updated_at": "2025-10-17T17:28:14.627-07:00"
      }
    },
    {
      "id": "4d7bdb52-914e-451b-82f9-7954bb1d0608",
      "type": "custom_forms",
      "attributes": {
        "slug": "non-nihil-nesciunt-et",
        "name": "Non nihil nesciunt et.",
        "description": "Laudantium labore dolores doloremque.",
        "enabled": true,
        "command": "non-nihil-nesciunt-et",
        "created_at": "2025-10-17T17:28:14.621-07:00",
        "updated_at": "2025-10-17T17:28:14.621-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