---
title: "List Resource Groups"
method: GET
path: "/setup/v1/resourcegroups"
tags: ["ResourceGroups"]
---

# List Resource Groups

`GET /setup/v1/resourcegroups`

Use this endpoint to **List Resource Groups** for the specified location. If not specified, the business location defaults to the primary business location. **Name** is a required field.

Use the offset and limit parameters to control the page start and size. Default offset is 0, limit is 20, maximum is 100. Use the query parameters to filter the results further.

## Query parameters

- `locationId` string
- `deleted` boolean
- `offset` integer
- `limit` integer

## Response `200`

Success

- ResourceGroupListViewModel
  - `object` string, nullable
  - `url` string, nullable
  - `hasMore` boolean
  - `count` integer
  - `total` integer
  - `data` ResourceGroupViewModel[], nullable
    - `object` string, nullable
    - `id` string, nullable
    - `locationId` string, nullable
    - `name` string, nullable
    - `description` string, nullable
    - `email` string, nullable
    - `bookingNotification` integer
    - `deletedStatus` boolean
    - `deletedTime` string, date-time, nullable

---

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