---
schema: rendered-html/v1
title: "Project Custom Fields | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/resource-api-admin-customFieldSettings-customFields-fieldID-instances.html
generated_at: 2026-06-11T15:09:29.453993+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](jetbrains__com__help__youtrack__devportal__resource-api-admin-customfieldsettings-bundles-user.md)
- [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)
- Operations with Specific CustomField
- Sub-resources
- [Custom Field Defaults](jetbrains__com__help__youtrack__devportal__resource-api-admin-customfieldsettings-customfields-fieldid-fielddefaults.md)
- [Project Custom Fields](resource-api-admin-customFieldSettings-customFields-fieldID-instances.html)
- [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. [Custom Fields](jetbrains__com__help__youtrack__devportal__resource-api-admin-customfieldsettings-customfields.md)
5. [Sub-resources](#0)
6. [Project Custom Fields](#0)

# Project Custom Fields﻿

Last modified: 24 March 2026

This resource lets you read a so called instances of the custom fields - settings of the custom field in each project that uses it.

| Resource | ``` /api/admin/customFieldSettings/customFields/{fieldID}/instances ``` |
| --- | --- |
| Returned entity | ProjectCustomField. For the description of the entity attributes, see [Supported Fields](/help/youtrack/devportal/resource-api-admin-customFieldSettings-customFields-fieldID-instances.html#ProjectCustomField-supported-fields) section. |
| Supported methods | - `GET`: [Read a List of ProjectCustomFields](/help/youtrack/devportal/resource-api-admin-customFieldSettings-customFields-fieldID-instances.html#get_all-ProjectCustomField-method). |

## ProjectCustomField attributes﻿

Represents settings for custom fields in a particular project.

### Related Resources﻿

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

- Project Custom Fields

### Attributes﻿

This table describes attributes of the `ProjectCustomField` 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 project custom field. `Read-only`. |
| field | CustomField | The custom field in the project. `Read-only`. `Can be null`. |
| project | Project | The project where the custom field belongs. `Read-only`. `Can be null`. |
| canBeEmpty | Boolean | If `true`, the custom field can have empty value, otherwise `false`. |
| emptyFieldText | String | The text that is shown as a placeholder when the custom field has an empty value. `Can be null`. |
| ordinal | Int | The position number of this field on the list of project custom fields. |
| isPublic | Boolean | If `true`, the basic **Read Issue** and **Update Issue** permissions are sufficient to access this field. If `false`, the **Read Issue Private Fields** and **Update Issue Private Fields** permissions are required. |
| hasRunningJob | Boolean | If `true`, there is a background job running for this field. In this case, some field operations may be temporary inaccessible. `Read-only`. |
| condition | CustomFieldCondition | The condition for showing the custom field. `Can be null`. |

## Read a List of ProjectCustomFields﻿

Get all project related settings of this custom field. Basically, this method lets you see in which projects this custom field is used.

### Request syntax﻿

GET /api/admin/customFieldSettings/customFields/{fieldID}/instances?{fields}&{$top}&{$skip}

| null | The database ID of ProjectCustomField |
| --- | --- |

### Request parameters﻿

| Parameter | Type | Description |
| fields | String | A list of ProjectCustomField 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/customFields/58-8/instances?fields=field(name,id),project(id,name),canBeEmpty,emptyFieldText,isPublic,ordinal

#### Sample response body﻿

[
  {
    "emptyFieldText": "No due date",
    "project": {
      "name": "Sandbox",
      "id": "0-3",
      "$type": "Project"
    },
    "ordinal": 0,
    "canBeEmpty": true,
    "isPublic": true,
    "field": {
      "name": "Due Date",
      "id": "58-8",
      "$type": "CustomField"
    },
    "$type": "SimpleProjectCustomField"
  }
]

- [Project Custom Fields](/help/youtrack/devportal/resource-api-admin-customFieldSettings-customFields-fieldID-instances.html)
- [ProjectCustomField attributes](/help/youtrack/devportal/resource-api-admin-customFieldSettings-customFields-fieldID-instances.html#ProjectCustomField-supported-fields)
- [Read a List of ProjectCustomFields](/help/youtrack/devportal/resource-api-admin-customFieldSettings-customFields-fieldID-instances.html#get_all-ProjectCustomField-method)

Operations with Specific CustomFieldDefaults[Field Types](jetbrains__com__help__youtrack__devportal__resource-api-admin-customfieldsettings-types.md)

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

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

![](https://bat.bing.com/action/0?ti=5220035&tm=gtm002&Ver=2&mid=4441e83d-4d31-4265-bc87-2f58d2664d41&bo=4&sid=452929b065a111f19a7fe7356f74a419&vid=aa3122f0648711f1a10d6d095e10fd87&vids=0&msclkid=N&pi=918639831&lg=en-US&sw=1920&sh=1080&sc=24&tl=Project%20Custom%20Fields%20%7C%20Developer%20Portal%20for%20YouTrack%20and%20Hub%20Documentation&p=https%3A%2F%2Fwww.jetbrains.com%2Fhelp%2Fyoutrack%2Fdevportal%2Fresource-api-admin-customFieldSettings-customFields-fieldID-instances.html&r=&lt=744&pt=1781190565622,78,78,,,2,2,2,2,2,,3,52,52,83,269,269,269,743,744,744&pn=0,0&evt=pageLoad&sv=2&asc=G&cdb=AQAS&rn=37514)

![](https://crawler.prototype.prolicht.digital/l/DaNpBT)![](https://crawler.prototype.prolicht.digital/l/Mt1Le2)
