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": "b314ddef-1a88-4baf-82cc-efa00ea439ee",
      "type": "custom_forms",
      "attributes": {
        "slug": "ipsam-quae-quibusdam-illum",
        "name": "Ipsam quae quibusdam illum.",
        "description": "Veniam omnis quia a.",
        "enabled": true,
        "command": "ipsam-quae-quibusdam-illum",
        "created_at": "2025-11-28T18:08:12.749-08:00",
        "updated_at": "2025-11-28T18:08:12.749-08:00"
      }
    },
    {
      "id": "2ad83e95-a4cc-4ff5-b54e-84fb4025016c",
      "type": "custom_forms",
      "attributes": {
        "slug": "quibusdam-assumenda-reiciendis-magni",
        "name": "Quibusdam assumenda reiciendis magni.",
        "description": "Magni atque id amet.",
        "enabled": true,
        "command": "quibusdam-assumenda-reiciendis-magni",
        "created_at": "2025-11-28T18:08:12.744-08:00",
        "updated_at": "2025-11-28T18:08:12.744-08:00"
      }
    },
    {
      "id": "0a0198e5-11c3-4bd6-b3b9-a2a7e7fd9b7b",
      "type": "custom_forms",
      "attributes": {
        "slug": "praesentium-impedit-adipisci-iste",
        "name": "Praesentium impedit adipisci iste.",
        "description": "Magni voluptas nobis accusamus.",
        "enabled": true,
        "command": "praesentium-impedit-adipisci-iste",
        "created_at": "2025-11-28T18:08:12.740-08:00",
        "updated_at": "2025-11-28T18:08:12.740-08:00"
      }
    },
    {
      "id": "bd0d38aa-838c-40c5-9b58-78f6746d3719",
      "type": "custom_forms",
      "attributes": {
        "slug": "delectus-laborum-molestiae-ut",
        "name": "Delectus laborum molestiae ut.",
        "description": "Dicta nulla similique voluptatem.",
        "enabled": true,
        "command": "delectus-laborum-molestiae-ut",
        "created_at": "2025-11-28T18:08:12.736-08:00",
        "updated_at": "2025-11-28T18:08:12.736-08:00"
      }
    },
    {
      "id": "fa26dfa1-03b4-46dd-92a6-49d26553c118",
      "type": "custom_forms",
      "attributes": {
        "slug": "eos-id-atque-vitae",
        "name": "Eos id atque vitae.",
        "description": "Cum atque ipsa quae.",
        "enabled": true,
        "command": "eos-id-atque-vitae",
        "created_at": "2025-11-28T18:08:12.732-08:00",
        "updated_at": "2025-11-28T18:08:12.732-08:00"
      }
    },
    {
      "id": "f555f3a2-cad5-4267-a590-24d6b6ae9bd2",
      "type": "custom_forms",
      "attributes": {
        "slug": "hic-totam-doloremque-vel",
        "name": "Hic totam doloremque vel.",
        "description": "Quia quis nesciunt qui.",
        "enabled": true,
        "command": "hic-totam-doloremque-vel",
        "created_at": "2025-11-28T18:08:12.728-08:00",
        "updated_at": "2025-11-28T18:08:12.728-08:00"
      }
    },
    {
      "id": "90707608-5c5f-41ea-8718-ab8a9cc0546a",
      "type": "custom_forms",
      "attributes": {
        "slug": "aut-neque-facilis-maiores",
        "name": "Aut neque facilis maiores.",
        "description": "Dicta sunt dolor exercitationem.",
        "enabled": true,
        "command": "aut-neque-facilis-maiores",
        "created_at": "2025-11-28T18:08:12.724-08:00",
        "updated_at": "2025-11-28T18:08:12.724-08:00"
      }
    },
    {
      "id": "70f8a66f-6a2c-4b6d-8c77-bd1a37b69249",
      "type": "custom_forms",
      "attributes": {
        "slug": "eos-libero-natus-quia",
        "name": "Eos libero natus quia.",
        "description": "Quibusdam odit minus corporis.",
        "enabled": true,
        "command": "eos-libero-natus-quia",
        "created_at": "2025-11-28T18:08:12.719-08:00",
        "updated_at": "2025-11-28T18:08:12.719-08:00"
      }
    },
    {
      "id": "6cce5b4b-239b-43cf-9b7e-b5d6c18ac2b3",
      "type": "custom_forms",
      "attributes": {
        "slug": "et-qui-laborum-ipsa",
        "name": "Et qui laborum ipsa.",
        "description": "Minus consequatur ratione sit.",
        "enabled": true,
        "command": "et-qui-laborum-ipsa",
        "created_at": "2025-11-28T18:08:12.715-08:00",
        "updated_at": "2025-11-28T18:08:12.715-08:00"
      }
    },
    {
      "id": "eef88dda-dc16-4935-9990-30c71feef025",
      "type": "custom_forms",
      "attributes": {
        "slug": "sint-officiis-voluptatem-ullam",
        "name": "Sint officiis voluptatem ullam.",
        "description": "Est sed minima quidem.",
        "enabled": true,
        "command": "sint-officiis-voluptatem-ullam",
        "created_at": "2025-11-28T18:08:12.709-08:00",
        "updated_at": "2025-11-28T18:08:12.709-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