---
title: "List Components"
method: GET
path: "/components"
tags: ["Components"]
---

# List Components

`GET /components`

## Query parameters

- `sort` string
- `include` string
- `per_page` integer
- `page` integer
- `filter[status]` 1 | 2 | 3 | 4 | 5
- `filter[name]` string
- `filter[enabled]` boolean

## Response `200`

Paginated set of `Component`

- object
  - `data` Component[], required
    - `id` string, required
    - `type` 'components', required
    - `attributes` object
      - `id` integer, required
      - `name` string, required
      - `description` string, nullable, required
      - `link` string, nullable, required
      - `order` integer, nullable, required
      - `status` object, required
        - `human` string, required
        - `value` string, required
      - `enabled` boolean, required
      - `meta` unknown[], nullable, required
        - unknown
      - `created` object, required
        - `human` string, required
        - `string` string, required
      - `updated` object, required
        - `human` string, required
        - `string` string, required
    - `relationships` object
      - `group` object
        - `data` ComponentGroupIdentifier, required
          - `type` 'componentGroups', required
          - `id` string, required
      - `incidents` object
        - `data` Incident[], required
          - `id` string, required
          - `type` 'incidents', required
          - `attributes` object
            - `id` integer, required
            - `guid` string, required
            - `name` string, required
            - `message` string, required
            - `component_id` integer, nullable, required
            - `visible` 0 | 1 | 2, required
            - `stickied` boolean, required
            - `notifications` integer, required
            - `status` object, required
              - …
            - `occurred` object, required
              - …
            - `created` object, required
              - …
            - `updated` object, required
              - …
          - `relationships` object
            - `components` object
              - …
            - `updates` object
              - …
            - `user` object
              - …
  - `meta` object, required
    - `current_page` integer, required
    - `from` integer, nullable, required
    - `path` string, nullable, required — Base path for paginator generated URLs.
    - `per_page` integer, required — Number of items shown per page.
    - `to` integer, nullable, required — Number of the last item in the slice.
  - `links` object, required
    - `first` string, nullable
    - `last` string, nullable
    - `prev` string, nullable
    - `next` string, nullable
  - `included` union[]
    - union
      - ComponentGroup
        - `id` string, required
        - `type` 'componentGroups', required
        - `attributes` object
          - `id` integer, required
          - `name` string, required
          - `order` integer, required
          - `visible` 0 | 1 | 2, required
          - `created` object, required
            - `human` string, required
            - `string` string, required
          - `updated` object, required
            - `human` string, required
            - `string` string, required
        - `relationships` object
          - `components` object
            - `data` Component[], required
              - …
      - Incident
        - `id` string, required
        - `type` 'incidents', required
        - `attributes` object
          - `id` integer, required
          - `guid` string, required
          - `name` string, required
          - `message` string, required
          - `component_id` integer, nullable, required
          - `visible` 0 | 1 | 2, required
          - `stickied` boolean, required
          - `notifications` integer, required
          - `status` object, required
            - `human` string, required
            - `value` string, required
          - `occurred` object, required
            - `human` string, required
            - `string` string, required
          - `created` object, required
            - `human` string, required
            - `string` string, required
          - `updated` object, required
            - `human` string, required
            - `string` string, required
        - `relationships` object
          - `components` object
            - `data` Component[], required
              - …
          - `updates` object
            - `data` Update[], required
              - …
          - `user` object
            - `data` UserIdentifier, required
              - …

## Changes

- **2025-06-02** `9ad32c73fe39` — 20 breaking, 3 warning, 1 info
  - the response property `data/items/attributes/description` became nullable for the status `200`
  - the response property `data/items/attributes/link` became nullable for the status `200`
  - the response property `data/items/attributes/meta` became nullable for the status `200`
  - the response property `data/items/attributes/order` became nullable for the status `200`
  - …20 more
- **2025-05-29** `87e56b3f8fd7` — 3 warning
  - removed the optional property `data/items/relationships/group/data/attributes` from the response with the `200` status
  - removed the optional property `data/items/relationships/group/data/relationships` from the response with the `200` status
  - removed the optional property `data/items/relationships/incidents/data/items/relationships/user/data/attributes` from the response with the `200` status

[Change history](https://skmtc.dev/cachethq/apis/cachet/changes/components/get.md)

---

[API](https://skmtc.dev/cachethq/apis/cachet.md) · [All operations](https://skmtc.dev/cachethq/apis/cachet/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cachethq/cachet/revisions/9ad32c73fe39/schema)