---
title: "GroupList"
method: GET
path: "/groups"
tags: ["GroupList"]
---

# GroupList

`GET /groups`

## Query parameters

- `fields` string[]
- `filters` string[]

## Headers

- `Api-Version` 2, required
- `Api-Application` string, required
- `Api-Company` string, required
- `Api-Branding` string

## Response `200`

Success response. Data could be an object instead of a list when one value is returned

- object
  - `status` string, required
  - `type` string, required
  - `moreAfter` string, nullable
  - `data` object[], required
    - `publicId` string
    - `name` string
    - `type` object, nullable
      - `publicId` string
      - `name` string
      - `description` string, nullable
      - `order` integer
      - `color` string, nullable
      - `custom` object
    - `custom` object
    - `agent` object, nullable
      - `publicId` string
    - `asset` object, nullable
      - `publicId` string
    - `parent` object, nullable
      - `publicId` string
      - `name` string
      - `type` object, nullable
        - `publicId` string
        - `name` string
        - `description` string, nullable
        - `order` integer
        - `color` string, nullable
        - `custom` object
    - `managedBy` object, nullable
      - `publicId` string
      - `name` string
      - `type` object, nullable
        - `publicId` string
        - `name` string
        - `description` string, nullable
        - `order` integer
        - `color` string, nullable
        - `custom` object
    - `isCompanyGroup` boolean

## Other responses

- `4XX` — 4XX error response

---

[API](https://skmtc.net/ixon/apis/ixon-api.md) · [All operations](https://skmtc.net/ixon/apis/ixon-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ixon/ixon-api/revisions/7875dc33d41f/schema)
