Skip to main content
REST API はバージョン化されました。 詳細については、「API のバージョン管理について」を参照してください。

組織のカスタム プロパティ値の 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:org scope
  • Actors with the organization-level "read custom properties for an organization" fine-grained permission or above

fine_grained_access

works_with_fine_grained_tokens:

permission_set:

  • "Custom properties for organizations" organization permissions (read)

"Get all custom property values for an organization" のパラメーター

ヘッダー
名前, タイプ, 説明
accept string

Setting to application/vnd.github+json is recommended.

パスパラメーター
名前, タイプ, 説明
org string 必須

The organization name. The name is not case sensitive.

http_status_code

status_code説明
200

OK

403

Forbidden

404

Resource not found

code_samples

data_residency_notice

request_example

get/organizations/{org}/org-properties/values
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/organizations/ORG/org-properties/values

Response

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:org scope
  • Actors with the organization-level "edit custom properties for an organization" fine-grained permission

fine_grained_access

works_with_fine_grained_tokens:

permission_set:

  • "Custom properties for organizations" organization permissions (write)

"Create or update custom property values for an organization" のパラメーター

ヘッダー
名前, タイプ, 説明
accept string

Setting to application/vnd.github+json is recommended.

パスパラメーター
名前, タイプ, 説明
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.

名前, タイプ, 説明
property_name string 必須

The name of the property

value null or string or array 必須

The value assigned to the property

http_status_code

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

data_residency_notice

request_example

patch/organizations/{org}/org-properties/values
curl -L \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/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