enterprise-admin

Get a custom property for an enterprise

Gets a custom property that is defined for an enterprise. Enterprise members can read these properties.

get/enterprises/{enterprise}/properties/schema/{custom_property_name}

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/enterprises/{enterprise}/properties/schema/{custom_property_name}
  • Auth: none declared

Path parameters

enterprisestring required

The slug version of the enterprise name.

custom_property_namestring required

The custom property name

Response

Response

property_namestring required

The name of the property

urlstring uri

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

source_type'organization' | 'enterprise'

The source type of the property

value_type'string' | 'single_select' | 'multi_select' | 'true_false' | 'url' required

The type of the value for the property

requiredboolean

Whether the property is required.

descriptionstring nullable

Short description of the property

allowed_valuesstring[] nullable

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

values_editable_by'org_actors' | 'org_and_repo_actors' nullable

Who can edit the values of the property

require_explicit_valuesboolean

Whether setting properties values is mandatory

Example response

{
  "source_type": "organization",
  "value_type": "single_select",
  "values_editable_by": "org_actors"
}

Changes

No recorded changes to this operation across all 83 revisions of this API.