Skip to main content
The REST API is now versioned. For more information, see "About API versioning."

Custom properties

Use the REST API to create and manage custom properties for an organization.

About custom properties

You can use the REST API to create and manage custom properties for an organization. You can use custom properties to add metadata to repositories in your organization. For more information, see "Managing custom properties for repositories in your organization."

Get all custom properties for an organization

Gets all custom properties defined for an organization. Organization members can read these properties.

Fine-grained access tokens for "Get all custom properties for an organization"

This endpoint works with the following token types:

The token must have the following permission set:

  • organization_custom_properties:read

Parameters for "Get all custom properties for an organization"

Headers
Name, Type, Description
accept string

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

Path parameters
Name, Type, Description
org string Required

The organization name. The name is not case sensitive.

HTTP response status codes for "Get all custom properties for an organization"

Status codeDescription
200

OK

403

Forbidden

404

Resource not found

Code samples for "Get all custom properties for an organization"

Request example

get/orgs/{org}/properties/schema
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/properties/schema

Response

Status: 200
[ { "property_name": "environment", "value_type": "single_select", "required": true, "default_value": "production", "description": "Prod or dev environment", "allowed_values": [ "production", "development" ], "values_editable_by": "org_actors" }, { "property_name": "service", "value_type": "string" }, { "property_name": "team", "value_type": "string", "description": "Team owning the repository" } ]

Create or update custom properties for an organization

Creates new or updates existing custom properties defined for an organization in a batch.

To use this endpoint, the authenticated user must be one of:

  • An administrator for the organization.
  • A user, or a user on a team, with the fine-grained permission of custom_properties_org_definitions_manager in the organization.

Fine-grained access tokens for "Create or update custom properties for an organization"

This endpoint works with the following token types:

The token must have the following permission set:

  • organization_custom_properties:admin

Parameters for "Create or update custom properties for an organization"

Headers
Name, Type, Description
accept string

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

Path parameters
Name, Type, Description
org string Required

The organization name. The name is not case sensitive.

Body parameters
Name, Type, Description
properties array of objects Required

The array of custom properties to create or update.

Name, Type, Description
property_name string Required

The name of the property

value_type string Required

The type of the value for the property

Can be one of: string, single_select

required boolean

Whether the property is required.

default_value string or null

Default value of the property

description string or null

Short description of the property

allowed_values array of strings or null

An ordered list of the allowed values of the property. The property can have up to 200 allowed values.

values_editable_by string or null

Who can edit the values of the property

Can be one of: org_actors, org_and_repo_actors, null

HTTP response status codes for "Create or update custom properties for an organization"

Status codeDescription
200

OK

403

Forbidden

404

Resource not found

Code samples for "Create or update custom properties for an organization"

Request example

patch/orgs/{org}/properties/schema
curl -L \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/properties/schema \ -d '{"properties":[{"property_name":"environment","value_type":"single_select","required":true,"default_value":"production","description":"Prod or dev environment","allowed_values":["production","development"],"values_editable_by":"org_actors"},{"property_name":"service","value_type":"string"},{"property_name":"team","value_type":"string","description":"Team owning the repository"}]}'

Response

Status: 200
[ { "property_name": "environment", "value_type": "single_select", "required": true, "default_value": "production", "description": "Prod or dev environment", "allowed_values": [ "production", "development" ], "values_editable_by": "org_actors" }, { "property_name": "service", "value_type": "string" }, { "property_name": "team", "value_type": "string", "description": "Team owning the repository" } ]

Get a custom property for an organization

Gets a custom property that is defined for an organization. Organization members can read these properties.

Fine-grained access tokens for "Get a custom property for an organization"

This endpoint works with the following token types:

The token must have the following permission set:

  • organization_custom_properties:read

Parameters for "Get a custom property for an organization"

Headers
Name, Type, Description
accept string

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

Path parameters
Name, Type, Description
org string Required

The organization name. The name is not case sensitive.

custom_property_name string Required

The custom property name. The name is case sensitive.

HTTP response status codes for "Get a custom property for an organization"

Status codeDescription
200

OK

403

Forbidden

404

Resource not found

Code samples for "Get a custom property for an organization"

Request example

get/orgs/{org}/properties/schema/{custom_property_name}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/properties/schema/CUSTOM_PROPERTY_NAME

Response

Status: 200
{ "property_name": "environment", "value_type": "single_select", "required": true, "default_value": "production", "description": "Prod or dev environment", "allowed_values": [ "production", "development" ] }

Create or update a custom property for an organization

Creates a new or updates an existing custom property that is defined for an organization.

To use this endpoint, the authenticated user must be one of:

  • An administrator for the organization.
  • A user, or a user on a team, with the fine-grained permission of custom_properties_org_definitions_manager in the organization.

Fine-grained access tokens for "Create or update a custom property for an organization"

This endpoint works with the following token types:

The token must have the following permission set:

  • organization_custom_properties:admin

Parameters for "Create or update a custom property for an organization"

Headers
Name, Type, Description
accept string

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

Path parameters
Name, Type, Description
org string Required

The organization name. The name is not case sensitive.

custom_property_name string Required

The custom property name. The name is case sensitive.

Body parameters
Name, Type, Description
value_type string Required

The type of the value for the property

Can be one of: string, single_select

required boolean

Whether the property is required.

default_value string or null

Default value of the property

description string or null

Short description of the property

allowed_values array of strings or null

An ordered list of the allowed values of the property. The property can have up to 200 allowed values.

HTTP response status codes for "Create or update a custom property for an organization"

Status codeDescription
200

OK

403

Forbidden

404

Resource not found

Code samples for "Create or update a custom property for an organization"

Request example

put/orgs/{org}/properties/schema/{custom_property_name}
curl -L \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/properties/schema/CUSTOM_PROPERTY_NAME \ -d '{"value_type":"single_select","required":true,"default_value":"production","description":"Prod or dev environment","allowed_values":["production","development"]}'

Response

Status: 200
{ "property_name": "environment", "value_type": "single_select", "required": true, "default_value": "production", "description": "Prod or dev environment", "allowed_values": [ "production", "development" ] }

Remove a custom property for an organization

Removes a custom property that is defined for an organization.

To use this endpoint, the authenticated user must be one of:

  • An administrator for the organization.
  • A user, or a user on a team, with the fine-grained permission of custom_properties_org_definitions_manager in the organization.

Fine-grained access tokens for "Remove a custom property for an organization"

This endpoint works with the following token types:

The token must have the following permission set:

  • organization_custom_properties:admin

Parameters for "Remove a custom property for an organization"

Headers
Name, Type, Description
accept string

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

Path parameters
Name, Type, Description
org string Required

The organization name. The name is not case sensitive.

custom_property_name string Required

The custom property name. The name is case sensitive.

HTTP response status codes for "Remove a custom property for an organization"

Status codeDescription
204

A header with no content is returned.

403

Forbidden

404

Resource not found

Code samples for "Remove a custom property for an organization"

Request example

delete/orgs/{org}/properties/schema/{custom_property_name}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/properties/schema/CUSTOM_PROPERTY_NAME

A header with no content is returned.

Status: 204

List custom property values for organization repositories

Lists organization repositories with all of their custom property values. Organization members can read these properties.

Fine-grained access tokens for "List custom property values for organization repositories"

This endpoint works with the following token types:

The token must have the following permission set:

  • organization_custom_properties:read

Parameters for "List custom property values for organization repositories"

Headers
Name, Type, Description
accept string

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

Path parameters
Name, Type, Description
org string Required

The organization name. The name is not case sensitive.

Query parameters
Name, Type, Description
per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Default: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Default: 1

repository_query string

Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query. See "Searching for repositories" for a detailed list of qualifiers.

HTTP response status codes for "List custom property values for organization repositories"

Status codeDescription
200

OK

403

Forbidden

404

Resource not found

Code samples for "List custom property values for organization repositories"

Request example

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

Response

Status: 200
[ { "repository_id": 1296269, "repository_name": "Hello-World", "repository_full_name": "octocat/Hello-World", "properties": [ { "property_name": "environment", "value": "production" }, { "property_name": "service", "value": "web" }, { "property_name": "team", "value": "octocat" } ] } ]

Create or update custom property values for organization repositories

Create new or update existing custom property values for repositories in a batch that belong to an organization. Each target repository will have its custom property values updated to match the values provided in the request.

A maximum of 30 repositories can be updated in a single request.

Using a value of null for a custom property will remove or 'unset' the property value from the repository.

To use this endpoint, the authenticated user must be one of:

  • An administrator for the organization.
  • A user, or a user on a team, with the fine-grained permission of custom_properties_org_values_editor in the organization.

Fine-grained access tokens for "Create or update custom property values for organization repositories"

This endpoint works with the following token types:

The token must have the following permission set:

  • organization_custom_properties:write

Parameters for "Create or update custom property values for organization repositories"

Headers
Name, Type, Description
accept string

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

Path parameters
Name, Type, Description
org string Required

The organization name. The name is not case sensitive.

Body parameters
Name, Type, Description
repository_names array of strings Required

The names of repositories that the custom property values will be applied to.

properties array of objects Required

List of custom property names and associated values to apply to the repositories.

Name, Type, Description
property_name string Required

The name of the property

value null or string or array Required

The value assigned to the property

HTTP response status codes for "Create or update custom property values for organization repositories"

Status codeDescription
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 organization repositories"

Request example

patch/orgs/{org}/properties/values
curl -L \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/properties/values \ -d '{"repository_names":["Hello-World","octo-repo"],"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