> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omneo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Browse Appointment Capacity Groups

> A `GET` to the `/appointment-capacity-groups` endpoint allows your application to retrieve all appointment capacity group records. Each group is a resource several appointment definitions share, such as one station or room.

## Filtering

> [!NOTE]
>
> This endpoint accepts `filter` and `sort` query parameters. See [Filtering, sorting, and search](https://docs.omneo.io/dev-guides/core-setup/filtering-and-sorting.md) for paging and for the shared `search_with`, `custom_field`, and `json_contains` filters.

### Examples

```bash Exact match theme={null}
curl -X GET "https://api.[tenant].getomneo.com/api/v3/appointment-capacity-groups?filter[handle]={handle}" \
  -H "Authorization: Bearer ${TOKEN}"
```

```bash Only rows with a value theme={null}
curl -X GET "https://api.[tenant].getomneo.com/api/v3/appointment-capacity-groups?filter[handle][nullable]=0" \
  -H "Authorization: Bearer ${TOKEN}"
```

### Operators

| Operator | Meaning | Example |
| - | - | - |
| `eq` | Equal to. Applied when you give no operator. | `filter[handle]={handle}` |
| `ne` | Not equal to. | `filter[handle][ne]={handle}` |
| `gt` | Greater than. | `filter[max_concurrent_bookings][gt]=100` |
| `gte` | Greater than or equal to. | `filter[max_concurrent_bookings][gte]=100` |
| `lt` | Less than. | `filter[max_concurrent_bookings][lt]=250` |
| `lte` | Less than or equal to. | `filter[max_concurrent_bookings][lte]=250` |
| `in` | Matches any value in a comma separated list. | `filter[handle][in]={handle},{other-handle}` |
| `not_in` | Excludes every value in a comma separated list. | `filter[handle][not_in]={handle},{other-handle}` |
| `nullable` | `1` returns records where the attribute is empty. Any other value returns records where it is set. | `filter[handle][nullable]=1` |

The `not_has` operator applies to related attributes, which this endpoint does not have.

### Filter attributes

| Attribute | Attribute | Attribute |
| - | - | - |
| `handle` | `name` | `description` |
| `max_concurrent_bookings` | `buffer_before_minutes` | `buffer_after_minutes` |
| `meta` | | |

Each attribute above is also a valid `sort` key, for example `?sort=-handle` for descending order.

### Search attributes

`filter[search]` runs one partial match term across `handle`, `name`. A record matches when any one of those attributes contains the term.

```bash theme={null}
curl -X GET "https://api.[tenant].getomneo.com/api/v3/appointment-capacity-groups?filter[search]={term}" \
  -H "Authorization: Bearer ${TOKEN}"
```


## OpenAPI

````yaml get /v3/appointment-capacity-groups
openapi: 3.1.0
info:
  title: Omneo
  version: 0.0.1
servers:
  - url: https://api.{tenant}.getomneo.com/api
    variables:
      tenant:
        default: example
security: []
paths:
  /v3/appointment-capacity-groups:
    get:
      tags:
        - Appointment Capacity Group
      summary: Browse Appointment Capacity Groups
      description: >-
        A `GET` to the `/appointment-capacity-groups` endpoint allows your
        application to retrieve all appointment capacity group records. Each
        group is a resource several appointment definitions share, such as one
        station or room.
      operationId: appointment-capacity-groups.index
      parameters:
        - name: page[size]
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Array of `AppointmentCapacityGroup`
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/AppointmentCapacityGroup'
                required:
                  - data
        '401':
          $ref: '#/components/responses/AuthenticationException'
        '403':
          $ref: '#/components/responses/AuthorizationException'
components:
  schemas:
    AppointmentCapacityGroup:
      type: object
      properties:
        id:
          type: integer
        handle:
          type: string
        name:
          type: string
        description:
          type:
            - string
            - 'null'
        max_concurrent_bookings:
          type: integer
        buffer_before_minutes:
          anyOf:
            - type: integer
            - type: integer
              enum:
                - 0
        buffer_after_minutes:
          anyOf:
            - type: integer
            - type: integer
              enum:
                - 0
        meta:
          type:
            - array
            - 'null'
          items: {}
        appointment_definitions_count:
          type: integer
        appointment_definitions:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              handle:
                type: string
              name:
                type: string
            required:
              - id
              - handle
              - name
        created_at:
          type: string
        updated_at:
          type: string
      required:
        - id
        - handle
        - name
        - description
        - max_concurrent_bookings
        - buffer_before_minutes
        - buffer_after_minutes
        - meta
        - created_at
        - updated_at
      title: AppointmentCapacityGroup
  responses:
    AuthenticationException:
      description: Unauthenticated
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message
    AuthorizationException:
      description: Authorization error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.