# x-tagGroups

## Usage

Use `x-tagGroups` to group tags in the Reference docs navigation sidebar. Add it to the root OpenAPI object.

Important
When using `x-tagGroups`, **a tag that is not in a group is not displayed** at all. You must add every tag to at least one group.

| Field Name | Type | Description |
|  --- | --- | --- |
| x-tagGroups | [ [Tag Group Object](#tag-group-object) ] | A list of tag groups. |


### Tag group object

| Field Name | Type | Description |
|  --- | --- | --- |
| name | string | The group name. |
| tags | [ string ] | List of tags to include in this group. |


## Examples


```yaml
openapi: '3.0'
info: ...
tags:
  - name: Customers
  - name: Customer Authentication
  - name: AML
  - name: Customers Timeline
  - name: Payment Instruments
  - name: Payment Tokens
  - name: Payment Cards
x-tagGroups:
  - name: Customers
    tags:
      - Customers
      - Customer Authentication
      - AML
      - Customers Timeline
  - name: Payment Instruments
    tags:
      - Payment Instruments
      - Payment Tokens
      - Payment Cards
```


```json
{
  "x-tagGroups": [
    {
      "name": "Customers",
      "tags": ["Customers", "Customer Authentication", "AML", "Customers Timeline"]
    },
    {
      "name": "Payment Instruments",
      "tags": ["Payment Instruments", "Payment Tokens", "Payment Cards"]
    }
  ]
}
```

### In Reference docs

![Rebilly API Reference documentation](/assets/x-tag-group.77eaaf154dd96f7967697aff1a1370c8b8fa58deb4721b1186a8829f28c5f515.8dd5d84c.png)

Related options
Use [x-displayName](/docs-legacy/api-reference-docs/specification-extensions/x-display-name) and [x-traitTag](/docs-legacy/api-reference-docs/specification-extensions/x-trait-tag) to further customize tags.