# ProjectTeam

Represents a project team. To access a project team in a workflow, use the `team` property of a [Project](v1-Project.html) object, such as `ctx.issue.project.team`, or the `teams` property of a [User](v1-User.html) object. In rule requirements, reference a project team as a [UserGroup](v1-UserGroup.html) by name.

Extends [UserGroup](v1-UserGroup.html).

## Properties

| Name | Type | Description |
| --- | --- | --- |
| static allUsersGroup |  [UserGroup](v1-UserGroup.html)  | Read-only.  The All Users group.   |
| static fieldType |  String  | Read-only.  Field type. Used when defining rule requirements.   |
| becomesRemoved |  Boolean  | Read-only.  When `true`, the entity is removed in the current transaction. Otherwise, `false`. This property can become `true` only in on-change rules when the rule is triggered on the removal of an issue or an article. In the rule code, the `runOn` rule property must contain the `removal` parameter set to `true`.             Available since 2017.4.37915      ```JAVASCRIPT runOn: {removal: true} ```    |
| customerGroupProjects |  [Set](v1-Set.html).<[Project](v1-Project.html)>  | Read-only.  The set of helpdesk projects where this group is configured as a customer group. For groups that are not customer groups, this property is an empty set.             Available since 2026.2    |
| description |  String  | Read-only.  The description of the group.   |
| extensionProperties |  Object  |  The object containing extension properties for this entity and their values. Extension properties are custom properties that might be added to core YouTrack entities by an app. For details about extension properties, see [Extension Properties](apps-extension-properties.html).             Available since 2024.3      ```JAVASCRIPT const entities = require('@jetbrains/youtrack-scripting-api/entities');  exports.rule = entities.Issue.action({     command: 'test',     action: function (ctx) {         const printValues = () => {             return 'stringProp:' + ctx.issue.extensionProperties.stringProp + ';'                 + 'integerProp:' + ctx.issue.extensionProperties.integerProp + ';'                 + 'booleanProp:' + ctx.issue.extensionProperties.booleanProp + ';'                 + 'issueProp:' + ctx.issue.extensionProperties.issueProp?.id + ';'                 + 'issuesProp:' + ctx.issue.extensionProperties.issuesProp?.first()?.id + ';'         }         ctx.issue.addComment(printValues());     } }); ```    |
| isAllUsersGroup |  Boolean  | Read-only.  If the group is the All Users group, this property is `true`.   |
| isAutoJoin |  Boolean  | Read-only.  If the auto-join option is enabled for the group, this property is `true`.   |
| isCustomerGroup |  Boolean  | Read-only.  If this group is a helpdesk customer group, this property is `true`.             Available since 2026.2    |
| isNew |  Boolean  | Read-only.  When `true`, the entity is created in the current transaction. Otherwise, `false`.             Available since 2018.2.42351    |
| name |  String  | Read-only.  The name of the group.   |
| project |  [Project](v1-Project.html)  | Read-only.  The project that the team belongs to.             Available since 2025.3    |
| users |  [Set](v1-Set.html).<[User](v1-User.html)>  | Read-only.  A list of users who are members of the group.   |

## Methods

### findByExtensionProperties

```JAVASCRIPT
static findByExtensionProperties(extensionPropertiesQuery)
```

Searches for ProjectTeam entities with extension properties that match the specified query.

Available since 2024.3.43260

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | extensionPropertiesQuery |  Object  |  The extension properties query, defined as a set of key-value pairs representing properties and their corresponding values.                     |

Return Value
: | Type | Description |
: | --- | --- |
: |  [Set](v1-Set.html).<[ProjectTeam]()>  |  The set of ProjectTeam entities that contain the specified extension properties.                 |

Example
: ```JAVASCRIPT
: {
: property1: "value1",
: property2: "value2"
: }
: ```

### findByName

```JAVASCRIPT
static findByName(name)
```

Finds a group by name.

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | name |  String  |  The name of the group to search for.                     |

Return Value
: | Type | Description |
: | --- | --- |
: |  [UserGroup](v1-UserGroup.html)  |  The specified user group, or `null` when a group with the specified name is not found.                 |

### becomes

```JAVASCRIPT
becomes(fieldName, expected)
```

Checks whether a field is set to an expected value in the current transaction.

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | fieldName |  string  |  The name of the field to check.                     |
: | expected |  string  |  The expected value.                     |

Return Value
: | Type | Description |
: | --- | --- |
: |  boolean  |  If the field is set to the expected value, returns `true`.                 |

### canBeReadBy

```JAVASCRIPT
canBeReadBy(fieldName, user)
```

Checks whether a user has permission to read the field.

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | fieldName |  string  |  The name of the field.                     |
: | user |  [User](v1-User.html)  |  The user for whom the permission to read the field is checked.                     |

Return Value
: | Type | Description |
: | --- | --- |
: |  boolean  |  If the user can read the field, returns `true`.                 |

### canBeWrittenBy

```JAVASCRIPT
canBeWrittenBy(fieldName, user)
```

Checks whether a user has permission to update the field.

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | fieldName |  string  |  The name of the field.                     |
: | user |  [User](v1-User.html)  |  The user for whom the permission to update the field is checked.                     |

Return Value
: | Type | Description |
: | --- | --- |
: |  boolean  |  If the user can update the field, returns `true`.                 |

### is

```JAVASCRIPT
is(fieldName, expected)
```

Checks whether a field is equal to an expected value.

Available since 2019.2.55603

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | fieldName |  string  |  The name of the field to check.                     |
: | expected |  string  |  The expected value.                     |

Return Value
: | Type | Description |
: | --- | --- |
: |  boolean  |  If the field is equal to the expected value, returns `true`.                 |

### isChanged

```JAVASCRIPT
isChanged(fieldName)
```

Checks whether the value of a field is changed in the current transaction.

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | fieldName |  string  |  The name of the field to check.                     |

Return Value
: | Type | Description |
: | --- | --- |
: |  boolean  |  If the value of the field is changed in the current transaction, returns `true`.                 |

### notifyAllUsers

```JAVASCRIPT
notifyAllUsers(subject, body)
```

Sends an email notification to all of the users who are members of the group.

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | subject |  String  |  The subject line of the email notification.                     |
: | body |  String  |  The message text of the email notification.                     |

Example
: ```JAVASCRIPT
: issue.oldValue('permittedGroup').notifyAllUsers('Visibility has been changed',
: 'The visibility group for the issue ' + issue.getId() +
: ' has been changed to ' + permittedGroup.name);
: ```

### oldValue

```JAVASCRIPT
oldValue(fieldName)
```

Returns the previous value of a single-value field before an update was applied. If the field is not changed in the transaction, returns `null`.

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | fieldName |  string  |  The name of the field.                     |

Return Value
: | Type | Description |
: | --- | --- |
: |  Object  |  If the field is changed in the current transaction, the previous value of the field. Otherwise, `null`.                 |

### required

```JAVASCRIPT
required(fieldName, message)
```

Asserts that a value is set for a field. If a value for the required field is not set, the specified message is displayed in the user interface.

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | fieldName |  string  |  The name of the field to check.                     |
: | message |  string  |  The message that is displayed to the user that describes the field requirement.                     |

### was

```JAVASCRIPT
was(fieldName, expected)
```

Checks whether a field was equal to an expected value prior to the current transaction.

Available since 2019.2.55603

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | fieldName |  string  |  The name of the field to check.                     |
: | expected |  string  |  The expected value.                     |

Return Value
: | Type | Description |
: | --- | --- |
: |  boolean  |  If the field was equal to the expected value, returns `true`.                 |

## See also

[UserGroup](v1-UserGroup.html) [Set](v1-Set.html) [Project](v1-Project.html) [Extension Properties](apps-extension-properties.html) [User](v1-User.html)