Skip to main content
GET
List Components

Query Parameters

per_page
integer
default:15

How many items to show per page.

page
integer

Which page to show.

filter[meta]
string
sort
enum<string>[]
Available options:
name,
-name,
order,
-order,
id,
-id
filter[status]
enum<integer>

Filter by status

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

Filter by name.

filter[enabled]
boolean

Filter by enabled status.

include
enum<string>[]

Include related data (group, incidents, meta).

Available options:
group,
groupCount,
groupExists,
incidents,
meta,
metaCount,
metaExists

Response

200 - application/vnd.api+json

Paginated set of Component

data
Component · object[]
required
meta
object
required
included
(ComponentGroup · object | Incident · object)[]