組織のカスタム プロパティ値の REST API エンドポイント
REST API を使用して組織のカスタム プロパティ値を管理する
Get all custom property values for an organization
Gets all custom property values that are set for an organization.
The organization must belong to an enterprise.
Access requirements:
- Organization admins
- OAuth tokens and personal access tokens (classic) with the
read:orgscope - Actors with the organization-level "read custom properties for an organization" fine-grained permission or above
Fine-grained access tokens for "Get all custom property values for an organization"
This endpoint works with the following fine-grained token types:
- GitHub App user access tokens
- GitHub App installation access tokens
- Fine-grained personal access tokens
The fine-grained token must have the following permission set:
- "Custom properties for organizations" organization permissions (read)
"Get all custom property values for an organization" のパラメーター
| 名前, タイプ, 説明 |
|---|
accept string Setting to |
| 名前, タイプ, 説明 |
|---|
org string 必須The organization name. The name is not case sensitive. |
HTTP response status codes for "Get all custom property values for an organization"
| Status code | 説明 |
|---|---|
200 | OK |
403 | Forbidden |
404 | Resource not found |
Code samples for "Get all custom property values for an organization"
Request example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
http(s)://HOSTNAME/api/v3/organizations/ORG/org-properties/valuesResponse
Status: 200[
{
"property_name": "environment",
"value": "production"
},
{
"property_name": "service",
"value": "web"
},
{
"property_name": "team",
"value": "octocat"
}
]Create or update custom property values for an organization
Create new or update existing custom property values for an organization.
To remove a custom property value from an organization, set the property value to null.
The organization must belong to an enterprise.
Access requirements:
- Organization admins
- OAuth tokens and personal access tokens (classic) with the
admin:orgscope - Actors with the organization-level "edit custom properties for an organization" fine-grained permission
Fine-grained access tokens for "Create or update custom property values for an organization"
This endpoint works with the following fine-grained token types:
- GitHub App user access tokens
- GitHub App installation access tokens
- Fine-grained personal access tokens
The fine-grained token must have the following permission set:
- "Custom properties for organizations" organization permissions (write)
"Create or update custom property values for an organization" のパラメーター
| 名前, タイプ, 説明 |
|---|
accept string Setting to |
| 名前, タイプ, 説明 |
|---|
org string 必須The organization name. The name is not case sensitive. |
| 名前, タイプ, 説明 | |||
|---|---|---|---|
properties array of objects 必須A list of custom property names and associated values to apply to the organization. | |||
Properties of |
| 名前, タイプ, 説明 |
|---|
property_name string 必須The name of the property |
value null or string or array 必須The value assigned to the property |
HTTP response status codes for "Create or update custom property values for an organization"
| Status code | 説明 |
|---|---|
204 | No Content when custom property values are successfully created or updated |
403 | Forbidden |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Code samples for "Create or update custom property values for an organization"
Request example
curl -L \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
http(s)://HOSTNAME/api/v3/organizations/ORG/org-properties/values \
-d '{"properties":[{"property_name":"environment","value":"production"},{"property_name":"service","value":"web"},{"property_name":"team","value":"octocat"}]}'No Content when custom property values are successfully created or updated
Status: 204