---
title: "List provider scheduling groups"
method: GET
path: "/providerSchedulingGroups"
tags: ["providerSchedulingGroups"]
---

# List provider scheduling groups

`GET /providerSchedulingGroups`

## Request

- Base URL: `https://api.lumahealth.io/api/v2`
- URL: `https://api.lumahealth.io/api/v2/providerSchedulingGroups`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/lumahealth/apis/rest-service/docs/providerSchedulingGroups/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `name` string
- `groupType` 'structured' | 'parallel'
- `active` boolean
- `user` string
- `deleted` 0 | 1
- `createdBy` string
- `updatedBy` string
- `createdAt` string, date-time
- `updatedAt` string, date-time
- `page` integer
- `limit` integer
- `_populate` string
- `_select` string

## Response `200`

List of provider scheduling groups

- object
  - `response` ProviderSchedulingGroupResponse[], required
    - `_id` string: Luma's internal ID of an object.
    - `user` string: The ID of the root account user.
    - `deleted` 0 | 1: Flag for logical deletion where 1 means deleted.
    - `createdBy` string: The ID of the user who created this object.
    - `updatedBy` string: The ID of the user who updated this object.
    - `createdAt` string, date-time: The date/time when this object was created.
    - `updatedAt` string, date-time: The date/time when this object was updated.
    - `name` string: Name of the provider scheduling group.
    - `groupType` 'structured' | 'parallel': The scheduling behavior used to assign appointments across the group's members.
    - `members` object[]: Members of the scheduling group and their priority tier. Each provider may only appear once in the array.
      - `provider` string, required: ID of a provider.
      - `tier` integer: Priority tier for this provider within the group. Lower tiers are prioritized first.
    - `active` boolean: Indicates whether this group is active and should be used by scheduling logic.
  - `page` integer, required
  - `size` integer, required

## Other responses

- `401`: Not authenticated
- `403`: Access token does not have the required scope

---

[API](https://skmtc.dev/lumahealth/apis/rest-service.md) - [All operations](https://skmtc.dev/lumahealth/apis/rest-service/llms.txt) - [OpenAPI document](https://skmtc.dev/lumahealth/apis/rest-service/revisions/f19aeba84a26?raw)