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

Custom properties

Use the REST API to list the custom properties assigned to a repository by the organization.

About custom properties

You can use the REST API to view the custom properties that were assigned to a repository by the organization that owns the repository. For more information, see "Managing custom properties for repositories in your organization." For more information about the REST API endpoints to manage custom properties, see "Custom properties."

Note: The API endpoints for custom properties are in public beta and subject to change.

Get all custom property values for a repository

Works with GitHub Apps

Gets all custom property values that are set for a repository. Users with read access to the repository can use this endpoint.

Parameters for "Get all custom property values for a repository"

Headers
Name, Type, Description
accept string

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

Path parameters
Name, Type, Description
owner string Required

The account owner of the repository. The name is not case sensitive.

repo string Required

The name of the repository without the .git extension. The name is not case sensitive.

HTTP response status codes for "Get all custom property values for a repository"

Status codeDescription
200

OK

403

Forbidden

404

Resource not found

Code samples for "Get all custom property values for a repository"

get/repos/{owner}/{repo}/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/repos/OWNER/REPO/properties/values

Response

Status: 200
[ { "property_name": "environment", "value": "production" }, { "property_name": "service", "value": "web" }, { "property_name": "team", "value": "octocat" } ]