---
schema: rendered-html/v1
title: "User Bundles | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/resource-api-admin-customFieldSettings-bundles-user.html
generated_at: 2026-06-11T15:09:18.493676+00:00
---

Feedback

Thanks for your feedback!

Was this page helpful?

YesNo

Developer Portal for YouTrack and Hub

- Developer Portal
- Apps
- MCP Tools
- YouTrack Workflows
- YouTrack Import Scripts
- YouTrack Form API
- YouTrack REST API
- Get Started with REST API
- REST API Reference
- Entities
- Resources
- Activity Items
- Issue Activities Page
- Build Bundles
- Enum Bundles
- Owned Bundles
- State Bundles
- [User Bundles](resource-api-admin-customFieldSettings-bundles-user.html)
- Operations with Specific UserBundle
- Sub-resources
- [Version Bundles](jetbrains__com__help__youtrack__devportal__resource-api-admin-customfieldsettings-bundles-version.md)
- [Custom Fields](jetbrains__com__help__youtrack__devportal__resource-api-admin-customfieldsettings-customfields.md)
- [Field Types](jetbrains__com__help__youtrack__devportal__resource-api-admin-customfieldsettings-types.md)
- [Backup Files](jetbrains__com__help__youtrack__devportal__resource-api-admin-databasebackup-backups.md)
- Database Backup Settings
- Global Settings
- Organizations
- Projects
- Telemetry data
- Global Time Tracking Settings
- Agiles
- Articles
- Assigned Roles
- Commands
- Command Suggestions
- User Groups
- Issue Link Types
- Issue Tag
- Issues
- Issue Count
- Permissions
- Roles
- Saved Queries
- Search Suggestions
- Tags
- Users
- My User Profile
- Issue Work Items
- REST API Use Cases
- REST API Troubleshooting
- Color Indices List
- Hub REST API

1. YouTrack REST API
2. REST API Reference
3. Resources
4. [User Bundles](#0)

# User Bundles﻿

Last modified: 24 March 2026

This resource lets you work with the sets of users in YouTrack.

| Resource | ``` /api/admin/customFieldSettings/bundles/user ``` |
| --- | --- |
| Returned entity | UserBundle. For the description of the entity attributes, see [Supported Fields](/help/youtrack/devportal/resource-api-admin-customFieldSettings-bundles-user.html#UserBundle-supported-fields) section. |
| Supported methods | - `GET`: [Read a List of UserBundles](/help/youtrack/devportal/resource-api-admin-customFieldSettings-bundles-user.html#get_all-UserBundle-method). - `POST`: [Add a New UserBundle](/help/youtrack/devportal/resource-api-admin-customFieldSettings-bundles-user.html#create-UserBundle-method). |
| Supported sub-resources | - /api/admin/customFieldSettings/bundles/user/{bundleID} : Operations with Specific UserBundle - /api/admin/customFieldSettings/bundles/user/{bundleID}/groups : [Groups in the User Bundle](jetbrains__com__help__youtrack__devportal__resource-api-admin-customfieldsettings-bundles-user-bundleid-groups.md) - /api/admin/customFieldSettings/bundles/user/{bundleID}/individuals : [Individual Users in the Bundle](jetbrains__com__help__youtrack__devportal__resource-api-admin-customfieldsettings-bundles-user-bundleid-individuals.md) - /api/admin/customFieldSettings/bundles/user/{bundleID}/aggregatedUsers : [Aggregated Users in the Bundle](jetbrains__com__help__youtrack__devportal__resource-api-admin-customfieldsettings-bundles-user-bundleid-aggregatedusers.md) |

## UserBundle attributes﻿

Represents a set of values that contains users. You can add to the set both individual user accounts and groups of users.

### Related Resources﻿

Below you can find the list of resources that let you work with this entity.

- User Bundles

Extends Bundle

### Attributes﻿

This table describes attributes of the `UserBundle` entity.

- To receive an attribute in the response from the server, specify it explicitly in the `fields` request parameter.
- To update an attribute, provide it in the body of a POST request.

| Field | Type | Description |
| id | String | The ID of the set of users. `Read-only`. |
| groups | Array of UserGroups | User groups that belong to this bundle. |
| individuals | Array of Users | Individual users that belong to this bundle. |
| aggregatedUsers | Array of Users | All users that belong to this bundle. `Read-only`. |
| isUpdateable | Boolean | If `true`, then the currently logged-in user can update this bundle. Otherwise, `false`. `Read-only`. |

## Read a List of UserBundles﻿

Get the list of all available sets of users in YouTrack.

### Request syntax﻿

GET /api/admin/customFieldSettings/bundles/user?{fields}&{$top}&{$skip}

| null | The database ID of UserBundle |
| --- | --- |

### Request parameters﻿

| Parameter | Type | Description |
| fields | String | A list of UserBundle attributes that should be returned in the response. If no field is specified, only the `entityID` is returned. |
| $skip | Int | Optional. Lets you set a number of returned entities to skip before returning the first one. |
| $top | Int | Optional. Lets you specify the maximum number of entries that are returned in the response. If you don't set the $top value, the server limits the maximum number of returned entries.  The server returns a maximum of 42 entries for most resources that return collections. For more information, see Pagination. |

### Sample﻿

#### Sample request﻿

https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/user?fields=name,id,isUpdateable,individuals(login,id,name),groups(name,id),aggregatedUsers(name,id,login)&$top=2

#### Sample response body﻿

[
  {
    "groups": [
      {
        "name": "Sample Project Team",
        "id": "3-2",
        "$type": "UserGroup"
      }
    ],
    "aggregatedUsers": [
      {
        "login": "root",
        "name": "John Smith",
        "id": "1-1",
        "$type": "User"
      },
      {
        "login": "john.doe",
        "name": "John Doe",
        "id": "1-2",
        "$type": "User"
      },
      {
        "login": "jane.doe",
        "name": "Jane Doe",
        "id": "1-3",
        "$type": "User"
      }
    ],
    "individuals": [],
    "isUpdateable": true,
    "name": "Sample Project: Assignees",
    "id": "8-0",
    "$type": "UserBundle"
  },
  {
    "groups": [
      {
        "name": "Rest Api Project Team",
        "id": "3-4",
        "$type": "UserGroup"
      }
    ],
    "aggregatedUsers": [
      {
        "login": "john.doe",
        "name": "John Doe",
        "id": "1-2",
        "$type": "User"
      },
      {
        "login": "jane.doe",
        "name": "Jane Doe",
        "id": "1-3",
        "$type": "User"
      },
      {
        "login": "Jane_Smith",
        "name": "Jane Smith",
        "id": "1-4",
        "$type": "User"
      }
    ],
    "individuals": [
      {
        "login": "jane.doe",
        "name": "Jane Doe",
        "id": "1-3",
        "$type": "User"
      },
      {
        "login": "Jane_Smith",
        "name": "Jane Smith",
        "id": "1-4",
        "$type": "User"
      }
    ],
    "isUpdateable": true,
    "name": "Rest Api Project: Assignees",
    "id": "8-2",
    "$type": "UserBundle"
  }
]

## Add a New UserBundle﻿

Create a new set of users.

### Required permissions﻿

Requires permissions: Update Project or Low-level Admin Write

### Request syntax﻿

POST /api/admin/customFieldSettings/bundles/user?{fields}

| null | The database ID of UserBundle |
| --- | --- |

### Request parameters﻿

| Parameter | Type | Description |
| fields | String | A list of UserBundle attributes that should be returned in the response. If no field is specified, only the `entityID` is returned. |

### Sample﻿

#### Sample request﻿

https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/user?fields=id,name,aggregatedUsers(id,login)

#### Sample request body﻿

{
  "individuals": [
    {
      "id": "1-3"
    },
    {
      "id": "1-2"
    },
    {
      "id": "1-4"
    }
  ],
  "name": "Hero-team",
  "isUpdateable": true
}

#### Sample response body﻿

{
  "aggregatedUsers": [
    {
      "login": "john.doe",
      "id": "1-2",
      "$type": "User"
    },
    {
      "login": "jane.doe",
      "id": "1-3",
      "$type": "User"
    },
    {
      "login": "Jane_Smith",
      "id": "1-4",
      "$type": "User"
    }
  ],
  "name": "Hero-team",
  "id": "8-20",
  "$type": "UserBundle"
}

- [User Bundles](/help/youtrack/devportal/resource-api-admin-customFieldSettings-bundles-user.html)
- [UserBundle attributes](/help/youtrack/devportal/resource-api-admin-customFieldSettings-bundles-user.html#UserBundle-supported-fields)
- [Read a List of UserBundles](/help/youtrack/devportal/resource-api-admin-customFieldSettings-bundles-user.html#get_all-UserBundle-method)
- [Add a New UserBundle](/help/youtrack/devportal/resource-api-admin-customFieldSettings-bundles-user.html#create-UserBundle-method)

Operations with Specific Values in the State BundleOperations with Specific UserBundle

- Privacy & Security
- Terms Of Use
- Trademarks
- Legal

Copyright © 2000–2026 JetBrains s.r.o.
