# Teams reference

Copy as Markdown[View as Markdown](/docs/development/guides/owners/teams-reference.md)

***

This page lists the fields and paths supported by teams.

## Paths[​](#paths "Direct link to Paths")

Teams are created in the `teams` folder:

```
/teams/{team-id}.mdx
```

Teams can also be synced from directory sources such as GitHub or Microsoft Entra.

## Routes[​](#routes "Direct link to Routes")

| Route                   | Description              |
| ----------------------- | ------------------------ |
| `/docs/teams/{team-id}` | Team documentation page. |

## Required fields[​](#required-fields "Direct link to Required fields")

### `id`[​](#id "Direct link to id")

* Type: `string`

Unique id of the team. EventCatalog uses this for URLs and resource references.

Example

```
---
id: payments-platform
---
```

### `name`[​](#name "Direct link to name")

* Type: `string`

Display name of the team.

Example

```
---
name: Payments Platform
---
```

## Optional fields[​](#optional-fields "Direct link to Optional fields")

### `summary`[​](#summary "Direct link to summary")

* Type: `string`

Short description of the team.

Example

```
---
summary: Owns payment processing and refund workflows.
---
```

### `email`[​](#email "Direct link to email")

* Type: `string`

Team email address.

Example

```
---
email: payments@example.com
---
```

### `hidden`[​](#hidden "Direct link to hidden")

* Type: `boolean`

Hide the team from generated lists.

Example

```
---
hidden: true
---
```

### `slackDirectMessageUrl`[​](#slackDirectMessageUrl "Direct link to slackDirectMessageUrl")

* Type: `string`

Slack URL for contacting the team.

Example

```
---
slackDirectMessageUrl: https://slack.example.com/team/payments
---
```

### `msTeamsDirectMessageUrl`[​](#msTeamsDirectMessageUrl "Direct link to msTeamsDirectMessageUrl")

* Type: `string`

Microsoft Teams URL for contacting the team.

Example

```
---
msTeamsDirectMessageUrl: https://teams.microsoft.com/l/channel/example
---
```

### `members`[​](#members "Direct link to members")

* Type: `array`

Users that belong to the team.

Example

```
---
members:
  - dboyne
---
```

## Example[​](#example "Direct link to Example")

```
---
id: payments-platform
name: Payments Platform
summary: Owns payment processing and refund workflows.
members:
  - dboyne
ownedServices:
  - payment-api
ownedEvents:
  - PaymentAuthorized
---
```
