GET/orgs/{org}/properties/installations

Get registered app installations for external custom properties

Gets the registered GitHub App installations used to read and write external custom properties for an organization.

A GitHub App installation token will only be able to see its own registration info, whereas an authenticated user will be able to see all registrations for the organization.

To use this endpoint, the authenticated caller must have the organization_external_properties_for_repos:admin permission.

1 parameter

orgstringrequired

The organization name. The name is not case sensitive.

4 status codes

200Response

display_namestringrequired

The display name assigned to the app installation's external custom properties in the organization.

installationobjectrequired

The GitHub App installation that was registered.

403Forbidden

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

422Validation failed, or the endpoint has been spammed.

messagestringrequired

documentation_urlstringrequired

errorsarray<object>optional

Error handling

A 403 is returned: Forbidden. A 404 is returned: Resource not found. A 422 is returned: Validation failed, or the endpoint has been spammed.

import { Client } from "@octridev/github";

const client = new Client({
  baseUrl: "https://api.github.com",
});

const result = await client.installations.list({ org: "acme-inc" });

[
  {
    "value": {
      "display_name": "Acme",
      "installation": {
        "id": 1
      }
    }
  }
]

Request

Response

Errors