Get a custom property for an organization

GET

/orgs/{org}/properties/schema/{custom_property_name}

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

API method documentation

Parameters

Path Parameters

org

required

string

The organization name. The name is not case sensitive.

custom_property_name

required

string

The custom property name

Responses

200

Response

Media type application/json

Organization Custom Property

Custom property defined on an organization

object

property_name

required

The name of the property

string

url

The URL that can be used to fetch, update, or delete info about this property via the API.

string format: uri

source_type

The source type of the property

string

Allowed values: organization enterprise

value_type

required

The type of the value for the property

string

Allowed values: string single_select multi_select true_false url

required

Whether the property is required.

boolean

default_value

One of:

string

string

Array<string>

Array<string>

description

Short description of the property

string

nullable

allowed_values

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

Array<string>

nullable

values_editable_by

Who can edit the values of the property

string

nullable

Allowed values: org_actors org_and_repo_actors

require_explicit_values

Whether setting properties values is mandatory

boolean

Examples

Example default

{
  "property_name": "environment",
  "url": "https://api.github.com/orgs/github/properties/schema/environment",
  "source_type": "organization",
  "value_type": "single_select",
  "required": true,
  "default_value": "production",
  "description": "Prod or dev environment",
  "allowed_values": [
    "production",
    "development"
  ]
}

403

Forbidden

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

404

Resource not found

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}