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": "961be3a5-d100-47b7-88a8-94d51521550e",
      "type": "custom_forms",
      "attributes": {
        "slug": "consequatur-dolorum-labore-itaque",
        "name": "Consequatur dolorum labore itaque.",
        "description": "Consequatur reprehenderit nihil qui.",
        "enabled": true,
        "command": "consequatur-dolorum-labore-itaque",
        "created_at": "2026-01-21T13:41:02.950-08:00",
        "updated_at": "2026-01-21T13:41:02.950-08:00"
      }
    },
    {
      "id": "53ef67cd-0e08-4f39-ba04-be752307704d",
      "type": "custom_forms",
      "attributes": {
        "slug": "sed-asperiores-odio-velit",
        "name": "Sed asperiores odio velit.",
        "description": "Adipisci at et voluptatem.",
        "enabled": true,
        "command": "sed-asperiores-odio-velit",
        "created_at": "2026-01-21T13:41:02.944-08:00",
        "updated_at": "2026-01-21T13:41:02.944-08:00"
      }
    },
    {
      "id": "6b772203-ec6c-4103-8c5b-b9df26721170",
      "type": "custom_forms",
      "attributes": {
        "slug": "laudantium-consequatur-aperiam-molestias",
        "name": "Laudantium consequatur aperiam molestias.",
        "description": "Et neque qui eos.",
        "enabled": true,
        "command": "laudantium-consequatur-aperiam-molestias",
        "created_at": "2026-01-21T13:41:02.937-08:00",
        "updated_at": "2026-01-21T13:41:02.937-08:00"
      }
    },
    {
      "id": "cbc7fa97-ff47-40fb-861f-21c426f0eccd",
      "type": "custom_forms",
      "attributes": {
        "slug": "vero-voluptates-nisi-et",
        "name": "Vero voluptates nisi et.",
        "description": "Ut ut tenetur inventore.",
        "enabled": true,
        "command": "vero-voluptates-nisi-et",
        "created_at": "2026-01-21T13:41:02.929-08:00",
        "updated_at": "2026-01-21T13:41:02.929-08:00"
      }
    },
    {
      "id": "0787b848-2a9d-4677-860c-8b0a310ad4ac",
      "type": "custom_forms",
      "attributes": {
        "slug": "magni-consectetur-non-sit",
        "name": "Magni consectetur non sit.",
        "description": "Sed qui velit sequi.",
        "enabled": true,
        "command": "magni-consectetur-non-sit",
        "created_at": "2026-01-21T13:41:02.922-08:00",
        "updated_at": "2026-01-21T13:41:02.922-08:00"
      }
    },
    {
      "id": "0e6eb911-6211-4bf4-a64f-60eee89f3944",
      "type": "custom_forms",
      "attributes": {
        "slug": "rerum-qui-qui-reiciendis",
        "name": "Rerum qui qui reiciendis.",
        "description": "Officia consequuntur et id.",
        "enabled": true,
        "command": "rerum-qui-qui-reiciendis",
        "created_at": "2026-01-21T13:41:02.916-08:00",
        "updated_at": "2026-01-21T13:41:02.916-08:00"
      }
    },
    {
      "id": "ce1db3da-4eb8-40ce-a67c-43fb2e54e420",
      "type": "custom_forms",
      "attributes": {
        "slug": "iste-nulla-ut-neque",
        "name": "Iste nulla ut neque.",
        "description": "Officiis earum fuga veritatis.",
        "enabled": true,
        "command": "iste-nulla-ut-neque",
        "created_at": "2026-01-21T13:41:02.910-08:00",
        "updated_at": "2026-01-21T13:41:02.910-08:00"
      }
    },
    {
      "id": "439f4d79-0913-4bf0-b09b-546f50b94823",
      "type": "custom_forms",
      "attributes": {
        "slug": "nemo-et-aut-aut",
        "name": "Nemo et aut aut.",
        "description": "Voluptatem quis vitae maxime.",
        "enabled": true,
        "command": "nemo-et-aut-aut",
        "created_at": "2026-01-21T13:41:02.903-08:00",
        "updated_at": "2026-01-21T13:41:02.903-08:00"
      }
    },
    {
      "id": "e4cd3e9e-ff41-4431-9c62-4b748993313f",
      "type": "custom_forms",
      "attributes": {
        "slug": "in-vitae-corporis-debitis",
        "name": "In vitae corporis debitis.",
        "description": "Ab cupiditate id vel.",
        "enabled": true,
        "command": "in-vitae-corporis-debitis",
        "created_at": "2026-01-21T13:41:02.896-08:00",
        "updated_at": "2026-01-21T13:41:02.896-08:00"
      }
    },
    {
      "id": "e7ad14e4-5afb-455d-92a6-deda2df8441a",
      "type": "custom_forms",
      "attributes": {
        "slug": "blanditiis-est-officiis-ducimus",
        "name": "Blanditiis est officiis ducimus.",
        "description": "Nulla porro eaque ut.",
        "enabled": true,
        "command": "blanditiis-est-officiis-ducimus",
        "created_at": "2026-01-21T13:41:02.889-08:00",
        "updated_at": "2026-01-21T13:41:02.889-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