Users¶

The user-related endpoints cover personal profiles, email addresses and public keys, namespaces, stars and watches, notifications, and querying "my" repositories and pull requests as the current token's identity.

The same resource usually has two versions: /user/… refers to the currently authorized user, while /users/{username}/… refers to a specific user, with different permissions and result scopes.

Objects¶

Identification¶

• A specific user is identified by username; the authorized user is addressed directly as /user with no parameter.
• Repositories use owner + repo, where repository ownership can be given as owner or as an organization or enterprise path.
• Public keys are identified by id; notifications are located by owner + repo.

Common tasks¶

Notes¶

• /user/… and /users/{username}/… are two separate endpoint families: the former only acts on the account belonging to the current token, while the latter can read any user's public data; do not use the former as a general-purpose query.
• Namespaces have both a plural and a singular endpoint: GET /api/v5/user/namespaces returns the list, while GET /api/v5/user/namespace returns a single one; the paths differ by one s.
• The email endpoint is GET /api/v5/emails, without a user prefix.
• "List the organizations the authorized user belongs to" lives in the organizations group, and its path is GET /api/v5/users/orgs (without {username}), which is a different endpoint from GET /api/v5/users/{username}/orgs.
• Notifications are provided only per repository; there is no cross-repository notification-list endpoint.

Endpoint list¶

This module contains 22 endpoints in total.