GET
/
components
curl --request GET \
  --url http://localhost/api/components
{
  "data": [
    {
      "id": "<string>",
      "type": "components",
      "attributes": {
        "id": 123,
        "name": "<string>",
        "description": "<string>",
        "link": "<string>",
        "order": 123,
        "status": {
          "human": "<string>",
          "value": "<string>"
        },
        "enabled": true,
        "meta": [
          "<any>"
        ],
        "created": {
          "human": "<string>",
          "string": "<string>"
        },
        "updated": {
          "human": "<string>",
          "string": "<string>"
        }
      },
      "relationships": {
        "group": {
          "data": {
            "type": "componentGroups",
            "id": "<string>"
          }
        },
        "incidents": {
          "data": [
            {
              "id": "<string>",
              "type": "incidents",
              "attributes": {
                "id": 123,
                "guid": "<string>",
                "name": "<string>",
                "message": "<string>",
                "component_id": 123,
                "visible": 0,
                "stickied": true,
                "notifications": 123,
                "status": {
                  "human": "<string>",
                  "value": "<string>"
                },
                "occurred": {
                  "human": "<string>",
                  "string": "<string>"
                },
                "created": {
                  "human": "<string>",
                  "string": "<string>"
                },
                "updated": {
                  "human": "<string>",
                  "string": "<string>"
                }
              },
              "relationships": {
                "components": {
                  "data": [
                    {}
                  ]
                },
                "updates": {
                  "data": [
                    {
                      "id": "<string>",
                      "type": "updates",
                      "attributes": {
                        "id": 123,
                        "updateable_id": 123,
                        "updateable_type": "<string>",
                        "message": "<string>",
                        "status": {
                          "human": "<string>",
                          "value": "<string>"
                        },
                        "created": {
                          "human": "<string>",
                          "string": "<string>"
                        },
                        "updated": {
                          "human": "<string>",
                          "string": "<string>"
                        }
                      }
                    }
                  ]
                },
                "user": {
                  "data": {
                    "type": "<string>",
                    "id": "<string>"
                  }
                }
              }
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "current_page": 123,
    "from": 123,
    "path": "<string>",
    "per_page": 123,
    "to": 123
  },
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "included": [
    {
      "id": "<string>",
      "type": "componentGroups",
      "attributes": {
        "id": 123,
        "name": "<string>",
        "order": 123,
        "visible": 0,
        "created": {
          "human": "<string>",
          "string": "<string>"
        },
        "updated": {
          "human": "<string>",
          "string": "<string>"
        }
      },
      "relationships": {
        "components": {
          "data": [
            {
              "id": "<string>",
              "type": "components",
              "attributes": {
                "id": 123,
                "name": "<string>",
                "description": "<string>",
                "link": "<string>",
                "order": 123,
                "status": {
                  "human": "<string>",
                  "value": "<string>"
                },
                "enabled": true,
                "meta": [
                  "<any>"
                ],
                "created": {
                  "human": "<string>",
                  "string": "<string>"
                },
                "updated": {
                  "human": "<string>",
                  "string": "<string>"
                }
              },
              "relationships": {
                "group": {
                  "data": {
                    "type": "componentGroups",
                    "id": "<string>"
                  }
                },
                "incidents": {
                  "data": [
                    {
                      "id": "<string>",
                      "type": "incidents",
                      "attributes": {
                        "id": 123,
                        "guid": "<string>",
                        "name": "<string>",
                        "message": "<string>",
                        "component_id": 123,
                        "visible": 0,
                        "stickied": true,
                        "notifications": 123,
                        "status": {
                          "human": "<string>",
                          "value": "<string>"
                        },
                        "occurred": {
                          "human": "<string>",
                          "string": "<string>"
                        },
                        "created": {
                          "human": "<string>",
                          "string": "<string>"
                        },
                        "updated": {
                          "human": "<string>",
                          "string": "<string>"
                        }
                      },
                      "relationships": {
                        "components": {
                          "data": [
                            {}
                          ]
                        },
                        "updates": {
                          "data": [
                            {
                              "id": "<string>",
                              "type": "updates",
                              "attributes": {
                                "id": 123,
                                "updateable_id": 123,
                                "updateable_type": "<string>",
                                "message": "<string>",
                                "status": {
                                  "human": "<string>",
                                  "value": "<string>"
                                },
                                "created": {
                                  "human": "<string>",
                                  "string": "<string>"
                                },
                                "updated": {
                                  "human": "<string>",
                                  "string": "<string>"
                                }
                              }
                            }
                          ]
                        },
                        "user": {
                          "data": {
                            "type": "<string>",
                            "id": "<string>"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          ]
        }
      }
    }
  ]
}

Query Parameters

​
sort
string

Available sorts are name, order, id. You can sort by multiple options by separating them with a comma. To sort in descending order, use - sign in front of the sort, for example: -name.

​
include
string

Available includes are group, groupCount, groupExists, incidents, incidentsCount, incidentsExists. You can include multiple options by separating them with a comma.

​
per_page
integer
default:15

How many items to show per page.

​
page
integer

Which page to show.

​
filter[status]
enum<integer>

Filter by status

Available options:
1,
2,
3,
4,
5
​
filter[name]
string

Filter by name.

​
filter[enabled]
boolean

Filter by enabled status.

Response

200 - application/json

Paginated set of Component

The response is of type object.