Enterprise¶

An enterprise is the namespace above organizations. With the API you can manage enterprise members and their roles, view enterprise custom roles and associated organizations, and maintain enterprise milestones, enterprise labels, and custom fields for enterprise issues.

Every endpoint in this group uses the /api/v8 prefix, unlike the /api/v5 used elsewhere. The enterprise member endpoints also have /api/v5 versions in the organizations group.

Objects¶

Identification¶

• Enterprises are identified by enterprise or enterprise_id (both placeholders are used in this group; follow each endpoint page).
• Members use username, milestones use milestone_id, and labels use label_id.
• The endpoint that resolves an organization's enterprise uses the singular org: /api/v8/org/{org}/enterprise.

Common tasks¶

Notes¶

• The whole group uses /api/v8: the enterprise member endpoints in the organizations group are /api/v5 versions with the same meaning but a different version, so paths are not interchangeable and the returned fields may differ.
• Placeholders are mixed: some endpoints use {enterprise} and others {enterprise_id}; custom roles use the singular enterprise, and the organization-to-enterprise endpoint uses the singular org.
• The enterprise label path segment is the singular label (not labels), and creation, update, and deletion all live under /label.
• The enterprise issue list is fetched with POST (not GET), the opposite of the convention for repository issues.
• Enterprise members and organization members are two separate sets of endpoints, and the enterprise-side role enum (viewer, tester, developer, and so on) differs from the organization side.

Endpoint list¶

This module contains 18 endpoints in total.