Preview GraphQL API v4 Node IDs in REST API v3 resources
To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a new preview period to include the GraphQL node ID in the response for the following REST API v3 resources:
- Deployments
- Gists
- Git Blobs
- Git Commits
- Git References
- Git Tags
- Issues
- Labels
- Milestones
- Organizations
- Projects
- Pull Requests
- Reactions
- Releases
- Repositories
- Statuses
- Teams
- Users
To access the API during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.jean-grey-preview+json
Example response from Users which includes node_id
:
{
"id": 79995,
"login": "dewski",
"node_id": "MDQ6VXNlcjc5OTk1"
}
Fetching the same user using the node interface in our GraphQL API v4:
{
node(id: "MDQ6VXNlcjc5OTk1") {
... on User {
databaseId
login
id
}
}
}
Which would return:
{
"data": {
"node": {
"databaseId": 79995,
"login": "dewski",
"id": "MDQ6VXNlcjc5OTk1"
}
}
}
For more information, see "GraphQL Global Node IDs."
Please note that node_id
is only available to GitHub Enterprise customers on 2.12 (and future GHE versions when they are released).
If you have any questions or feedback, please let us know on the GitHub Platform Forum.