The CData Sync App provides a straightforward way to continuously pipeline your GitHub data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The GitHub connector can be used from the CData Sync application to pull data from GitHub and move it to any of the supported destinations.
The Sync App models entities in the GitHub GraphQL API as relational views.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
This section details a selection of advanced features of the GitHub Sync App.
The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
For further information, see Query Processing.
By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
The CData Sync App models GitHub data as an easy-to-use SQL database with tables, views, and stored procedures.
The Sync App exposes three types of schemas:
In the Information Data Model schema, the Sync App models licensing information and high-level overviews of the organizations, projects, and repositories associated with the authenticated account as an easy-to-use SQL database. Live connectivity to these objects means that any changes to your GitHub account are immediately reflected in the Sync App.
The Tables section, which details standard SQL tables, and the Views section, which lists read-only SQL tables, contain samples of what you might have access to in your GitHub account.
The following tables and views are shipped with the Sync App:
| Table | Description |
| EnterpriseAdminInvitations | Lists users who have been invited to join as GitHub Enterprise account administrators. |
| EnterpriseAdmins | Catalogs the administrators responsible for managing and maintaining a GitHub Enterprise account. |
| EnterpriseMembers | Lists all users who are members of a specified GitHub Enterprise account. |
| Enterprises | Stores information about GitHub enterprises associated with the user, including identifiers and descriptive details. |
| EnterpriseUnaffiliatedMemberInvitations | Tracks invitations sent to unaffiliated users to join a GitHub Enterprise account, aiding recruitment efforts. |
| LicenseConditions | Lists conditions and obligations imposed by a specific software license applied to a GitHub repository. |
| LicenseLimitations | Details restrictions and limitations imposed by a specific license in the context of a GitHub repository. |
| LicensePermissions | Describes permissions granted by a specific repository license, helping users understand the scope of allowed actions. |
| Licenses | Compiles all supported open-source licenses recognized by GitHub, aiding in license selection and compliance. |
| OrganizationMannequins | Contains comprehensive information about organizations linked either to the authenticated user or to a specified organization. |
| OrganizationMembers | Contains comprehensive information about organizations linked either to the authenticated user or to a specified organization. |
| OrganizationTeamMembers | Tracks team memberships within organizations, detailing roles and associated permissions for each member. |
| OrganizationTeamProjects | Lists projects accessible to specific teams within a GitHub organization, including details on collaboration and access rights. |
| OrganizationTeamRepositories | Tracks repositories that teams in an organization have access to, along with permission levels for each repository. |
| Organizations | Contains comprehensive information about organizations linked either to the authenticated user or to a specified organization. |
| OrganizationTeams | Maintains a list of all teams within the user's organizations, supporting team management and collaboration. |
| Projects | Holds metadata and organization-related details for GitHub projects, enabling structured project tracking. |
| ProjectStatusUpdates | Records project status updates, including any changes to goals or scope. |
| Repositories | Provides comprehensive details about user-owned or managed repositories, including configuration and metadata. |
Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including getting the currently authenticated user or retrieving and refreshing OAuth access tokens.
The Sync App models the data in GitHub as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| EnterpriseAdminInvitations | Lists users who have been invited to join as GitHub Enterprise account administrators. |
| EnterpriseAdmins | Catalogs the administrators responsible for managing and maintaining a GitHub Enterprise account. |
| EnterpriseMembers | Lists all users who are members of a specified GitHub Enterprise account. |
| EnterpriseUnaffiliatedMemberInvitations | Tracks invitations sent to unaffiliated users to join a GitHub Enterprise account, aiding recruitment efforts. |
| Organizations | Contains comprehensive information about organizations linked either to the authenticated user or to a specified organization. |
| OrganizationTeams | Maintains a list of all teams within the user's organizations, supporting team management and collaboration. |
| ProjectStatusUpdates | Records project status updates, including any changes to goals or scope. |
| Repositories | Provides comprehensive details about user-owned or managed repositories, including configuration and metadata. |
Lists users who have been invited to join as GitHub Enterprise account administrators.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM [EnterpriseAdminInvitations]
SELECT * FROM [EnterpriseAdminInvitations] WHERE [EnterpriseSlug] = 'Val1'
SELECT * FROM [EnterpriseAdminInvitations] WHERE [Role] = 'OWNER'
The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions that are built with the following column: CreatedAt
SELECT * FROM [EnterpriseAdminInvitations] ORDER BY [CreatedAt]
The Sync App uses client-side processing when ordering by any other columns. This impacts performance.
You can use the following columns to create (insert) a new record:
INSERT INTO [EnterpriseAdminInvitations] ([EnterpriseId], [Role], [InviteeLogin]) VALUES ('E_kgDOAAO82g', 'OWNER', 'test')
You can specify the following column to delete a record: Id
DELETE FROM [EnterpriseAdminInvitations] WHERE [Id] = 'EAI_kwDOAAO82s4AA6xw'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique node ID representing the enterprise invitation object. | |
| EnterpriseId | String | True |
Enterprises.Id |
The unique node ID of the enterprise associated with the invitation. |
| EnterpriseSlug | String | True |
Enterprises.Slug |
The URL-friendly identifier (slug) used to reference the enterprise in URLs and APIs. |
| String | True |
The email address of the person invited to join the enterprise. | ||
| Role | String | True |
The role that the invited user has in the enterprise once they accept the invitation (for example, admin, member). The allowed values are OWNER, BILLING_MANAGER. | |
| InviteeId | String | True |
The unique node ID of the user invited to the enterprise. Null if the invitee is not yet a registered GitHub user. | |
| InviteeLogin | String | True |
The username (login) of the invited user. Null if the invitee is not yet a registered GitHub user. | |
| InviterId | String | True |
The unique node ID of the user who sent the invitation. | |
| InviterLogin | String | True |
The username (login) of the user who sent the invitation. | |
| CreatedAt | Datetime | True |
The date and time when the invitation was created, in ISO 8601 format. |
Catalogs the administrators responsible for managing and maintaining a GitHub Enterprise account.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM [EnterpriseAdmins]
SELECT * FROM [EnterpriseAdmins] WHERE [EnterpriseSlug] = 'Val1'
SELECT * FROM [EnterpriseAdmins] WHERE [Role] = 'OWNER'
SELECT * FROM [EnterpriseAdmins] WHERE [OrganizationLogins] = 'Val1'
SELECT * FROM [EnterpriseAdmins] WHERE [TwoFactorMethodSecurity] = 'SECURE'
The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions that are built with the following columns:
SELECT * FROM [EnterpriseAdmins] ORDER BY [Login]
SELECT * FROM [EnterpriseAdmins] ORDER BY [CreatedAt]
The Sync App uses client-side processing when ordering by any other columns. This impacts performance.
You can specify the following columns to delete a record:
DELETE FROM [EnterpriseAdmins] WHERE ([Login] = 'Test') AND ([EnterpriseId] = 'E_kgDOAAO82g')
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique identifier (node ID) assigned to the user. | |
| DatabaseId | Int | True |
The primary key of the user in the database, used for internal reference. | |
| Login | String | True |
The unique username of the user, used for login and profile identification. | |
| Name | String | True |
The publicly visible name of the user as displayed on their GitHub profile. | |
| String | True |
The publicly visible email address associated with the user’s GitHub profile. | ||
| TwitterUsername | String | True |
The user’s Twitter handle as listed on their GitHub profile. | |
| Pronouns | String | True |
The pronouns specified by the user on their GitHub profile (for example, they/them, she/her, he/him). | |
| Bio | String | True |
The user’s public profile bio, which provides an overview or description of the user. | |
| BioHTML | String | True |
The user’s profile bio formatted in HTML for display purposes. | |
| Company | String | True |
The user’s publicly displayed company or organization affiliation. | |
| CompanyHTML | String | True |
The HTML-formatted version of the user’s company information for display purposes. | |
| Location | String | True |
The geographic location specified by the user on their public profile. | |
| AnyPinnableItems | Bool | True |
Indicates whether the user has any content, such as repositories or gists, that can be pinned to their profile. Accepts arguments to filter by type. | |
| PinnedItemsRemaining | Int | True |
The number of additional items the user can pin to their profile. | |
| ItemShowcaseHasPinnedItems | Bool | True |
Indicates whether the user has pinned any repositories or gists to their profile. | |
| IsEmployee | Bool | True |
Indicates whether the user is an employee of GitHub. | |
| IsHireable | Bool | True |
Indicates whether the user has marked themselves as available for hire. | |
| IsBountyHunter | Bool | True |
Indicates whether the user participates in the GitHub Security Bug Bounty program. | |
| IsCampusExpert | Bool | True |
Indicates whether the user is a member of the GitHub Campus Experts program. | |
| IsFollowingViewer | Bool | True |
Indicates whether this user is following the current viewer of the profile. Inverse of viewerIsFollowing. | |
| IsSiteAdmin | Bool | True |
Indicates whether the user is a GitHub site administrator with elevated permissions. | |
| IsDeveloperProgramMember | Bool | True |
Indicates whether the user is a member of the GitHub Developer Program. | |
| IsGitHubStar | Bool | True |
Indicates whether the user is a recognized member of the GitHub Stars program. | |
| IsSponsoringViewer | Bool | True |
Indicates whether the user is financially sponsoring the current viewer of their profile or organization. | |
| IsViewer | Bool | True |
Indicates whether this user is the currently logged-in viewer of the profile. | |
| ViewerCanFollow | Bool | True |
Indicates whether the current viewer has the ability to follow this user. | |
| ViewerCanSponsor | Bool | True |
Indicates whether the current viewer can sponsor this user or organization through GitHub Sponsors. | |
| ViewerIsFollowing | Bool | True |
Indicates whether the current viewer is following this user. | |
| ViewerIsSponsoring | Bool | True |
Indicates whether the current viewer is sponsoring this user or organization. | |
| ViewerCanCreateProjects | Bool | True |
Indicates whether the current viewer has permission to create new projects for this user or organization. | |
| ViewerCanChangePinnedItems | Bool | True |
Indicates whether the current viewer can pin repositories and gists to the user's profile. | |
| StatusId | String | True |
The unique identifier of the user’s status emoji. | |
| StatusEmoji | String | True |
An emoji representing the user’s current status. | |
| StatusMessage | String | True |
A short, user-defined message describing their current activity or status. | |
| StatusIndicatesLimitedAvailability | Bool | True |
Indicates whether the user’s status suggests they have limited availability on GitHub. | |
| StatusEmojiHTML | String | True |
The HTML representation of the user’s status emoji for display purposes. | |
| StatusCreatedAt | Datetime | True |
The date and time when the user’s status was created, in ISO 8601 format. | |
| StatusExpiresAt | Datetime | True |
The expiration date and time for the user’s status. After this time, the status is no longer be visible. | |
| StatusUpdatedAt | Datetime | True |
The date and time when the user’s status was last updated, in ISO 8601 format. | |
| StatusOrganizationId | String | True |
The unique identifier (node ID) of the organization associated with the user’s status. | |
| StatusOrganizationLogin | String | True |
The login name of the organization associated with the user’s status. | |
| InteractionAbilityLimit | String | True |
The current interaction restriction level on this user’s account or content (for example, collaborators only). | |
| InteractionAbilityOrigin | String | True |
The source or origin of the currently applied interaction restriction (for example, account settings). | |
| InteractionAbilityExpiresAt | Datetime | True |
The date and time when the current interaction restriction expires, if applicable. | |
| HasSponsorsListing | Bool | True |
Indicates whether this user or organization has an active GitHub Sponsors listing. | |
| MonthlyEstimatedSponsorsIncomeInCents | Int | True |
The estimated monthly income from GitHub Sponsors for this user or organization, in cents (USD). | |
| EstimatedNextSponsorsPayoutInCents | Int | True |
The estimated amount of the next payout from GitHub Sponsors for this user or organization, in cents (USD). | |
| SponsorsListingId | String | True |
The unique identifier (node ID) of the GitHub Sponsors listing for this user or organization. | |
| SponsorsListingName | String | True |
The full display name of the GitHub Sponsors listing for this user or organization. | |
| TotalSponsorshipAmountAsSponsorInCents | Int | True |
The total amount (in cents, USD) spent by this user or organization to sponsor others on GitHub. Only visible to the user or managers of the organization. | |
| ResourcePath | String | True |
The relative HTTP path to this user’s profile on GitHub. | |
| ProjectsResourcePath | String | True |
The relative HTTP path to the list of projects associated with this user. | |
| Url | String | True |
The absolute HTTP URL for this user’s GitHub profile. | |
| ProjectsUrl | String | True |
The absolute HTTP URL to the list of projects associated with this user. | |
| WebsiteUrl | String | True |
A URL pointing to the user’s personal website or blog, as listed on their profile. | |
| AvatarUrl | String | True |
The URL pointing to the user’s public avatar image. Optionally accepts a 'size' argument to specify the dimensions of the square image in pixels. | |
| CopilotEndpointsApi | String | True |
The API endpoint used to interact with GitHub Copilot services. | |
| CopilotEndpointsOriginTracker | String | True |
The endpoint used by GitHub Copilot for tracking the origin of requests. | |
| CopilotEndpointsProxy | String | True |
The proxy endpoint used for routing GitHub Copilot requests. | |
| CopilotEndpointsTelemetry | String | True |
The telemetry endpoint used for collecting data related to GitHub Copilot activities and usage. | |
| CreatedAt | Datetime | True |
The date and time when this object was created, in ISO 8601 format. | |
| UpdatedAt | Datetime | True |
The date and time when this object was last updated, in ISO 8601 format. | |
| RepositoryCount | Int | True |
The total number of repositories owned by the user. | |
| FollowerCount | Int | True |
The total number of users following this user on GitHub. | |
| EnterpriseId [KEY] | String | True |
Enterprises.Id |
The unique node ID of the enterprise associated with this user or data. |
| EnterpriseSlug | String | True |
Enterprises.Slug |
The URL-friendly identifier (slug) for the enterprise, used in APIs and URLs. |
| Role | String | True |
The role assigned to the user within the enterprise (for example, 'admin', 'member'). Can be used for filtering. The allowed values are OWNER, BILLING_MANAGER. | |
| OrganizationLogins | String | True |
Organizations.Login |
Filters results to include only members from the specified organizations, identified by their login names. |
| TwoFactorMethodSecurity | String | True |
Filters results to include only users who have this type of two-factor authentication enabled. Excludes users with accounts only on GitHub Enterprise Server instances. The allowed values are SECURE, INSECURE, DISABLED. |
Lists all users who are members of a specified GitHub Enterprise account.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM [EnterpriseMembers]
SELECT * FROM [EnterpriseMembers] WHERE [EnterpriseSlug] = 'Val1'
SELECT * FROM [EnterpriseMembers] WHERE [Role] = 'MEMBER'
SELECT * FROM [EnterpriseMembers] WHERE [OrganizationLogins] = 'Val1'
SELECT * FROM [EnterpriseMembers] WHERE [Deployment] = 'CLOUD'
SELECT * FROM [EnterpriseMembers] WHERE [TwoFactorMethodSecurity] = 'SECURE'
The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions that are built with the following columns:
SELECT * FROM [EnterpriseMembers] ORDER BY [Login]
SELECT * FROM [EnterpriseMembers] ORDER BY [CreatedAt]
The Sync App uses client-side processing when ordering by any other columns. This impacts performance.
You can specify the following columns to delete a record:
DELETE FROM [EnterpriseMembers] WHERE ([Id] = 'U_kgDOCRzGkQ') AND ([EnterpriseId] = 'E_kgDOAAO82g')
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique identifier (node ID) assigned to the user. | |
| DatabaseId | Int | True |
The primary key identifier for the user in the database, used for internal reference. | |
| Login | String | True |
The unique username of the user, used for login and profile identification. | |
| Name | String | True |
The publicly visible name of the user as displayed on their GitHub profile. | |
| String | True |
The publicly visible email address associated with the user’s GitHub profile. | ||
| TwitterUsername | String | True |
The Twitter handle listed on the user’s GitHub profile, if provided. | |
| Pronouns | String | True |
The pronouns specified by the user on their GitHub profile (for example, they/them, she/her, he/him). | |
| Bio | String | True |
The user’s public profile bio, describing their professional background or interests. | |
| BioHTML | String | True |
The HTML-formatted version of the user’s bio for display purposes. | |
| Company | String | True |
The publicly visible company or organization affiliation listed on the user’s profile. | |
| CompanyHTML | String | True |
The HTML-formatted version of the user’s company information for display purposes. | |
| Location | String | True |
The geographic location specified by the user on their public profile. | |
| AnyPinnableItems | Bool | True |
Indicates whether the user has any content, such as repositories or gists, that can be pinned to their profile. Can be filtered by content type. | |
| PinnedItemsRemaining | Int | True |
The number of additional items the user can pin to their profile. | |
| ItemShowcaseHasPinnedItems | Bool | True |
Indicates whether the user has pinned any repositories or gists to their profile. | |
| IsEmployee | Bool | True |
Indicates whether the user is a GitHub employee. | |
| IsHireable | Bool | True |
Indicates whether the user has marked themselves as available for hire on GitHub. | |
| IsBountyHunter | Bool | True |
Indicates whether the user participates in the GitHub Security Bug Bounty program. | |
| IsCampusExpert | Bool | True |
Indicates whether the user is a member of the GitHub Campus Experts program. | |
| IsFollowingViewer | Bool | True |
Indicates whether the user is following the current viewer of their profile. This is the inverse of ViewerIsFollowing. | |
| IsSiteAdmin | Bool | True |
Indicates whether the user is a GitHub site administrator with elevated permissions. | |
| IsDeveloperProgramMember | Bool | True |
Indicates whether the user is a member of the GitHub Developer Program. | |
| IsGitHubStar | Bool | True |
Indicates whether the user is a recognized member of the GitHub Stars program. | |
| IsSponsoringViewer | Bool | True |
Indicates whether the user or organization is financially sponsoring the current viewer. | |
| IsViewer | Bool | True |
Indicates whether the user is the currently logged-in viewer of the profile. | |
| ViewerCanFollow | Bool | True |
Indicates whether the current viewer has the ability to follow this user. | |
| ViewerCanSponsor | Bool | True |
Indicates whether the current viewer can sponsor this user or organization through GitHub Sponsors. | |
| ViewerIsFollowing | Bool | True |
Indicates whether the current viewer is following this user. | |
| ViewerIsSponsoring | Bool | True |
Indicates whether the current viewer is sponsoring this user or organization through GitHub Sponsors. | |
| ViewerCanCreateProjects | Bool | True |
Indicates whether the current viewer can create new projects for this user or organization. | |
| ViewerCanChangePinnedItems | Bool | True |
Indicates whether the current viewer has permission to pin repositories and gists to the user's profile. | |
| StatusId | String | True |
The unique identifier (ID) of the emoji representing the user’s status. | |
| StatusEmoji | String | True |
An emoji that visually summarizes the user’s current status. | |
| StatusMessage | String | True |
A brief, user-defined message that describes what the user is currently doing or their availability. | |
| StatusIndicatesLimitedAvailability | Bool | True |
Indicates whether the user’s status suggests limited availability on GitHub. | |
| StatusEmojiHTML | String | True |
The HTML representation of the status emoji for display purposes. | |
| StatusCreatedAt | Datetime | True |
The date and time when the user’s status was created, in ISO 8601 format. | |
| StatusExpiresAt | Datetime | True |
The expiration date and time for the user’s status. After this time, the status is no longer be visible. | |
| StatusUpdatedAt | Datetime | True |
The date and time when the user’s status was last updated, in ISO 8601 format. | |
| StatusOrganizationId | String | True |
The unique identifier (node ID) of the organization associated with the user’s status. | |
| StatusOrganizationLogin | String | True |
The login name of the organization associated with the user’s status. | |
| InteractionAbilityLimit | String | True |
Specifies the current interaction limit applied to this user’s account or content (for example, collaborators only). | |
| InteractionAbilityOrigin | String | True |
The source or reason for the currently active interaction limit (for example, account settings or an admin action). | |
| InteractionAbilityExpiresAt | Datetime | True |
The date and time when the currently active interaction limit expires, if applicable. | |
| HasSponsorsListing | Bool | True |
Indicates whether this user or organization has an active GitHub Sponsors listing. | |
| MonthlyEstimatedSponsorsIncomeInCents | Int | True |
The estimated monthly income from GitHub Sponsors for this user or organization, in cents (USD). | |
| EstimatedNextSponsorsPayoutInCents | Int | True |
The estimated amount of the next payout from GitHub Sponsors for this user or organization, in cents (USD). | |
| SponsorsListingId | String | True |
The unique identifier (node ID) of the GitHub Sponsors listing for this user or organization. | |
| SponsorsListingName | String | True |
The full display name of the GitHub Sponsors listing for this user or organization. | |
| TotalSponsorshipAmountAsSponsorInCents | Int | True |
The total amount (in cents, USD) that this entity has spent on GitHub to sponsor others. Only visible to the user or managers of the organization. | |
| ResourcePath | String | True |
The relative HTTP path to this user’s profile on GitHub. | |
| ProjectsResourcePath | String | True |
The relative HTTP path to the list of projects associated with this user. | |
| Url | String | True |
The absolute HTTP URL for this user’s GitHub profile. | |
| ProjectsUrl | String | True |
The absolute HTTP URL to the list of projects associated with this user. | |
| WebsiteUrl | String | True |
A URL pointing to the user’s public website or blog, as listed on their profile. | |
| AvatarUrl | String | True |
The URL pointing to the user’s public avatar image. Optionally accepts a 'size' argument to specify the dimensions of the square image in pixels. | |
| CopilotEndpointsApi | String | True |
The API endpoint used to interact with GitHub Copilot services. | |
| CopilotEndpointsOriginTracker | String | True |
The endpoint used by GitHub Copilot for tracking the origin of requests. | |
| CopilotEndpointsProxy | String | True |
The proxy endpoint used for routing GitHub Copilot requests. | |
| CopilotEndpointsTelemetry | String | True |
The telemetry endpoint used for collecting data related to GitHub Copilot activities and usage. | |
| CreatedAt | Datetime | True |
The date and time when the user or object was created, in ISO 8601 format. | |
| UpdatedAt | Datetime | True |
The date and time when the user or object was last updated, in ISO 8601 format. | |
| RepositoryCount | Int | True |
The total number of repositories owned by the user within the enterprise. | |
| FollowerCount | Int | True |
The total number of users following this user within the enterprise. | |
| EnterpriseId [KEY] | String | True |
Enterprises.Id |
The unique node ID of the enterprise associated with the user. |
| EnterpriseSlug | String | True |
Enterprises.Slug |
A URL-friendly identifier (slug) for the enterprise, used in APIs and URLs. |
| Role | String | True |
The specific role assigned to the user within the enterprise (for example, admin, member, or other enterprise-specific roles). The allowed values are MEMBER, OWNER, UNAFFILIATED. | |
| OrganizationLogins | String | True |
Organizations.Login |
Filters results to include only users who belong to the specified organizations, identified by their login names. |
| Deployment | String | True |
Filters results to include only users associated with the specified GitHub Enterprise deployment. The allowed values are CLOUD, SERVER. | |
| TwoFactorMethodSecurity | String | True |
Filters results to include only users who have enabled this type of two-factor authentication. Excludes users limited to accounts on GitHub Enterprise Server instances. The allowed values are SECURE, INSECURE, DISABLED. |
Tracks invitations sent to unaffiliated users to join a GitHub Enterprise account, aiding recruitment efforts.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following column and operators:
For example, the following queries are processed server-side:
SELECT * FROM [EnterpriseUnaffiliatedMemberInvitations]
SELECT * FROM [EnterpriseUnaffiliatedMemberInvitations] WHERE [EnterpriseSlug] = 'Val1'
The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions that are built with the following column: CreatedAt
SELECT * FROM [EnterpriseUnaffiliatedMemberInvitations] ORDER BY [CreatedAt]
The Sync App uses client-side processing when ordering by any other columns. This impacts performance.
You can use the following columns to create (insert) a new record:
INSERT INTO [EnterpriseUnaffiliatedMemberInvitations] ([EnterpriseId], [Email], [InviteeLogin]) VALUES ('E_kgDOAAO82g', '[email protected]', 'test')
You can specify the following column to delete a record: Id
DELETE FROM [EnterpriseUnaffiliatedMemberInvitations] WHERE [Id] = 'Test'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique node ID representing the invitation object. | |
| EnterpriseId | String | True |
Enterprises.Id |
The unique node ID of the enterprise associated with the invitation. |
| EnterpriseSlug | String | True |
Enterprises.Slug |
The URL-friendly identifier (slug) used to reference the enterprise in APIs and URLs. |
| String | True |
The email address of the person invited to join the enterprise. | ||
| InviteeId | String | True |
The unique node ID of the user who was invited to the enterprise. Null if the invitee is not a registered GitHub user. | |
| InviteeLogin | String | True |
The login (username) of the user who was invited to the enterprise. Null if the invitee is not a registered GitHub user. | |
| InviterId | String | True |
The unique node ID of the user who created and sent the invitation. | |
| InviterLogin | String | True |
The login (username) of the user who created and sent the invitation. | |
| CreatedAt | Datetime | True |
The date and time when the invitation object was created, in ISO 8601 format. |
Contains comprehensive information about organizations linked either to the authenticated user or to a specified organization.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM [Organizations]
SELECT * FROM [Organizations] WHERE [Login] = 'Val1'
SELECT * FROM [Organizations] WHERE [MemberLogin] = 'Val1'
The Sync App processes other filters client-side within the Sync App.
You can use the following columns to update a record:
UPDATE [Organizations] SET [Name] = 'test', [WebCommitSignoffRequired] = false WHERE [Login] = 'test'
You can specify the following column to delete a record: Login
DELETE FROM [Organizations] WHERE [Login] = 'test'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique identifier (node ID) of the organization. | |
| DatabaseId | Int | True |
The primary key identifier for the organization in the database, used for internal reference. | |
| Login | String | True |
The login (username) of the organization, used for identification and API references. | |
| Name | String | True |
The publicly displayed name of the organization. | |
| TwitterUsername | String | True |
The Twitter username associated with the organization, if provided. | |
| Description | String | True |
A brief description of the organization’s public profile, summarizing its purpose or mission. | |
| DescriptionHTML | String | True |
The HTML-rendered version of the organization’s public profile description for display purposes. | |
| String | True |
The publicly visible email address associated with the organization. | ||
| OrganizationBillingEmail | String | True |
The email address used for billing purposes within the organization. | |
| Location | String | True |
The geographic location specified in the organization’s public profile. | |
| AnyPinnableItems | Bool | True |
Indicates whether the organization has items, such as repositories or gists, that can be pinned to its profile. Can filter by item type. | |
| PinnedItemsRemaining | Int | True |
The number of additional items the organization can pin to its profile. | |
| WebCommitSignoffRequired | Bool | True |
Indicates whether contributors are required to sign off on web-based commits for repositories within the organization. | |
| MembersCanForkPrivateRepositories | Bool | True |
Indicates whether organization members are allowed to fork private repositories. | |
| IpAllowListEnabledSetting | String | True |
Specifies whether the organization has enabled an IP allow list for controlling access. | |
| NotificationDeliveryRestrictionEnabledSetting | String | True |
Indicates whether email notifications for the organization are restricted to verified or approved domains. | |
| IpAllowListForInstalledAppsEnabledSetting | String | True |
Specifies whether the organization has enabled IP allow list configuration for installed GitHub Apps. | |
| Announcement | String | True |
The text of the current announcement made by the organization. | |
| AnnouncementUserDismissible | Bool | True |
Indicates whether the announcement can be dismissed by users. | |
| AnnouncementCreatedAt | Datetime | True |
The date and time when the announcement was created, in ISO 8601 format. | |
| AnnouncementExpiresAt | Datetime | True |
The expiration date and time of the announcement, if set. | |
| CreatedAt | Datetime | True |
The date and time when the organization object was created, in ISO 8601 format. | |
| UpdatedAt | Datetime | True |
The date and time when the organization object was last updated, in ISO 8601 format. | |
| ArchivedAt | Datetime | True |
The date and time when the organization object was archived, if applicable. | |
| ResourcePath | String | True |
The relative HTTP path to the organization’s profile on GitHub. | |
| ProjectsResourcePath | String | True |
The relative HTTP path to the list of the organization’s projects. | |
| TeamsResourcePath | String | True |
The relative HTTP path to the list of the organization’s teams. | |
| NewTeamResourcePath | String | True |
The relative HTTP path for creating a new team within the organization. | |
| Url | String | True |
The absolute HTTP URL to the organization’s profile on GitHub. | |
| AvatarUrl | String | True |
A URL pointing to the organization’s public avatar image. Accepts an optional 'size' argument to specify the dimensions of the square image in pixels. | |
| ProjectsUrl | String | True |
The HTTP URL listing the organization’s projects on GitHub. | |
| WebsiteUrl | String | True |
The public URL of the organization’s website, as specified in its profile. | |
| TeamsUrl | String | True |
The HTTP URL listing the organization’s teams on GitHub. | |
| NewTeamUrl | String | True |
The HTTP URL for creating a new team within the organization. | |
| IsVerified | Bool | True |
Indicates whether the organization has verified its profile email and website. | |
| IsSponsoringViewer | Bool | True |
Indicates whether the organization is sponsoring the current viewer through GitHub Sponsors. | |
| ViewerCanAdminister | Bool | True |
Indicates whether the current viewer has administrative permissions for the organization. | |
| ViewerCanSponsor | Bool | True |
Indicates whether the current viewer is able to sponsor the organization through GitHub Sponsors. | |
| ViewerIsFollowing | Bool | True |
Indicates whether the current viewer is following the organization. | |
| ViewerIsSponsoring | Bool | True |
Indicates whether the current viewer is sponsoring the organization through GitHub Sponsors. | |
| ViewerCanCreateProjects | Bool | True |
Indicates whether the current viewer can create new projects within the organization. | |
| ViewerCanCreateRepositories | Bool | True |
Indicates whether the current viewer can create repositories within the organization. | |
| ViewerCanCreateTeams | Bool | True |
Indicates whether the current viewer can create teams within the organization. | |
| ViewerIsAMember | Bool | True |
Indicates whether the current viewer is an active member of the organization. | |
| ViewerCanChangePinnedItems | Bool | True |
Indicates whether the current viewer can pin repositories and gists to the organization’s profile. | |
| InteractionAbilityLimit | String | True |
Specifies the current interaction restriction applied to the organization (for example, collaborators only). | |
| InteractionAbilityOrigin | String | True |
The source or reason for the currently active interaction restriction (for example, account settings or admin action). | |
| InteractionAbilityExpiresAt | Datetime | True |
The date and time when the currently active interaction restriction expires, if applicable. | |
| ItemShowcaseHasPinnedItems | Bool | True |
Indicates whether the organization has pinned any repositories or gists to its profile. | |
| RequiresTwoFactorAuthentication | Bool | True |
Indicates whether the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication. | |
| SamlIdentityProviderId | String | True |
The unique identifier (node ID) for the SAML Identity Provider associated with the organization. | |
| SamlIdentityProviderIssuer | String | True |
The Issuer Entity ID for the SAML Identity Provider, used to identify the issuer of SAML assertions. | |
| SamlIdentityProviderDigestMethod | String | True |
The digest algorithm used to sign SAML requests for the Identity Provider. | |
| SamlIdentityProviderIdpCertificate | String | True |
The x509 certificate used by the Identity Provider to sign SAML assertions and responses. | |
| SamlIdentityProviderSignatureMethod | String | True |
The signature algorithm used to sign SAML requests for the Identity Provider. | |
| SamlIdentityProviderSsoUrl | String | True |
The Single Sign-On (SSO) URL endpoint for the Identity Provider’s SAML SSO. | |
| HasSponsorsListing | Bool | True |
Indicates whether the organization has an active GitHub Sponsors listing. | |
| SponsorsListingId | String | True |
The unique identifier (node ID) for the organization’s GitHub Sponsors listing. | |
| SponsorsListingName | String | True |
The full name of the organization’s GitHub Sponsors listing. | |
| EstimatedNextSponsorsPayoutInCents | Int | True |
The estimated amount of the next payout from GitHub Sponsors for this organization, in cents (USD). | |
| MonthlyEstimatedSponsorsIncomeInCents | Int | True |
The estimated monthly income from GitHub Sponsors for this organization, in cents (USD). | |
| MemberLogin | String | True |
Filters the list of organizations to include only those that have a specific member, identified by the user's login (username). |
Maintains a list of all teams within the user's organizations, supporting team management and collaboration.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM [OrganizationTeams]
SELECT * FROM [OrganizationTeams] WHERE [OrganizationLogin] = 'Val1'
SELECT * FROM [OrganizationTeams] WHERE [Privacy] = 'SECRET'
SELECT * FROM [OrganizationTeams] WHERE [Slug] = 'Val1'
SELECT * FROM [OrganizationTeams] WHERE [NotificationSetting] = 'NOTIFICATIONS_ENABLED'
SELECT * FROM [OrganizationTeams] WHERE [LdapMapped] = true
SELECT * FROM [OrganizationTeams] WHERE [Role] = 'ADMIN'
SELECT * FROM [OrganizationTeams] WHERE [RootTeamsOnly] = true
SELECT * FROM [OrganizationTeams] WHERE [UserLogins] = 'Val1'
The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions that are built with the following column:
SELECT * FROM [OrganizationTeams] ORDER BY [Name] ASC
The Sync App uses client-side processing when ordering by any other columns. This impacts performance.
You can use the following columns to create (insert) a new record:
You can use the following pseudo-column to create a new record: RepositoryNamesWithOwner
INSERT INTO [OrganizationTeams] ([Name], [Description], [Privacy], [NotificationSetting], [OrganizationLogin], [UserLogins], [RepositoryNamesWithOwner]) VALUES ('TestTeam', 'A test team.', 'SECRET', 'NOTIFICATIONS_ENABLED', 'myorg', 'User1,User2', 'myorg/test2,myorg/test')
You can use the following columns to update a record:
UPDATE [OrganizationTeams] SET [Name] = '123456', [Description] = 'newDescription', [Privacy] = 'VISIBLE', [NotificationSetting] = 'NOTIFICATIONS_DISABLED' WHERE [OrganizationLogin] = 'myorg' AND [Slug] = 'team'
You can specify either of the following sets of WHERE conditions to delete a record:
DELETE FROM [OrganizationTeams] WHERE ([OrganizationLogin] = 'myorg') AND ([Slug] = 'team')
DELETE FROM [OrganizationTeams] WHERE ([OrganizationDatabaseId] = '178278991') AND ([DatabaseId] = '11017906')
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique identifier (node ID) of the team. | |
| DatabaseId | Int | True |
The primary key identifier for the team in the database, used for internal reference. | |
| OrganizationId | String | True |
The unique identifier (node ID) of the organization associated with the team. | |
| OrganizationDatabaseId | Int | True |
Organizations.DatabaseId |
The primary key identifier for the organization in the database, used for internal reference. |
| OrganizationLogin | String | True |
Organizations.Login |
The login (username) of the organization associated with the team. |
| ParentTeamId | String | True |
The unique identifier (node ID) of the parent team, if this team is part of a parent-child team hierarchy. | |
| ParentTeamDatabaseId | Int | True |
The primary key identifier for the parent team in the database, used for internal reference. | |
| ParentTeamName | String | True |
The name of the parent team, if applicable. | |
| Name | String | True |
The name of the team, as displayed within the organization. | |
| Description | String | True |
A brief description of the team, summarizing its purpose or activities. | |
| Privacy | String | True |
The privacy level of the team, which can be 'secret' or 'closed'. The allowed values are SECRET, VISIBLE. | |
| Slug | String | True |
The URL-friendly identifier (slug) corresponding to the team. | |
| Url | String | True |
The absolute HTTP URL to access the team on GitHub. | |
| AvatarUrl | String | True |
A URL pointing to the team’s avatar image, if available. | |
| CombinedSlug | String | True |
The combined slug of the organization and team (for example, 'org-name/team-name'). | |
| DiscussionsUrl | String | True |
The absolute HTTP URL to access the team's discussions on GitHub. | |
| MembersUrl | String | True |
The absolute HTTP URL to view the team’s members on GitHub. | |
| NotificationSetting | String | True |
The current notification setting for the team (for example, 'all', 'mentions'). The allowed values are NOTIFICATIONS_ENABLED, NOTIFICATIONS_DISABLED. | |
| RepositoriesUrl | String | True |
The absolute HTTP URL to view the repositories associated with the team. | |
| ResourcePath | String | True |
The relative HTTP path to access the team on GitHub. | |
| TeamsUrl | String | True |
The absolute HTTP URL to view the sub-teams under this team, if any. | |
| ViewerSubscription | String | True |
Indicates whether the viewer is 'watching', 'not watching', or 'ignoring' the team’s updates. | |
| DiscussionsResourcePath | String | True |
The relative HTTP path to the team's discussions on GitHub. | |
| EditTeamUrl | String | True |
The absolute HTTP URL to access the editing page for this team. | |
| MembersResourcePath | String | True |
The relative HTTP path to the team’s members on GitHub. | |
| NewTeamUrl | String | True |
The absolute HTTP URL to create a new team within the organization. | |
| RepositoriesResourcePath | String | True |
The relative HTTP path to the team’s associated repositories. | |
| TeamsResourcePath | String | True |
The relative HTTP path to the sub-teams under this team, if any. | |
| ViewerCanAdminister | Bool | True |
Indicates whether the current viewer has administrative permissions for this team. | |
| ViewerCanSubscribe | Bool | True |
Indicates whether the viewer can change their subscription status for the team. | |
| EditTeamResourcePath | String | True |
The relative HTTP path to the page for editing this team on GitHub. | |
| NewTeamResourcePath | String | True |
The relative HTTP path to the page for creating a new team within the organization. | |
| CreatedAt | Datetime | True |
The date and time when the team object was created, in ISO 8601 format. | |
| UpdatedAt | Datetime | True |
The date and time when the team object was last updated, in ISO 8601 format. | |
| ReviewRequestDelegationAlgorithm | String | True |
Specifies the algorithm used for assigning code reviews to team members (for example, round-robin). | |
| ReviewRequestDelegationEnabled | Bool | True |
Indicates whether automatic review assignment is enabled for this team. | |
| ReviewRequestDelegationMemberCount | Int | True |
The number of team members required to be assigned for review requests when delegation is enabled. | |
| ReviewRequestDelegationNotifyTeam | Bool | True |
Indicates whether the entire team should be notified when review requests are assigned via delegation. | |
| LdapMapped | Bool | True |
Indicates whether the team is mapped to an LDAP Group (Enterprise feature only). | |
| Role | String | True |
Filters teams based on whether the viewer is an 'admin' or a 'member' of the team, if applicable. The allowed values are ADMIN, MEMBER. | |
| RootTeamsOnly | Bool | True |
Restricts results to only root-level teams if set to true, excluding sub-teams. | |
| UserLogins | String | True |
OrganizationMembers.Login |
A comma-separated list of user logins to filter by when querying team data or assigning users as team maintainers during team creation. |
Pseudo-columns are fields that can only be used in the types of statements under which they are explicitly listed. They are not standard columns but instead provide additional functionality for specific operations.
| Name | Type | Description |
| RepositoryNamesWithOwner | String |
A comma-separated list of fully qualified repository names (for example, 'organization-name/repository-name') to add the team to. |
Records project status updates, including any changes to goals or scope.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM [ProjectStatusUpdates]
SELECT * FROM [ProjectStatusUpdates] WHERE [OwnerLogin] = 'Val1'
SELECT * FROM [ProjectStatusUpdates] WHERE [ProjectNumber] = 123
The Sync App processes other filters client-side within the Sync App.
You can use the following columns to create (insert) a new record:
INSERT INTO [ProjectStatusUpdates] ([ProjectId], [Body]) VALUES ('PVT_kwHOBTvkJ84Ad8nn', 'Test')
You can use the following columns to update a record:
UPDATE [ProjectStatusUpdates] SET [Body] = 'Test' WHERE [Id] = 'PVTSU_lAHOBTvkJ84Ad8nnzgABIoI'
You can specify the following column to delete a record: Id
DELETE FROM [ProjectStatusUpdates] WHERE [Id] = 'PVTSU_lAHOBTvkJ84Ad8nnzgABIoI'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique node ID of the ProjectV2StatusUpdate object. | |
| OwnerLogin | String | True |
The login (username) of the owner of the project, which could be a user or organization. | |
| ProjectId | String | True |
Projects.Id |
The unique node ID of the associated Project object. |
| ProjectNumber | Int | True |
Projects.Number |
The unique number assigned to the project within its scope (for example, repository, organization). |
| FullDatabaseId | Long | True |
The primary key identifier for the status update in the database, represented as a BigInt. | |
| Body | String | False |
The main text content of the status update, describing progress or updates. | |
| BodyHTML | String | True |
The HTML-rendered version of the status update body for display purposes. | |
| CreatedAt | Datetime | True |
The date and time when the status update object was created, in ISO 8601 format. | |
| StartDate | Date | False |
The start date associated with the status update, typically indicating when progress began. | |
| Status | String | False |
The current status of the update (for example, 'in progress', 'completed', 'on hold'). | |
| TargetDate | Date | False |
The target date by which the goals of the status update are expected to be achieved. | |
| UpdatedAt | Datetime | True |
The date and time when the status update object was last updated, in ISO 8601 format. |
Provides comprehensive details about user-owned or managed repositories, including configuration and metadata.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM [Repositories]
SELECT * FROM [Repositories] WHERE [Name] = 'Val1'
SELECT * FROM [Repositories] WHERE [OwnerLogin] = 'Val1'
SELECT * FROM [Repositories] WHERE [ForkCount] = 123
SELECT * FROM [Repositories] WHERE [StargazerCount] = 123
SELECT * FROM [Repositories] WHERE [TopicCount] = 123
SELECT * FROM [Repositories] WHERE [IsArchived] = true
SELECT * FROM [Repositories] WHERE [IsFork] = true
SELECT * FROM [Repositories] WHERE [IsMirror] = true
SELECT * FROM [Repositories] WHERE [IsPrivate] = true
SELECT * FROM [Repositories] WHERE [LicenseKey] = 'Val1'
SELECT * FROM [Repositories] WHERE [LanguageName] = 'Val1'
SELECT * FROM [Repositories] WHERE [PushedAt] = '2023-01-01 11:10:00'
SELECT * FROM [Repositories] WHERE [CreatedAt] = '2023-01-01 11:10:00'
The Sync App processes other filters client-side within the Sync App.
You can use the following columns to create (insert) a new record:
You can use the following pseudo-column to create a new record: TeamId
INSERT INTO [Repositories] ([Name], [OwnerId], [Visibility], [HasWikiEnabled]) VALUES ('APIRepo', 'MDQ6VXNlcjg3ODExMTEx', 'PRIVATE', true)
INSERT INTO [Repositories] ([Name], [OwnerId], [Visibility], [HomepageUrl], [TeamId]) VALUES ('OrgRepo', 'O_kgDOCfyf0Q', 'PRIVATE', 'www.test.com', 'T_kwDOCfyf0c4AmRiX')
You can use the following columns to update a record:
You can use the following column to archive a record: IsArchived
You can use the following column to unarchive a record: IsArchived
UPDATE [Repositories] SET [Name] = 'NewRepoNameTest', [Description] = 'Test description.', [HasProjectsEnabled] = true WHERE [Id] = 'R_kgDOML7svg'
UPDATE [Repositories] SET [IsArchived] = false WHERE [Id] = 'R_kgDOML7svg'
UPDATE [Repositories] SET [IsArchived] = true WHERE [Id] = 'R_kgDOML7svg'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique identifier (node ID) of the repository. | |
| DatabaseId | Int | True |
The primary key identifier for the repository in the database, used for internal reference. | |
| Name | String | False |
The name of the repository, as set by its owner. | |
| NameWithOwner | String | True |
The repository's name, prefixed with the owner's username or organization (for example, 'owner/repository-name'). | |
| OwnerId | String | True |
The unique identifier (node ID) of the owner of the repository, which could be a user or organization. | |
| OwnerLogin | String | True |
The login (username) of the repository's owner, which could be a user or organization. | |
| Visibility | String | True |
The visibility level of the repository ('public', 'private', or 'internal'). | |
| DiskUsage | Int | True |
The amount of disk space (in kilobytes) occupied by the repository. | |
| ForkCount | Int | True |
The total number of forks created from this repository across the network. | |
| StargazerCount | Int | True |
The total number of users who have starred this repository. | |
| WatcherCount | Int | True |
The total number of users watching this repository for updates. | |
| TopicCount | Int | True |
The number of topics assigned to the repository to improve discoverability. | |
| TempCloneToken | String | True |
A temporary authentication token for cloning the repository. | |
| WebCommitSignoffRequired | Bool | True |
Indicates whether contributors must sign off on web-based commits to this repository. | |
| UsesCustomOpenGraphImage | Bool | True |
Indicates whether the repository uses a custom image for Open Graph instead of the owner's avatar. | |
| Description | String | False |
A brief text description of the repository, as provided by the owner. | |
| DescriptionHTML | String | True |
The HTML-rendered version of the repository's description for display purposes. | |
| ShortDescriptionHTML | String | True |
A simplified version of the repository's description, rendered in HTML without links. | |
| ResourcePath | String | True |
The relative HTTP path to access the repository on GitHub. | |
| ProjectsResourcePath | String | True |
The relative HTTP path listing the projects associated with this repository. | |
| Url | String | True |
The absolute HTTP URL to the repository's main page on GitHub. | |
| HomepageUrl | String | False |
The URL of the repository's homepage, if specified. | |
| MirrorUrl | String | True |
The URL of the repository's original mirror, if applicable. | |
| ProjectsUrl | String | True |
The absolute HTTP URL listing the projects associated with this repository. | |
| SecurityPolicyUrl | String | True |
The URL pointing to the repository's security policy, if available. | |
| SSHUrl | String | True |
The SSH URL used for cloning the repository. | |
| OpenGraphImageUrl | String | True |
The image used to represent this repository in Open Graph metadata. | |
| MergeCommitTitle | String | True |
Specifies how the default commit title is generated when merging a pull request (for example, 'pull request title'). | |
| MergeCommitMessage | String | True |
Specifies how the default commit message is generated when merging a pull request (for example, 'pull request description'). | |
| SquashMergeCommitTitle | String | True |
Specifies how the default commit title is generated when squash-merging a pull request (for example, 'pull request title'). | |
| SquashMergeCommitMessage | String | True |
Specifies how the default commit message is generated when squash-merging a pull request (for example, 'pull request description'). | |
| DeleteBranchOnMerge | Bool | True |
Indicates whether branches are automatically deleted after being merged in this repository. | |
| HasDiscussionsEnabled | Bool | False |
Indicates whether the Discussions feature is enabled for this repository. | |
| HasIssuesEnabled | Bool | False |
Indicates whether the Issues feature is enabled for this repository. | |
| HasProjectsEnabled | Bool | False |
Indicates whether the Projects feature is enabled for this repository. | |
| HasWikiEnabled | Bool | False |
Indicates whether the Wiki feature is enabled for this repository. | |
| HasVulnerabilityAlertsEnabled | Bool | True |
Indicates whether vulnerability alerts are enabled for this repository. | |
| HasSponsorshipsEnabled | Bool | False |
Indicates whether the repository displays a Sponsor button for financial contributions. | |
| IsInOrganization | Bool | True |
Indicates whether the repository is owned by an organization or is a private fork of an organization repository. | |
| IsBlankIssuesEnabled | Bool | True |
Indicates whether blank issue creation is allowed for this repository. | |
| IsSecurityPolicyEnabled | Bool | True |
Indicates whether the repository has a security policy in place. | |
| IsUserConfigurationRepository | Bool | True |
Indicates whether the repository is a user configuration repository. | |
| IsArchived | Bool | True |
Indicates whether the repository is archived and unmaintained. | |
| IsDisabled | Bool | True |
Indicates whether the repository is disabled. | |
| IsEmpty | Bool | True |
Indicates whether the repository is empty. | |
| IsFork | Bool | True |
Indicates whether the repository is a fork of another repository. | |
| IsLocked | Bool | True |
Indicates whether the repository has been locked. | |
| IsMirror | Bool | True |
Indicates whether the repository is a mirror of another repository. | |
| IsPrivate | Bool | True |
Indicates whether the repository is private and not publicly accessible. | |
| IsTemplate | Bool | False |
Indicates whether the repository is a template that can be used to generate new repositories. | |
| LockReason | String | True |
Specifies the reason why the repository has been locked, if applicable. The allowed values are BILLING, MIGRATING, MOVING, RENAME. | |
| TemplateRepositoryId | String | True |
The unique identifier (node ID) of the template repository from which this repository was generated, if any. | |
| ParentId | String | True |
The unique identifier (node ID) of the parent repository, if this repository is a fork. | |
| ForkingAllowed | Bool | True |
Indicates whether forking is allowed for this repository. | |
| AutoMergeAllowed | Bool | True |
Indicates whether Auto-merge can be enabled on pull requests for this repository. | |
| SquashMergeAllowed | Bool | True |
Indicates whether squash-merging is enabled for pull requests in this repository. | |
| RebaseMergeAllowed | Bool | True |
Indicates whether rebase-merging is enabled for pull requests in this repository. | |
| MergeCommitAllowed | Bool | True |
Indicates whether pull requests can be merged with a merge commit in this repository. | |
| AllowUpdateBranch | Bool | True |
Indicates whether pull request head branches that are behind their base branches can always be updated even if not required for merging. | |
| ViewerPermission | String | True |
Specifies the permission level of the viewer on the repository (for example, 'read', 'write', 'admin'). Returns null if authenticated as a GitHub App. The allowed values are ADMIN, MAINTAIN, READ, TRIAGE, WRITE. | |
| ViewerSubscription | String | True |
Indicates whether the viewer is watching, not watching, or ignoring the repository. The allowed values are IGNORED, SUBSCRIBED, UNSUBSCRIBED. | |
| ViewerHasStarred | Bool | True |
Indicates whether the viewing user has starred this repository. | |
| ViewerDefaultCommitEmail | String | True |
The email address used by the viewer for their most recent commit in this repository. | |
| ViewerDefaultMergeMethod | String | True |
The last merge method used by the viewer (for example, 'merge', 'squash', 'rebase') or the repository's default merge method. | |
| ViewerPossibleCommitEmails | String | True |
A list of email addresses available for the viewer to use for committing in this repository. | |
| ViewerCanAdminister | Bool | True |
Indicates whether the viewer has administrative permissions on this repository. | |
| ViewerCanSubscribe | Bool | True |
Indicates whether the viewer can change their subscription status for the repository. | |
| ViewerCanCreateProjects | Bool | True |
Indicates whether the viewer can create new projects associated with this repository. | |
| ViewerCanUpdateTopics | Bool | True |
Indicates whether the viewer can update the topics (tags) of this repository. | |
| CodeOfConductId | String | True |
The unique identifier (node ID) of the Code of Conduct associated with this repository. | |
| CodeOfConductName | String | True |
The formal name of the Code of Conduct applied to this repository. | |
| CodeOfConductBody | String | True |
The full text of the Code of Conduct describing its rules and guidelines. | |
| CodeOfConductKey | String | True |
The unique key identifier for the Code of Conduct. | |
| CodeOfConductUrl | String | True |
The absolute HTTP URL to access the Code of Conduct for this repository. | |
| CodeOfConductResourcePath | String | True |
The relative HTTP path to access the Code of Conduct for this repository. | |
| DefaultBranchRefId | String | True |
The unique identifier (node ID) of the default branch in this repository. | |
| DefaultBranchRefName | String | True |
The name of the default branch in this repository (for example, 'main', 'master'). | |
| InteractionAbilityLimit | String | True |
The current interaction restriction applied to this repository (for example, 'collaborators only'). | |
| InteractionAbilityOrigin | String | True |
The source or reason for the currently active interaction restriction (for example, account settings, admin action). | |
| InteractionAbilityExpiresAt | Datetime | True |
The expiration date and time of the current interaction restriction, if applicable. | |
| LatestReleaseId | String | True |
The unique identifier (node ID) of the latest release in this repository. | |
| LatestReleaseName | String | True |
The title of the latest release in this repository. | |
| LicenseId | String | True |
The unique identifier (node ID) of the license associated with the repository. | |
| LicenseKey | String | True |
Licenses.Key |
The SPDX key of the license associated with the repository (for example, 'mit', 'apache-2.0'). |
| LanguageId | String | True |
The unique identifier (node ID) of the primary programming language used in this repository. | |
| LanguageName | String | True |
The name of the primary programming language used in this repository (for example, 'JavaScript', 'Python'). | |
| LanguageColor | String | True |
The hexadecimal color code associated with the primary programming language used in the repository. | |
| PushedAt | Datetime | True |
The date and time when the repository was last pushed to, in ISO 8601 format. | |
| ArchivedAt | Datetime | True |
The date and time when the repository was archived, in ISO 8601 format. | |
| CreatedAt | Datetime | True |
The date and time when the repository was created, in ISO 8601 format. | |
| UpdatedAt | Datetime | True |
The date and time when the repository was last updated, in ISO 8601 format. | |
| PlanFeaturesCodeOwners | Bool | True |
Indicates whether reviews can be automatically requested and enforced using a CODEOWNERS file. | |
| PlanFeaturesDraftPullRequests | Bool | True |
Indicates whether pull requests can be created as drafts or converted to drafts. | |
| PlanFeaturesMaximumAssignees | Int | True |
The maximum number of users that can be assigned to an issue or pull request in this repository. | |
| PlanFeaturesMaximumManualReviewRequests | Int | True |
The maximum number of manually requested reviews allowed on a pull request in this repository. | |
| PlanFeaturesTeamReviewRequests | Bool | True |
Indicates whether teams can be requested to review pull requests in this repository. |
Pseudo-columns are fields that can only be used in the types of statements under which they are explicitly listed. They are not standard columns but instead provide additional functionality for specific operations.
| Name | Type | Description |
| TeamId | String |
Specifies the team ID to be granted access to the repository when an organization is set as the owner. |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| Enterprises | Stores information about GitHub enterprises associated with the user, including identifiers and descriptive details. |
| LicenseConditions | Lists conditions and obligations imposed by a specific software license applied to a GitHub repository. |
| LicenseLimitations | Details restrictions and limitations imposed by a specific license in the context of a GitHub repository. |
| LicensePermissions | Describes permissions granted by a specific repository license, helping users understand the scope of allowed actions. |
| Licenses | Compiles all supported open-source licenses recognized by GitHub, aiding in license selection and compliance. |
| OrganizationMannequins | Lists mannequin accounts (placeholders) linked to an organization for use in managing legacy contributions. |
| OrganizationMembers | Details all members and collaborators associated with the user's organizations or a specific organization. |
| OrganizationTeamMembers | Tracks team memberships within organizations, detailing roles and associated permissions for each member. |
| OrganizationTeamProjects | Lists projects accessible to specific teams within a GitHub organization, including details on collaboration and access rights. |
| OrganizationTeamRepositories | Tracks repositories that teams in an organization have access to, along with permission levels for each repository. |
| Projects | Holds metadata and organization-related details for GitHub projects, enabling structured project tracking. |
Stores information about GitHub enterprises associated with the user, including identifiers and descriptive details.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM [Enterprises]
SELECT * FROM [Enterprises] WHERE [Slug] = 'Val1'
SELECT * FROM [Enterprises] WHERE [MembershipType] = 'ALL'
SELECT * FROM [Enterprises] WHERE [Login] = 'Val1'
The Sync App processes other filters client-side within the Sync App.
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | The unique identifier (node ID) of the Enterprise object. | ||
| UserId | String | The unique identifier (node ID) of the User associated with the enterprise. | ||
| Location | String | The physical or geographical location of the enterprise, as specified in its profile. | ||
| Name | String | The name of the enterprise, as displayed in its profile. | ||
| DatabaseId | Int | The primary key identifier for the enterprise in the database. | ||
| Announcement | String | The text of the current enterprise-wide announcement. | ||
| AnnouncementCreatedAt | Datetime | The date and time when the announcement was created, in ISO 8601 format. | ||
| AnnouncementExpiresAt | Datetime | The expiration date and time of the announcement, if specified. | ||
| AnnouncementUserDismissible | Bool | Indicates whether users can dismiss the announcement from their view. | ||
| BillingEmail | String | The billing email address associated with the enterprise. | ||
| BillingInfoAllLicensableUsersCount | Int | The total number of licensable users or email addresses within the enterprise. | ||
| BillingInfoAssetPacks | Int | The number of data packs used by all organizations owned by the enterprise. | ||
| BillingInfoBandwidthQuota | Double | The total bandwidth quota (in GB) allocated to all organizations owned by the enterprise. | ||
| BillingInfoBandwidthUsage | Double | The total bandwidth usage (in GB) by all organizations owned by the enterprise. | ||
| BillingInfoBandwidthUsagePercentage | Int | The percentage of the bandwidth quota currently used by the enterprise. | ||
| BillingInfoStorageQuota | Double | The total storage quota (in GB) allocated to all organizations owned by the enterprise. | ||
| BillingInfoStorageUsage | Double | The total storage usage (in GB) by all organizations owned by the enterprise. | ||
| BillingInfoStorageUsagePercentage | Int | The percentage of the storage quota currently used by the enterprise. | ||
| BillingInfoTotalAvailableLicenses | Int | The number of licenses available across all owned organizations, based on unique billable users. | ||
| BillingInfoTotalLicenses | Int | The total number of licenses allocated to the enterprise. | ||
| CreatedAt | Datetime | The date and time when the enterprise object was created, in ISO 8601 format. | ||
| Description | String | A brief text description of the enterprise, provided in its profile. | ||
| DescriptionHTML | String | The HTML-formatted description of the enterprise, suitable for display purposes. | ||
| OwnerInfoOidcProviderId | String | The unique identifier (node ID) of the OIDCProvider object associated with the enterprise. | ||
| OwnerInfoOidcProviderTenantId | String | The unique identifier of the tenant to which the OIDC provider is attached. | ||
| OwnerInfoSamlIdentityProviderId | String | The unique identifier (node ID) of the SAML identity provider object for the enterprise. | ||
| ResourcePath | String | The relative HTTP path to the enterprise’s profile on GitHub. | ||
| Slug | String | The URL-friendly identifier (slug) for the enterprise, used in APIs and URLs. | ||
| Url | String | The absolute HTTP URL for the enterprise’s profile on GitHub. | ||
| ViewerIsAdmin | Bool | Indicates whether the current viewer has administrative privileges for this enterprise. | ||
| WebsiteUrl | String | The URL of the enterprise's official website or homepage. | ||
| Readme | String | The raw, plain-text content of the enterprise's README file, if available. | ||
| ReadmeHTML | String | The content of the enterprise's README file formatted as HTML for display purposes. | ||
| MembershipType | String | Filters enterprises based on the user's membership type (for example, 'owner', 'member').
The allowed values are ALL, ADMIN, BILLING_MANAGER, ORG_MEMBERSHIP. | ||
| Login | String | The login or username associated with the enterprise or user account. |
Lists conditions and obligations imposed by a specific software license applied to a GitHub repository.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following column and operators:
For example, the following queries are processed server-side:
SELECT * FROM [LicenseConditions]
SELECT * FROM [LicenseConditions] WHERE [LicenseKey] = 'Val1'
The Sync App processes other filters client-side within the Sync App.
| Name | Type | References | OrderBySupport | Description |
| Key [KEY] | String | The machine-readable key that uniquely identifies the license condition. | ||
| LicenseKey [KEY] | String |
Licenses.Key | The SPDX (Software Package Data Exchange) ID of the license, typically represented in lowercase, which corresponds to a specific open-source license (for example, 'mit', 'apache-2.0'). | |
| Description | String | A detailed description of the condition associated with the license, explaining its terms or requirements. | ||
| Label | String | A human-readable label or title for the condition, designed to be easily understood by users without technical or legal knowledge. |
Details restrictions and limitations imposed by a specific license in the context of a GitHub repository.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following column and operators:
For example, the following queries are processed server-side:
SELECT * FROM [LicenseLimitations]
SELECT * FROM [LicenseLimitations] WHERE [LicenseKey] = 'Val1'
The Sync App processes other filters client-side within the Sync App.
| Name | Type | References | OrderBySupport | Description |
| Key [KEY] | String | The machine-readable key that uniquely identifies the license limitation. | ||
| LicenseKey [KEY] | String |
Licenses.Key | The SPDX (Software Package Data Exchange) ID of the license, typically represented in lowercase, which corresponds to a specific open-source license (for example, 'mit', 'apache-2.0'). | |
| Description | String | A detailed description of the limitation associated with the license, outlining any restrictions or prohibited uses. | ||
| Label | String | A human-readable label or title for the limitation, designed to be easily understood by users without technical or legal expertise. |
Describes permissions granted by a specific repository license, helping users understand the scope of allowed actions.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following column and operators:
For example, the following queries are processed server-side:
SELECT * FROM [LicensePermissions]
SELECT * FROM [LicensePermissions] WHERE [LicenseKey] = 'Val1'
The Sync App processes other filters client-side within the Sync App.
| Name | Type | References | OrderBySupport | Description |
| Key [KEY] | String | The machine-readable key that uniquely identifies the specific permission granted by the license. | ||
| LicenseKey [KEY] | String |
Licenses.Key | The SPDX (Software Package Data Exchange) ID of the license, typically represented in lowercase, corresponding to a specific open-source license (for example, 'mit', 'apache-2.0'). | |
| Description | String | A detailed description of the permission granted by the license, explaining what actions or rights are explicitly allowed. | ||
| Label | String | A human-readable label or title for the permission, designed to be easily understood by users without technical or legal expertise. |
Compiles all supported open-source licenses recognized by GitHub, aiding in license selection and compliance.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following column and operators:
For example, the following queries are processed server-side:
SELECT * FROM [Licenses]
SELECT * FROM [Licenses] WHERE [Key] = 'Val1'
The Sync App processes other filters client-side within the Sync App.
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | The unique identifier (node ID) of the license. | ||
| Key | String | The lowercase SPDX (Software Package Data Exchange) ID of the license, used as a unique machine-readable identifier (for example, 'mit', 'apache-2.0'). | ||
| SpdxId | String | The short identifier for the license as specified by the SPDX License List (https://spdx.org/licenses). | ||
| Name | String | The full official name of the license, as specified by the SPDX License List. | ||
| Nickname | String | The customary short name or abbreviation for the license, if applicable (for example, 'GPLv3'). | ||
| Body | String | The complete text of the license, specifying all terms and conditions. | ||
| Description | String | A concise, human-readable explanation of the license, summarizing its key aspects. | ||
| Featured | Bool | Indicates whether the license is highlighted or featured in license pickers or recommendations. | ||
| Implementation | String | Guidelines or instructions on how to apply or implement the license in a project. | ||
| Url | String | The URL linking to the license details on https://choosealicense.com. | ||
| PseudoLicense | Bool | Indicates whether the license is a placeholder for pseudo-licenses (for example, 'other', 'no-license'). | ||
| Hidden | Bool | Indicates whether the license should be hidden from license pickers and user-facing lists. |
Lists mannequin accounts (placeholders) linked to an organization for use in managing legacy contributions.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following column and operators:
For example, the following queries are processed server-side:
SELECT * FROM [OrganizationMannequins]
SELECT * FROM [OrganizationMannequins] WHERE [OrganizationLogin] = 'Val1'
The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions that are built with the following columns:
SELECT * FROM [OrganizationMannequins] ORDER BY [Login]
SELECT * FROM [OrganizationMannequins] ORDER BY [CreatedAt]
The Sync App uses client-side processing when ordering by any other columns. This impacts performance.
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | The unique identifier (node ID) of the mannequin. | ||
| DatabaseId | Int | The primary key identifier for the mannequin in the database, used for internal reference. | ||
| OrganizationLogin | String |
Organizations.Login | The login (username) of the organization associated with the mannequin. | |
| Login | String | The username of the mannequin actor on the platform. | ||
| String | The email address associated with the mannequin on the source instance. | |||
| Url | String | The URL linking to the mannequin's resource on GitHub. | ||
| ResourcePath | String | The HTML path to access the mannequin's resource on GitHub. | ||
| CreatedAt | Datetime | The date and time when the mannequin object was created, in ISO 8601 format. | ||
| UpdatedAt | Datetime | The date and time when the mannequin object was last updated, in ISO 8601 format. | ||
| ClaimantId | String | The unique identifier (node ID) of the user or entity claiming the mannequin. | ||
| ClaimantLogin | String | The username (login) of the claimant who is associated with the mannequin. |
Details all members and collaborators associated with the user's organizations or a specific organization.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following column and operators:
For example, the following queries are processed server-side:
SELECT * FROM [OrganizationMembers]
SELECT * FROM [OrganizationMembers] WHERE [OrganizationLogin] = 'Val1'
The Sync App processes other filters client-side within the Sync App.
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | The unique identifier (node ID) of the user within the organization. | ||
| DatabaseId | Int | The primary key identifier for the user in the database, used for internal reference. | ||
| Login | String | The username used by the user to log in and identify their GitHub account. | ||
| Name | String | The publicly visible name of the user as displayed on their GitHub profile. | ||
| String | The email address publicly associated with the user’s profile, if available. | |||
| TwitterUsername | String | The Twitter handle provided by the user on their public profile, if available. | ||
| Pronouns | String | The pronouns specified by the user on their profile (for example, they/them, she/her, he/him). | ||
| Bio | String | The user’s public profile bio, which provides a brief description of their background or interests. | ||
| BioHTML | String | The HTML-formatted version of the user's bio for display purposes. | ||
| Company | String | The organization or company name listed on the user’s public profile. | ||
| CompanyHTML | String | The HTML-formatted version of the user’s company information for display purposes. | ||
| Location | String | The geographic location provided by the user on their public profile. | ||
| AnyPinnableItems | Bool | Indicates whether the user has any items, such as repositories or gists, that can be pinned to their profile. Can be filtered by item type. | ||
| PinnedItemsRemaining | Int | The number of additional items the user can pin to their profile. | ||
| ItemShowcaseHasPinnedItems | Bool | Indicates whether the user has pinned any repositories or gists to their profile. | ||
| IsEmployee | Bool | Indicates whether the user is a GitHub employee. | ||
| IsHireable | Bool | Indicates whether the user has marked themselves as available for hire on GitHub. | ||
| IsBountyHunter | Bool | Indicates whether the user participates in the GitHub Security Bug Bounty program. | ||
| IsCampusExpert | Bool | Indicates whether the user is a member of the GitHub Campus Experts program. | ||
| IsFollowingViewer | Bool | Indicates whether the user is following the current viewer of their profile. This is the inverse of ViewerIsFollowing. | ||
| IsSiteAdmin | Bool | Indicates whether the user is a GitHub site administrator with elevated permissions. | ||
| IsDeveloperProgramMember | Bool | Indicates whether the user is a participant in the GitHub Developer Program. | ||
| IsGitHubStar | Bool | Indicates whether the user is a recognized member of the GitHub Stars program. | ||
| IsSponsoringViewer | Bool | Indicates whether the user or organization is financially sponsoring the current viewer. | ||
| IsViewer | Bool | Indicates whether the user is the currently logged-in viewer of the profile. | ||
| ViewerCanFollow | Bool | Indicates whether the current viewer has the ability to follow this user. | ||
| ViewerCanSponsor | Bool | Indicates whether the current viewer can sponsor this user or organization through GitHub Sponsors. | ||
| ViewerIsFollowing | Bool | Indicates whether the current viewer is following this user. | ||
| ViewerIsSponsoring | Bool | Indicates whether the current viewer is sponsoring this user or organization through GitHub Sponsors. | ||
| ViewerCanCreateProjects | Bool | Indicates whether the current viewer can create new projects for this user or organization. | ||
| ViewerCanChangePinnedItems | Bool | Indicates whether the current viewer has permission to pin repositories and gists to the user's profile. | ||
| StatusId | String | The unique identifier (ID) of the emoji representing the user’s status. | ||
| StatusEmoji | String | An emoji that visually represents the user’s current status. | ||
| StatusMessage | String | A brief, user-defined message describing the user’s current activity or availability. | ||
| StatusIndicatesLimitedAvailability | Bool | Indicates whether the user’s status suggests limited availability on GitHub. | ||
| StatusEmojiHTML | String | The HTML representation of the emoji used for the user’s status. | ||
| StatusCreatedAt | Datetime | The date and time when the user’s status was created, in ISO 8601 format. | ||
| StatusExpiresAt | Datetime | The expiration date and time for the user’s status. After this time, the status is no longer be visible. | ||
| StatusUpdatedAt | Datetime | The date and time when the user’s status was last updated, in ISO 8601 format. | ||
| StatusOrganizationId | String | The unique identifier (node ID) of the organization associated with the user’s status. | ||
| StatusOrganizationLogin | String | The login name of the organization associated with the user’s status. | ||
| InteractionAbilityLimit | String | Specifies the current interaction restriction applied to this user’s account or content (for example, collaborators only). | ||
| InteractionAbilityOrigin | String | The source or reason for the currently active interaction restriction (for example, account settings or an admin action). | ||
| InteractionAbilityExpiresAt | Datetime | The date and time when the currently active interaction restriction expires, if applicable. | ||
| HasSponsorsListing | Bool | Indicates whether this user or organization has an active GitHub Sponsors listing. | ||
| MonthlyEstimatedSponsorsIncomeInCents | Int | The estimated monthly income from GitHub Sponsors for this user or organization, in cents (USD). | ||
| EstimatedNextSponsorsPayoutInCents | Int | The estimated amount of the next payout from GitHub Sponsors for this user or organization, in cents (USD). | ||
| SponsorsListingId | String | The unique identifier (node ID) of the GitHub Sponsors listing for this user or organization. | ||
| SponsorsListingName | String | The full name of the GitHub Sponsors listing for this user or organization. | ||
| TotalSponsorshipAmountAsSponsorInCents | Int | The total amount (in cents, USD) that this user or organization has spent to sponsor others on GitHub. Only visible to the user or managers of the organization. | ||
| ResourcePath | String | The relative HTTP path to this user’s profile on GitHub. | ||
| ProjectsResourcePath | String | The relative HTTP path to the list of projects associated with this user. | ||
| Url | String | The absolute HTTP URL to the user’s profile on GitHub. | ||
| ProjectsUrl | String | The absolute HTTP URL to the list of projects associated with this user. | ||
| WebsiteUrl | String | A URL pointing to the user’s personal website or blog, as listed on their profile. | ||
| AvatarUrl | String | The URL pointing to the user’s public avatar image. Optionally accepts a 'size' argument to specify the dimensions of the square image in pixels. | ||
| CopilotEndpointsApi | String | The API endpoint used to interact with GitHub Copilot services. | ||
| CopilotEndpointsOriginTracker | String | The endpoint used by GitHub Copilot for tracking the origin of requests. | ||
| CopilotEndpointsProxy | String | The proxy endpoint used for routing GitHub Copilot requests. | ||
| CopilotEndpointsTelemetry | String | The telemetry endpoint used for collecting data related to GitHub Copilot activities and usage. | ||
| CreatedAt | Datetime | The date and time when the object or user was created, in ISO 8601 format. | ||
| UpdatedAt | Datetime | The date and time when the object or user was last updated, in ISO 8601 format. | ||
| RepositoryCount | Int | The total number of repositories owned by the user within the organization. | ||
| FollowerCount | Int | The total number of followers the user has on GitHub. | ||
| Role | String | The specific role assigned to the user within the organization (for example, 'member', 'admin'). | ||
| HasTwoFactorEnabled | Bool | Indicates whether the organization member has two-factor authentication enabled. Returns null if the information is not visible to the current viewer. | ||
| OrganizationLogin [KEY] | String |
Organizations.Login | The login (username) of the organization associated with the member. |
Tracks team memberships within organizations, detailing roles and associated permissions for each member.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM [OrganizationTeamMembers]
SELECT * FROM [OrganizationTeamMembers] WHERE [Role] = 'MAINTAINER'
SELECT * FROM [OrganizationTeamMembers] WHERE [OrganizationTeamSlug] = 'Val1'
SELECT * FROM [OrganizationTeamMembers] WHERE [OrganizationLogin] = 'Val1'
SELECT * FROM [OrganizationTeamMembers] WHERE [Membership] = 'IMMEDIATE'
The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions that are built with the following columns:
SELECT * FROM [OrganizationTeamMembers] ORDER BY [Login]
SELECT * FROM [OrganizationTeamMembers] ORDER BY [CreatedAt]
The Sync App uses client-side processing when ordering by any other columns. This impacts performance.
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | The unique identifier (node ID) of the user who is a team member. | ||
| DatabaseId | Int | The primary key identifier for the user in the database, used for internal reference. | ||
| Login | String | The username used by the team member to log in and identify their GitHub account. | ||
| Name | String | The publicly visible name of the team member as displayed on their GitHub profile. | ||
| String | The publicly visible email address of the team member, if available. | |||
| TwitterUsername | String | The Twitter handle provided by the team member on their public profile, if available. | ||
| Pronouns | String | The pronouns specified by the team member on their profile (for example, they/them, she/her, he/him). | ||
| Bio | String | The public profile bio of the team member, providing a brief description of their background or interests. | ||
| BioHTML | String | The HTML-formatted version of the team member's bio for display purposes. | ||
| Company | String | The organization or company name listed on the team member’s public profile. | ||
| CompanyHTML | String | The HTML-formatted version of the team member’s company information for display purposes. | ||
| Location | String | The geographic location specified by the team member on their public profile. | ||
| AnyPinnableItems | Bool | Indicates whether the team member has any items, such as repositories or gists, that can be pinned to their profile. Can filter by item type. | ||
| PinnedItemsRemaining | Int | The number of additional items the team member can pin to their profile. | ||
| ItemShowcaseHasPinnedItems | Bool | Indicates whether the team member has pinned any repositories or gists to their profile. | ||
| IsEmployee | Bool | Indicates whether the team member is a GitHub employee. | ||
| IsHireable | Bool | Indicates whether the team member has marked themselves as available for hire. | ||
| IsBountyHunter | Bool | Indicates whether the team member participates in the GitHub Security Bug Bounty program. | ||
| IsCampusExpert | Bool | Indicates whether the team member is a participant in the GitHub Campus Experts program. | ||
| IsFollowingViewer | Bool | Indicates whether the team member is following the current viewer of their profile. This is the inverse of ViewerIsFollowing. | ||
| IsSiteAdmin | Bool | Indicates whether the team member is a GitHub site administrator with elevated permissions. | ||
| IsDeveloperProgramMember | Bool | Indicates whether the team member is a participant in the GitHub Developer Program. | ||
| IsGitHubStar | Bool | Indicates whether the team member is a recognized member of the GitHub Stars program. | ||
| IsSponsoringViewer | Bool | Indicates whether the team member or their organization is financially sponsoring the current viewer. | ||
| IsViewer | Bool | Indicates whether the team member is the currently logged-in viewer of the profile. | ||
| ViewerCanFollow | Bool | Indicates whether the current viewer has the ability to follow this team member. | ||
| ViewerCanSponsor | Bool | Indicates whether the current viewer can sponsor this team member or their organization through GitHub Sponsors. | ||
| ViewerIsFollowing | Bool | Indicates whether the current viewer is following this team member. | ||
| ViewerIsSponsoring | Bool | Indicates whether the current viewer is sponsoring this team member or their organization through GitHub Sponsors. | ||
| ViewerCanCreateProjects | Bool | Indicates whether the current viewer can create new projects within this user’s or organization’s scope. | ||
| ViewerCanChangePinnedItems | Bool | Indicates whether the current viewer has permission to pin repositories and gists to this user’s profile. | ||
| StatusId | String | The unique identifier (node ID) for the emoji representing the user’s status. | ||
| StatusEmoji | String | An emoji that visually summarizes the user’s current status or activity. | ||
| StatusMessage | String | A brief, user-defined message describing the user’s current activity or availability. | ||
| StatusIndicatesLimitedAvailability | Bool | Indicates whether the user’s status signifies limited availability on GitHub. | ||
| StatusEmojiHTML | String | The HTML representation of the emoji used for the user’s status. | ||
| StatusCreatedAt | Datetime | The date and time when the user’s status was created, in ISO 8601 format. | ||
| StatusExpiresAt | Datetime | The expiration date and time of the user’s status. After this date, the status is no longer displayed. | ||
| StatusUpdatedAt | Datetime | The date and time when the user’s status was last updated, in ISO 8601 format. | ||
| StatusOrganizationId | String | The unique identifier (node ID) of the organization associated with the user’s status. | ||
| StatusOrganizationLogin | String | The login name of the organization associated with the user’s status. | ||
| InteractionAbilityLimit | String | Specifies the current interaction restriction applied to this user or their content (for example, 'collaborators only'). | ||
| InteractionAbilityOrigin | String | The source or reason for the currently active interaction restriction (for example, account settings, admin action). | ||
| InteractionAbilityExpiresAt | Datetime | The expiration date and time of the current interaction restriction, if applicable. | ||
| HasSponsorsListing | Bool | Indicates whether this user or organization has an active GitHub Sponsors listing. | ||
| MonthlyEstimatedSponsorsIncomeInCents | Int | The estimated monthly income from GitHub Sponsors for this user or organization, in cents (USD). | ||
| EstimatedNextSponsorsPayoutInCents | Int | The estimated amount of the next payout from GitHub Sponsors for this user or organization, in cents (USD). | ||
| SponsorsListingId | String | The unique identifier (node ID) for this user’s or organization’s GitHub Sponsors listing. | ||
| SponsorsListingName | String | The full display name of the GitHub Sponsors listing for this user or organization. | ||
| TotalSponsorshipAmountAsSponsorInCents | Int | The total amount in US cents that this user or organization has spent sponsoring others on GitHub. Visible only to the user or managers of the organization. | ||
| ResourcePath | String | The relative HTTP path to this user’s profile on GitHub. | ||
| ProjectsResourcePath | String | The relative HTTP path listing the projects associated with this user. | ||
| Url | String | The absolute HTTP URL to the user’s GitHub profile. | ||
| ProjectsUrl | String | The absolute HTTP URL listing the projects associated with this user. | ||
| WebsiteUrl | String | A URL pointing to the user’s personal website or blog, as listed on their profile. | ||
| AvatarUrl | String | The URL to the user’s public avatar image. Can accept an optional 'size' parameter to specify the dimensions of the square image in pixels. | ||
| CopilotEndpointsApi | String | The API endpoint for interacting with GitHub Copilot services. | ||
| CopilotEndpointsOriginTracker | String | The endpoint used by GitHub Copilot to track the origin of requests. | ||
| CopilotEndpointsProxy | String | The proxy endpoint used for routing GitHub Copilot requests. | ||
| CopilotEndpointsTelemetry | String | The telemetry endpoint for collecting data related to GitHub Copilot activities and usage. | ||
| CreatedAt | Datetime | The date and time when the object or team member was created, in ISO 8601 format. | ||
| UpdatedAt | Datetime | The date and time when the object or team member was last updated, in ISO 8601 format. | ||
| RepositoryCount | Int | The total number of repositories owned by the user within the team or organization. | ||
| FollowerCount | Int | The total number of followers the team member has on GitHub. | ||
| MemberAccessResourcePath | String | The relative HTTP path to the organization's member access page. | ||
| MemberAccessUrl | String | The absolute HTTP URL to the organization's member access page. | ||
| Role | String | The specific role assigned to the team member within the team (for example, 'member', 'maintainer').
The allowed values are MAINTAINER, MEMBER. | ||
| OrganizationTeamSlug [KEY] | String |
OrganizationTeams.Slug | The unique slug (URL-friendly identifier) corresponding to the team within the organization. | |
| OrganizationLogin [KEY] | String |
Organizations.Login | The login (username) of the organization associated with the team. | |
| Membership | String | Filters team members based on their membership type (for example, 'active', 'pending').
The allowed values are IMMEDIATE, CHILD_TEAM, ALL. |
Lists projects accessible to specific teams within a GitHub organization, including details on collaboration and access rights.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM [OrganizationTeamProjects]
SELECT * FROM [OrganizationTeamProjects] WHERE [Number] = 123
SELECT * FROM [OrganizationTeamProjects] WHERE [OrganizationTeamSlug] = 'Val1'
SELECT * FROM [OrganizationTeamProjects] WHERE [OrganizationLogin] = 'Val1'
SELECT * FROM [OrganizationTeamProjects] WHERE [MinPermissionLevel] = 'READ'
The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions that are built with the following columns:
SELECT * FROM [OrganizationTeamProjects] ORDER BY [Number]
SELECT * FROM [OrganizationTeamProjects] ORDER BY [Title]
SELECT * FROM [OrganizationTeamProjects] ORDER BY [UpdatedAt]
SELECT * FROM [OrganizationTeamProjects] ORDER BY [CreatedAt]
The Sync App uses client-side processing when ordering by any other columns. This impacts performance.
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | The unique identifier (node ID) of the project. | ||
| Number | Int | The project’s unique number within the organization or team. | ||
| FullDatabaseId | Long | The primary key identifier for the project in the database, represented as a BigInt. | ||
| Title | String | The name or title of the project. | ||
| ShortDescription | String | A brief description of the project, summarizing its purpose or goals. | ||
| Readme | String | The README content associated with the project, providing detailed information about it. | ||
| Creator | String | The login (username) of the user who originally created the project. | ||
| Public | Bool | Indicates whether the project is public and accessible to everyone. | ||
| Template | Bool | Indicates whether this project serves as a template for creating new projects. | ||
| Closed | Bool | Indicates whether the project is currently closed. | ||
| ViewerCanClose | Bool | Indicates whether the current viewer has permission to close the project. | ||
| ViewerCanReopen | Bool | Indicates whether the current viewer has permission to reopen the project. | ||
| ViewerCanUpdate | Bool | Indicates whether the current viewer has permission to update the project. | ||
| ResourcePath | String | The relative HTTP path to access the project on GitHub. | ||
| Url | String | The absolute HTTP URL to access the project on GitHub. | ||
| UpdatedAt | Datetime | The date and time when the project was last updated, in ISO 8601 format. | ||
| ClosedAt | Datetime | The date and time when the project was closed, in ISO 8601 format. | ||
| CreatedAt | Datetime | The date and time when the project was created, in ISO 8601 format. | ||
| OrganizationTeamSlug [KEY] | String |
OrganizationTeams.Slug | The unique slug (URL-friendly identifier) corresponding to the team associated with the project. | |
| OrganizationLogin [KEY] | String |
Organizations.Login | The login (username) of the organization associated with the project. | |
| MinPermissionLevel | String | Filters projects based on the user’s minimum permission level (for example, 'read', 'write', 'admin').
The allowed values are READ, WRITE, ADMIN. | ||
| DatabaseId | Int | (Deprecated) The primary key identifier for the project in the database. |
Tracks repositories that teams in an organization have access to, along with permission levels for each repository.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM [OrganizationTeamRepositories]
SELECT * FROM [OrganizationTeamRepositories] WHERE [OrganizationTeamSlug] = 'Val1'
SELECT * FROM [OrganizationTeamRepositories] WHERE [OrganizationLogin] = 'Val1'
The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions that are built with the following columns:
SELECT * FROM [OrganizationTeamRepositories] ORDER BY [Name]
SELECT * FROM [OrganizationTeamRepositories] ORDER BY [StargazerCount]
SELECT * FROM [OrganizationTeamRepositories] ORDER BY [PushedAt]
SELECT * FROM [OrganizationTeamRepositories] ORDER BY [CreatedAt]
SELECT * FROM [OrganizationTeamRepositories] ORDER BY [Permission]
The Sync App uses client-side processing when ordering by any other columns. This impacts performance.
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | The unique identifier (node ID) of the repository. | ||
| DatabaseId | Int | The primary key identifier for the repository in the database, used for internal reference. | ||
| Name | String | The name of the repository, as set by its owner. | ||
| NameWithOwner | String | The repository's name, prefixed with the owner's username or organization (for example, 'owner/repository-name'). | ||
| Visibility | String | Indicates the visibility level of the repository ('public', 'private', or 'internal'). | ||
| DiskUsage | Int | The amount of disk space (in kilobytes) that the repository occupies. | ||
| ForkCount | Int | The total number of forks created from this repository across the network. | ||
| StargazerCount | Int | The total number of users who have starred this repository. | ||
| WatcherCount | Int | The total number of users watching this repository for updates. | ||
| TopicCount | Int | The number of topics assigned to the repository to improve discoverability. | ||
| TempCloneToken | String | A temporary authentication token for cloning the repository. | ||
| WebCommitSignoffRequired | Bool | Indicates whether contributors must sign off on web-based commits to this repository. | ||
| UsesCustomOpenGraphImage | Bool | Indicates whether the repository uses a custom image for Open Graph instead of the owner's avatar. | ||
| Description | String | A brief text description of the repository, as provided by the owner. | ||
| DescriptionHTML | String | The HTML-rendered version of the repository's description for display purposes. | ||
| ShortDescriptionHTML | String | A simplified version of the repository's description, rendered in HTML without links. | ||
| ResourcePath | String | The relative HTTP path to access the repository on GitHub. | ||
| ProjectsResourcePath | String | The relative HTTP path listing the repository's associated projects. | ||
| Url | String | The absolute HTTP URL to the repository's main page on GitHub. | ||
| HomepageUrl | String | The URL of the repository's homepage, if specified. | ||
| MirrorUrl | String | The URL of the repository's original mirror, if applicable. | ||
| ProjectsUrl | String | The absolute HTTP URL listing the repository's associated projects. | ||
| SecurityPolicyUrl | String | The URL pointing to the repository's security policy, if available. | ||
| SSHUrl | String | The SSH URL used for cloning the repository. | ||
| OpenGraphImageUrl | String | The image used to represent this repository in Open Graph metadata. | ||
| MergeCommitTitle | String | Specifies how the default commit title is generated when merging a pull request (for example, 'pull request title'). | ||
| MergeCommitMessage | String | Specifies how the default commit message is generated when merging a pull request (for example, 'pull request description'). | ||
| SquashMergeCommitTitle | String | Specifies how the default commit title is generated when squash merging a pull request. | ||
| SquashMergeCommitMessage | String | Specifies how the default commit message is generated when squash merging a pull request. | ||
| DeleteBranchOnMerge | Bool | Indicates whether branches are automatically deleted after being merged in this repository. | ||
| HasDiscussionsEnabled | Bool | Indicates whether the Discussions feature is enabled for this repository. | ||
| HasIssuesEnabled | Bool | Indicates whether the Issues feature is enabled for this repository. | ||
| HasProjectsEnabled | Bool | Indicates whether the Projects feature is enabled for this repository. | ||
| HasWikiEnabled | Bool | Indicates whether the Wiki feature is enabled for this repository. | ||
| HasVulnerabilityAlertsEnabled | Bool | Indicates whether vulnerability alerts are enabled for this repository. | ||
| HasSponsorshipsEnabled | Bool | Indicates whether the repository displays a Sponsor button for financial contributions. | ||
| IsInOrganization | Bool | Indicates whether the repository is owned by an organization or is a private fork of an organization repository. | ||
| IsBlankIssuesEnabled | Bool | Indicates whether blank issue creation is allowed for this repository. | ||
| IsSecurityPolicyEnabled | Bool | Indicates whether the repository has a security policy in place. | ||
| IsUserConfigurationRepository | Bool | Indicates whether the repository is a user configuration repository. | ||
| IsArchived | Bool | Indicates whether the repository is archived and unmaintained. | ||
| IsDisabled | Bool | Indicates whether the repository is disabled. | ||
| IsEmpty | Bool | Indicates whether the repository is empty. | ||
| IsFork | Bool | Indicates whether the repository is a fork of another repository. | ||
| IsLocked | Bool | Indicates whether the repository is locked. | ||
| IsMirror | Bool | Indicates whether the repository is a mirror of another repository. | ||
| IsPrivate | Bool | Indicates whether the repository is private and not publicly accessible. | ||
| IsTemplate | Bool | Indicates whether the repository is a template that can be used to generate new repositories. | ||
| LockReason | String | The reason why the repository has been locked, if applicable.
The allowed values are BILLING, MIGRATING, MOVING, RENAME. | ||
| TemplateRepositoryId | String | The unique identifier (node ID) of the template repository from which this repository was generated, if any. | ||
| ParentId | String | The unique identifier (node ID) of the parent repository, if this repository is a fork. | ||
| ForkingAllowed | Bool | Indicates whether forking is allowed for this repository. | ||
| AutoMergeAllowed | Bool | Indicates whether Auto-merge can be enabled on pull requests for this repository. | ||
| SquashMergeAllowed | Bool | Indicates whether squash-merging is enabled for pull requests in this repository. | ||
| RebaseMergeAllowed | Bool | Indicates whether rebase-merging is enabled for pull requests in this repository. | ||
| MergeCommitAllowed | Bool | Indicates whether pull requests can be merged with a merge commit in this repository. | ||
| AllowUpdateBranch | Bool | Indicates whether pull request head branches that are behind their base branches can be updated even if it is not required for merging. | ||
| ViewerPermission | String | Specifies the permission level of the viewer on the repository (for example, 'read', 'write', 'admin'). Returns null if authenticated as a GitHub App.
The allowed values are ADMIN, MAINTAIN, READ, TRIAGE, WRITE. | ||
| ViewerSubscription | String | Indicates whether the viewer is watching, not watching, or ignoring the repository.
The allowed values are IGNORED, SUBSCRIBED, UNSUBSCRIBED. | ||
| ViewerHasStarred | Bool | Indicates whether the viewing user has starred this repository. | ||
| ViewerDefaultCommitEmail | String | The email address used by the viewer for their last commit in this repository. | ||
| ViewerDefaultMergeMethod | String | The last merge method used by the viewer (for example, 'merge', 'squash', 'rebase') or the repository's default merge method. | ||
| ViewerPossibleCommitEmails | String | A list of email addresses the viewer can use for committing in this repository. | ||
| ViewerCanAdminister | Bool | Indicates whether the viewer has administrative permissions on this repository. | ||
| ViewerCanSubscribe | Bool | Indicates whether the viewer can change their subscription status for this repository. | ||
| ViewerCanCreateProjects | Bool | Indicates whether the viewer can create new projects within this repository. | ||
| ViewerCanUpdateTopics | Bool | Indicates whether the viewer can update the topics (tags) for this repository. | ||
| CodeOfConductId | String | The unique identifier (node ID) of the Code of Conduct associated with this repository. | ||
| CodeOfConductName | String | The formal name of the Code of Conduct applied to this repository. | ||
| CodeOfConductBody | String | The text body of the Code of Conduct describing its rules and guidelines. | ||
| CodeOfConductKey | String | The unique key identifier for the Code of Conduct. | ||
| CodeOfConductUrl | String | The absolute HTTP URL to view the Code of Conduct for this repository. | ||
| CodeOfConductResourcePath | String | The relative HTTP path to view the Code of Conduct for this repository. | ||
| DefaultBranchRefId | String | The unique identifier (node ID) of the default branch in this repository. | ||
| DefaultBranchRefName | String | The name of the default branch for this repository (for example, 'main', 'master'). | ||
| InteractionAbilityLimit | String | Specifies the current interaction restriction applied to this repository (for example, 'collaborators only'). | ||
| InteractionAbilityOrigin | String | The source or reason for the currently active interaction restriction (for example, account settings, admin action). | ||
| InteractionAbilityExpiresAt | Datetime | The expiration date and time for the current interaction restriction, if applicable. | ||
| LatestReleaseId | String | The unique identifier (node ID) of the latest release in this repository. | ||
| LatestReleaseName | String | The title of the latest release in this repository. | ||
| LicenseId | String | The unique identifier (node ID) of the license associated with the repository. | ||
| LicenseKey | String |
Licenses.Key | The unique key identifier for the license associated with the repository (for example, 'mit', 'apache-2.0'). | |
| LanguageId | String | The unique identifier (node ID) of the primary programming language used in the repository. | ||
| LanguageName | String | The name of the primary programming language used in the repository (for example, 'JavaScript', 'Python'). | ||
| LanguageColor | String | The hexadecimal color code associated with the primary programming language used in the repository. | ||
| PushedAt | Datetime | The date and time when the repository was last pushed to, in ISO 8601 format. | ||
| ArchivedAt | Datetime | The date and time when the repository was archived, in ISO 8601 format. | ||
| CreatedAt | Datetime | The date and time when the repository was created, in ISO 8601 format. | ||
| UpdatedAt | Datetime | The date and time when the repository was last updated, in ISO 8601 format. | ||
| PlanFeaturesCodeOwners | Bool | Indicates whether the repository supports automatic review requests and enforcement using a CODEOWNERS file. | ||
| PlanFeaturesDraftPullRequests | Bool | Indicates whether the repository allows pull requests to be created as drafts or converted to drafts. | ||
| PlanFeaturesMaximumAssignees | Int | The maximum number of users that can be assigned to an issue or pull request in this repository. | ||
| PlanFeaturesMaximumManualReviewRequests | Int | The maximum number of manually requested reviews allowed on a pull request in this repository. | ||
| PlanFeaturesTeamReviewRequests | Bool | Indicates whether teams can be requested to review pull requests in this repository. | ||
| Permission | String | The permission level that the team has on the repository (for example, 'read', 'write', 'admin', 'maintain', 'triage'). | ||
| OrganizationTeamSlug [KEY] | String |
OrganizationTeams.Slug | The URL-friendly identifier (slug) for the team associated with the repository. | |
| OrganizationLogin [KEY] | String |
Organizations.Login | The login (username) of the organization associated with the repository. |
Holds metadata and organization-related details for GitHub projects, enabling structured project tracking.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM [Projects]
SELECT * FROM [Projects] WHERE [OwnerLogin] = 'Val1'
SELECT * FROM [Projects] WHERE [Number] = 123
SELECT * FROM [Projects] WHERE [MinPermissionLevel] = 'READ'
The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions that are built with the following columns:
SELECT * FROM [Projects] ORDER BY [Number]
SELECT * FROM [Projects] ORDER BY [Title]
SELECT * FROM [Projects] ORDER BY [UpdatedAt]
SELECT * FROM [Projects] ORDER BY [CreatedAt]
The Sync App uses client-side processing when ordering by any other columns. This impacts performance.
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | The unique identifier (node ID) of the project. | ||
| OwnerLogin | String | The login (username) of the owner of the project, which could be a user or an organization. | ||
| Number | Int | The unique number assigned to the project within its scope (for example, repository, organization). | ||
| FullDatabaseId | Long | The primary key identifier for the project in the database, represented as a BigInt. | ||
| Title | String | The name or title of the project, as set by its creator. | ||
| ShortDescription | String | A brief description of the project, summarizing its purpose or goals. | ||
| Readme | String | The README content associated with the project, providing detailed information or instructions. | ||
| Creator | String | The login (username) of the user who originally created the project. | ||
| Public | Bool | Indicates whether the project is public and accessible to everyone. | ||
| Template | Bool | Indicates whether the project is a template that can be used to create new projects. | ||
| Closed | Bool | Indicates whether the project is currently closed and no longer active. | ||
| ViewerCanClose | Bool | Indicates whether the current viewer has permission to close the project. | ||
| ViewerCanReopen | Bool | Indicates whether the current viewer has permission to reopen the project. | ||
| ViewerCanUpdate | Bool | Indicates whether the current viewer has permission to update the project. | ||
| ResourcePath | String | The relative HTTP path to access the project on GitHub. | ||
| Url | String | The absolute HTTP URL to access the project on GitHub. | ||
| UpdatedAt | Datetime | The date and time when the project was last updated, in ISO 8601 format. | ||
| ClosedAt | Datetime | The date and time when the project was closed, in ISO 8601 format. | ||
| CreatedAt | Datetime | The date and time when the project was created, in ISO 8601 format. | ||
| MinPermissionLevel | String | Filters projects based on the user’s minimum permission level (for example, 'read', 'write', 'admin').
The allowed values are READ, WRITE, ADMIN. | ||
| DatabaseId | Int | (Deprecated) The primary key identifier for the project in the database. |
In the Repository Data Model schema, the Sync App models each repository associated with the authenticated account as a schema. Live connectivity to these objects means that any changes to your GitHub account are immediately reflected in the Sync App.
The Tables section, which details standard SQL tables, and the Views section, which lists read-only SQL tables, contain samples of what you might have access to in your GitHub account.
Common tables include:
| Table | Description |
| Issues | Stores comprehensive details about issues in a repository, including labels, assignees, priorities, and statuses. |
| PullRequests | Contains metadata about pull requests in a repository, such as their titles, descriptions, current statuses, and authors, to manage proposed changes effectively. |
| Commits | Contains metadata for commits in a repository, including author information, timestamps, and commit messages for version tracking. |
| Branches | Contains detailed information about branches in a repository, including branch names, active statuses, and their relationships with other branches for version control. |
| Collaborators | Lists collaborators in a repository, including their roles, permissions, and contributions to the project. |
| Forks | Provides metadata about forks created from a repository, including fork ownership and purpose, to support collaboration and innovation. |
| Labels | Maintains a catalog of labels available in a repository, enabling effective categorization and filtering of issues and pull requests. |
| Milestones | Details milestones in a repository, including their goals, deadlines, and associated issues or pull requests for project tracking. |
| Releases | Tracks versioned releases in a repository, detailing associated tags, descriptions, and links to attached assets. |
| Stargazers | Lists users who have starred a repository, indicating their interest in or support for the project. |
| Watchers | Tracks users watching a repository, providing visibility into who is monitoring updates, changes, and activity. |
| IssueComments | Logs comments added to issues, capturing discussions, updates, and resolutions for tracking purposes. |
| PullRequestComments | Records comments on pull requests, documenting feedback and discussions during the code review process. |
| PullRequestReviews | Stores details of reviews conducted on pull requests, including reviewer actions (approved, requested changes, commented) and timestamps. |
| PullRequestReviewComments | Logs comments made during pull request reviews, capturing feedback, suggestions, and discussions for improving the code. |
| PullRequestCommits | Provides a list of commits included in pull requests, detailing the changes introduced and the commits' authors. |
| PullRequestFiles | Tracks files modified within pull requests, listing filenames, change types, and details for thorough review. |
| AssignableUsers | Identifies users who are eligible to be assigned to repository issues, based on their roles and permissions. |
| MentionableUsers | Identifies users who can be mentioned in repository discussions, including issues, pull requests, and comments, based on permissions. |
| Environments | Lists deployment environments configured for a repository, including environment names, statuses, and related configuration data. |
Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including getting the currently authenticated user or retrieving and refreshing OAuth access tokens.
The Sync App models the data in GitHub as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| Environments | Lists deployment environments configured for a repository, including environment names, statuses, and related configuration data. |
| IssueComments | Logs comments added to issues, capturing discussions, updates, and resolutions for tracking purposes. |
| Issues | Stores comprehensive details about issues in a repository, including labels, assignees, priorities, and statuses. |
| PullRequestReviewRequests | Tracks requests for reviews on pull requests, including information about requested reviewers and their response statuses. |
| PullRequests | Contains metadata about pull requests in a repository, such as their titles, descriptions, current statuses, and authors, to manage proposed changes effectively. |
Lists deployment environments configured for a repository, including environment names, statuses, and related configuration data.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM [Environments]
SELECT * FROM [Environments] WHERE [Name] = 'Val1'
SELECT * FROM [Environments] WHERE [IsPinned] = true
The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions that are built with the following column: Name
SELECT * FROM [Environments] ORDER BY [Name]
The Sync App uses client-side processing when ordering by any other columns. This impacts performance.
You can use the following column to update a record: IsPinned
UPDATE [Environments] SET [IsPinned] = true WHERE [Id] = 'EN_kwDOLvThzs8AAAABBc1m-g'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique node ID assigned to the Environment object. | |
| DatabaseId | Long | True |
The primary key that uniquely identifies this environment in the database. | |
| Name | String | True |
The name of the environment. | |
| IsPinned | Bool | False |
Indicates whether the environment is currently pinned to the repository (true or false). | |
| PinnedPosition | Int | True |
The position of the environment in the list, if it is pinned; null if the environment is not pinned. | |
| LatestCompletedDeploymentId | String | True |
The Node ID of the most recent completed deployment in this environment. | |
| LatestCompletedDeploymentState | String | True |
The current state of the latest completed deployment (for example, 'success', 'failed'). |
Logs comments added to issues, capturing discussions, updates, and resolutions for tracking purposes.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following column and operators:
For example, the following queries are processed server-side:
SELECT * FROM [IssueComments]
SELECT * FROM [IssueComments] WHERE [IssueNumber] = 123
The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions that are built with the following column: UpdatedAt
SELECT * FROM [IssueComments] ORDER BY [UpdatedAt]
The Sync App uses client-side processing when ordering by any other columns. This impacts performance.
You can use the following columns to create (insert) a new record:
INSERT INTO [IssueComments] ([IssueId], [Body]) VALUES ('I_kwDOLkrwGs6OhNo0', 'hello there')
You can use the following column to update a record: Body
UPDATE [IssueComments] SET [Body] = 'test' WHERE [Id] = 'IC_kwDOLkrwGs6GFwhQ'
You can specify the following column to delete a record: Id
DELETE FROM [IssueComments] WHERE [Id] = 'IC_kwDOLkrwGs6GFuN2'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique identifier for the comment. | |
| Body | String | False |
The body of the comment in Markdown format. | |
| BodyText | String | True |
The body of the comment rendered as plain text. | |
| BodyHTML | String | True |
The body of the comment rendered in HTML. | |
| Author | String | True |
The username of the person who authored the comment. | |
| AuthorAssociation | String | True |
The author's association with the subject of the comment. | |
| Editor | String | True |
The username of the actor who edited the comment. | |
| IsMinimized | Bool | True |
Indicates whether or not the comment has been minimized. | |
| MinimizedReason | String | True |
The reason why the comment was minimized. | |
| CreatedViaEmail | Bool | True |
Indicates if the comment was created through an email reply. | |
| IncludesCreatedEdit | Bool | True |
Indicates if the comment was edited and includes the creation data in the edit. | |
| ResourcePath | String | True |
The HTTP path for this comment. | |
| Url | String | True |
The HTTP URL for this comment. | |
| LastEditedAt | Datetime | True |
The date and time when the comment was last edited. | |
| PublishedAt | Datetime | True |
The date and time when the comment was published. | |
| CreatedAt | Datetime | True |
The date and time when the comment was created. | |
| UpdatedAt | Datetime | True |
The date and time when the comment was last updated. | |
| ViewerDidAuthor | Bool | True |
Indicates whether the viewer authored this comment. | |
| ViewerCanDelete | Bool | True |
Indicates if the current viewer has permission to delete this comment. | |
| ViewerCanMinimize | Bool | True |
Indicates if the current viewer has permission to minimize this comment. | |
| ViewerCanReact | Bool | True |
Indicates if the user can react to this comment. | |
| ViewerCanUpdate | Bool | True |
Indicates if the current viewer can update this comment. | |
| ViewerCannotUpdateReasons | String | True |
Lists the reasons why the current viewer cannot update this comment. | |
| ReactionGroups | String | True |
A list of reactions grouped by content left on the subject. | |
| ViewerId | String | True |
The ID of the viewer. | |
| IssueNumber | Int | True |
Issues.Number |
The issue number associated with the comment. |
| IssueId | String | True |
The issue ID associated with the comment. | |
| PullRequestId | String | True |
The ID of the pull request associated with the comment, if applicable. | |
| FullDatabaseId | Long | True |
The primary key for the comment in the database, stored as a BigInt. |
Stores comprehensive details about issues in a repository, including labels, assignees, priorities, and statuses.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM [Issues]
SELECT * FROM [Issues] WHERE [Author] = 'Val1'
SELECT * FROM [Issues] WHERE [State] = 'open'
SELECT * FROM [Issues] WHERE [ClosedAt] = '2023-01-01 11:10:00'
SELECT * FROM [Issues] WHERE [UpdatedAt] = '2023-01-01 11:10:00'
SELECT * FROM [Issues] WHERE [CreatedAt] = '2023-01-01 11:10:00'
SELECT * FROM [Issues] WHERE [CommentCount] = 123
SELECT * FROM [Issues] WHERE [ReactionCount] = 123
SELECT * FROM [Issues] WHERE [Mentions] = 'Val1'
SELECT * FROM [Issues] WHERE [Assignee] = 'Val1'
The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions that are built with the following columns:
SELECT * FROM [Issues] ORDER BY [UpdatedAt]
SELECT * FROM [Issues] ORDER BY [CreatedAt]
The Sync App uses client-side processing when ordering by any other columns. This impacts performance.
You can use the following columns to create (insert) a new record:
You can use the following pseudo-columns to create a new record:
INSERT INTO [Issues] ([Title], [AssigneeIds]) VALUES ('TestIssue', 'MDQ6VXNlcjg3ODExMTEx,U_kgDOCXOvpA')
You can use the following columns to update a record:
You can use the following pseudo-columns to update a record:
You can use the following columns to lock a record:
You can use the following columns to unlock a record: Locked
UPDATE [Issues] SET [Title] = 'NewTitle', [AssigneeIds] = 'MDQ6VXNlcjg3ODExMTEx,U_kgDOCXOvpA', [State] = 'CLOSED' WHERE [Id] = 'I_kwDOLkrwGs6M5WWy'
UPDATE [Issues] SET [Locked] = true WHERE [Id] = 'I_kwDOLkrwGs6M5WWy'
UPDATE [Issues] SET [Locked] = false WHERE [Id] = 'I_kwDOLkrwGs6M5WWy'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A unique identifier for the issue within the repository. | |
| FullDatabaseId | Long | True |
The primary key of the issue in the database, stored as a BigInt. | |
| Title | String | False |
The title of the issue, summarizing its content. | |
| TitleHTML | String | True |
The issue title formatted as HTML for web display. | |
| Author | String | True |
The username of the user who created the issue. | |
| AuthorAssociation | String | True |
The relationship of the author to the repository, such as collaborator or owner. | |
| Editor | String | True |
The username of the user who last edited the issue. | |
| Body | String | False |
The main content or description provided in the issue. | |
| BodyText | String | True |
The issue body converted to plain text, without formatting. | |
| BodyHTML | String | True |
The issue body formatted as HTML for web display. | |
| BodyResourcePath | String | True |
The relative HTTP path to access the issue body. | |
| BodyUrl | String | True |
The full HTTP URL to directly access the issue body. | |
| Number | Int | True |
A sequential number assigned to the issue within the repository. | |
| State | String | False |
The current status of the issue, such as open or closed. The allowed values are open, closed. | |
| StateReason | String | True |
The explanation for the current issue state, if applicable. | |
| Locked | Bool | True |
Indicates whether the issue is locked to prevent further comments. | |
| ActiveLockReason | String | True |
The reason why the issue discussion was locked. | |
| Closed | Bool | True |
Indicates whether the issue has been closed. | |
| IsPinned | Bool | True |
Indicates whether the issue is pinned to the top of the repository's issue list. | |
| IncludesCreatedEdit | Bool | True |
Indicates whether the issue has been edited since its creation. | |
| CreatedViaEmail | Bool | True |
Indicates whether the issue was created through an email reply. | |
| ResourcePath | String | True |
The relative HTTP path to access the issue. | |
| Url | String | True |
The full HTTP URL to directly access the issue. | |
| LastEditedAt | Datetime | True |
The date and time when the issue was last edited. | |
| PublishedAt | Datetime | True |
The date and time when the issue was initially published. | |
| ClosedAt | Datetime | True |
The date and time when the issue was closed, if applicable. | |
| UpdatedAt | Datetime | True |
The date and time of the most recent update to the issue. | |
| CreatedAt | Datetime | True |
The date and time when the issue was first created. | |
| MilestoneId | String | False |
Milestones.Id |
The unique identifier of the milestone associated with this issue. |
| MilestoneTitle | String | True |
The title of the milestone associated with the issue. | |
| MilestoneNumber | Int | True |
The sequential number assigned to the milestone in the repository. | |
| IsReadByViewer | Bool | True |
Indicates whether the issue has been read by the current viewer. | |
| ViewerDidAuthor | Bool | True |
Indicates whether the current viewer is the author of the issue. | |
| ViewerSubscription | String | True |
The viewer's subscription status for this issue, such as watching, not watching, or ignoring. | |
| ViewerCanLabel | Bool | True |
Indicates whether the viewer has permission to add or edit labels on this issue. | |
| ViewerCanClose | Bool | True |
Indicates whether the viewer has permission to close the issue. | |
| ViewerCanReopen | Bool | True |
Indicates whether the viewer has permission to reopen a previously closed issue. | |
| ViewerCanDelete | Bool | True |
Indicates whether the viewer has permission to delete this issue. | |
| ViewerCanReact | Bool | True |
Indicates whether the viewer can react to this issue with emojis. | |
| ViewerCanSubscribe | Bool | True |
Indicates whether the viewer can modify their subscription status for the issue. | |
| ViewerThreadSubscriptionStatus | String | True |
The viewer's current subscription status for the issue's thread. | |
| ViewerThreadSubscriptionFormAction | String | True |
The available actions for the viewer to change their thread subscription. | |
| ViewerCanUpdate | Bool | True |
Indicates whether the viewer has permission to update this issue. | |
| ViewerCannotUpdateReasons | String | True |
The reasons why the viewer cannot update the issue, if applicable. | |
| CommentCount | Int | True |
The total number of comments added to the issue. | |
| ReactionCount | Int | True |
The total number of reactions added to the issue. | |
| Mentions | String | True |
Allows filtering of issues that mention a specific user. | |
| Assignee | String | True |
The username of the user assigned to the issue or pull request. |
Pseudo-columns are fields that can only be used in the types of statements under which they are explicitly listed. They are not standard columns but instead provide additional functionality for specific operations.
| Name | Type | Description |
| AssigneeIds | String |
A list of assignee node IDs for the issue, separated by commas with spaces after each comma. |
| LabelIds | String |
A list of label node IDs associated with the issue, separated by commas with spaces after each comma. |
| IssueTemplate | String |
The name of an issue template used to pre-fill the issue with predefined labels and assignees. |
Tracks requests for reviews on pull requests, including information about requested reviewers and their response statuses.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following column and operators:
For example, the following queries are processed server-side:
SELECT * FROM [PullRequestReviewRequests]
SELECT * FROM [PullRequestReviewRequests] WHERE [PullRequestId] = 'Val1'
The Sync App processes other filters client-side within the Sync App.
You can use the following columns to create (insert) a new record:
Note: It is not possible to request both a user and team in the same statement.
INSERT INTO [PullRequestReviewRequests] ([PullRequestId], [RequestedReviewerUserId]) VALUES ('123', '456')
INSERT INTO [PullRequestReviewRequests] ([PullRequestId], [RequestedReviewerTeamId]) VALUES ('123', '789')
You can specify either of the following sets of WHERE conditions to delete a record:
DELETE FROM [PullRequestReviewRequests] WHERE [PullRequestId] = '123' AND [RequestedReviewerUserId] = '456'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique node ID of the ReviewRequest object, which is used to identify this specific review request within the GitHub system. | |
| DatabaseId | Int | True |
The primary key identifier for the review request in the database, represented as an integer and used for internal storage and references. | |
| AsCodeOwner | Bool | True |
Indicates whether the review request was specifically made for a code owner to review, highlighting requests that require specialized review. | |
| RequestedReviewerUserId | String | True |
The node ID of the User object representing the individual user who has been requested to review the pull request. | |
| RequestedReviewerUserLogin | String | True |
The GitHub username of the user who has been requested to review the pull request, enabling identification of the reviewer. | |
| RequestedReviewerTeamId | String | True |
The node ID of the Team object representing the team requested to review the pull request, used for organizing team-based reviews. | |
| RequestedReviewerTeamSlug | String | True |
The unique slug of the team within the organization, which helps identify the team in a standardized way across the repository. | |
| RequestedReviewerMannequinId | String | True |
The node ID of the Mannequin object, representing a template or placeholder user that is being requested to review, often used for automating review assignments. | |
| RequestedReviewerMannequinLogin | String | True |
The username of the Mannequin object, which serves as a placeholder or template user when no real reviewer is assigned. | |
| RequestedReviewerBotId | String | True |
The node ID of the Bot object representing a bot that has been requested to review the pull request, typically used for automated checks or processes. | |
| RequestedReviewerBotLogin | String | True |
The username of the bot that is requested to review the pull request, often involved in automated review workflows. | |
| PullRequestId | String | True |
The unique identifier for the pull request to which this review request is associated, linking the review request to a specific pull request. | |
| PullRequestNumber | Int | True |
The number assigned to the pull request within the repository, providing a unique identifier for the pull request and its associated review request. |
Contains metadata about pull requests in a repository, such as their titles, descriptions, current statuses, and authors, to manage proposed changes effectively.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM [PullRequests]
SELECT * FROM [PullRequests] WHERE [BaseRefName] = 'Val1'
SELECT * FROM [PullRequests] WHERE [HeadRefName] = 'Val1'
SELECT * FROM [PullRequests] WHERE [State] = 'OPEN'
SELECT * FROM [PullRequests] WHERE [Number] = 123
The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions that are built with the following columns:
SELECT * FROM [PullRequests] ORDER BY [UpdatedAt]
SELECT * FROM [PullRequests] ORDER BY [CreatedAt]
The Sync App uses client-side processing when ordering by any other columns. This impacts performance.
You can use the following columns to create (insert) a new record:
INSERT INTO [PullRequests] ([Title], [BaseRefName], [HeadRefName]) VALUES ('TestPR', '1-1-out-of-100-issues', 'main')
You can use the following columns to update a record:
You can use the following pseudo-columns to update a record:
UPDATE [PullRequests] SET [Closed] = 'false' WHERE [Id] = 'PR_kwDOLkrwGs5zEp0s'
UPDATE [PullRequests] SET [Closed] = true WHERE [Id] = 'PR_kwDOLkrwGs5zEp0s'
UPDATE [PullRequests] SET [Title] = 'NewPRTitle', [AssigneeIds] = 'MDQ6VXNlcjg3ODExMTEx,U_kgDOCXOvpA' WHERE [Id] = 'PR_kwDOLkrwGs5zEp0s'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A unique identifier for the pull request, used to differentiate it from others in the system. | |
| FullDatabaseId | Long | True |
The primary database identifier for the pull request, stored as a BigInt for scalability. | |
| Author | String | True |
The username of the individual who created the pull request. | |
| AuthorAssociation | String | True |
Defines the relationship between the pull request's author and the repository (for example, 'OWNER', 'CONTRIBUTOR'). | |
| Editor | String | True |
The username of the individual who most recently updated the pull request's body content. | |
| HeadRepositoryId | String | True |
The unique identifier of the repository where the pull request's head branch resides. | |
| HeadRepositoryOwner | String | True |
The username of the owner of the repository containing the pull request's head branch. | |
| MergedBy | String | True |
The username of the individual who merged the pull request into the base branch. | |
| BaseRefId | String | True |
The unique identifier of the base branch for this pull request, even if the branch has been deleted. | |
| BaseRefOid | String | True |
The object identifier (OID) of the base branch for this pull request, even if the branch has been deleted. | |
| BaseRefPrefix | String | True |
The namespace prefix (for example, 'refs/heads/') of the base branch for this pull request. | |
| BaseRefName | String | False |
The name of the base branch for this pull request, even if the branch has been deleted. | |
| HeadRefId | String | True |
The unique identifier of the head branch for this pull request, even if the branch has been deleted. | |
| HeadRefOid | String | True |
The object identifier (OID) of the head branch for this pull request, even if the branch has been deleted. | |
| HeadRefPrefix | String | True |
The namespace prefix (for example, 'refs/heads/') of the head branch for this pull request. | |
| HeadRefName | String | True |
The name of the head branch for this pull request, even if the branch has been deleted. | |
| Title | String | False |
The descriptive title of the pull request. | |
| TitleHTML | String | True |
The title of the pull request rendered as formatted HTML. | |
| Body | String | False |
The main content of the pull request, provided in Markdown for formatting. | |
| BodyText | String | True |
The plain-text version of the pull request's content, stripped of any Markdown formatting. | |
| BodyHTML | String | True |
The body of the pull request rendered as HTML for display purposes. | |
| State | String | False |
Indicates the current status of the pull request (for example, 'OPEN', 'MERGED', 'CLOSED'). The allowed values are OPEN, CLOSED, MERGED. | |
| Number | Int | True |
The sequential number assigned to the pull request within the repository. | |
| Mergeable | String | True |
Specifies whether the pull request can be merged without conflicts. | |
| Merged | Bool | True |
A true/false indicator of whether the pull request has been successfully merged. | |
| Closed | Bool | True |
A true/false indicator of whether the pull request has been closed. | |
| ChangedFiles | Int | True |
The total count of files modified as part of this pull request. | |
| Additions | Int | True |
The total number of lines of code added in this pull request. | |
| Deletions | Int | True |
The total number of lines of code removed in this pull request. | |
| TotalCommentsCount | Int | True |
The total number of comments made on this pull request, including review and inline comments. | |
| ReviewDecision | String | True |
The current review status of the pull request, indicating if it has been approved or requires changes (for example, 'APPROVED', 'REQUEST_CHANGES'). | |
| Locked | Bool | True |
Indicates whether the conversation on this pull request is locked to prevent further discussion. True if locked, false otherwise. | |
| ActiveLockReason | String | True |
The reason provided for locking the pull request conversation, such as 'RESOLVED' or 'OFF_TOPIC'. | |
| IsDraft | Bool | True |
Indicates whether this pull request is in draft mode, meaning it is not yet ready for review. True if draft, false otherwise. | |
| IsCrossRepository | Bool | True |
Specifies whether the pull request originates from a different repository than the base repository. | |
| MaintainerCanModify | Bool | False |
Indicates whether maintainers of the base repository have permission to make changes to this pull request. | |
| CreatedViaEmail | Bool | True |
Indicates whetherthe pull request was created through an email reply, rather than through the GitHub interface. | |
| IncludesCreatedEdit | Bool | True |
Specifies whether the pull request includes an edit that was made at the time of its creation. | |
| MergeCommitId | String | True |
The unique identifier (commit hash) of the merge commit created when the pull request was merged. | |
| PotentialMergeCommitId | String | True |
A commit hash generated by GitHub to verify if the pull request can be merged, available before the pull request is merged. | |
| Permalink | String | True |
The permanent URL that links directly to this pull request. | |
| ResourcePath | String | True |
The relative API path to access details about this pull request. | |
| ChecksResourcePath | String | True |
The relative API path to access status checks associated with this pull request. | |
| RevertResourcePath | String | True |
The relative API path used to create a revert pull request based on this pull request. | |
| Url | String | True |
The full URL linking to the pull request on GitHub. | |
| ChecksUrl | String | True |
The full URL linking to the status checks for this pull request on GitHub. | |
| RevertUrl | String | True |
The full URL used to initiate a revert of this pull request. | |
| LastEditedAt | Datetime | True |
The timestamp of when the pull request was last edited by any user. | |
| MergedAt | Datetime | True |
The timestamp of when the pull request was successfully merged into the base branch. | |
| ClosedAt | Datetime | True |
The timestamp of when the pull request was closed without being merged. | |
| PublishedAt | Datetime | True |
The timestamp of when a comment related to this pull request was published. | |
| UpdatedAt | Datetime | True |
The timestamp of the most recent update to this pull request, including title, description, or review status changes. | |
| CreatedAt | Datetime | True |
The timestamp of when the pull request was originally created. | |
| MilestoneId | String | False |
The unique identifier of the milestone linked to this pull request. | |
| MilestoneTitle | String | True |
The descriptive title of the milestone associated with this pull request. | |
| MilestoneNumber | Int | True |
The sequential number assigned to the milestone linked to this pull request. | |
| AutoMergeRequestCommitHeadline | String | True |
The title of the commit created as part of the auto-merge request when required by the base branch's merge queue. | |
| AutoMergeRequestAuthorEmail | String | True |
The email address of the user who initiated the auto-merge request. | |
| AutoMergeRequestCommitBody | String | True |
The detailed commit message associated with the auto-merge request when required by the base branch. | |
| AutoMergeRequestEnabledAt | Datetime | True |
The timestamp of when auto-merge was enabled for this pull request. | |
| AutoMergeRequestMergeMethod | String | True |
Specifies the merge strategy used when auto-merging the pull request, determined by the base branch's merge queue requirements. | |
| ViewerDidAuthor | Bool | True |
Indicates whether the currently authenticated user is the author of this pull request. | |
| IsReadByViewer | Bool | True |
Shows whether the pull request has been marked as read by the current user. | |
| ViewerSubscription | String | True |
Indicates the subscription status of the current user regarding this pull request (for example, 'SUBSCRIBED', 'IGNORED'). | |
| ViewerCanLabel | Bool | True |
Specifies whether the current user has permission to add or remove labels on this pull request. | |
| ViewerCanClose | Bool | True |
Indicates whether the current user can close this pull request. | |
| ViewerCanReact | Bool | True |
Shows whether the current user can add emoji reactions to this pull request. | |
| ViewerCanReopen | Bool | True |
Indicates whether the current user has the ability to reopen this pull request if it is closed. | |
| ViewerCanSubscribe | Bool | True |
Determines whether the current user can modify their subscription settings for notifications related to this pull request. | |
| ViewerCanApplySuggestion | Bool | True |
Specifies whether the current user has permission to apply suggested code changes in this pull request. | |
| ViewerCanEditFiles | Bool | True |
Indicates whether the current user can edit the files modified in this pull request. | |
| ViewerCanDeleteHeadRef | Bool | True |
Shows whether the current user can restore the deleted head reference of the pull request. | |
| ViewerCanDisableAutoMerge | Bool | True |
Indicates whether the current user has permission to disable the auto-merge feature for this pull request. | |
| ViewerCanEnableAutoMerge | Bool | True |
Shows whether the current user has permission to enable the auto-merge feature for this pull request. | |
| ViewerCanMergeAsAdmin | Bool | True |
Specifies whether the current user can override branch protections and merge the pull request immediately as an administrator. | |
| ViewerCanUpdate | Bool | True |
Indicates whether the current user can modify details of the pull request, such as its title or description. | |
| ViewerCanUpdateBranch | Bool | True |
Shows whether the current user can update the pull request's head branch by merging or rebasing the base branch. | |
| ViewerCannotUpdateReasons | String | True |
Lists the reasons why the current user is unable to update this pull request. | |
| ViewerLatestReviewRequestId | String | True |
The unique identifier of the latest review request made by the current user for this pull request. | |
| ViewerLatestReviewId | String | True |
The unique identifier of the latest review submitted by the current user for this pull request. | |
| IsMergeQueueEnabled | Bool | True |
Indicates whether a merge queue is enabled for the pull request's base branch. | |
| IsInMergeQueue | Bool | True |
Shows whether this pull request is currently waiting in the merge queue. | |
| MergeQueueEntryId | String | True |
The unique identifier for this pull request's entry in the merge queue. | |
| MergeQueueEntryJump | Bool | True |
Indicates whether this pull request has been prioritized to jump ahead in the merge queue. | |
| MergeQueueEntryPosition | Int | True |
The current position of this pull request in the merge queue. | |
| MergeQueueEntrySolo | Bool | True |
Specifies whether this pull request must be merged and deployed independently from other changes. | |
| MergeQueueEntryState | String | True |
Represents the current state of this pull request within the merge queue. | |
| MergeQueueEntryEnqueuedAt | Datetime | True |
The timestamp of when this pull request was added to the merge queue. | |
| MergeQueueEntryEstimatedTimeToMerge | Int | True |
The estimated time, in seconds, until this pull request is expected to be merged from the queue. | |
| MergeQueueEntryBaseCommitId | String | True |
The commit ID representing the base commit in the merge queue entry. | |
| MergeQueueEntryHeadCommitId | String | True |
The commit ID representing the head commit in the merge queue entry. | |
| MergeQueueEntryMergeQueueId | String | True |
The unique identifier for the merge queue that this entry belongs to. | |
| MergeQueueEntryMergeQueueUrl | String | True |
The URL providing access to the merge queue entry within the GitHub web interface. | |
| MergeQueueEntryMergeQueueResourcePath | String | True |
The API resource path to access the merge queue entry details. | |
| MergeQueueEntryMergeQueueNextEntryEstimatedTimeToMerge | Int | True |
The estimated time, in seconds, for the next entry in the merge queue to be merged. | |
| StatusCheckRollupId | String | True |
The unique node ID of the StatusCheckRollup object associated with this pull request. | |
| StatusCheckRollupCommitId | String | True |
The commit ID linked to the status checks and check runs for this pull request. | |
| StatusCheckRollupState | String | True |
The overall status of the pull request's associated checks (for example, 'SUCCESS', 'FAILURE'). |
Pseudo-columns are fields that can only be used in the types of statements under which they are explicitly listed. They are not standard columns but instead provide additional functionality for specific operations.
| Name | Type | Description |
| AssigneeIds | String |
A comma-separated list of node IDs representing users assigned to this pull request. |
| LabelIds | String |
A comma-separated list of node IDs representing labels applied to this pull request. |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| AssignableUsers | Identifies users who are eligible to be assigned to repository issues, based on their roles and permissions. |
| Branches | Contains detailed information about branches in a repository, including branch names, active statuses, and their relationships with other branches for version control. |
| Collaborators | Lists collaborators in a repository, including their roles, permissions, and contributions to the project. |
| CommitComments | Tracks comments made on specific commits, providing insights into discussions and feedback related to code changes. |
| CommitCompare | Stores a detailed list of commits generated from a comparison of two references, such as branches or tags. |
| CommitCompareFiles | Tracks files modified during a comparison between two references, providing details on up to 300 changed files for review. |
| CommitFiles | Details files modified in specific commits, including filenames, change types (for example, added, deleted, modified), and related metadata. |
| Commits | Contains metadata for commits in a repository, including author information, timestamps, and commit messages for version tracking. |
| Forks | Provides metadata about forks created from a repository, including fork ownership and purpose, to support collaboration and innovation. |
| IssueAssignees | Tracks users assigned to issues within a repository, detailing responsibilities and roles for task ownership. |
| IssuePullRequests | Connects issues to related pull requests, allowing traceability between reported problems and their solutions. |
| Labels | Maintains a catalog of labels available in a repository, enabling effective categorization and filtering of issues and pull requests. |
| MentionableUsers | Identifies users who can be mentioned in repository discussions, including issues, pull requests, and comments, based on permissions. |
| MergeQueueEntries | Tracks individual pull requests in the merge queue, including their statuses and any pending actions for orderly processing. |
| MergeQueues | Provides an overview of active merge queues in a repository, listing pull requests and their order for systematic integration. |
| Milestones | Details milestones in a repository, including their goals, deadlines, and associated issues or pull requests for project tracking. |
| PullRequestComments | Records comments on pull requests, documenting feedback and discussions during the code review process. |
| PullRequestCommits | Provides a list of commits included in pull requests, detailing the changes introduced and the commits' authors. |
| PullRequestFiles | Tracks files modified within pull requests, listing filenames, change types, and details for thorough review. |
| PullRequestReviewComments | Logs comments made during pull request reviews, capturing feedback, suggestions, and discussions for improving the code. |
| PullRequestReviews | Stores details of reviews conducted on pull requests, including reviewer actions (approved, requested changes, commented) and timestamps. |
| ReleaseAssets | Lists assets attached to repository releases, including binary files, source code archives, and other downloadable content for distribution. |
| Releases | Tracks versioned releases in a repository, detailing associated tags, descriptions, and links to attached assets. |
| Stargazers | Lists users who have starred a repository, indicating their interest in or support for the project. |
| Topics | Catalogs topics assigned to a repository, helping categorize and improve discoverability through tags such as 'open-source' or 'web-development.' |
| TrafficClonesDaily | Logs daily statistics of repository clones for the last 14 days, providing insight into the frequency and patterns of cloning activity. |
| TrafficClonesWeekly | Summarizes weekly clone statistics for the last 14 days, offering a higher-level view of cloning trends. |
| TrafficPageViewsDaily | Records daily page view statistics for a repository, helping track user engagement and traffic patterns over time. |
| TrafficPageViewsWeekly | Aggregates weekly page view statistics for a repository, giving an overview of user interaction trends for the past two weeks. |
| TrafficTopReferralPaths | Lists the top 10 most frequently accessed paths in a repository over the past 14 days, helping identify popular content and entry points. |
| TrafficTopReferralSources | Identifies the top 10 sources driving traffic to a repository in the last 14 days, such as search engines, social media, or external links. |
| Watchers | Tracks users watching a repository, providing visibility into who is monitoring updates, changes, and activity. |
Identifies users who are eligible to be assigned to repository issues, based on their roles and permissions.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following column and operator:
For example, the following queries are processed server-side:
SELECT * FROM [AssignableUsers]
SELECT * FROM [AssignableUsers] WHERE [Login] = 'Val1'
The Sync App processes other filters client-side within the Sync App.
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | The unique identifier for the user, used across the system. | ||
| DatabaseId | Int | The primary key for the user in the database, ensuring unique identification. | ||
| Login | String | The user's GitHub login username, used for authentication and display. | ||
| Name | String | The publicly visible name of the user, often used for display purposes. | ||
| String | The user's publicly visible email address, if they have chosen to share it. | |||
| TwitterUsername | String | The user's Twitter handle, linked to their GitHub profile. | ||
| Pronouns | String | The pronouns specified by the user on their profile. | ||
| Bio | String | A textual description of the user, provided on their public GitHub profile. | ||
| BioHTML | String | The user's biography rendered as HTML, for use in web applications. | ||
| Company | String | The organization or company the user is affiliated with, as per their profile. | ||
| CompanyHTML | String | The user's affiliated company rendered as HTML for web use. | ||
| Location | String | The geographic location provided by the user on their profile. | ||
| AnyPinnableItems | Bool | Indicates whether this user can pin items, such as repositories, to their profile. | ||
| PinnedItemsRemaining | Int | The number of additional items this user can pin to their profile. | ||
| ItemShowcaseHasPinnedItems | Bool | Indicates whether this user has any pinned repositories or gists in their profile showcase. | ||
| IsEmployee | Bool | Specifies whether the user is an employee of GitHub. | ||
| IsHireable | Bool | Indicates whether the user has marked themselves as available for hiring opportunities. | ||
| IsBountyHunter | Bool | Indicates whether this user participates in the GitHub Security Bug Bounty program. | ||
| IsCampusExpert | Bool | Indicates whether this user is part of the GitHub Campus Experts program. | ||
| IsFollowingViewer | Bool | Indicates whether this user is following the current viewer. Inverse of ViewerIsFollowing. | ||
| IsSiteAdmin | Bool | Specifies whether the user has administrative privileges on the GitHub site. | ||
| IsDeveloperProgramMember | Bool | Indicates whether the user is a member of the GitHub Developer Program. | ||
| IsGitHubStar | Bool | Specifies whether the user is part of the GitHub Stars program, recognizing outstanding community members. | ||
| IsSponsoringViewer | Bool | True if the user or organization is sponsoring the current viewer on GitHub. | ||
| IsViewer | Bool | Indicates whether this user is the same as the current viewing user. | ||
| ViewerCanFollow | Bool | Indicates whether the current viewer has the option to follow this user. | ||
| ViewerCanSponsor | Bool | Indicates whether the current viewer can sponsor this user or organization. | ||
| ViewerIsFollowing | Bool | True if this user is currently being followed by the viewer. | ||
| ViewerIsSponsoring | Bool | True if the viewer is currently sponsoring this user or organization. | ||
| ViewerCanCreateProjects | Bool | Indicates whether the current viewer can create new projects associated with this user. | ||
| ViewerCanChangePinnedItems | Bool | Indicates whether the viewer has permission to pin repositories and gists to this user's profile. | ||
| StatusId | String | A unique identifier for the user's current status emoji. | ||
| StatusEmoji | String | An emoji representing the user's current status, such as availability or mood. | ||
| StatusMessage | String | A short custom message set by the user to describe their current status or activity. | ||
| StatusIndicatesLimitedAvailability | Bool | True if the status indicates that the user has limited availability on GitHub. | ||
| StatusEmojiHTML | String | The status emoji formatted as HTML for web display. | ||
| StatusCreatedAt | Datetime | The timestamp when the status was first created. | ||
| StatusExpiresAt | Datetime | If specified, this timestamp indicates when the status automatically expires and is no longer displayed. | ||
| StatusUpdatedAt | Datetime | The timestamp of the most recent update to the user's status. | ||
| StatusOrganizationId | String | A unique identifier for the organization associated with the user's status. | ||
| StatusOrganizationLogin | String | The login name of the organization associated with the user's status. | ||
| InteractionAbilityLimit | String | The current interaction restriction applied to this user or organization (for example, limit on who can comment or interact). | ||
| InteractionAbilityOrigin | String | Specifies the source of the current interaction limit (for example, user settings or GitHub policy). | ||
| InteractionAbilityExpiresAt | Datetime | The expiration timestamp of the current interaction limit, after which restrictions will be lifted. | ||
| HasSponsorsListing | Bool | True if this user or organization has a GitHub Sponsors listing to receive financial support. | ||
| MonthlyEstimatedSponsorsIncomeInCents | Int | The estimated monthly income in cents (USD) from GitHub Sponsors for this user or organization. | ||
| EstimatedNextSponsorsPayoutInCents | Int | The estimated payout in cents (USD) for the next GitHub Sponsors disbursement. | ||
| SponsorsListingId | String | A unique identifier for the GitHub Sponsors listing associated with this user or organization. | ||
| SponsorsListingName | String | The full name of the GitHub Sponsors listing for this user or organization. | ||
| TotalSponsorshipAmountAsSponsorInCents | Int | The total amount in cents (USD) that this user or organization has spent on GitHub sponsorships. Visible only to the user or authorized managers. | ||
| ResourcePath | String | The relative GitHub API path to access this user's profile. | ||
| ProjectsResourcePath | String | The relative GitHub API path to list this user's projects. | ||
| Url | String | The full HTTP URL to the user's GitHub profile. | ||
| ProjectsUrl | String | The full HTTP URL listing the user's GitHub projects. | ||
| WebsiteUrl | String | A publicly shared URL linking to the user's personal website or blog. | ||
| AvatarUrl | String | A URL pointing to the user's avatar image. Accepts a size argument to specify the resolution. | ||
| CopilotEndpointsApi | String | The API endpoint used for GitHub Copilot services. | ||
| CopilotEndpointsOriginTracker | String | The tracking endpoint used to monitor Copilot request origins. | ||
| CopilotEndpointsProxy | String | The proxy endpoint for routing GitHub Copilot requests. | ||
| CopilotEndpointsTelemetry | String | The telemetry endpoint used for GitHub Copilot usage tracking. | ||
| CreatedAt | Datetime | The timestamp when this user account was created. | ||
| UpdatedAt | Datetime | The timestamp of the most recent update to the user's profile. | ||
| RepositoryCount | Int | The total number of repositories owned by the user. | ||
| FollowerCount | Int | The total number of followers the user has on GitHub. |
Contains detailed information about branches in a repository, including branch names, active statuses, and their relationships with other branches for version control.
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server-side:
SELECT * FROM [Branches]
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | A unique identifier for the branch within the repository. | ||
| Name | String | The name of the branch, typically representing a feature, fix, or release. | ||
| Prefix | String | The prefix used for the branch, often indicating its purpose (for example, 'feature/', 'bugfix/', 'release/'). |
Lists collaborators in a repository, including their roles, permissions, and contributions to the project.
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server-side:
SELECT * FROM [Collaborators]
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | A unique identifier for the user. | ||
| DatabaseId | Int | The primary key identifying the user in the database. | ||
| Login | String | The username associated with the user's GitHub account. | ||
| Name | String | The user's publicly displayed name on their GitHub profile. | ||
| String | The publicly visible email address listed on the user's profile, if available. | |||
| TwitterUsername | String | The user's Twitter handle, if linked to their GitHub profile. | ||
| Pronouns | String | The pronouns specified by the user on their profile. | ||
| Bio | String | A short biography provided by the user to describe themselves. | ||
| BioHTML | String | The user's bio formatted in HTML for display on web pages. | ||
| Company | String | The company or organization the user is affiliated with, as listed on their profile. | ||
| CompanyHTML | String | The user's company information formatted as HTML. | ||
| Location | String | The geographic location specified by the user on their profile. | ||
| AnyPinnableItems | Bool | Indicates whether the user has repositories or gists that can be pinned to their profile. Accepts a filter argument for specific item types. | ||
| PinnedItemsRemaining | Int | The number of additional repositories or gists the user can pin to their profile. | ||
| ItemShowcaseHasPinnedItems | Bool | Indicates whether the user has pinned any repositories or gists to their profile. | ||
| IsEmployee | Bool | Indicates whether the user is an employee of GitHub. | ||
| IsHireable | Bool | Indicates whether the user has marked themselves as available for hiring. | ||
| IsBountyHunter | Bool | Indicates whether the user participates in the GitHub Security Bug Bounty program. | ||
| IsCampusExpert | Bool | Indicates whether the user is a member of the GitHub Campus Experts Program. | ||
| IsFollowingViewer | Bool | Indicates whether this user is following the currently authenticated viewer. | ||
| IsSiteAdmin | Bool | Indicates whether the user has GitHub site administrator privileges. | ||
| IsDeveloperProgramMember | Bool | Indicates whether the user is a member of the GitHub Developer Program. | ||
| IsGitHubStar | Bool | Indicates whether the user is recognized as a GitHub Star for their contributions to the community. | ||
| IsSponsoringViewer | Bool | True if this user or organization is sponsoring the currently authenticated viewer. | ||
| IsViewer | Bool | Indicates whether this user is the currently authenticated viewer. | ||
| ViewerCanFollow | Bool | Indicates whether the currently authenticated viewer is able to follow this user. | ||
| ViewerCanSponsor | Bool | Indicates whether the currently authenticated viewer is able to sponsor this user or organization through GitHub Sponsors. | ||
| ViewerIsFollowing | Bool | Indicates whether the currently authenticated viewer is following this user. | ||
| ViewerIsSponsoring | Bool | True if the currently authenticated viewer is sponsoring this user or organization. | ||
| ViewerCanCreateProjects | Bool | Indicates whether the currently authenticated viewer has permission to create new projects for this user or organization. | ||
| ViewerCanChangePinnedItems | Bool | Indicates whether the viewer has permission to pin repositories and gists to the user's GitHub profile. | ||
| StatusId | String | A unique identifier for the emoji representing the user's current status. | ||
| StatusEmoji | String | The emoji used to summarize the user's current status, such as availability or activity. | ||
| StatusMessage | String | A short custom message set by the user to describe what they are currently doing. | ||
| StatusIndicatesLimitedAvailability | Bool | True if the user's status indicates limited availability on GitHub, such as being away or unavailable. | ||
| StatusEmojiHTML | String | The status emoji formatted as HTML for rendering on web pages. | ||
| StatusCreatedAt | Datetime | The timestamp when the user's status was first created. | ||
| StatusExpiresAt | Datetime | The expiration timestamp for the user's status, after which it is no longer be visible. | ||
| StatusUpdatedAt | Datetime | The timestamp of the last update made to the user's status. | ||
| StatusOrganizationId | String | The unique identifier of the organization associated with the user's status. | ||
| StatusOrganizationLogin | String | The login name of the organization to which the user belongs, if applicable. | ||
| InteractionAbilityLimit | String | The type of limit currently imposed on interactions with the user's profile (for example, comment restrictions). | ||
| InteractionAbilityOrigin | String | The source or origin of the interaction limit, such as user settings or a GitHub policy. | ||
| InteractionAbilityExpiresAt | Datetime | The expiration timestamp of the active interaction limit, indicating when the restriction will be lifted. | ||
| HasSponsorsListing | Bool | Indicates whether the user or organization has a public listing on GitHub Sponsors to receive financial support. | ||
| MonthlyEstimatedSponsorsIncomeInCents | Int | The estimated monthly income (in cents USD) that the user or organization receives through GitHub Sponsors. | ||
| EstimatedNextSponsorsPayoutInCents | Int | The estimated payout (in cents USD) the user or organization will receive from GitHub Sponsors during the next disbursement. | ||
| SponsorsListingId | String | The unique identifier of the GitHub Sponsors listing associated with the user or organization. | ||
| SponsorsListingName | String | The full name of the GitHub Sponsors listing for the user or organization. | ||
| TotalSponsorshipAmountAsSponsorInCents | Int | The total amount (in cents USD) the user or organization has spent sponsoring other GitHub users or projects. | ||
| ResourcePath | String | The relative HTTP path that leads to this user's profile resource in the GitHub API. | ||
| ProjectsResourcePath | String | The relative HTTP path listing the user's projects available through the GitHub API. | ||
| Url | String | The full HTTP URL pointing to the user's public GitHub profile. | ||
| ProjectsUrl | String | The full HTTP URL listing the user's GitHub projects. | ||
| WebsiteUrl | String | A URL pointing to the user's personal or professional website or blog, if available. | ||
| AvatarUrl | String | A URL pointing to the user's avatar image on GitHub. The 'size' parameter can be specified to adjust the image resolution. | ||
| CopilotEndpointsApi | String | The API endpoint used for GitHub Copilot services, providing access to Copilot features. | ||
| CopilotEndpointsOriginTracker | String | The endpoint for tracking the origin of requests made to GitHub Copilot services. | ||
| CopilotEndpointsProxy | String | The proxy endpoint used for routing requests made to GitHub Copilot services. | ||
| CopilotEndpointsTelemetry | String | The endpoint used for sending telemetry data related to GitHub Copilot usage. | ||
| CreatedAt | Datetime | The timestamp when this user's GitHub profile or object was created. | ||
| UpdatedAt | Datetime | The timestamp when the user's GitHub profile or object was last updated. | ||
| RepositoryCount | Int | The total number of repositories that the user owns on GitHub. | ||
| FollowerCount | Int | The total number of users who are following this user on GitHub. | ||
| Permission | String | The level of permission granted to the user for the repository, such as 'read', 'write', or 'admin'. | ||
| RepositoryId | String | The unique identifier for the repository that the user has access to. |
Tracks comments made on specific commits, providing insights into discussions and feedback related to code changes.
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server-side:
SELECT * FROM [CommitComments]
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | A unique identifier for the commit comment, used for referencing it within the system. | ||
| DatabaseId | Int | The primary key for this commit comment in the database. | ||
| Body | String | The content of the comment, written in Markdown format for formatting flexibility. | ||
| BodyText | String | The body of the comment, rendered as plain text, with Markdown removed. | ||
| BodyHTML | String | The body of the comment, rendered as HTML, preserving Markdown formatting for web display. | ||
| Author | String | The username of the individual who authored the comment on the commit. | ||
| AuthorAssociation | String | Describes the author's relationship to the subject of the comment (for example, 'OWNER', 'COLLABORATOR'). | ||
| Editor | String | The username of the person who last edited the comment, if applicable. | ||
| IsMinimized | Bool | Indicates whether the comment has been minimized (that is, collapsed) for display purposes. | ||
| MinimizedReason | String | Provides a reason for why the comment was minimized, if available. | ||
| CreatedViaEmail | Bool | Indicates whether the comment was created by replying to an email notification from GitHub. | ||
| IncludesCreatedEdit | Bool | Indicates whether the comment was edited after it was initially created, with the creation data included. | ||
| ResourcePath | String | The relative HTTP path to access this specific comment resource in the GitHub API. | ||
| Url | String | The full HTTP URL where the comment can be accessed on GitHub. | ||
| LastEditedAt | Datetime | The timestamp of the most recent edit made to the comment. | ||
| PublishedAt | Datetime | The timestamp when the comment was originally published. | ||
| CreatedAt | Datetime | The timestamp when the comment object was created, including its first submission. | ||
| UpdatedAt | Datetime | The timestamp when the comment was last updated, reflecting changes to its content or metadata. | ||
| ViewerDidAuthor | Bool | Indicates whether the current viewer authored this comment. | ||
| ViewerCanDelete | Bool | Indicates whether the current viewer has permission to delete this comment. | ||
| ViewerCanMinimize | Bool | Indicates whether the current viewer can minimize this comment to hide it. | ||
| ViewerCanReact | Bool | Indicates whether the viewer is allowed to react (for example, thumbs up or thumbs down) to this comment. | ||
| ViewerCanUpdate | Bool | Indicates whether the current viewer has permission to edit or update this comment. | ||
| ViewerCannotUpdateReasons | String | Lists the reasons why the current viewer cannot update this comment, such as permission issues or content restrictions. | ||
| ReactionGroups | String | A list of grouped reactions (for example, thumbs up, thumbs down) left by users on this comment. | ||
| ViewerId | String | The unique identifier for the viewer who is accessing or interacting with the comment. | ||
| CommitId | String |
Commits.Id | The unique identifier for the commit associated with the comment, if applicable. | |
| Path | String | The file path that the comment refers to within the commit's changes. | ||
| Position | Int | The line number or position within the file where the comment is associated. |
Stores a detailed list of commits generated from a comparison of two references, such as branches or tags.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:
For example, the following query is processed server-side:
SELECT * FROM [CommitCompare] WHERE [Base] = 'Val1' AND [Head] = 'Val2'
The Sync App processes other filters client-side within the Sync App.
| Name | Type | References | OrderBySupport | Description |
| Type [KEY] | String | The type of the commit, indicating its purpose or classification (for example, 'merge', 'update', 'feature'). | ||
| Id [KEY] | String |
Commits.Id | The unique node ID associated with this commit, used for internal reference within the system. | |
| Oid | String |
Commits.Oid | The unique SHA identifier for the commit, representing a cryptographic hash of the commit's contents. | |
| Url | String | The URL used to access the commit details via the GitHub API. | ||
| HtmlUrl | String | The URL to view this commit directly in a web browser on GitHub. | ||
| CommentsUrl | String | The URL for accessing any comments associated with this commit. | ||
| CommentCount | Int | The number of comments currently made on this commit, indicating user interaction. | ||
| TreeSha | String | The SHA hash of the tree object associated with this commit, identifying the directory structure at the time of the commit. | ||
| TreeUrl | String | The URL for accessing the tree structure (that is, the files and directories) related to this commit. | ||
| GitUrl | String | The URL that provides access to Git-specific information about the commit, often used for Git operations. | ||
| Message | String | The commit message provided by the author, summarizing the changes made in this commit. | ||
| AuthorName | String | The name of the person who authored the commit. | ||
| AuthorEmail | String | The email address of the author who made the commit, often used for contact or attribution. | ||
| AuthorLogin | String | The GitHub username of the commit author, used to reference the author within the GitHub platform. | ||
| AuthorId | Int | A unique identifier assigned to the author within GitHub's database. | ||
| AuthorNodeId | String | The unique node ID assigned to the author, used internally by GitHub for reference. | ||
| AuthorAvatarUrl | String | The URL pointing to the author's avatar image, displayed on their profile or commit history. | ||
| AuthorGravatarId | String | The Gravatar ID associated with the author, used for avatar management across various services. | ||
| AuthorUrl | String | The API URL for accessing the author's GitHub profile data programmatically. | ||
| AuthorHtmlUrl | String | The HTML URL that leads to the author's profile page on GitHub, where their repositories and contributions can be viewed. | ||
| AuthorFollowersUrl | String | The URL for accessing the list of followers of the author, showing their connections within GitHub. | ||
| AuthorFollowingUrl | String | The URL for accessing the list of users the author is following, which indicates their network and collaboration links. | ||
| AuthorGistsUrl | String | The URL for accessing the author's public gists, which are small code snippets or files shared within GitHub. | ||
| AuthorStarredUrl | String | The URL for accessing the repositories that the author has starred, indicating their favorite or most important projects. | ||
| AuthorSubscriptionsUrl | String | The URL for accessing the author's subscription list, showing the repositories or users they are subscribed to for notifications. | ||
| AuthorOrganizationsUrl | String | The URL for accessing the organizations that the author belongs to, useful for viewing their team collaborations. | ||
| AuthorReposUrl | String | The URL for accessing the author's repositories, where all their contributed or owned repositories are listed. | ||
| AuthorEventsUrl | String | The URL for accessing the events generated by the author, such as push events, pull requests, etc. | ||
| AuthorReceivedEventsUrl | String | The URL for accessing events received by the author, such as comments or mentions by others. | ||
| AuthorType | String | Indicates the type of the author, such as 'User' or 'Organization'. | ||
| AuthorSiteAdmin | Bool | Indicates whether the author is a GitHub site administrator, providing them with elevated access and privileges within the platform. | ||
| AuthorStarredAt | Datetime | The timestamp when the author starred this repository, indicating their interest or endorsement of the repository. | ||
| AuthorDate | Datetime | The date and time when the commit was authored, reflecting when the changes were initially made. | ||
| CommitterName | String | The name of the committer who finalized the commit, potentially different from the author if they are distinct individuals. | ||
| CommitterEmail | String | The email address of the committer, providing a point of contact for the person who made the commit. | ||
| CommitterLogin | String | The GitHub username of the committer, used to identify them within GitHub. | ||
| CommitterId | Int | The unique identifier of the committer within GitHub's database, used for internal referencing. | ||
| CommitterNodeId | String | The unique node ID assigned to the committer, a system-wide identifier used in GitHub's infrastructure. | ||
| CommitterAvatarUrl | String | The URL pointing to the committer's avatar image, used to visually identify them across the platform. | ||
| CommitterGravatarId | String | The Gravatar ID associated with the committer, used for cross-service avatar management. | ||
| CommitterUrl | String | The API URL for accessing the committer's profile data, useful for automated tools and integrations. | ||
| CommitterHtmlUrl | String | The HTML URL that leads to the committer's public profile on GitHub. | ||
| CommitterFollowersUrl | String | The URL to view the list of followers of the committer, indicating their network within GitHub. | ||
| CommitterFollowingUrl | String | The URL to view the list of users that the committer is following, indicating their interests and collaborations. | ||
| CommitterGistsUrl | String | The URL to access the committer's public gists, which are shared snippets of code or documentation. | ||
| CommitterStarredUrl | String | The URL for accessing repositories that the committer has starred, indicating their favorite or noteworthy projects. | ||
| CommitterSubscriptionsUrl | String | The URL for accessing the committer's subscription list, showing repositories or users they are subscribed to for notifications. | ||
| CommitterOrganizationsUrl | String | The URL to access the organizations the committer belongs to, providing information about their professional associations. | ||
| CommitterReposUrl | String | The URL for accessing the committer's repositories, which lists all the repositories they own or contribute to. | ||
| CommitterEventsUrl | String | The URL for accessing events that the committer has performed, such as pushes or pull requests. | ||
| CommitterReceivedEventsUrl | String | The URL for accessing events received by the committer, like comments or mentions from others. | ||
| CommitterType | String | Indicates the type of the committer (for example, 'User', 'Bot', or 'Organization'). | ||
| CommitterSiteAdmin | Bool | Indicates whether the committer has site administrator privileges on GitHub, providing them with special access and control. | ||
| CommitterStarredAt | Datetime | The timestamp when the committer starred this repository, showing their personal endorsement of the repository. | ||
| CommitterDate | Datetime | The date and time when the commit was actually made, reflecting when the changes were committed to the repository. | ||
| VerificationVerified | Bool | Indicates whether the commit has been verified, confirming the authenticity of the commit's source. | ||
| VerificationReason | String | The reason explaining why the commit was or was not verified, such as security or trust issues. | ||
| VerificationPayload | String | The payload used during the commit verification process, providing technical details related to the verification process. | ||
| VerificationSignature | String | The cryptographic signature used for verifying the commit, ensuring the integrity and origin of the changes. | ||
| StatsAdditions | Int | The number of lines of code added in this commit, indicating the extent of new content introduced. | ||
| StatsDeletions | Int | The number of lines of code deleted in this commit, showing the scope of changes that removed content. | ||
| StatsTotal | Int | The total number of lines changed in this commit, which is the sum of both added and deleted lines. | ||
| Parents | String | The list of parent commits for this commit, representing the commit history leading up to the current commit. Multiple parents indicate a merge commit. | ||
| Base | String | The ref (branch, tag, or commit hash) that serves as the base for a comparison, representing the starting point in the comparison between two commits. | ||
| Head | String | The ref (branch, tag, or commit hash) that serves as the head for a comparison, representing the endpoint in the comparison between two commits. |
Tracks files modified during a comparison between two references, providing details on up to 300 changed files for review.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:
For example, the following query is processed server-side:
SELECT * FROM [CommitCompareFiles] WHERE [Base] = 'Val1' AND [Head] = 'Val2'
The Sync App processes other filters client-side within the Sync App.
| Name | Type | References | OrderBySupport | Description |
| Sha [KEY] | String | The SHA (Secure Hash Algorithm) of the file, uniquely identifying the file's content in the repository. | ||
| FileName | String | The name of the file that was changed in the commit. | ||
| Additions | Int | The number of lines added to the file in this commit. | ||
| Deletions | Int | The number of lines deleted from the file in this commit. | ||
| Changes | Int | The total number of changes made to the file, including additions and deletions. | ||
| Status | String | The status of the file in the commit, such as 'modified', 'added', or 'removed'. | ||
| BlobUrl | String | A URL linking to the file in blob format, representing the file's content at the time of the commit. | ||
| RawUrl | String | A direct URL linking to the raw content of the file, allowing users to view the file as plain text. | ||
| ContentsUrl | String | A URL linking to the file served by the content management system, providing access to the file's content. | ||
| Patch | String | A diff-format representation of the changes made to the file, showing additions and deletions. | ||
| PreviousFileName | String | The name of the file before any changes were made in this commit, if applicable (for example, in renaming). | ||
| Base | String | The ref (branch, tag, or commit hash) that serves as the starting point for a comparison between the file versions. | ||
| Head | String | The ref (branch, tag, or commit hash) that serves as the endpoint for a comparison between the file versions. |
Details files modified in specific commits, including filenames, change types (for example, added, deleted, modified), and related metadata.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following column and operators:
For example, the following queries are processed server-side:
SELECT * FROM [CommitFiles]
SELECT * FROM [CommitFiles] WHERE [CommitOid] = 'Val1'
The Sync App processes other filters client-side within the Sync App.
| Name | Type | References | OrderBySupport | Description |
| CommitId [KEY] | String |
Commits.Id | The node ID of the commit, uniquely identifying the commit in the repository history. | |
| CommitOid | String |
Commits.Oid | The SHA (Secure Hash Algorithm) of the commit, which serves as a unique identifier for this commit. | |
| Sha [KEY] | String | The SHA of the file, uniquely identifying the file's content in the commit. | ||
| FileName | String | The name of the file that was modified in the commit. | ||
| Additions | Int | The number of lines added to the file in this commit. | ||
| Deletions | Int | The number of lines deleted from the file in this commit. | ||
| Changes | Int | The total number of changes made to the file, including both additions and deletions. | ||
| Status | String | The status of the file after the commit, such as 'modified', 'added', or 'removed'. | ||
| BlobUrl | String | A URL linking to the file in blob format, which represents the file's content at the time of the commit. | ||
| RawUrl | String | A direct URL linking to the raw content of the file, allowing access to the file as plain text. | ||
| ContentsUrl | String | A URL linking to the file served by the content management system, providing access to the file's content. | ||
| Patch | String | A diff representation of the changes made to the file, showing additions and deletions. | ||
| PreviousFileName | String | The name of the file before it was changed in this commit, applicable in case of renaming. |
Contains metadata for commits in a repository, including author information, timestamps, and commit messages for version tracking.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM [Commits]
SELECT * FROM [Commits] WHERE [BranchName] = 'Val1'
SELECT * FROM [Commits] WHERE [CommittedDate] = '2023-01-01 11:10:00'
The Sync App processes other filters client-side within the Sync App.
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | The unique identifier for the commit. | ||
| Oid | String | The Git object ID, uniquely identifying this commit in the Git repository. | ||
| AbbreviatedOid | String | An abbreviated version of the Git object ID, commonly used for easier reference. | ||
| BranchName [KEY] | String |
Branches.Name | The name of the branch where the commit was made. | |
| ChangedFilesIfAvailable | Int | The number of files changed in this commit. Returns 'null' if the number can't be calculated. | ||
| Additions | Int | The total number of lines added in this commit. | ||
| Deletions | Int | The total number of lines removed in this commit. | ||
| AuthoredByCommitter | Bool | Indicates whether the author and the committer of this commit are the same. | ||
| CommittedViaWeb | Bool | Indicates whether this commit was made through GitHub's web UI. | ||
| AuthoredDate | Datetime | The date and time when this commit was authored. | ||
| CommittedDate | Datetime | The date and time when this commit was actually committed. | ||
| ViewerSubscription | String | Indicates the subscription status of the viewer (for example, watching, not watching, ignoring) for this commit's repository. | ||
| ViewerCanSubscribe | Bool | Indicates whether the viewer has the ability to change their subscription status for the repository. | ||
| Message | String | The main message or description of the changes made in this commit. | ||
| MessageBody | String | The full body text of the commit message. | ||
| MessageHeadline | String | The headline or short summary of the commit message. | ||
| MessageBodyHTML | String | The body of the commit message rendered as HTML. | ||
| MessageHeadlineHTML | String | The headline of the commit message rendered as HTML. | ||
| ResourcePath | String | The HTTP path for this specific commit. | ||
| CommitResourcePath | String | The HTTP path for the Git object associated with this commit. | ||
| TreeResourcePath | String | The HTTP path for accessing the tree structure of the commit. | ||
| Url | String | The HTTP URL that leads to this commit's page. | ||
| CommitUrl | String | The URL for accessing this specific Git object in the repository. | ||
| TarballUrl | String | The URL to download a tarball archive of the repository. (Links expire after five minutes for private repositories.) | ||
| TreeUrl | String | The HTTP URL for accessing the tree structure of this commit. | ||
| ZipballUrl | String | The URL to download a zipball archive of the repository. (Links expire after five minutes for private repositories.) | ||
| AuthorName | String | The name of the author who authored the commit. | ||
| AuthorEmail | String | The email address of the commit author. | ||
| AuthorDate | Datetime | The timestamp when the commit was authored (Git action). | ||
| AuthorUserLogin | String | The GitHub username corresponding to the email address associated with this commit. Null if no user is found. | ||
| CommitterName | String | The name of the committer who committed the changes. | ||
| CommitterEmail | String | The email address of the person who committed the changes. | ||
| CommitterDate | Datetime | The timestamp indicating when the commit was committed. | ||
| CommitterUserLogin | String | The GitHub username corresponding to the email address of the committer. Null if no user is found. | ||
| OnBehalfOfId | String | The unique ID of the organization this commit was made on behalf of. | ||
| OnBehalfOf | String | The login name of the organization this commit was made on behalf of. | ||
| SignatureIsValid | Bool | Indicates whether the commit's signature is valid and verified by GitHub. | ||
| Signature | String | The ASCII-armored signature header used in this commit. | ||
| SignatureEmail | String | The email address associated with the signature for this commit. | ||
| SignaturePayload | String | The payload used for the GPG signature. Represents the raw ODB object without the signature header. | ||
| SignatureState | String | The state of the signature. 'VALID' indicates that the signature is valid, and other states indicate why the signature is considered invalid. | ||
| SignatureSigner | String | The GitHub username of the person who signed this commit. | ||
| WasSignedByGitHub | Bool | Indicates whether the commit was signed using GitHub's signing key. | ||
| StatusId | String | The unique ID of the commit status associated with this commit. | ||
| StatusState | String | The overall status of the commit, combining various checks and statuses. | ||
| StatusCheckRollupId | String | The unique ID for the Check and Status rollup associated with this commit. | ||
| StatusCheckRollupState | String | The combined state of the Check and Status rollup for this commit. | ||
| TreeId | String | The unique ID of the root tree object for this commit. | ||
| TreeOid | String | The Git object ID of the tree associated with this commit. | ||
| TreeAbbreviatedOid | String | An abbreviated version of the Git object ID of the tree. | ||
| TreeCommitUrl | String | The HTTP URL to view the tree object associated with this commit. | ||
| TreeCommitResourcePath | String | The HTTP path to access the tree object associated with this commit. |
Provides metadata about forks created from a repository, including fork ownership and purpose, to support collaboration and innovation.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM [Forks]
SELECT * FROM [Forks] WHERE [HasIssuesEnabled] = true
SELECT * FROM [Forks] WHERE [IsLocked] = true
SELECT * FROM [Forks] WHERE [IsPrivate] = true
SELECT * FROM [Forks] WHERE [Visibility] = 'PRIVATE'
The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions that are built with the following columns:
SELECT * FROM [Forks] ORDER BY [Name]
SELECT * FROM [Forks] ORDER BY [StargazerCount]
SELECT * FROM [Forks] ORDER BY [CreatedAt]
SELECT * FROM [Forks] ORDER BY [UpdatedAt]
SELECT * FROM [Forks] ORDER BY [PushedAt]
The Sync App uses client-side processing when ordering by any other columns. This impacts performance.
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | The unique identifier assigned to the fork. | ||
| ForkOwnerLogin | String | The login name of the user or organization that owns the fork. | ||
| Name | String | The name of the fork. | ||
| Description | String | A brief description of the fork. | ||
| DescriptionHTML | String | The HTML version of the fork description. | ||
| HasIssuesEnabled | Bool | Indicates if the 'Issues' feature is enabled for this fork. | ||
| IsLocked | Bool | Indicates whether the fork is locked (true or false). | ||
| IsPrivate | Bool | Identifies whether the fork is private (true) or public (false). | ||
| Visibility | String | The visibility level of the fork (for example, 'public', 'private').
The allowed values are PRIVATE, PUBLIC, INTERNAL. | ||
| ForkCount | Int | The total number of forks that this fork has in the entire network. | ||
| StargazerCount | Int | The number of stargazers who have starred this fork. | ||
| ForkingAllowed | Bool | Indicates whether forking is allowed for this fork. | ||
| Url | String | The HTTP URL that points to the fork. | ||
| MirrorUrl | String | The mirror URL for this fork, if applicable. | ||
| CreatedAt | Datetime | The date and time when the fork was created. | ||
| UpdatedAt | Datetime | The date and time when the fork was last updated. | ||
| PushedAt | Datetime | The date and time when the fork was last pushed to. |
Tracks users assigned to issues within a repository, detailing responsibilities and roles for task ownership.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following column and operators:
For example, the following queries are processed server-side:
SELECT * FROM [IssueAssignees]
SELECT * FROM [IssueAssignees] WHERE [IssueNumber] = 123
The Sync App processes other filters client-side within the Sync App.
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | The unique ID of the user assigned to the issue. | ||
| DatabaseId | Int | The primary key for the user in the database. | ||
| Login | String | The username that is used by the user to login. | ||
| Name | String | The user's public profile name. | ||
| String | The user's publicly visible profile email. | |||
| TwitterUsername | String | The user's Twitter username. | ||
| Pronouns | String | The user's profile pronouns. | ||
| Bio | String | The user's public profile bio. | ||
| BioHTML | String | The user's public profile bio rendered in HTML. | ||
| Company | String | The company listed in the user's public profile. | ||
| CompanyHTML | String | The user's company name rendered in HTML. | ||
| Location | String | The location of the user as listed on their public profile. | ||
| AnyPinnableItems | Bool | Indicates whether the repository owner has any items that can be pinned to their profile. | ||
| PinnedItemsRemaining | Int | The number of items that the profile owner can still pin. | ||
| ItemShowcaseHasPinnedItems | Bool | Indicates whether the owner has any pinned repositories or gists. | ||
| IsEmployee | Bool | Indicates whether the user is a GitHub employee. | ||
| IsHireable | Bool | Indicates whether the user has marked themselves as available for hire. | ||
| IsBountyHunter | Bool | Indicates whether the user participates in the GitHub Security Bug Bounty program. | ||
| IsCampusExpert | Bool | Indicates whether the user is a part of the GitHub Campus Experts Program. | ||
| IsFollowingViewer | Bool | Indicates whether the user is following the viewer. This is the inverse of viewerIsFollowing. | ||
| IsSiteAdmin | Bool | Indicates whether the user is a GitHub site administrator. | ||
| IsDeveloperProgramMember | Bool | Indicates whether the user is a member of the GitHub Developer Program. | ||
| IsGitHubStar | Bool | Indicates whether the user is a member of the GitHub Stars Program. | ||
| IsSponsoringViewer | Bool | Indicates whether the viewer is sponsored by this user or organization. | ||
| IsViewer | Bool | Indicates whether this user is the viewer. | ||
| ViewerCanFollow | Bool | Indicates whether the viewer is able to follow this user. | ||
| ViewerCanSponsor | Bool | Indicates whether the viewer is able to sponsor this user or organization. | ||
| ViewerIsFollowing | Bool | Indicates whether the viewer is following this user. | ||
| ViewerIsSponsoring | Bool | Indicates whether the viewer is sponsoring this user or organization. | ||
| ViewerCanCreateProjects | Bool | Indicates whether the current viewer can create new projects on this owner's account. | ||
| ViewerCanChangePinnedItems | Bool | Indicates whether the viewer can pin repositories and gists to their profile. | ||
| StatusId | String | The ID associated with the user's status emoji. | ||
| StatusEmoji | String | An emoji representing the user's current status. | ||
| StatusMessage | String | A brief message describing what the user is currently doing. | ||
| StatusIndicatesLimitedAvailability | Bool | Indicates whether the user's status signifies limited availability on GitHub. | ||
| StatusEmojiHTML | String | The HTML representation of the status emoji. | ||
| StatusCreatedAt | Datetime | The date and time when the status was created. | ||
| StatusExpiresAt | Datetime | The expiration date of the status. The status is not shown after this date. | ||
| StatusUpdatedAt | Datetime | The date and time when the status was last updated. | ||
| StatusOrganizationId | String | The ID of the organization associated with the user's status. | ||
| StatusOrganizationLogin | String | The login name of the organization associated with the status. | ||
| InteractionAbilityLimit | String | Describes the current interaction limit imposed on this object. | ||
| InteractionAbilityOrigin | String | Indicates the source or origin of the active interaction limit. | ||
| InteractionAbilityExpiresAt | Datetime | The time when the current interaction limit expires. | ||
| HasSponsorsListing | Bool | Indicates whether the user or organization has a GitHub Sponsors listing. | ||
| MonthlyEstimatedSponsorsIncomeInCents | Int | The estimated monthly income from GitHub Sponsors for this user or organization, in cents (USD). | ||
| EstimatedNextSponsorsPayoutInCents | Int | The estimated amount of the next GitHub Sponsors payout, in cents (USD). | ||
| SponsorsListingId | String | The ID of the GitHub Sponsors listing. | ||
| SponsorsListingName | String | The full name of the GitHub Sponsors listing. | ||
| TotalSponsorshipAmountAsSponsorInCents | Int | The total amount spent by the user/organization on GitHub Sponsors, in cents (USD). This value is only available for users who can manage sponsorships. | ||
| ResourcePath | String | The HTTP path for this user. | ||
| ProjectsResourcePath | String | The HTTP path listing the user's projects. | ||
| Url | String | The HTTP URL for this user's profile. | ||
| ProjectsUrl | String | The HTTP URL listing the user's projects. | ||
| WebsiteUrl | String | A URL pointing to the user's public website or blog. | ||
| AvatarUrl | String | A URL pointing to the user's public avatar. The 'size' argument specifies the size of the resulting square image. | ||
| CopilotEndpointsApi | String | The API endpoint for Copilot services. | ||
| CopilotEndpointsOriginTracker | String | The endpoint used for Copilot's origin tracking. | ||
| CopilotEndpointsProxy | String | The proxy endpoint used for Copilot services. | ||
| CopilotEndpointsTelemetry | String | The telemetry endpoint used by Copilot for data tracking. | ||
| CreatedAt | Datetime | The date and time when the object was created. | ||
| UpdatedAt | Datetime | The date and time when the object was last updated. | ||
| RepositoryCount | Int | The total number of repositories owned by the user. | ||
| FollowerCount | Int | The total number of followers the user has. | ||
| IssueNumber [KEY] | Int |
Issues.Number | The issue number associated with the assignee. |
Connects issues to related pull requests, allowing traceability between reported problems and their solutions.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM [IssuePullRequests]
SELECT * FROM [IssuePullRequests] WHERE [IssueNumber] = 123
SELECT * FROM [IssuePullRequests] WHERE [UserLinkedOnly] = true
SELECT * FROM [IssuePullRequests] WHERE [ExcludeClosedPullRequests] = true
The Sync App processes other filters client-side within the Sync App.
| Name | Type | References | OrderBySupport | Description |
| IssueId [KEY] | String |
Issues.Id | The unique identifier for an issue within the repository. | |
| IssueNumber | Int |
Issues.Number | The sequential number assigned to an issue within the repository. | |
| IssueAuthor | String | The username of the user who created the issue. | ||
| IssueState | String | The current state of the issue, such as open, closed, or draft. | ||
| IssueTitle | String | The title summarizing the issue's purpose or content. | ||
| IssueLastEditedAt | Datetime | The date and time when the issue was last edited by any user. | ||
| IssuePublishedAt | Datetime | The date and time when the issue was first published. | ||
| IssueClosedAt | Datetime | The date and time when the issue was marked as closed. | ||
| IssueUpdatedAt | Datetime | The most recent date and time the issue's content or metadata was updated. | ||
| IssueCreatedAt | Datetime | The date and time when the issue was initially created. | ||
| PullRequestId [KEY] | String |
PullRequests.Id | The unique identifier for a pull request within the repository. | |
| PullRequestNumber | Int |
PullRequests.Number | The sequential number assigned to a pull request within the repository. | |
| PullRequestState | String | The current state of the pull request, such as open, closed, or merged. | ||
| PullRequestAuthor | String | The username of the user who created the pull request. | ||
| PullRequestTitle | String | The title summarizing the pull request's purpose or changes. | ||
| PullRequestReviewDecision | String | The current review status of the pull request, such as approved or changes requested. | ||
| PullRequestMergeable | String | Indicates whether the pull request can be merged, considering potential merge conflicts. | ||
| PullRequestLastEditedAt | Datetime | The date and time when the pull request was last edited by any user. | ||
| PullRequestMergedAt | Datetime | The date and time when the pull request was successfully merged. | ||
| PullRequestClosedAt | Datetime | The date and time when the pull request was marked as closed. | ||
| PullRequestPublishedAt | Datetime | The date and time when the pull request was first published. | ||
| PullRequestUpdatedAt | Datetime | The most recent date and time the pull request's content or metadata was updated. | ||
| PullRequestCreatedAt | Datetime | The date and time when the pull request was initially created. | ||
| UserLinkedOnly | Bool | Filters results to include only pull requests manually linked to issues. | ||
| ExcludeClosedPullRequests | Bool | Filters results to exclude pull requests that are closed. |
Maintains a catalog of labels available in a repository, enabling effective categorization and filtering of issues and pull requests.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following column and operators:
For example, the following queries are processed server-side:
SELECT * FROM [Labels]
SELECT * FROM [Labels] WHERE [Name] = 'Val1'
The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions that are built with the following columns:
SELECT * FROM [Labels] ORDER BY [Name]
SELECT * FROM [Labels] ORDER BY [CreatedAt]
The Sync App uses client-side processing when ordering by any other columns. This impacts performance.
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | A unique identifier for the label within the repository. | ||
| Name | String | The name of the label, used to categorize issues and pull requests. | ||
| Description | String | A short summary explaining the purpose or usage of the label. | ||
| Color | String | The hexadecimal color code representing the label's appearance. | ||
| IsDefault | Bool | Indicates whether this label is one of the repository's default labels. | ||
| ResourcePath | String | The relative HTTP path to access the label within the repository. | ||
| Url | String | The full HTTP URL to directly access the label. | ||
| UpdatedAt | Datetime | The date and time when the label was most recently updated. | ||
| CreatedAt | Datetime | The date and time when the label was originally created. |
Identifies users who can be mentioned in repository discussions, including issues, pull requests, and comments, based on permissions.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following column and operator:
For example, the following queries are processed server-side:
SELECT * FROM [MentionableUsers]
SELECT * FROM [MentionableUsers] WHERE [Login] = 'Val1'
The Sync App processes other filters client-side within the Sync App.
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | A unique identifier for the user within the GitHub platform. | ||
| DatabaseId | Int | The primary key of the user record in the GitHub database. | ||
| Login | String | The username the user uses to log in to GitHub. | ||
| Name | String | The public profile name of the user, as displayed on their GitHub account. | ||
| String | The user's publicly visible email address, if provided. | |||
| TwitterUsername | String | The user's Twitter username, if linked to their GitHub profile. | ||
| Pronouns | String | The pronouns the user has chosen for their public profile. | ||
| Bio | String | The user's brief description or bio displayed on their public profile. | ||
| BioHTML | String | The user's bio formatted in HTML for rendering on their profile. | ||
| Company | String | The company the user publicly associates with on their profile. | ||
| CompanyHTML | String | The user's company name formatted in HTML for rendering. | ||
| Location | String | The location the user has provided on their GitHub profile. | ||
| AnyPinnableItems | Bool | Indicates whether the user has any repositories or other items that can be pinned to their profile. | ||
| PinnedItemsRemaining | Int | The number of additional items the user can pin to their profile. | ||
| ItemShowcaseHasPinnedItems | Bool | Indicates whether the user has pinned any repositories or gists to their profile. | ||
| IsEmployee | Bool | Indicates whether the user is a GitHub employee. | ||
| IsHireable | Bool | Indicates whether the user has marked themselves as available for hire. | ||
| IsBountyHunter | Bool | Indicates whether the user is a participant in the GitHub Security Bug Bounty program. | ||
| IsCampusExpert | Bool | Indicates whether the user is part of the GitHub Campus Experts Program. | ||
| IsFollowingViewer | Bool | Indicates whether the user is following the current viewer (inverse of viewerIsFollowing). | ||
| IsSiteAdmin | Bool | Indicates whether the user is a site administrator for GitHub. | ||
| IsDeveloperProgramMember | Bool | Indicates whether the user is a member of the GitHub Developer Program. | ||
| IsGitHubStar | Bool | Indicates whether the user is a member of the GitHub Stars Program. | ||
| IsSponsoringViewer | Bool | Indicates whether the viewer is being sponsored by this user or organization. | ||
| IsViewer | Bool | Indicates whether the current user is the viewer (that is, the user making the request). | ||
| ViewerCanFollow | Bool | Indicates whether the viewer can follow this user. | ||
| ViewerCanSponsor | Bool | Indicates whether the viewer can sponsor this user or organization. | ||
| ViewerIsFollowing | Bool | Indicates whether the viewer is currently following this user. | ||
| ViewerIsSponsoring | Bool | Indicates whether the viewer is sponsoring this user or organization. | ||
| ViewerCanCreateProjects | Bool | Indicates whether the current viewer can create new projects under this owner. | ||
| ViewerCanChangePinnedItems | Bool | Indicates whether the viewer has permission to pin repositories or gists to the owner's profile. | ||
| StatusId | String | The unique identifier for the user's status emoji. | ||
| StatusEmoji | String | The emoji representing the user's current status. | ||
| StatusMessage | String | A brief description of the user's current activity or status. | ||
| StatusIndicatesLimitedAvailability | Bool | Indicates whether the user's status suggests they are not fully available on GitHub. | ||
| StatusEmojiHTML | String | The status emoji represented as HTML code for embedding. | ||
| StatusCreatedAt | Datetime | The date and time when the user's status was created. | ||
| StatusExpiresAt | Datetime | The expiration date for the status, after which it is no longer be displayed. | ||
| StatusUpdatedAt | Datetime | The date and time when the user's status was last updated. | ||
| StatusOrganizationId | String | The unique identifier for the organization associated with the status, if applicable. | ||
| StatusOrganizationLogin | String | The login name of the organization associated with the status, if applicable. | ||
| InteractionAbilityLimit | String | The current interaction limit in place on this object, if any. | ||
| InteractionAbilityOrigin | String | The source of the active interaction limit on this object. | ||
| InteractionAbilityExpiresAt | Datetime | The date and time when the current interaction limit expires. | ||
| HasSponsorsListing | Bool | Indicates whether the user or organization has a GitHub Sponsors listing. | ||
| MonthlyEstimatedSponsorsIncomeInCents | Int | The estimated monthly income this user or organization receives through GitHub Sponsors, in cents (USD). | ||
| EstimatedNextSponsorsPayoutInCents | Int | The estimated amount this user or organization will receive in their next GitHub Sponsors payout, in cents (USD). | ||
| SponsorsListingId | String | The unique identifier for the GitHub Sponsors listing associated with this user or organization. | ||
| SponsorsListingName | String | The full name of the GitHub Sponsors listing. | ||
| TotalSponsorshipAmountAsSponsorInCents | Int | The total amount this user or organization has spent on GitHub sponsorships, in US cents. Only visible to the user themselves or those who can manage sponsorships. | ||
| ResourcePath | String | The relative HTTP path to access the user's profile. | ||
| ProjectsResourcePath | String | The relative HTTP path to access the user's project listings. | ||
| Url | String | The full HTTP URL to the user's GitHub profile. | ||
| ProjectsUrl | String | The full HTTP URL to the user's project listings. | ||
| WebsiteUrl | String | A URL pointing to the user's personal website or blog. | ||
| AvatarUrl | String | A URL pointing to the user's avatar image. | ||
| CopilotEndpointsApi | String | The API endpoint for GitHub Copilot. | ||
| CopilotEndpointsOriginTracker | String | The origin tracker endpoint for GitHub Copilot. | ||
| CopilotEndpointsProxy | String | The proxy endpoint for GitHub Copilot. | ||
| CopilotEndpointsTelemetry | String | The telemetry endpoint for GitHub Copilot. | ||
| CreatedAt | Datetime | Represents the exact date and time when the user or object was first created in the system. This field can be used to track the object's lifecycle or for filtering and sorting based on creation date. | ||
| UpdatedAt | Datetime | Represents the most recent date and time when the user or object was modified. It can be helpful for tracking changes, updates, or for identifying the last time the record was actively managed. | ||
| RepositoryCount | Int | Indicates how many repositories are currently owned by the user. This is a count of all repositories that have been created or forked by the user, providing insight into their activity level in terms of repository creation. | ||
| FollowerCount | Int | Displays the total number of followers associated with the user’s profile. This metric reflects the user’s popularity or influence within the GitHub community. |
Tracks individual pull requests in the merge queue, including their statuses and any pending actions for orderly processing.
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server-side:
SELECT * FROM [MergeQueueEntries]
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | Represents a unique identifier for the merge queue entry, ensuring each entry in the queue can be uniquely referenced or tracked. | ||
| RepositoryId | String | Specifies the unique identifier of the repository that this merge queue entry is associated with. This helps link the entry to a specific project or codebase. | ||
| RepositoryMergeQueueId | String | Indicates the unique identifier for the specific merge queue to which this entry belongs. This ties the entry to a particular queue within the repository for processing. | ||
| BaseCommitId | String | Represents the commit ID that corresponds to the base state of the branch before the merge operation begins. This provides a reference point for the changes being introduced. | ||
| EnqueuedAt | Datetime | The exact date and time when this merge queue entry was added. This timestamp is useful for tracking how long an entry has been waiting in the queue. | ||
| EstimatedTimeToMerge | Int | An estimate, in seconds, of the time required for this entry to be merged into the target branch. This helps prioritize entries based on expected merge times. | ||
| HeadCommitId | String | The commit ID representing the most recent changes made to the branch that is being merged. It shows the latest state of the branch being worked on. | ||
| Jump | Bool | Indicates whether this particular pull request is allowed to bypass the normal processing order in the merge queue. A value of 'true' means it can jump ahead of other entries. | ||
| Position | Int | Displays the current position of this merge queue entry within the queue. A lower number represents a higher priority for merging. | ||
| PullRequestId | String | The unique identifier for the pull request associated with this merge queue entry. It links the queue entry to a specific pull request in the repository. | ||
| Solo | Bool | Indicates whether this pull request needs to be deployed independently of other changes. If 'true', the pull request is merged without other concurrent changes. | ||
| State | String | Describes the current status of the merge queue entry. Common states include 'QUEUED' (waiting for processing), 'MERGING' (currently being merged), or 'FAILED' (an error occurred during the merge). |
Provides an overview of active merge queues in a repository, listing pull requests and their order for systematic integration.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following column and operators:
For example, the following queries are processed server-side:
SELECT * FROM [MergeQueues]
SELECT * FROM [MergeQueues] WHERE [Branch] = 'Val1'
The Sync App processes other filters client-side within the Sync App.
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | Represents a unique identifier for the merge queue, ensuring each merge queue can be distinctly referenced or tracked. | ||
| ResourcePath | String | Specifies the relative HTTP path to access the merge queue within the GitHub API. This allows interaction with the merge queue programmatically by specifying the appropriate API endpoint. | ||
| Branch | String |
Branches.Name | Indicates the name of the branch for which the merge queue is being retrieved. This is useful when managing queues for specific branches that need to be merged into the main codebase. | |
| Url | String | Provides the full HTTP URL to access the merge queue through the GitHub API. This is the complete web address used for interacting with the merge queue via HTTP requests. | ||
| RepositoryId | String | Specifies the unique identifier of the repository that this merge queue is associated with. It helps identify the repository to which the merge queue belongs within GitHub. | ||
| NextEntryEstimatedTimeToMerge | Int | Represents the estimated time, in seconds, for the next entry to be merged in the queue. This helps predict when the next merge operation will occur. |
Details milestones in a repository, including their goals, deadlines, and associated issues or pull requests for project tracking.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM [Milestones]
SELECT * FROM [Milestones] WHERE [Number] = 123
SELECT * FROM [Milestones] WHERE [State] = 'OPEN'
The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions that are built with the following columns:
SELECT * FROM [Milestones] ORDER BY [Number]
SELECT * FROM [Milestones] ORDER BY [DueOn]
SELECT * FROM [Milestones] ORDER BY [UpdatedAt]
SELECT * FROM [Milestones] ORDER BY [CreatedAt]
The Sync App uses client-side processing when ordering by any other columns. This impacts performance.
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | Represents a unique identifier for the milestone, ensuring it can be distinctly referenced or tracked within the project or repository. | ||
| Title | String | Specifies the title of the milestone, which typically summarizes its goal or intended outcome, such as 'Version 2.0 Release' or 'Bug Fixes'. This helps users quickly understand the focus of the milestone. | ||
| Closed | Bool | Indicates whether the milestone has been closed. The criteria for closure might differ depending on the specific project or repository, but a 'true' value signifies that the milestone is no longer active. | ||
| ProgressPercentage | Double | Represents the current completion progress of the milestone, shown as a percentage from 0 to 100. This value is typically calculated based on completed issues or tasks associated with the milestone. | ||
| Description | String | Provides a detailed description outlining the objectives, scope, or tasks related to the milestone. This offers further context for what needs to be achieved to consider the milestone complete. | ||
| Number | Int | A unique sequential number assigned to the milestone within the repository. This number helps identify milestones in the order they were created. | ||
| State | String | Describes the current status of the milestone. Common values include 'OPEN' (active and ongoing) or 'CLOSED' (completed and no longer active).
The allowed values are OPEN, CLOSED. | ||
| ResourcePath | String | Specifies the relative HTTP path used to access this milestone via the GitHub API. This is useful for API interactions and retrieving milestone data programmatically. | ||
| Url | String | Provides the full HTTP URL to directly access this milestone. This URL can be used to view the milestone details in a web browser or interact with the milestone via the API. | ||
| ViewerCanClose | Bool | Indicates whether the current user has the necessary permissions to close the milestone. A value of 'true' means the user can mark the milestone as closed. | ||
| ViewerCanReopen | Bool | Indicates whether the current user has the necessary permissions to reopen the milestone if it was previously closed. A value of 'true' means the user can reinitiate the milestone if needed. | ||
| DueOn | Datetime | Specifies the scheduled date and time by which the milestone is expected to be completed. This serves as a deadline for the milestone, helping teams manage expectations. | ||
| ClosedAt | Datetime | Represents the date and time when the milestone was officially closed. This timestamp is recorded once all tasks or objectives for the milestone are completed. | ||
| UpdatedAt | Datetime | Represents the date and time when the milestone was last modified. This helps track when changes, such as adjustments to scope or due dates, were made. | ||
| CreatedAt | Datetime | Specifies the date and time when the milestone was initially created, providing context for how long the milestone has been in progress. |
Records comments on pull requests, documenting feedback and discussions during the code review process.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following column and operators:
For example, the following queries are processed server-side:
SELECT * FROM [PullRequestComments]
SELECT * FROM [PullRequestComments] WHERE [PullRequestId] = 'Val1'
The Sync App processes other filters client-side within the Sync App.
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | Represents a unique identifier for the comment, allowing the comment to be distinctly referenced or tracked within the system. | ||
| Body | String | Contains the main content of the comment written in Markdown format, allowing for rich text, links, images, and other Markdown-supported elements. | ||
| BodyText | String | Contains the content of the comment rendered as plain text. This version strips away any formatting and is useful for simple text parsing or processing. | ||
| BodyHTML | String | Contains the content of the comment rendered as HTML, allowing for formatted text with applied styles, links, and other HTML elements. | ||
| Author | String | Specifies the username of the person who originally authored the comment. This identifies the contributor or reviewer who posted the comment. | ||
| AuthorAssociation | String | Describes the relationship between the author and the subject of the comment. Possible values include 'OWNER', 'COLLABORATOR', or 'CONTRIBUTOR', indicating the role of the author in relation to the repository. | ||
| Editor | String | Indicates the username of the person who last edited the comment. If the comment has been edited after its original post, this field shows the editor’s username. | ||
| IsMinimized | Bool | Indicates whether the comment has been minimized for any reason. A value of 'true' means the comment is minimized and is not fully visible to users by default. | ||
| MinimizedReason | String | Provides the reason why the comment was minimized, if applicable. This can be due to content moderation or other factors like spam or inappropriate content. | ||
| CreatedViaEmail | Bool | Indicates whether the comment was created via an email reply to a GitHub notification. A value of 'true' means the comment originated from email communication. | ||
| IncludesCreatedEdit | Bool | Indicates whether the comment includes an edit that was made at the time of creation. This field is useful for tracking whether the comment was edited right after it was created. | ||
| ResourcePath | String | Specifies the relative HTTP path to access this comment via the GitHub API. This allows for API interactions and programmatically retrieving the comment. | ||
| Url | String | Provides the full HTTP URL to access this comment directly on GitHub. This URL can be used to view the comment in a browser or to link directly to the comment. | ||
| LastEditedAt | Datetime | Represents the date and time when the comment was last edited. If the comment has been edited, this timestamp shows when the most recent change occurred. | ||
| PublishedAt | Datetime | Represents the date and time when the comment was originally published. This timestamp is recorded when the comment was first posted, before any potential edits. | ||
| CreatedAt | Datetime | Specifies the date and time when the comment was initially created. This is the moment the comment was first added to the thread or pull request. | ||
| UpdatedAt | Datetime | Represents the date and time when the comment was last updated, including any edits or changes to the comment’s content. | ||
| ViewerDidAuthor | Bool | Indicates whether the current viewer is the author of the comment. A value of 'true' means the viewer is the person who posted the comment. | ||
| ViewerCanDelete | Bool | Indicates whether the current viewer has permission to delete this comment. A value of 'true' means the viewer can remove the comment from the thread. | ||
| ViewerCanMinimize | Bool | Indicates whether the current viewer has permission to minimize this comment. A value of 'true' means the viewer can collapse the comment to reduce its visibility. | ||
| ViewerCanReact | Bool | Indicates whether the viewer can react to the comment using emoji or other reactions. A value of 'true' means the viewer can add a reaction to the comment. | ||
| ViewerCanUpdate | Bool | Indicates whether the current viewer has permission to update or edit this comment. A value of 'true' means the viewer is allowed to modify the comment. | ||
| ViewerCannotUpdateReasons | String | A list of reasons why the current viewer cannot update this comment, if applicable. This can include restrictions like 'permission denied' or 'comment is locked'. | ||
| IssueId | String | Represents the ID of the issue associated with the comment, if the comment was made on an issue. This links the comment to a specific issue within the repository. | ||
| PullRequestId | String | Represents the ID of the pull request associated with the comment, if the comment was made on a pull request. This links the comment to a specific pull request being discussed or reviewed. | ||
| FullDatabaseId | Long | Represents a unique identifier for the comment in the database, stored as a BigInt. This ID is used internally within GitHub to reference the comment in the database. |
Provides a list of commits included in pull requests, detailing the changes introduced and the commits' authors.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following column and operators:
For example, the following queries are processed server-side:
SELECT * FROM [PullRequestCommits]
SELECT * FROM [PullRequestCommits] WHERE [PullRequestNumber] = 123
The Sync App processes other filters client-side within the Sync App.
| Name | Type | References | OrderBySupport | Description |
| Id | String | Represents the unique identifier for the commit, which can be used to reference or track the commit within the GitHub repository. | ||
| Oid | String | Represents the Git object ID, a globally unique identifier for the commit in the Git repository, used for identifying commits in Git operations. | ||
| AbbreviatedOid | String | A shortened version of the Git object ID, used for easier display and reference in user interfaces where a full ID is not necessary. | ||
| ChangedFilesIfAvailable | Int | Represents the number of files changed in this commit. If the number cannot be determined (for example, due to timeouts), the field returns 'null'. It is the preferred field to use over 'changedFiles'. | ||
| Additions | Int | Indicates the number of lines added in this commit. This provides insight into the extent of code changes made. | ||
| Deletions | Int | Indicates the number of lines deleted in this commit. This gives an idea of how much code was removed in the commit. | ||
| AuthoredByCommitter | Bool | Indicates whether the author of the commit is the same as the committer. If 'true', the author and the committer are the same person. | ||
| CommittedViaWeb | Bool | Indicates whether the commit was made through GitHub’s web interface, rather than through a Git client. | ||
| AuthoredDate | Datetime | Represents the date and time when the commit was authored, based on the author’s local machine settings at the time of creation. | ||
| CommittedDate | Datetime | Represents the date and time when the commit was actually committed, based on the commit timestamp recorded by the Git system. | ||
| ViewerSubscription | String | Indicates the viewer's current subscription status for the entity, such as 'WATCHING', 'NOT WATCHING', or 'IGNORING'. This allows for tracking user interest. | ||
| ViewerCanSubscribe | Bool | Indicates whether the viewer can change their subscription status for the repository, allowing the viewer to adjust their notifications preferences. | ||
| Message | String | Contains the full commit message associated with the commit, which might include both the headline and the detailed description of the changes. | ||
| MessageBody | String | The body of the commit message, providing a detailed explanation of the changes made in the commit to help reviewers understand the modifications. | ||
| MessageHeadline | String | The headline or summary line of the commit message, usually a brief overview of the commit’s purpose or changes. | ||
| MessageBodyHTML | String | The body of the commit message rendered as HTML, which allows the message to be displayed with any HTML formatting applied. | ||
| MessageHeadlineHTML | String | The headline of the commit message rendered as HTML, providing a visually formatted summary of the commit changes. | ||
| ResourcePath | String | Specifies the relative HTTP path to access this commit via the GitHub API, enabling programmatic access to the commit details. | ||
| CommitResourcePath | String | Specifies the relative HTTP path for this Git object within the GitHub API, allowing access to detailed information about the specific commit object. | ||
| TreeResourcePath | String | Specifies the relative HTTP path to access the commit tree via the GitHub API. The tree represents the file structure as it was at the commit. | ||
| Url | String | Provides the full HTTP URL to access this commit directly on GitHub, allowing users to view the commit’s details in a browser. | ||
| CommitUrl | String | Provides the full HTTP URL for the specific Git object associated with the commit, enabling access to detailed information about the commit in the repository. | ||
| TarballUrl | String | The URL to download a tarball archive of the repository at the commit's state. For private repositories, the URL expires within five minutes. | ||
| TreeUrl | String | The full HTTP URL for accessing the tree structure of this commit, providing a way to view the file hierarchy of the commit’s changes. | ||
| ZipballUrl | String | The URL to download a zipball archive of the repository at the commit's state. This link is temporary and expires within five minutes for private repositories. | ||
| AuthorName | String | The name of the author as listed in the Git commit, identifying the individual who wrote the changes in the commit. | ||
| AuthorEmail | String | The email address of the commit author, which can be used for contact or identification purposes. | ||
| AuthorDate | Datetime | Represents the timestamp when the commit was authored, according to the author’s local machine settings and recorded in the commit. | ||
| AuthorUserLogin | String | The GitHub username associated with the author's email, or 'null' if no corresponding user is found on GitHub. | ||
| CommitterName | String | The name of the individual or bot who made the commit, as recorded in the Git commit metadata. | ||
| CommitterEmail | String | The email address associated with the committer, which is recorded in the Git commit metadata. | ||
| CommitterDate | Datetime | The date and time when the commit was created, representing when the commit was authored or committed, depending on the scenario. | ||
| CommitterUserLogin | String | The GitHub username linked to the committer's email address. If no matching user is found, the value is 'null'. | ||
| OnBehalfOfId | String | A unique identifier for the organization on whose behalf the commit was made, if applicable. | ||
| OnBehalfOf | String | The login name of the GitHub organization that is associated with the commit, if the commit was made on behalf of an organization. | ||
| SignatureIsValid | Bool | Indicates whether the commit's GPG signature is valid and verified by GitHub. A 'true' value means the signature is verified. | ||
| Signature | String | The ASCII-armored GPG signature associated with the commit, which is used to verify the commit's authenticity. | ||
| SignatureEmail | String | The email address used in the GPG signature, typically associated with the person or bot who signed the commit. | ||
| SignaturePayload | String | The raw data of the commit (without the GPG signature header) that was signed using GPG encryption. | ||
| SignatureState | String | The state of the GPG signature, such as 'VALID' if it has been successfully verified, or other values indicating why the signature failed verification. | ||
| SignatureSigner | String | The GitHub username of the individual or bot that signed the commit, matching the email used for signing. | ||
| WasSignedByGitHub | Bool | Indicates whether the commit was signed using GitHub's own GPG key, marking it as a trusted commit. | ||
| StatusId | String | A unique identifier for the status of the commit, which can be linked to external status checks such as continuous integration results. | ||
| StatusState | String | The combined status of the commit reflecting the success or failure of the commit as determined by status checks (for example, 'SUCCESS', 'ERROR'). | ||
| StatusCheckRollupId | String | A unique identifier for the aggregated status checks and results that apply to the commit. | ||
| StatusCheckRollupState | String | The overall result of the combined status checks and any additional validations, such as 'SUCCESS', 'FAILURE', etc. | ||
| TreeId | String | The unique identifier for the root tree object that represents the snapshot of the directory structure at the time of the commit. | ||
| TreeOid | String | The Git object ID representing the tree associated with the commit, which is a key part of the commit's internal structure. | ||
| TreeAbbreviatedOid | String | A shortened version of the full Git object ID for the tree associated with the commit, for easier reference. | ||
| TreeCommitUrl | String | The full URL for accessing the commit's tree object on GitHub, allowing access to the directory structure at that commit. | ||
| TreeCommitResourcePath | String | The relative path within the GitHub API to access the tree object, used for programmatic access to the commit's directory structure. | ||
| PullRequestCommitId [KEY] | String | A unique node ID identifying the specific commit within the context of the pull request, used for referencing this commit in the pull request. | ||
| PullRequestCommitResourcePath | String | The relative path within the GitHub API for accessing the specific pull request commit, which is part of the pull request's commit history. | ||
| PullRequestCommitUrl | String | The full URL to view the specific pull request commit directly on GitHub, allowing quick access to the commit's page in the pull request. | ||
| PullRequestId | String | A unique identifier for the pull request associated with this commit, used to link the commit to the specific pull request in GitHub. | ||
| PullRequestNumber | Int | The number assigned to the pull request for identification within the repository, used to track and reference the pull request. |
Tracks files modified within pull requests, listing filenames, change types, and details for thorough review.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following column and operators:
For example, the following queries are processed server-side:
SELECT * FROM [PullRequestFiles]
SELECT * FROM [PullRequestFiles] WHERE [PullRequestNumber] = 123
The Sync App processes other filters client-side within the Sync App.
| Name | Type | References | OrderBySupport | Description |
| PullRequestId [KEY] | String | A unique identifier for the pull request associated with the file changes, used to link these modifications to a specific pull request. | ||
| PullRequestNumber | Int | The number assigned to the pull request for identification, allowing users to refer to it easily within the repository's pull request system. | ||
| Path [KEY] | String | The relative file path within the repository that was modified by this pull request, showing the location of the file that was changed. | ||
| ChangeType | String | The type of modification made to the file in the pull request, such as 'ADDED' for new files, 'MODIFIED' for changes to existing files, or 'DELETED' for removed files. | ||
| ViewerViewedState | String | The state of the file as seen by the current user in the context of the review process. This can indicate whether the file has been reviewed, approved, or is still pending review. | ||
| Additions | Int | The total number of lines added to the file as part of the changes in this pull request. | ||
| Deletions | Int | The total number of lines removed from the file as part of the changes in this pull request. |
Logs comments made during pull request reviews, capturing feedback, suggestions, and discussions for improving the code.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following column and operators:
For example, the following queries are processed server-side:
SELECT * FROM [PullRequestReviewComments]
SELECT * FROM [PullRequestReviewComments] WHERE [PullRequestReviewId] = 'Val1'
The Sync App processes other filters client-side within the Sync App.
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | A unique identifier for each review comment, used to distinguish it from other comments in the system. | ||
| Body | String | The content of the comment, written in Markdown format, allowing for rich text, links, and other formatting features. | ||
| BodyText | String | The plain text version of the comment's body, with all Markdown formatting removed. | ||
| BodyHTML | String | The HTML-rendered version of the comment, which shows how the comment appears when viewed on the web. | ||
| Author | String | The GitHub username of the person who authored the comment, indicating the individual who wrote the feedback or notes. | ||
| AuthorAssociation | String | The relationship between the author and the repository, such as 'OWNER', 'CONTRIBUTOR', or 'COLLABORATOR', indicating their role in the project. | ||
| Editor | String | The GitHub username of the person who last edited or modified the comment after it was originally posted. | ||
| IsMinimized | Bool | Indicates whether the comment has been minimized or collapsed in the view, which can be done by the author or a reviewer. | ||
| MinimizedReason | String | The reason why the comment was minimized, such as it being flagged as less relevant or having an insignificant impact. | ||
| CreatedViaEmail | Bool | Indicates whether the comment was created via email, such as through an email reply to a pull request notification. | ||
| IncludesCreatedEdit | Bool | Indicates whether the comment has been edited after it was first created, and whether it includes information on the original creation of the comment. | ||
| ResourcePath | String | The relative HTTP path for accessing the review comment through the GitHub API, which can be used to retrieve the comment programmatically. | ||
| Url | String | The full URL to access the comment directly on GitHub, which allows viewing and interacting with the comment on the platform. | ||
| LastEditedAt | Datetime | The timestamp when the comment was last edited, showing when the most recent update to the comment was made. | ||
| PublishedAt | Datetime | The timestamp when the comment was first published, marking the initial moment it became visible to others. | ||
| CreatedAt | Datetime | The timestamp when the comment was created, representing the exact time when the comment was first added to the system. | ||
| UpdatedAt | Datetime | The timestamp when the comment was last updated, which can be an edit or a new reply within the conversation thread. | ||
| ViewerDidAuthor | Bool | Indicates whether the current viewer is the author of the comment. A value of 'true' means the viewer is the one who wrote the comment. | ||
| ViewerCanDelete | Bool | Indicates whether the current viewer has permission to delete the comment, typically based on their role or relationship to the repository. | ||
| ViewerCanMinimize | Bool | Indicates whether the current viewer has the ability to minimize or collapse the comment in their view. | ||
| ViewerCanReact | Bool | Indicates whether the current viewer can react to the comment, such as adding a thumbs-up, thumbs-down, or other emoji reactions. | ||
| ViewerCanUpdate | Bool | Indicates whether the current viewer has the ability to edit or update the comment after it has been posted. | ||
| ViewerCannotUpdateReasons | String | Lists the reasons why the current viewer is unable to update or edit the comment, which can be due to permissions or specific restrictions. | ||
| PullRequestId | String | The ID of the pull request that this comment is associated with, linking the comment to the relevant pull request on GitHub. | ||
| PullRequestReviewId | String | The ID of the review to which this comment belongs, helping to group comments within a specific pull request review session. | ||
| FullDatabaseId | Long | The primary key identifier for the comment in the underlying database, represented as a BigInt, used internally for data storage and reference. |
Stores details of reviews conducted on pull requests, including reviewer actions (approved, requested changes, commented) and timestamps.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM [PullRequestReviews]
SELECT * FROM [PullRequestReviews] WHERE [Author] = 'Val1'
SELECT * FROM [PullRequestReviews] WHERE [PullRequestNumber] = 123
SELECT * FROM [PullRequestReviews] WHERE [State] = 'PENDING'
The Sync App processes other filters client-side within the Sync App.
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | The unique identifier for the pull request review, used to distinguish this review from others in the system. | ||
| Body | String | The content of the review, written in Markdown format, which typically includes feedback or comments about the pull request. | ||
| BodyText | String | The plain text version of the review's body, with all Markdown formatting removed for a simpler, text-only view. | ||
| BodyHTML | String | The HTML-rendered version of the review body, designed for displaying the review as formatted text on the web. | ||
| Author | String | The GitHub username of the individual who authored the review, indicating the person who provided the feedback. | ||
| AuthorAssociation | String | The association of the author with the pull request subject, such as 'OWNER', 'CONTRIBUTOR', or 'COLLABORATOR', indicating their role in the project. | ||
| Editor | String | The GitHub username of the individual who last edited the review comment, showing who made the most recent changes to the review. | ||
| IsMinimized | Bool | Indicates whether the review comment has been minimized or collapsed by the viewer, possibly to reduce clutter in the UI. | ||
| MinimizedReason | String | Describes the reason why the comment was minimized, such as it being less relevant or flagged by the viewer. | ||
| CreatedViaEmail | Bool | Indicates whether the review comment was created through an email reply to the review request, often from email notifications. | ||
| IncludesCreatedEdit | Bool | Indicates whether the review comment includes an edit along with its creation data, reflecting that the comment has been modified since it was first posted. | ||
| ResourcePath | String | The relative HTTP path for accessing the review comment through the GitHub API, used for programmatically retrieving the review. | ||
| Url | String | The full HTTP URL that directs to the review comment directly on GitHub, allowing users to view it in the GitHub interface. | ||
| LastEditedAt | Datetime | The timestamp indicating when the review comment was last edited, showing when the comment was last updated. | ||
| PublishedAt | Datetime | The timestamp indicating when the review comment was first published and visible to others. | ||
| CreatedAt | Datetime | The timestamp indicating when the review comment was created, marking the original moment it was submitted. | ||
| UpdatedAt | Datetime | The timestamp indicating when the review comment was last updated, reflecting any edits made since its creation. | ||
| ViewerDidAuthor | Bool | Indicates whether the current viewer is the author of the review comment. A value of 'true' means the viewer is the one who wrote the review. | ||
| ViewerCanDelete | Bool | Indicates whether the current viewer has permission to delete the review comment, typically based on their role in the repository. | ||
| ViewerCanMinimize | Bool | Indicates whether the current viewer can minimize or collapse the review comment in their interface to streamline the view. | ||
| ViewerCanReact | Bool | Indicates whether the current viewer has the ability to react to the review comment, such as adding emojis or other reactions. | ||
| ViewerCanUpdate | Bool | Indicates whether the current viewer has permission to edit or update the review comment after it has been posted. | ||
| ViewerCannotUpdateReasons | String | Lists the reasons why the current viewer is unable to update the review comment, which can include permissions or restrictions. | ||
| ReactionGroups | String | A list of reaction types (such as 'thumbs-up' or 'thumbs-down') grouped by the content left on the review comment, showing the reactions the comment has received. | ||
| ViewerId | String | The unique identifier of the viewer interacting with the review comment, typically used to track the individual’s actions and permissions. | ||
| PullRequestId | String |
PullRequests.Id | The unique identifier of the pull request associated with this review, linking the review directly to the specific pull request. | |
| PullRequestNumber | Int | The number assigned to the pull request associated with this review, providing a reference for the review within the repository. | ||
| CommitId | String | The identifier of the commit that this review is associated with, linking the review to a specific commit in the pull request. | ||
| SubmittedAt | Datetime | The timestamp when the pull request review was officially submitted, indicating when the review was completed and submitted to the system. | ||
| State | String | The current state of the pull request review, indicating its status (for example, 'APPROVED', 'CHANGES_REQUESTED'). This reflects the reviewer's decision regarding the pull request.
The allowed values are PENDING, COMMENTED, APPROVED, CHANGES_REQUESTED, DISMISSED. | ||
| AuthorCanPushToRepository | Bool | Indicates whether the author of the review has the necessary permissions to push changes directly to the repository. This can be useful for identifying if the reviewer can make updates themselves. | ||
| FullDatabaseId | Long | The primary key identifier for the review comment in the database, represented as a BigInt. This is used internally for database queries and tracking. |
Lists assets attached to repository releases, including binary files, source code archives, and other downloadable content for distribution.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM [ReleaseAssets]
SELECT * FROM [ReleaseAssets] WHERE [ReleaseTagName] = 'Val1'
SELECT * FROM [ReleaseAssets] WHERE [Name] = 'Val1'
The Sync App processes other filters client-side within the Sync App.
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | A unique identifier assigned to the release asset for tracking and reference. | ||
| ReleaseTagName | String |
Releases.TagName | The tag associated with the release to which this asset belongs, used for versioning and reference. | |
| Name | String | The name or title of the release asset, typically describing the file's content or purpose. | ||
| ContentType | String | The MIME type that indicates the format of the release asset (for example, 'application/zip', 'image/png'). | ||
| Size | Int | The total file size of the release asset, measured in bytes. | ||
| UploadedBy | String | The GitHub username of the user who uploaded this asset to the release. | ||
| Url | String | The API URL that provides access to metadata and information about the release asset. | ||
| DownloadCount | Int | The total number of times this release asset has been downloaded by users. | ||
| DownloadUrl | String | The direct URL to download the release asset through a web browser or other tools. | ||
| UpdatedAt | Datetime | The date and time when the release asset was last modified or updated. | ||
| CreatedAt | Datetime | The date and time when the release asset was originally uploaded to the release. |
Tracks versioned releases in a repository, detailing associated tags, descriptions, and links to attached assets.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following column and operators:
For example, the following queries are processed server-side:
SELECT * FROM [Releases]
SELECT * FROM [Releases] WHERE [TagName] = 'Val1'
The Sync App processes other filters client-side within the Sync App.
The Sync App uses the GitHub API to process ORDER BY clause conditions that are built with the following columns:
SELECT * FROM [Releases] ORDER BY [Name]
SELECT * FROM [Releases] ORDER BY [CreatedAt]
The Sync App uses client-side processing when ordering by any other columns. This impacts performance.
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | A unique identifier assigned to the release for tracking and reference. | ||
| DatabaseId | Int | The primary key value for the release, as stored in the database. | ||
| Name | String | The title or name of the release, typically used for display and identification. | ||
| Description | String | A detailed explanation of the release, including its purpose and key features. | ||
| ShortDescriptionHTML | String | A brief summary of the release, rendered in HTML without links. The output is limited to a set number of characters (default 200). | ||
| DescriptionHTML | String | The full description of the release, formatted and rendered in HTML. | ||
| IsDraft | Bool | Indicates whether the release is in draft status and not yet published. | ||
| IsLatest | Bool | Indicates whether this release is the most recent published version. | ||
| IsPrerelease | Bool | Indicates whether this release is a prerelease version, intended for testing before an official launch. | ||
| ViewerCanReact | Bool | Indicates whether the current user is allowed to add reactions (such as emoji) to the release. | ||
| AuthorId | String | The unique identifier of the user who created the release. | ||
| Author | String | The GitHub username of the individual who authored the release. | ||
| TagId | String | The unique identifier of the Git tag associated with this release. | ||
| TagName | String | The name of the Git tag linked to this release, typically representing a version number. | ||
| TagCommitId | String | The commit ID associated with the Git tag for this release. | ||
| Url | String | The full HTTP URL to access the release page on GitHub. | ||
| ResourcePath | String | The relative HTTP path for accessing the release within the repository. | ||
| CreatedAt | Datetime | The date and time when the release was initially created. | ||
| PublishedAt | Datetime | The date and time when the release was officially published and made available. | ||
| UpdatedAt | Datetime | The date and time when the release was last modified or updated. |
Lists users who have starred a repository, indicating their interest in or support for the project.
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server-side:
SELECT * FROM [Stargazers]
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | A unique identifier assigned to the user for tracking and reference. | ||
| DatabaseId | Int | The primary key value for the user as stored in the database. | ||
| Login | String | The GitHub username used by the user to log in and interact with the platform. | ||
| Name | String | The public display name of the user on their GitHub profile. | ||
| String | The publicly visible email address listed on the user's profile, if available. | |||
| TwitterUsername | String | The Twitter handle associated with the user's GitHub profile. | ||
| Pronouns | String | The pronouns specified by the user on their public GitHub profile. | ||
| Bio | String | A brief description or biography provided by the user on their profile. | ||
| BioHTML | String | The user's biography formatted and rendered in HTML for profile display. | ||
| Company | String | The organization or company the user is affiliated with, as listed on their profile. | ||
| CompanyHTML | String | The company information rendered in HTML for profile display. | ||
| Location | String | The geographic location specified by the user on their public profile. | ||
| AnyPinnableItems | Bool | Indicates whether the user has any repositories or gists that can be pinned to their profile. | ||
| PinnedItemsRemaining | Int | The number of additional items the user can pin to their profile. | ||
| ItemShowcaseHasPinnedItems | Bool | Indicates whether the user has already pinned repositories or gists to their profile. | ||
| IsEmployee | Bool | Indicates whether the user is an employee of GitHub. | ||
| IsHireable | Bool | Indicates whether the user is open to job opportunities, as stated on their profile. | ||
| IsBountyHunter | Bool | Indicates whether the user participates in the GitHub Security Bug Bounty Program. | ||
| IsCampusExpert | Bool | Indicates whether the user is part of the GitHub Campus Experts Program, which promotes technical leadership on campuses. | ||
| IsFollowingViewer | Bool | Indicates whether this user is currently following the viewer. | ||
| IsSiteAdmin | Bool | Indicates whether the user has administrative privileges on GitHub. | ||
| IsDeveloperProgramMember | Bool | Indicates whether the user is a member of the GitHub Developer Program, which provides early access to new features. | ||
| IsGitHubStar | Bool | Indicates whether the user is a recognized member of the GitHub Stars Program, highlighting influential contributors. | ||
| IsSponsoringViewer | Bool | Indicates whether this user or organization is sponsoring the viewer on GitHub Sponsors. | ||
| IsViewer | Bool | Indicates whether this user is the currently authenticated viewer. | ||
| ViewerCanFollow | Bool | Indicates whether the currently authenticated viewer has permission to follow this user. | ||
| ViewerCanSponsor | Bool | Indicates whether the viewer can sponsor this user or organization via GitHub Sponsors. | ||
| ViewerIsFollowing | Bool | Indicates whether the viewer is currently following this user. | ||
| ViewerIsSponsoring | Bool | Indicates whether the viewer is currently sponsoring this user or organization on GitHub. | ||
| ViewerCanCreateProjects | Bool | Indicates whether the current viewer is authorized to create new projects for this user or organization. | ||
| ViewerCanChangePinnedItems | Bool | Indicates whether the viewer can pin repositories and gists to the user's profile. | ||
| StatusId | String | A unique identifier for the user's status emoji. | ||
| StatusEmoji | String | An emoji representing the user's current status. | ||
| StatusMessage | String | A short message that describes the user's current activity or availability. | ||
| StatusIndicatesLimitedAvailability | Bool | Indicates whether the user's status message signifies limited availability on GitHub. | ||
| StatusEmojiHTML | String | The user's status emoji rendered in HTML format. | ||
| StatusCreatedAt | Datetime | The date and time when the user's status was first set. | ||
| StatusExpiresAt | Datetime | The expiration date and time after which the status will no longer be displayed. | ||
| StatusUpdatedAt | Datetime | The date and time when the user's status was last updated. | ||
| StatusOrganizationId | String | The unique identifier of the organization associated with the user's status. | ||
| StatusOrganizationLogin | String | The login name of the organization linked to the user's status. | ||
| InteractionAbilityLimit | String | The current interaction restriction applied to this user (for example, limits on comments or contributions). | ||
| InteractionAbilityOrigin | String | The origin of the active interaction restriction (for example, organization or GitHub-wide policy). | ||
| InteractionAbilityExpiresAt | Datetime | The expiration date and time for the currently active interaction restriction. | ||
| HasSponsorsListing | Bool | Indicates whether the user or organization has an active GitHub Sponsors profile. | ||
| MonthlyEstimatedSponsorsIncomeInCents | Int | The estimated monthly GitHub Sponsors income for this user or organization, in cents (USD). | ||
| EstimatedNextSponsorsPayoutInCents | Int | The estimated amount in cents (USD) for the next GitHub Sponsors payout. | ||
| SponsorsListingId | String | The unique identifier for the user's GitHub Sponsors listing. | ||
| SponsorsListingName | String | The full name associated with the GitHub Sponsors listing. | ||
| TotalSponsorshipAmountAsSponsorInCents | Int | The total amount in cents (USD) that this user has spent sponsoring others on GitHub. | ||
| ResourcePath | String | The HTTP path that provides access to the user's profile on GitHub. | ||
| ProjectsResourcePath | String | The HTTP path that lists the user's projects. | ||
| Url | String | The HTTP URL to the user's profile page on GitHub. | ||
| ProjectsUrl | String | The HTTP URL that lists the user's projects. | ||
| WebsiteUrl | String | The URL of the user's personal website or blog. | ||
| AvatarUrl | String | The URL of the user's avatar image on GitHub. | ||
| CopilotEndpointsApi | String | The API endpoint used for GitHub Copilot integration. | ||
| CopilotEndpointsOriginTracker | String | The GitHub Copilot origin tracking endpoint. | ||
| CopilotEndpointsProxy | String | The proxy endpoint used for GitHub Copilot interactions. | ||
| CopilotEndpointsTelemetry | String | The telemetry endpoint used for tracking GitHub Copilot usage data. | ||
| CreatedAt | Datetime | The date and time when the user's GitHub account or organization was created. | ||
| UpdatedAt | Datetime | The date and time when the user's profile information was last updated. | ||
| RepositoryCount | Int | The total number of repositories owned by the user. | ||
| FollowerCount | Int | The total number of users following this user. |
Catalogs topics assigned to a repository, helping categorize and improve discoverability through tags such as 'open-source' or 'web-development.'
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server-side:
SELECT * FROM [Topics]
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | The unique identifier of the topic. | ||
| URL | String | The HTTP URL that links to the topic's page on GitHub. | ||
| ResourcePath | String | The relative HTTP path for accessing the topic within the GitHub platform. | ||
| Name | String | The name of the topic. | ||
| StargazerCount | Int | The total number of users who have starred this topic. | ||
| ViewerHasStarred | Bool | Indicates whether the currently authenticated user has starred this topic. |
Logs daily statistics of repository clones for the last 14 days, providing insight into the frequency and patterns of cloning activity.
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server-side:
SELECT * FROM [TrafficClonesDaily]
| Name | Type | References | OrderBySupport | Description |
| CountTotal | Int | The total number of clones for the repository, reflecting all cloning activity. | ||
| UniquesTotal | Int | The total number of unique users who cloned the repository, ensuring duplicates are excluded. | ||
| Count | Int | The number of clones for a specific period or breakdown. | ||
| Uniques | Int | The number of unique users who cloned the repository within a specific period. | ||
| Timestamp | Datetime | The timestamp representing when the data was recorded or relevant for the breakdown. |
Summarizes weekly clone statistics for the last 14 days, offering a higher-level view of cloning trends.
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server-side:
SELECT * FROM [TrafficClonesWeekly]
| Name | Type | References | OrderBySupport | Description |
| CountTotal | Int | The total number of clones for the repository over the weekly period. | ||
| UniquesTotal | Int | The total number of unique users who cloned the repository during the weekly period, excluding duplicates. | ||
| Count | Int | The number of clones for the repository recorded during the specific week. | ||
| Uniques | Int | The number of unique users who cloned the repository during the specified week. | ||
| Timestamp | Datetime | The timestamp representing the end of the weekly period or when the data was collected. |
Records daily page view statistics for a repository, helping track user engagement and traffic patterns over time.
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server-side:
SELECT * FROM [TrafficPageViewsDaily]
| Name | Type | References | OrderBySupport | Description |
| CountTotal | Int | The total number of page views for the repository on a daily basis. | ||
| UniquesTotal | Int | The total number of unique visitors who viewed the repository pages each day, excluding repeat views. | ||
| Count | Int | The number of page views recorded for the repository during the specific day. | ||
| Uniques | Int | The number of unique visitors who viewed the repository pages during the specific day. | ||
| Timestamp | Datetime | The timestamp indicating the specific day for which the page view data was recorded. |
Aggregates weekly page view statistics for a repository, giving an overview of user interaction trends for the past two weeks.
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server-side:
SELECT * FROM [TrafficPageViewsWeekly]
| Name | Type | References | OrderBySupport | Description |
| CountTotal | Int | The total number of page views across all repository pages on a daily basis. | ||
| UniquesTotal | Int | The total number of unique visitors who accessed any repository pages during the day, ensuring repeat visitors are excluded. | ||
| Count | Int | The number of page views recorded for specific repository pages within the day. | ||
| Uniques | Int | The number of unique visitors who accessed specific repository pages on the day. | ||
| Timestamp | Datetime | The date and time indicating when the page view data was recorded or is relevant. |
Lists the top 10 most frequently accessed paths in a repository over the past 14 days, helping identify popular content and entry points.
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server-side:
SELECT * FROM [TrafficTopReferralPaths]
| Name | Type | References | OrderBySupport | Description |
| Path | String | The specific URL path within the repository that received referral traffic. | ||
| Title | String | The title or name associated with the content at the specified path. | ||
| Count | Int | The total number of views for the content at the given path from referral sources. | ||
| Uniques | Int | The total number of unique visitors who accessed the content at the given path from referral sources. |
Identifies the top 10 sources driving traffic to a repository in the last 14 days, such as search engines, social media, or external links.
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server-side:
SELECT * FROM [TrafficTopReferralSources]
| Name | Type | References | OrderBySupport | Description |
| Referrer | String | The name of the website or source that referred traffic to the repository. | ||
| Count | Int | The total number of views generated from the specified referrer. | ||
| Uniques | Int | The total number of unique visitors referred to the repository by the specified source. |
Tracks users watching a repository, providing visibility into who is monitoring updates, changes, and activity.
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server-side:
SELECT * FROM [Watchers]
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | The unique identifier of the user. | ||
| DatabaseId | Int | The primary key for the user in the database, used for internal reference. | ||
| Login | String | The username that the user uses to log in to GitHub. | ||
| Name | String | The publicly visible name displayed on the user's profile. | ||
| String | The publicly visible email address listed on the user's profile. | |||
| TwitterUsername | String | The username of the user's Twitter account, if the account is linked. | ||
| Pronouns | String | The pronouns the user has listed on their profile. | ||
| Bio | String | The text description provided by the user in their public-profile biography. | ||
| BioHTML | String | The user's public-profile biography formatted as HTML. | ||
| Company | String | The name of the company the user has associated with their profile. | ||
| CompanyHTML | String | The company name listed on the user's profile, formatted as HTML. | ||
| Location | String | The geographic location listed on the user's public profile. | ||
| AnyPinnableItems | Bool | Indicates whether the user has any items, such as repositories or gists, that can be pinned to their profile. | ||
| PinnedItemsRemaining | Int | The number of additional items the user can pin to their profile. | ||
| ItemShowcaseHasPinnedItems | Bool | Indicates whether the user has pinned any repositories or gists to their profile. | ||
| IsEmployee | Bool | Indicates whether the user is an employee of GitHub. | ||
| IsHireable | Bool | Indicates whether the user has marked themselves as available for hire. | ||
| IsBountyHunter | Bool | Indicates whether the user is a participant in the GitHub Security Bug Bounty program. | ||
| IsCampusExpert | Bool | Indicates whether the user is a member of the GitHub Campus Experts program. | ||
| IsFollowingViewer | Bool | Indicates whether the user is following the viewer. This is the inverse of ViewerIsFollowing. | ||
| IsSiteAdmin | Bool | Indicates whether the user is a GitHub site administrator. | ||
| IsDeveloperProgramMember | Bool | Indicates whether the user is a member of the GitHub Developer Program. | ||
| IsGitHubStar | Bool | Indicates whether the user is a member of the GitHub Stars Program. | ||
| IsSponsoringViewer | Bool | Indicates whether the user or organization is sponsoring the viewer. | ||
| IsViewer | Bool | Indicates whether this user is the same as the viewing user. | ||
| ViewerCanFollow | Bool | Indicates whether the viewer has the ability to follow this user. | ||
| ViewerCanSponsor | Bool | Indicates whether the viewer has the ability to sponsor this user or organization. | ||
| ViewerIsFollowing | Bool | Indicates whether the viewer is currently following this user. | ||
| ViewerIsSponsoring | Bool | Indicates whether the viewer is currently sponsoring this user or organization. | ||
| ViewerCanCreateProjects | Bool | Can the current viewer create new projects on this owner? | ||
| ViewerCanChangePinnedItems | Bool | Can the viewer pin repositories and gists to the profile? | ||
| StatusId | String | The emoji's ID. | ||
| StatusEmoji | String | An emoji summarizing the user's status. | ||
| StatusMessage | String | A brief message describing what the user is doing. | ||
| StatusIndicatesLimitedAvailability | Bool | Specifies whether this status indicates that the user is not fully available on GitHub. | ||
| StatusEmojiHTML | String | The status emoji as HTML. | ||
| StatusCreatedAt | Datetime | Identifies the date and time when the object was created. | ||
| StatusExpiresAt | Datetime | If set, the status is not shown after this date. | ||
| StatusUpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
| StatusOrganizationId | String | The organization's ID. | ||
| StatusOrganizationLogin | String | The organization's login name. | ||
| InteractionAbilityLimit | String | The current limit that is enabled on this object. | ||
| InteractionAbilityOrigin | String | The origin of the currently active interaction limit. | ||
| InteractionAbilityExpiresAt | Datetime | The time the currently active limit expires. | ||
| HasSponsorsListing | Bool | True if this user/organization has a GitHub Sponsors listing. | ||
| MonthlyEstimatedSponsorsIncomeInCents | Int | The estimated monthly GitHub Sponsors income for this user/organization in cents (USD). | ||
| EstimatedNextSponsorsPayoutInCents | Int | The estimated next GitHub Sponsors payout for this user/organization in cents (USD). | ||
| SponsorsListingId | String | The listing's ID. | ||
| SponsorsListingName | String | The listing's full name. | ||
| TotalSponsorshipAmountAsSponsorInCents | Int | The amount in US cents that this entity has spent on GitHub to fund sponsorships. Only returns a value when viewed by the user themselves or by a user who can manage sponsorships for the requested organization. | ||
| ResourcePath | String | The HTTP path for this user. | ||
| ProjectsResourcePath | String | The HTTP path listing user's projects. | ||
| Url | String | The HTTP URL for this user. | ||
| ProjectsUrl | String | The HTTP URL listing user's projects. | ||
| WebsiteUrl | String | A URL pointing to the user's public website/blog. | ||
| AvatarUrl | String | A URL pointing to the user's public avatar. | ||
| CopilotEndpointsApi | String | Copilot API endpoint. | ||
| CopilotEndpointsOriginTracker | String | Copilot origin tracker endpoint. | ||
| CopilotEndpointsProxy | String | Copilot proxy endpoint. | ||
| CopilotEndpointsTelemetry | String | Copilot telemetry endpoint. | ||
| CreatedAt | Datetime | Identifies the date and time when the object was created. | ||
| UpdatedAt | Datetime | Identifies the date and time when the object was last updated. | ||
| RepositoryCount | Int | The number of repositories that a user owns. | ||
| FollowerCount | Int | The number of followers that a user has. |
In the Project Data Model schema, the Sync App models each project associated with the authenticated account as a schema. Live connectivity to these objects means that any changes to your GitHub account are immediately reflected in the Sync App.
Note: The Sync App does not read from classic projects; they have been deprecated in the GitHub API.
The Tables section, which details standard SQL tables, and the Views section, which lists read-only SQL tables, contain samples of what you might have access to in your GitHub account.
The following tables and views are shipped with the Sync App:
| Table | Description |
| CustomView | Displays project items labeled 'bug,' sorted by label name in ascending order, to facilitate issue tracking. |
| ItemAssignees | Tracks users assigned to project items, offering a detailed view of task ownership and accountability. |
| ItemLabels | Stores labels applied to project items, enabling better categorization and filtering of tasks. |
| ItemLinkedPullRequests | Connects pull requests to specific project items, creating traceability between project tasks and related code changes. |
| ItemReviewers | Maintains a list of reviewers assigned to specific project items, ensuring tracking of review responsibilities. |
| Items | Contains all details related to project items, including metadata and any associated fields. |
| ItemsView | Offers a complete and unfiltered view of all project items, facilitating comprehensive project analysis. |
| StatusUpdates | Logs status changes for project items, helping teams track progress and communicate updates effectively. |
Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including getting the currently authenticated user or retrieving and refreshing OAuth access tokens.
The Sync App models the data in GitHub as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| StatusUpdates | Logs status changes for project items, helping teams track progress and communicate updates effectively. |
Logs status changes for project items, helping teams track progress and communicate updates effectively.
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server-side:
SELECT * FROM [StatusUpdates]
You can use the following columns to create (insert) a new record:
INSERT INTO [StatusUpdates] ([Body]) VALUES ('Test')
You can use the following columns to update a record:
UPDATE [StatusUpdates] SET [Body] = 'Test' WHERE [Id] = 'PVTSU_lAHOBTvkJ84Ad8nnzgABIno'
You can specify the following column to delete a record: Id
DELETE FROM [StatusUpdates] WHERE [Id] = 'PVTSU_lAHOBTvkJ84Ad8nnzgABInY'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique node ID of the ProjectV2StatusUpdate object. | |
| FullDatabaseId | Long | True |
The primary key of the status update in the database, stored as a BigInt for scalability. | |
| Body | String | False |
The textual content of the status update. | |
| BodyHTML | String | True |
The content of the status update rendered in HTML format for web display. | |
| CreatedAt | Datetime | True |
The date and time when the status update was initially created. | |
| StartDate | Date | False |
The start date associated with the status update. | |
| Status | String | False |
The current status of the status update, such as 'IN_PROGRESS' or 'COMPLETED'. | |
| TargetDate | Date | False |
The target completion date specified in the status update. | |
| UpdatedAt | Datetime | True |
The date and time when the status update was last modified. |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| CustomView | Displays project items labeled 'bug,' sorted by label name in ascending order, to facilitate issue tracking. |
| ItemAssignees | Tracks users assigned to project items, offering a detailed view of task ownership and accountability. |
| ItemLabels | Stores labels applied to project items, enabling better categorization and filtering of tasks. |
| ItemLinkedPullRequests | Connects pull requests to specific project items, creating traceability between project tasks and related code changes. |
| ItemReviewers | Maintains a list of reviewers assigned to specific project items, ensuring tracking of review responsibilities. |
| Items | Contains all details related to project items, including metadata and any associated fields. |
| ItemsView | Offers a complete and unfiltered view of all project items, facilitating comprehensive project analysis. |
Displays project items labeled 'bug,' sorted by label name in ascending order, to facilitate issue tracking.
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server side:
SELECT * FROM CustomView
| Name | Type | References | OrderBySupport | Description |
| ItemId [KEY] | String | A unique identifier for the item, used as a primary key. | ||
| Title | String | The text value of the item's title or main heading. | ||
| Assignees | String | The usernames of users assigned to the item, separated by commas if multiple. | ||
| Status | String | The current status of the item, represented by the selected option from a predefined list. | ||
| Labels | String | A comma-separated list of labels applied to categorize the item. | ||
| Linked pull requests | String | A list of numbers representing pull requests associated with the item. | ||
| Milestone | String | The title of the milestone that the item is associated with, used for tracking progress. | ||
| Repository | String | The full name of the repository, including the owner (for example, owner/repo-name). | ||
| Reviewers | String | The usernames of individuals designated as reviewers for the item. | ||
| CustomText | String | Custom-defined textual content for additional item-specific details. | ||
| CustomNumber | Double | A numeric field allowing custom floating-point values for calculations or metrics. | ||
| CustomDate | Date | A custom-defined date associated with the item, used for deadlines or events. | ||
| CustomSingleSelect | String | The selected value from a custom single-choice dropdown field. | ||
| CustomIteration | String | The title of the iteration or sprint associated with the item. |
Tracks users assigned to project items, offering a detailed view of task ownership and accountability.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following column and operators:
For example, the following queries are processed server-side:
SELECT * FROM [ItemAssignees]
SELECT * FROM [ItemAssignees] WHERE [ItemId] = 'Val1'
The Sync App processes other filters client-side within the Sync App.
| Name | Type | References | OrderBySupport | Description |
| ItemId [KEY] | String | A unique identifier for the item being referenced, such as an issue or pull request. | ||
| Id [KEY] | String | A unique identifier for the user assigned to the item. | ||
| DatabaseId | Int | The primary key for the user in the database, used for internal reference. | ||
| Login | String | The username associated with the user's GitHub account, used for authentication and identification. | ||
| Name | String | The full name associated with the user's public GitHub profile. | ||
| String | The publicly visible email address of the user, if they have chosen to make it available. | |||
| TwitterUsername | String | The user's Twitter handle, as provided on their GitHub profile. | ||
| Pronouns | String | The pronouns listed by the user in their public GitHub profile, if provided. | ||
| Bio | String | The user's public biography, offering a brief description about themselves. | ||
| BioHTML | String | The user's public biography formatted in HTML, suitable for display in web applications. | ||
| Company | String | The organization or company associated with the user's public GitHub profile. | ||
| CompanyHTML | String | The organization or company formatted as HTML, suitable for rendering in web pages. | ||
| Location | String | The geographic location provided in the user's public profile, such as city or country. | ||
| AnyPinnableItems | Bool | Indicates whether the user has any repositories, gists, or projects that can be pinned to their profile. | ||
| PinnedItemsRemaining | Int | The number of additional items that the user can pin to their profile. | ||
| ItemShowcaseHasPinnedItems | Bool | Indicates whether the user has pinned any repositories or gists to their profile showcase. | ||
| IsEmployee | Bool | Indicates if the user is an employee of GitHub. | ||
| IsHireable | Bool | Indicates if the user is open to job opportunities and marked as hireable. | ||
| IsBountyHunter | Bool | Indicates if the user participates in the GitHub Security Bug Bounty program. | ||
| IsCampusExpert | Bool | Indicates if the user is a participant in the GitHub Campus Experts Program. | ||
| IsFollowingViewer | Bool | Indicates if this user is following the authenticated viewer. This is the inverse of 'ViewerIsFollowing.' | ||
| IsSiteAdmin | Bool | Indicates if the user has site-wide administrative privileges on GitHub. | ||
| IsDeveloperProgramMember | Bool | Indicates if the user is a member of the GitHub Developer Program. | ||
| IsGitHubStar | Bool | Indicates if the user is recognized as a member of the GitHub Stars Program. | ||
| IsSponsoringViewer | Bool | Indicates if the user is sponsoring the authenticated viewer through GitHub Sponsors. | ||
| IsViewer | Bool | Indicates if this user is the currently authenticated viewer. | ||
| ViewerCanFollow | Bool | Indicates if the authenticated viewer has the ability to follow this user. | ||
| ViewerCanSponsor | Bool | Indicates if the authenticated viewer can sponsor this user or organization through GitHub Sponsors. | ||
| ViewerIsFollowing | Bool | Indicates if the authenticated viewer is following this user. | ||
| ViewerIsSponsoring | Bool | Indicates if the currently authenticated viewer is sponsoring this user or organization through GitHub Sponsors. | ||
| ViewerCanCreateProjects | Bool | Indicates if the authenticated viewer has permission to create new projects for this user or organization. | ||
| ViewerCanChangePinnedItems | Bool | Indicates if the viewer can pin repositories or gists to this user's profile. | ||
| StatusId | String | A unique identifier for the user's current status emoji. | ||
| StatusEmoji | String | An emoji representing the user's current status, providing a visual summary. | ||
| StatusMessage | String | A brief text message describing the user's current activity or availability. | ||
| StatusIndicatesLimitedAvailability | Bool | Indicates whether the user's status signifies limited availability on GitHub. | ||
| StatusEmojiHTML | String | The user's status emoji formatted as HTML, suitable for rendering in web applications. | ||
| StatusCreatedAt | Datetime | The date and time when the user's status was initially set. | ||
| StatusExpiresAt | Datetime | The expiration date and time for the user's status, after which it is no longer displayed. | ||
| StatusUpdatedAt | Datetime | The date and time when the user's status was last updated. | ||
| StatusOrganizationId | String | The unique identifier of the organization associated with the user's status. | ||
| StatusOrganizationLogin | String | The login name of the organization associated with the user's status. | ||
| InteractionAbilityLimit | String | The type of interaction limit currently applied to this object, such as restricting comments or contributions. | ||
| InteractionAbilityOrigin | String | The origin or reason for the currently active interaction limit, such as an organization policy. | ||
| InteractionAbilityExpiresAt | Datetime | The date and time when the current interaction limit expires. | ||
| HasSponsorsListing | Bool | Indicates if this user or organization has a GitHub Sponsors listing to receive sponsorships. | ||
| MonthlyEstimatedSponsorsIncomeInCents | Int | The estimated monthly income from GitHub Sponsors for this user or organization, in cents (USD). | ||
| EstimatedNextSponsorsPayoutInCents | Int | The estimated amount for the next GitHub Sponsors payout, in cents (USD). | ||
| SponsorsListingId | String | The unique identifier of the GitHub Sponsors listing. | ||
| SponsorsListingName | String | The full name of the GitHub Sponsors listing associated with this user or organization. | ||
| TotalSponsorshipAmountAsSponsorInCents | Int | The total amount in US cents spent by this entity on sponsorships through GitHub. Only visible to the user or authorized managers. | ||
| ResourcePath | String | The HTTP path for accessing this user's profile. | ||
| ProjectsResourcePath | String | The HTTP path for viewing this user's GitHub projects. | ||
| Url | String | The HTTP URL for accessing this user's profile. | ||
| ProjectsUrl | String | The HTTP URL listing this user's GitHub projects. | ||
| WebsiteUrl | String | A URL pointing to the user's public website or blog, if provided. | ||
| AvatarUrl | String | A URL pointing to the user's public avatar image. The 'size' argument specifies the dimensions of the square image. | ||
| CopilotEndpointsApi | String | The API endpoint for GitHub Copilot integration. | ||
| CopilotEndpointsOriginTracker | String | The endpoint for tracking the origin of requests made through GitHub Copilot. | ||
| CopilotEndpointsProxy | String | The proxy endpoint for GitHub Copilot requests. | ||
| CopilotEndpointsTelemetry | String | The endpoint for gathering telemetry data related to GitHub Copilot usage. | ||
| CreatedAt | Datetime | The date and time when this object, such as a user or resource, was initially created. | ||
| UpdatedAt | Datetime | The date and time when this object was last updated or modified. | ||
| RepositoryCount | Int | The total number of repositories owned by the user. | ||
| FollowerCount | Int | The total number of users following this user on GitHub. |
Stores labels applied to project items, enabling better categorization and filtering of tasks.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following column and operators:
For example, the following queries are processed server-side:
SELECT * FROM [ItemLabels]
SELECT * FROM [ItemLabels] WHERE [ItemId] = 'Val1'
The Sync App processes other filters client-side within the Sync App.
| Name | Type | References | OrderBySupport | Description |
| ItemId [KEY] | String | A unique identifier for the item (for example, issue or pull request) associated with the label. | ||
| Id [KEY] | String | A unique identifier for the label. | ||
| Name | String | The name of the label, used to categorize or tag items. | ||
| Description | String | A brief description providing additional context or purpose for the label. | ||
| Color | String | The hexadecimal color code representing the label's visual appearance. | ||
| IsDefault | Bool | Indicates whether this label is one of the default labels provided by GitHub or custom-created. | ||
| ResourcePath | String | The relative HTTP path to access this label on GitHub. | ||
| Url | String | The full HTTP URL to view this label on GitHub. | ||
| UpdatedAt | Datetime | The date and time when the label was last updated or modified. | ||
| CreatedAt | Datetime | The date and time when the label was initially created. |
Connects pull requests to specific project items, creating traceability between project tasks and related code changes.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following column and operators:
For example, the following queries are processed server-side:
SELECT * FROM [ItemLinkedPullRequests]
SELECT * FROM [ItemLinkedPullRequests] WHERE [ItemId] = 'Val1'
The Sync App processes other filters client-side within the Sync App.
| Name | Type | References | OrderBySupport | Description |
| ItemId [KEY] | String | A unique identifier for the item (for example, issue or task) associated with the linked pull request. | ||
| Id [KEY] | String | A unique identifier for the pull request. | ||
| FullDatabaseId | Long | The primary key of the pull request in the database, stored as a BigInt for scalability. | ||
| Author | String | The login name of the user who authored the pull request. | ||
| AuthorAssociation | String | The author's relationship with the repository (for example, 'CONTRIBUTOR', 'MEMBER', or 'OWNER'). | ||
| Editor | String | The login name of the user who last edited the body of the pull request. | ||
| HeadRepositoryId | String | The unique identifier for the repository associated with the pull request's head branch. | ||
| HeadRepositoryOwner | String | The login name of the owner of the repository associated with the pull request's head branch. | ||
| MergedBy | String | The login name of the user who merged the pull request. | ||
| BaseRefId | String | The unique identifier for the base branch of the pull request, even if the branch has been deleted. | ||
| BaseRefOid | String | The Git Object ID (OID) of the base branch associated with the pull request. | ||
| BaseRefPrefix | String | The prefix (for example, 'refs/heads/') of the base branch associated with the pull request. | ||
| BaseRefName | String | The name of the base branch associated with the pull request, even if the branch has been deleted. | ||
| HeadRefId | String | The unique identifier for the head branch of the pull request, even if the branch has been deleted. | ||
| HeadRefOid | String | The Git Object ID (OID) of the head branch associated with the pull request. | ||
| HeadRefPrefix | String | The prefix (for example, 'refs/heads/') of the head branch associated with the pull request. | ||
| HeadRefName | String | The name of the head branch associated with the pull request, even if the branch has been deleted. | ||
| Title | String | The title of the pull request, summarizing its purpose or changes. | ||
| TitleHTML | String | The pull request title formatted in HTML for rendering in web applications. | ||
| Body | String | The full content of the pull request description written in Markdown. | ||
| BodyText | String | The content of the pull request description rendered as plain text. | ||
| BodyHTML | String | The content of the pull request description rendered as HTML for display purposes. | ||
| State | String | The current state of the pull request (for example, 'OPEN', 'CLOSED', or 'MERGED').
The allowed values are OPEN, CLOSED, MERGED. | ||
| Number | Int | The unique number assigned to the pull request within its repository. | ||
| Mergeable | String | Indicates whether the pull request is mergeable, based on the absence of merge conflicts. | ||
| Merged | Bool | Indicates whether the pull request has been successfully merged. | ||
| Closed | Bool | Indicates whether the pull request is closed without being merged. | ||
| ChangedFiles | Int | The total number of files that were modified in this pull request. | ||
| Additions | Int | The total number of lines added in this pull request. | ||
| Deletions | Int | The total number of lines removed in this pull request. | ||
| TotalCommentsCount | Int | The total number of comments, including review comments, on this pull request. | ||
| ReviewDecision | String | The current review status of the pull request, such as 'APPROVED', 'CHANGES_REQUESTED', or 'REVIEW_REQUIRED'. | ||
| Locked | Bool | Indicates whether the pull request is locked to prevent further discussion or changes. | ||
| ActiveLockReason | String | The reason provided for locking the conversation on this pull request, such as 'RESOLVED' or 'OFF_TOPIC'. | ||
| IsDraft | Bool | Indicates whether the pull request is a draft, meaning it is not yet ready for review or merging. | ||
| IsCrossRepository | Bool | Indicates whether the pull request's base and head branches are in different repositories. | ||
| MaintainerCanModify | Bool | Indicates whether repository maintainers are allowed to make changes to the pull request's branch. | ||
| CreatedViaEmail | Bool | Indicates whether this comment on the pull request was created through an email reply. | ||
| IncludesCreatedEdit | Bool | Indicates whether the comment on the pull request has been edited and includes data from the original creation. | ||
| MergeCommitId | String | The unique commit ID generated when the pull request was successfully merged. | ||
| PotentialMergeCommitId | String | The unique commit ID generated by GitHub to test the mergeability of the pull request. This is not available if the pull request is already merged or if the test is still in progress. | ||
| Permalink | String | The permanent URL that links directly to this pull request. | ||
| ResourcePath | String | The relative HTTP path for accessing this pull request on GitHub. | ||
| ChecksResourcePath | String | The relative HTTP path for viewing the checks and statuses for this pull request. | ||
| RevertResourcePath | String | The relative HTTP path for initiating a revert of this pull request. | ||
| Url | String | The full HTTP URL for accessing this pull request. | ||
| ChecksUrl | String | The full HTTP URL for viewing the checks and statuses for this pull request. | ||
| RevertUrl | String | The full HTTP URL for initiating a revert of this pull request. | ||
| LastEditedAt | Datetime | The date and time when the last edit was made to this pull request. | ||
| MergedAt | Datetime | The date and time when the pull request was successfully merged. | ||
| ClosedAt | Datetime | The date and time when the pull request was closed, either by merging or other means. | ||
| PublishedAt | Datetime | The date and time when the comment associated with the pull request was published. | ||
| UpdatedAt | Datetime | The date and time when the pull request or its associated data was last updated. | ||
| CreatedAt | Datetime | The date and time when the pull request or its associated data was created. | ||
| MilestoneId | String | The unique identifier of the milestone associated with this pull request. | ||
| MilestoneTitle | String | The title of the milestone associated with this pull request. | ||
| MilestoneNumber | Int | The unique number of the milestone associated with this pull request. | ||
| AutoMergeRequestCommitHeadline | String | The title of the commit created as part of the auto-merge request. Set by the merge queue if required by the base branch. | ||
| AutoMergeRequestAuthorEmail | String | The email address of the user who initiated the auto-merge request. | ||
| AutoMergeRequestCommitBody | String | The commit message created as part of the auto-merge request. Set by the merge queue if required by the base branch. | ||
| AutoMergeRequestEnabledAt | Datetime | The date and time when the auto-merge request for this pull request was enabled. | ||
| AutoMergeRequestMergeMethod | String | Specifies the merge method (for example, 'MERGE', 'SQUASH', 'REBASE') used for the auto-merge request. This value is set by the merge queue if required by the base branch. | ||
| ViewerDidAuthor | Bool | Indicates whether the currently authenticated viewer authored this comment on the pull request. | ||
| IsReadByViewer | Bool | Indicates whether the pull request has been marked as read by the viewer. | ||
| ViewerSubscription | String | Identifies the viewer's subscription status for the pull request, such as 'WATCHING', 'NOT_WATCHING', or 'IGNORING'. | ||
| ViewerCanLabel | Bool | Indicates whether the viewer has permission to edit or add labels to the pull request. | ||
| ViewerCanClose | Bool | Indicates whether the viewer has permission to close the pull request. | ||
| ViewerCanReact | Bool | Indicates whether the viewer can react to this pull request or its comments with emoji reactions. | ||
| ViewerCanReopen | Bool | Indicates whether the viewer can reopen the pull request after it has been closed. | ||
| ViewerCanSubscribe | Bool | Indicates whether the viewer can change their subscription status for the repository containing this pull request. | ||
| ViewerCanApplySuggestion | Bool | Indicates whether the viewer has permission to apply suggested changes to the pull request. | ||
| ViewerCanEditFiles | Bool | Indicates whether the viewer can edit files within the context of this pull request. | ||
| ViewerCanDeleteHeadRef | Bool | Indicates whether the viewer can restore a deleted head reference associated with this pull request. | ||
| ViewerCanDisableAutoMerge | Bool | Indicates whether the viewer can disable the auto-merge feature for this pull request. | ||
| ViewerCanEnableAutoMerge | Bool | Indicates whether the viewer can enable the auto-merge feature for this pull request. | ||
| ViewerCanMergeAsAdmin | Bool | Indicates whether the viewer can bypass branch protection rules and merge the pull request immediately as an administrator. | ||
| ViewerCanUpdate | Bool | Indicates whether the viewer can update this pull request or its associated content. | ||
| ViewerCanUpdateBranch | Bool | Indicates whether the viewer can update the head branch of this pull request by merging or rebasing the base branch. | ||
| ViewerCannotUpdateReasons | String | A list of reasons why the viewer cannot update this pull request or its associated content. | ||
| ViewerLatestReviewRequestId | String | The unique ID of the viewer's most recent review request for this pull request. | ||
| ViewerLatestReviewId | String | The unique ID of the viewer's most recent review on this pull request. | ||
| IsMergeQueueEnabled | Bool | Indicates whether the base branch of this pull request has a merge queue enabled for managing merge operations. | ||
| IsInMergeQueue | Bool | Indicates whether the pull request is currently in a merge queue awaiting processing. | ||
| MergeQueueEntryId | String | A unique identifier for this pull request's entry in the merge queue. | ||
| MergeQueueEntryJump | Bool | Indicates whether this pull request is prioritized to jump ahead in the merge queue. | ||
| MergeQueueEntryPosition | Int | The position of this pull request's entry in the merge queue. | ||
| MergeQueueEntrySolo | Bool | Indicates whether this pull request needs to be merged or deployed independently, without batching with others. | ||
| MergeQueueEntryState | String | The current state of this pull request's entry in the merge queue, such as 'ENQUEUED', 'MERGING', or 'FAILED'. | ||
| MergeQueueEntryEnqueuedAt | Datetime | The date and time when this pull request was added to the merge queue. | ||
| MergeQueueEntryEstimatedTimeToMerge | Int | The estimated time in seconds until this pull request is expected to be merged. | ||
| MergeQueueEntryBaseCommitId | String | The unique ID of the base commit associated with this merge queue entry. | ||
| MergeQueueEntryHeadCommitId | String | The unique ID of the head commit associated with this merge queue entry. | ||
| MergeQueueEntryMergeQueueId | String | The unique identifier of the merge queue containing this pull request. | ||
| MergeQueueEntryMergeQueueUrl | String | The full HTTP URL for viewing the merge queue containing this pull request. | ||
| MergeQueueEntryMergeQueueResourcePath | String | The relative HTTP path for accessing the merge queue containing this pull request. | ||
| MergeQueueEntryMergeQueueNextEntryEstimatedTimeToMerge | Int | The estimated time in seconds until a newly added entry in this merge queue is expected to be merged. | ||
| StatusCheckRollupId | String | The unique Node ID of the StatusCheckRollup object, which aggregates status checks and runs. | ||
| StatusCheckRollupCommitId | String | The commit ID to which the status checks and check runs are attached. | ||
| StatusCheckRollupState | String | The combined status of all checks and runs for the associated commit, such as 'SUCCESS', 'PENDING', or 'FAILURE'. |
Maintains a list of reviewers assigned to specific project items, ensuring tracking of review responsibilities.
The Sync App uses the GitHub API to process WHERE clause conditions that are built with the following column and operators:
For example, the following queries are processed server-side:
SELECT * FROM [ItemReviewers]
SELECT * FROM [ItemReviewers] WHERE [ItemId] = 'Val1'
The Sync App processes other filters client-side within the Sync App.
| Name | Type | References | OrderBySupport | Description |
| ItemId [KEY] | String | A unique identifier for the item (for example, a pull request or issue) associated with the reviewer. | ||
| NodeId [KEY] | String | A unique identifier for the object in the GitHub system. | ||
| UserId | String | A unique identifier for the user acting as a reviewer. | ||
| UserDatabaseId | Int | The primary key of the user in the database, used for internal reference. | ||
| UserLogin | String | The username associated with the user's GitHub account, used for authentication and identification. | ||
| UserName | String | The full name associated with the user's public GitHub profile. | ||
| UserEmail | String | The publicly visible email address of the user, if they have chosen to make it available. | ||
| UserTwitterUsername | String | The Twitter username provided on the user's GitHub profile. | ||
| UserPronouns | String | The pronouns listed by the user in their public GitHub profile. | ||
| UserBio | String | The user's public biography, offering a brief description about themselves. | ||
| UserBioHTML | String | The user's public biography formatted in HTML for rendering in web applications. | ||
| UserCompany | String | The organization or company associated with the user's public GitHub profile. | ||
| UserCompanyHTML | String | The organization or company formatted as HTML, suitable for rendering in web applications. | ||
| UserLocation | String | The geographic location provided in the user's public profile, such as city or country. | ||
| UserAnyPinnableItems | Bool | Indicates whether the user has any repositories, gists, or projects that can be pinned to their profile. | ||
| UserPinnedItemsRemaining | Int | The number of additional items the user can pin to their GitHub profile. | ||
| UserItemShowcaseHasPinnedItems | Bool | Indicates whether the user has pinned any repositories or gists to their profile showcase. | ||
| UserIsEmployee | Bool | Indicates whether the user is an employee of GitHub. | ||
| UserIsHireable | Bool | Indicates whether the user has marked themselves as available for hiring opportunities. | ||
| UserIsBountyHunter | Bool | Indicates whether the user participates in the GitHub Security Bug Bounty program. | ||
| UserIsCampusExpert | Bool | Indicates whether the user is a participant in the GitHub Campus Experts Program. | ||
| UserIsFollowingViewer | Bool | Indicates whether the user is following the authenticated viewer. This is the inverse of 'UserViewerIsFollowing.' | ||
| UserIsSiteAdmin | Bool | Indicates whether the user has site-wide administrative privileges on GitHub. | ||
| UserIsDeveloperProgramMember | Bool | Indicates whether the user is a member of the GitHub Developer Program. | ||
| UserIsGitHubStar | Bool | Indicates whether the user is recognized as a member of the GitHub Stars Program. | ||
| UserIsSponsoringViewer | Bool | Indicates whether the user is sponsoring the authenticated viewer through GitHub Sponsors. | ||
| UserIsViewer | Bool | Indicates whether the user is the currently authenticated viewer. | ||
| UserViewerCanFollow | Bool | Indicates whether the viewer can follow this user. | ||
| UserViewerCanSponsor | Bool | Indicates whether the viewer can sponsor this user or organization through GitHub Sponsors. | ||
| UserViewerIsFollowing | Bool | Indicates whether the viewer is currently following this user. | ||
| UserViewerIsSponsoring | Bool | Indicates whether the currently authenticated viewer is sponsoring this user or organization through GitHub Sponsors. | ||
| UserViewerCanCreateProjects | Bool | Indicates whether the authenticated viewer has permission to create new projects for this user or organization. | ||
| UserViewerCanChangePinnedItems | Bool | Indicates whether the viewer can pin repositories or gists to this user's profile. | ||
| UserStatusId | String | A unique identifier for the emoji used in the user's current status. | ||
| UserStatusEmoji | String | An emoji representing the user's current status, providing a visual summary. | ||
| UserStatusMessage | String | A brief text message describing the user's current activity or availability. | ||
| UserStatusIndicatesLimitedAvailability | Bool | Indicates whether the user's status signifies limited availability on GitHub. | ||
| UserStatusEmojiHTML | String | The user's status emoji formatted as HTML, suitable for display in web applications. | ||
| UserStatusCreatedAt | Datetime | The date and time when the user's status was initially set. | ||
| UserStatusExpiresAt | Datetime | The expiration date and time for the user's status, after which it is no longer displayed. | ||
| UserStatusUpdatedAt | Datetime | The date and time when the user's status was last updated. | ||
| UserStatusOrganizationId | String | The unique identifier of the organization associated with the user's status. | ||
| UserStatusOrganizationLogin | String | The login name of the organization associated with the user's status. | ||
| UserInteractionAbilityLimit | String | The type of interaction limit currently applied to this user's repositories or objects, such as restricting comments or contributions. | ||
| UserInteractionAbilityOrigin | String | The origin or reason for the currently active interaction limit, such as an organization policy. | ||
| UserInteractionAbilityExpiresAt | Datetime | The date and time when the current interaction limit expires. | ||
| UserHasSponsorsListing | Bool | Indicates whether the user or organization has a GitHub Sponsors listing to receive sponsorships. | ||
| UserMonthlyEstimatedSponsorsIncomeInCents | Int | The estimated monthly income from GitHub Sponsors for this user or organization, in cents (USD). | ||
| UserEstimatedNextSponsorsPayoutInCents | Int | The estimated amount for the next GitHub Sponsors payout, in cents (USD). | ||
| UserSponsorsListingId | String | A unique identifier for the GitHub Sponsors listing associated with this user or organization. | ||
| UserSponsorsListingName | String | The full name of the GitHub Sponsors listing associated with this user or organization. | ||
| UserTotalSponsorshipAmountAsSponsorInCents | Int | The total amount in US cents that this user or organization has spent on sponsorships through GitHub. | ||
| UserResourcePath | String | The relative HTTP path for accessing this user's GitHub profile. | ||
| UserProjectsResourcePath | String | The relative HTTP path for viewing this user's GitHub projects. | ||
| UserUrl | String | The full HTTP URL for accessing this user's GitHub profile. | ||
| UserProjectsUrl | String | The full HTTP URL for viewing this user's GitHub projects. | ||
| UserWebsiteUrl | String | A URL pointing to the user's public website or blog, if provided. | ||
| UserAvatarUrl | String | A URL pointing to the user's public avatar image. The 'size' argument specifies the dimensions of the square image. | ||
| UserCopilotEndpointsApi | String | The API endpoint for GitHub Copilot integration specific to this user. | ||
| UserCopilotEndpointsOriginTracker | String | The endpoint for tracking the origin of requests made through GitHub Copilot for this user. | ||
| UserCopilotEndpointsProxy | String | The proxy endpoint for GitHub Copilot requests associated with this user. | ||
| UserCopilotEndpointsTelemetry | String | The telemetry endpoint for gathering data related to GitHub Copilot usage for this user. | ||
| UserCreatedAt | Datetime | The date and time when this user's GitHub account was created. | ||
| UserUpdatedAt | Datetime | The date and time when this user's profile or associated data was last updated. | ||
| UserRepositoryCount | Int | The total number of repositories owned by this user. | ||
| UserFollowerCount | Int | The total number of followers this user has on GitHub. | ||
| BotId | String | The unique identifier for this bot in the GitHub system. | ||
| BotDatabaseId | Int | The primary key of the bot in the database, used for internal reference. | ||
| BotLogin | String | The username or handle associated with this bot on GitHub. | ||
| BotUrl | String | The full HTTP URL for accessing this bot's profile or details. | ||
| BotResourcePath | String | The relative HTTP path for accessing this bot's profile or details. | ||
| BotCreatedAt | Datetime | The date and time when this bot account was created on GitHub. | ||
| BotUpdatedAt | Datetime | The date and time when this bot's profile or associated data was last updated. | ||
| MannequinId | String | The unique identifier for this mannequin user on GitHub. | ||
| MannequinDatabaseId | Int | The primary key of the mannequin user in the database, used for internal reference. | ||
| MannequinLogin | String | The username associated with this mannequin account, typically used for attribution. | ||
| MannequinEmail | String | The email address of the mannequin user from the source instance, if available. | ||
| MannequinUrl | String | The full HTTP URL to access this mannequin's profile or details. | ||
| MannequinResourcePath | String | The relative HTML path for accessing this mannequin's profile or details. | ||
| MannequinCreatedAt | Datetime | The date and time when this mannequin account was created on GitHub. | ||
| MannequinUpdatedAt | Datetime | The date and time when this mannequin's profile or associated data was last updated. | ||
| MannequinClaimantId | String | The unique identifier for the user or entity claiming ownership of this mannequin account. | ||
| MannequinClaimantLogin | String | The username of the user or entity that has claimed the mannequin account. | ||
| TeamId | String | A unique identifier for the team in the GitHub system. | ||
| TeamDatabaseId | Int | The primary key of the team in the database, used for internal reference. | ||
| TeamOrganizationId | String | A unique identifier for the organization to which the team belongs. | ||
| TeamOrganizationDatabaseId | Int | The primary key of the organization in the database, used for internal reference. | ||
| TeamParentTeamId | String | A unique identifier for the parent team of the current team, if applicable. | ||
| TeamParentTeamDatabaseId | Int | The primary key of the parent team in the database, used for internal reference. | ||
| TeamParentTeamName | String | The name of the parent team of the current team, if applicable. | ||
| TeamName | String | The name of the team, used for identification and display purposes. | ||
| TeamDescription | String | A brief description of the team's purpose or role within the organization. | ||
| TeamPrivacy | String | The privacy level of the team, such as 'PRIVATE' or 'SECRET'.
The allowed values are SECRET, VISIBLE. | ||
| TeamSlug | String | A URL-friendly identifier (slug) for the team. | ||
| TeamUrl | String | The full HTTP URL for accessing this team's details on GitHub. | ||
| TeamAvatarUrl | String | A URL pointing to the team's avatar or profile image. | ||
| TeamCombinedSlug | String | A URL-friendly identifier combining the organization and team slugs. | ||
| TeamDiscussionsUrl | String | The full HTTP URL for accessing discussions related to this team. | ||
| TeamMembersUrl | String | The full HTTP URL for accessing the list of this team's members. | ||
| TeamNotificationSetting | String | The notification preferences set for this team.
The allowed values are NOTIFICATIONS_ENABLED, NOTIFICATIONS_DISABLED. | ||
| TeamRepositoriesUrl | String | The full HTTP URL for accessing the repositories associated with this team. | ||
| TeamResourcePath | String | The relative HTTP path for accessing this team's details on GitHub. | ||
| TeamTeamsUrl | String | The full HTTP URL for accessing this team's child teams, if applicable. | ||
| TeamViewerSubscription | String | Indicates the viewer's subscription status for the team, such as 'WATCHING', 'NOT_WATCHING', or 'IGNORING'. | ||
| TeamDiscussionsResourcePath | String | The relative HTTP path for accessing team discussions. | ||
| TeamEditTeamUrl | String | The full HTTP URL for editing this team's details. | ||
| TeamMembersResourcePath | String | The relative HTTP path for accessing the list of this team's members. | ||
| TeamNewTeamUrl | String | The full HTTP URL for creating a new team under this organization. | ||
| TeamRepositoriesResourcePath | String | The relative HTTP path for accessing the repositories associated with this team. | ||
| TeamTeamsResourcePath | String | The relative HTTP path for accessing this team's child teams, if applicable. | ||
| TeamViewerCanAdminister | Bool | Indicates whether the viewer has administrative permissions for this team. | ||
| TeamViewerCanSubscribe | Bool | Indicates whether the viewer can change their subscription status for this team's repositories or discussions. | ||
| TeamEditTeamResourcePath | String | The relative HTTP path for editing this team's details. | ||
| TeamNewTeamResourcePath | String | The relative HTTP path for creating a new team within this organization. | ||
| TeamCreatedAt | Datetime | The date and time when the team was created in the GitHub system. | ||
| TeamUpdatedAt | Datetime | The date and time when the team's details were last updated. | ||
| TeamReviewRequestDelegationAlgorithm | String | The algorithm used by this team for assigning reviews, such as round-robin or load-balanced methods. | ||
| TeamReviewRequestDelegationEnabled | Bool | Indicates whether the review request delegation feature is enabled for this team. | ||
| TeamReviewRequestDelegationMemberCount | Int | The number of team members required to be assigned as reviewers when delegation is enabled. | ||
| TeamReviewRequestDelegationNotifyTeam | Bool | Indicates whether the entire team should be notified in addition to the delegated members when reviews are assigned. |
Contains all details related to project items, including metadata and any associated fields.
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server-side:
SELECT * FROM [Items]
| Name | Type | References | OrderBySupport | Description |
| Id [KEY] | String | A unique identifier for the item. | ||
| FullDatabaseId | Long | The primary key of the item in the database, stored as a BigInt. | ||
| UpdatedAt | Datetime | The date and time when the item or its details were last updated. | ||
| CreatedAt | Datetime | The date and time when the item was created. | ||
| IsArchived | Bool | Indicates whether the item is archived and no longer active. | ||
| Type | String | The type or category of the item, such as 'Issue' or 'Pull Request'. | ||
| DraftIssueId | String | The unique identifier for the draft issue associated with this item. | ||
| DraftIssueTitle | String | The title of the draft issue. | ||
| DraftIssueBody | String | The full content of the draft issue's body written in Markdown. | ||
| DraftIssueBodyText | String | The content of the draft issue's body rendered as plain text. | ||
| DraftIssueBodyHTML | String | The content of the draft issue's body rendered as HTML for display purposes. | ||
| DraftIssueUpdatedAt | Datetime | The date and time when the draft issue was last updated. | ||
| DraftIssueCreatedAt | Datetime | The date and time when the draft issue was created. | ||
| IssueId | String | A unique identifier for the issue associated with this item. | ||
| IssueFullDatabaseId | Long | The primary key of the issue in the database, stored as a BigInt. | ||
| IssueTitle | String | The title of the issue, summarizing its purpose or content. | ||
| IssueTitleHTML | String | The title of the issue rendered in HTML for display purposes. | ||
| IssueAuthor | String | The username of the user who authored the issue. | ||
| IssueAuthorAssociation | String | The author's relationship with the repository, such as 'CONTRIBUTOR' or 'OWNER'. | ||
| IssueEditor | String | The username of the user who last edited the issue. | ||
| IssueBody | String | The full content of the issue's body written in Markdown. | ||
| IssueBodyText | String | The content of the issue's body rendered as plain text. | ||
| IssueBodyHTML | String | The content of the issue's body rendered as HTML for display purposes. | ||
| IssueBodyResourcePath | String | The relative HTTP path to access the body of the issue. | ||
| IssueBodyUrl | String | The full HTTP URL to access the body of the issue. | ||
| IssueNumber | Int | The unique number assigned to the issue within its repository. | ||
| IssueState | String | The current state of the issue, such as 'OPEN' or 'CLOSED'.
The allowed values are open, closed. | ||
| IssueStateReason | String | The reason provided for the current state of the issue, such as 'COMPLETED' or 'NOT_PLANNED'. | ||
| IssueLocked | Bool | Indicates whether the issue is locked to prevent further changes or comments. | ||
| IssueActiveLockReason | String | The reason why the issue was locked, such as 'OFF_TOPIC' or 'RESOLVED'. | ||
| IssueClosed | Bool | Indicates whether the issue is closed. The definition of 'closed' may depend on the type of the issue. | ||
| IssueIsPinned | Bool | Indicates whether the issue is currently pinned to the top of the repository's issues list. | ||
| IssueIncludesCreatedEdit | Bool | Indicates whether the comment was edited and includes the original creation data. | ||
| IssueCreatedViaEmail | Bool | Indicates whether the comment was created via an email reply. | ||
| IssueResourcePath | String | The relative HTTP path to access this issue on GitHub. | ||
| IssueUrl | String | The full HTTP URL to access this issue on GitHub. | ||
| IssueLastEditedAt | Datetime | The date and time when the issue was last edited by an editor. | ||
| IssuePublishedAt | Datetime | The date and time when the issue or its associated comment was published. | ||
| IssueClosedAt | Datetime | The date and time when the issue was closed. | ||
| IssueUpdatedAt | Datetime | The date and time when the issue or its details were last updated. | ||
| IssueCreatedAt | Datetime | The date and time when the issue was created. | ||
| IssueMilestoneId | String | The unique identifier for the milestone associated with this issue. | ||
| IssueMilestoneTitle | String | The title of the milestone associated with this issue. | ||
| IssueMilestoneNumber | Int | The number assigned to the milestone associated with this issue. | ||
| IssueIsReadByViewer | Bool | Indicates whether the issue has been marked as read by the viewer. | ||
| IssueViewerDidAuthor | Bool | Indicates whether the viewer is the author of this comment or issue. | ||
| IssueViewerSubscription | String | The viewer's subscription status for this issue, such as 'WATCHING', 'NOT_WATCHING', or 'IGNORING'. | ||
| IssueViewerCanLabel | Bool | Indicates whether the viewer has permission to edit or add labels to this issue. | ||
| IssueViewerCanClose | Bool | Indicates whether the viewer can close this issue. | ||
| IssueViewerCanReopen | Bool | Indicates whether the viewer can reopen this issue after it has been closed. | ||
| IssueViewerCanDelete | Bool | Indicates whether the viewer can delete this issue or its associated content. | ||
| IssueViewerCanReact | Bool | Indicates whether the viewer can react to this issue or its comments using emojis. | ||
| IssueViewerCanSubscribe | Bool | Indicates whether the viewer can change their subscription status for this issue. | ||
| IssueViewerThreadSubscriptionStatus | String | The viewer's current thread subscription status for the issue. | ||
| IssueViewerThreadSubscriptionFormAction | String | The form action URL for updating the viewer's thread subscription status for the issue. | ||
| IssueViewerCanUpdate | Bool | Indicates whether the viewer can update this issue or its associated content. | ||
| IssueViewerCannotUpdateReasons | String | The reasons why the viewer is unable to update this issue or its content. | ||
| IssueCommentCount | Int | The total number of comments on this issue. | ||
| IssueReactionCount | Int | The total number of emoji reactions on this issue. | ||
| PullRequestId | String | The unique identifier for the pull request associated with this item. | ||
| PullRequestFullDatabaseId | Long | The primary key of the pull request in the database, stored as a BigInt. | ||
| PullRequestAuthor | String | The login name of the user who authored the pull request. | ||
| PullRequestAuthorAssociation | String | The author's relationship with the repository, such as 'CONTRIBUTOR' or 'MEMBER'. | ||
| PullRequestEditor | String | The login name of the user who last edited the body of the pull request. | ||
| PullRequestHeadRepositoryId | String | The unique identifier of the repository associated with the head branch of this pull request. | ||
| PullRequestHeadRepositoryOwner | String | The login name of the owner of the repository associated with the head branch of this pull request. | ||
| PullRequestMergedBy | String | The login name of the user who merged this pull request. | ||
| PullRequestBaseRefId | String | The unique identifier of the base branch associated with this pull request, even if the branch has been deleted. | ||
| PullRequestBaseRefOid | String | The Git Object ID (OID) of the base branch associated with this pull request, even if the branch has been deleted. | ||
| PullRequestBaseRefPrefix | String | The prefix of the base branch's reference path (for example, 'refs/heads/'). | ||
| PullRequestBaseRefName | String | The name of the base branch associated with this pull request, even if the branch has been deleted. | ||
| PullRequestHeadRefId | String | The unique identifier of the head branch associated with this pull request, even if the branch has been deleted. | ||
| PullRequestHeadRefOid | String | The Git Object ID (OID) of the head branch associated with this pull request, even if the branch has been deleted. | ||
| PullRequestHeadRefPrefix | String | The prefix of the head branch's reference path (for example, 'refs/heads/'). | ||
| PullRequestHeadRefName | String | The name of the head branch associated with this pull request, even if the branch has been deleted. | ||
| PullRequestTitle | String | The title of the pull request, summarizing its purpose or changes. | ||
| PullRequestTitleHTML | String | The title of the pull request rendered as HTML for web display. | ||
| PullRequestBody | String | The body content of the pull request, written in Markdown. | ||
| PullRequestBodyText | String | The body content of the pull request rendered as plain text. | ||
| PullRequestBodyHTML | String | The body content of the pull request rendered as HTML for web display. | ||
| PullRequestState | String | The current state of the pull request, such as 'OPEN', 'CLOSED', or 'MERGED'.
The allowed values are OPEN, CLOSED, MERGED. | ||
| PullRequestNumber | Int | The unique number assigned to this pull request within its repository. | ||
| PullRequestMergeable | String | Indicates whether the pull request is mergeable, considering the presence or absence of merge conflicts. | ||
| PullRequestMerged | Bool | Indicates whether the pull request has been successfully merged. | ||
| PullRequestClosed | Bool | Indicates whether the pull request is closed without being merged. | ||
| PullRequestChangedFiles | Int | The total number of files changed in this pull request. | ||
| PullRequestAdditions | Int | The total number of lines added in this pull request. | ||
| PullRequestDeletions | Int | The total number of lines removed in this pull request. | ||
| PullRequestTotalCommentsCount | Int | The total number of comments, including review comments, made on this pull request. | ||
| PullRequestReviewDecision | String | The current review decision on the pull request, such as 'APPROVED', 'CHANGES_REQUESTED', or 'REVIEW_REQUIRED'. | ||
| PullRequestLocked | Bool | Indicates whether the pull request is locked to prevent further activity. | ||
| PullRequestActiveLockReason | String | The reason provided for locking the pull request conversation, such as 'RESOLVED' or 'OFF_TOPIC'. | ||
| PullRequestIsDraft | Bool | Indicates whether the pull request is a draft and not yet ready for review or merging. | ||
| PullRequestIsCrossRepository | Bool | Indicates whether the pull request's head and base branches are in different repositories. | ||
| PullRequestMaintainerCanModify | Bool | Indicates whether repository maintainers are allowed to make changes to the pull request's branch. | ||
| PullRequestCreatedViaEmail | Bool | Indicates whether this comment on the pull request was created via an email reply. | ||
| PullRequestIncludesCreatedEdit | Bool | Indicates whether this comment on the pull request was edited and includes data from the original creation. | ||
| PullRequestMergeCommitId | String | The unique commit ID generated when this pull request was successfully merged. | ||
| PullRequestPotentialMergeCommitId | String | The unique commit ID automatically generated by GitHub to test the mergeability of this pull request. This value is unavailable if the pull request is already merged or the test merge commit is still being generated. | ||
| PullRequestPermalink | String | The permanent URL that links directly to this pull request. | ||
| PullRequestResourcePath | String | The relative HTTP path for accessing this pull request on GitHub. | ||
| PullRequestChecksResourcePath | String | The relative HTTP path for accessing the checks and statuses associated with this pull request. | ||
| PullRequestRevertResourcePath | String | The relative HTTP path for initiating a revert of this pull request. | ||
| PullRequestUrl | String | The full HTTP URL for accessing this pull request on GitHub. | ||
| PullRequestChecksUrl | String | The full HTTP URL for accessing the checks and statuses associated with this pull request. | ||
| PullRequestRevertUrl | String | The full HTTP URL for initiating a revert of this pull request. | ||
| PullRequestLastEditedAt | Datetime | The date and time when this pull request was last edited by an editor. | ||
| PullRequestMergedAt | Datetime | The date and time when this pull request was successfully merged. | ||
| PullRequestClosedAt | Datetime | The date and time when this pull request was closed. | ||
| PullRequestPublishedAt | Datetime | The date and time when this pull request or its associated comment was published. | ||
| PullRequestUpdatedAt | Datetime | The date and time when this pull request or its details were last updated. | ||
| PullRequestCreatedAt | Datetime | The date and time when this pull request was created. | ||
| PullRequestMilestoneId | String | The unique identifier for the milestone associated with this pull request. | ||
| PullRequestMilestoneTitle | String | The title of the milestone associated with this pull request. | ||
| PullRequestMilestoneNumber | Int | The number assigned to the milestone associated with this pull request. | ||
| PullRequestAutoMergeRequestCommitHeadline | String | The title of the commit created as part of the auto-merge request. This value is set by the merge queue if required by the base branch. | ||
| PullRequestAutoMergeRequestAuthorEmail | String | The email address of the author who initiated the auto-merge request. | ||
| PullRequestAutoMergeRequestCommitBody | String | The commit message created as part of the auto-merge request. This value is set by the merge queue if required by the base branch. | ||
| PullRequestAutoMergeRequestEnabledAt | Datetime | The date and time when the auto-merge request for this pull request was enabled. | ||
| PullRequestAutoMergeRequestMergeMethod | String | The merge method (for example, 'MERGE', 'SQUASH', 'REBASE') used for the auto-merge request. This value is set by the merge queue if required by the base branch. | ||
| PullRequestViewerDidAuthor | Bool | Indicates whether the viewer authored this comment or pull request. | ||
| PullRequestIsReadByViewer | Bool | Indicates whether this pull request has been marked as read by the viewer. | ||
| PullRequestViewerSubscription | String | Indicates the viewer's subscription status for this pull request, such as 'WATCHING', 'NOT_WATCHING', or 'IGNORING'. | ||
| PullRequestViewerCanLabel | Bool | Indicates whether the viewer has permission to edit or add labels to this pull request. | ||
| PullRequestViewerCanClose | Bool | Indicates whether the viewer has permission to close this pull request. | ||
| PullRequestViewerCanReact | Bool | Indicates whether the viewer can react to this pull request or its comments using emojis. | ||
| PullRequestViewerCanReopen | Bool | Indicates whether the viewer has permission to reopen this pull request after it has been closed. | ||
| PullRequestViewerCanSubscribe | Bool | Indicates whether the viewer can change their subscription status for the repository associated with this pull request. | ||
| PullRequestViewerCanApplySuggestion | Bool | Indicates whether the viewer can apply suggested changes to this pull request. | ||
| PullRequestViewerCanEditFiles | Bool | Indicates whether the viewer has permission to edit files within this pull request. | ||
| PullRequestViewerCanDeleteHeadRef | Bool | Indicates whether the viewer can restore a deleted head reference associated with this pull request. | ||
| PullRequestViewerCanDisableAutoMerge | Bool | Indicates whether the viewer can disable the auto-merge feature for this pull request. | ||
| PullRequestViewerCanEnableAutoMerge | Bool | Indicates whether the viewer can enable the auto-merge feature for this pull request. | ||
| PullRequestViewerCanMergeAsAdmin | Bool | Indicates whether the viewer, as an administrator, can bypass branch protection rules and merge the pull request immediately. | ||
| PullRequestViewerCanUpdate | Bool | Indicates whether the viewer has permission to update this pull request or its associated data. | ||
| PullRequestViewerCanUpdateBranch | Bool | Indicates whether the viewer can update the head branch of this pull request by merging or rebasing the base branch. Returns false if the head branch is up to date or the viewer lacks permissions. | ||
| PullRequestViewerCannotUpdateReasons | String | Lists the reasons why the viewer cannot update this pull request or its associated data. | ||
| PullRequestViewerLatestReviewRequestId | String | The unique identifier of the viewer's most recent review request for this pull request. | ||
| PullRequestViewerLatestReviewId | String | The unique identifier of the viewer's most recent review on this pull request. | ||
| PullRequestIsMergeQueueEnabled | Bool | Indicates whether the base branch of this pull request has a merge queue enabled to manage merge operations. | ||
| PullRequestIsInMergeQueue | Bool | Indicates whether this pull request is currently in a merge queue awaiting processing. | ||
| PullRequestMergeQueueEntryId | String | A unique identifier for this pull request's entry in the merge queue. | ||
| PullRequestMergeQueueEntryJump | Bool | Indicates whether this pull request has been prioritized to jump ahead in the merge queue. | ||
| PullRequestMergeQueueEntryPosition | Int | The position of this pull request's entry in the merge queue. | ||
| PullRequestMergeQueueEntrySolo | Bool | Indicates whether this pull request needs to be deployed or merged independently, without batching with others. | ||
| PullRequestMergeQueueEntryState | String | The current state of this pull request's entry in the merge queue, such as 'ENQUEUED', 'MERGING', or 'FAILED'. | ||
| PullRequestMergeQueueEntryEnqueuedAt | Datetime | The date and time when this pull request was added to the merge queue. | ||
| PullRequestMergeQueueEntryEstimatedTimeToMerge | Int | The estimated time in seconds until this pull request is expected to be merged from the queue. | ||
| PullRequestMergeQueueEntryBaseCommitId | String | The unique identifier of the base commit associated with this merge queue entry. | ||
| PullRequestMergeQueueEntryHeadCommitId | String | The unique identifier of the head commit associated with this merge queue entry. | ||
| PullRequestMergeQueueEntryMergeQueueId | String | The unique identifier of the merge queue containing this pull request entry. | ||
| PullRequestMergeQueueEntryMergeQueueUrl | String | The full HTTP URL for accessing the merge queue containing this pull request. | ||
| PullRequestMergeQueueEntryMergeQueueResourcePath | String | The relative HTTP path for accessing the merge queue containing this pull request. | ||
| PullRequestMergeQueueEntryMergeQueueNextEntryEstimatedTimeToMerge | Int | The estimated time in seconds until a newly added entry in the merge queue is expected to be merged. | ||
| PullRequestStatusCheckRollupId | String | The node ID of the StatusCheckRollup object aggregating status checks and runs for this pull request. | ||
| PullRequestStatusCheckRollupCommitId | String | The unique identifier of the commit to which the status checks and runs are attached. | ||
| PullRequestStatusCheckRollupState | String | The combined status of all checks and runs for the associated commit, such as 'SUCCESS', 'PENDING', or 'FAILURE'. | ||
| TitleId | String | A unique identifier for the title value associated with the item. | ||
| TitleDatabaseId | Int | The primary key of the title value in the database, used for internal reference. | ||
| TitleCreatorLogin | String | The username of the actor who created the item or title value. | ||
| TitleCreatedAt | Datetime | The date and time when the title value or item was created. | ||
| TitleUpdatedAt | Datetime | The date and time when the title value or item was last updated. | ||
| TitleText | String | The text value of the field representing the title. | ||
| StatusId | String | A unique identifier for the status value associated with the item. | ||
| StatusDatabaseId | Int | The primary key of the status value in the database, used for internal reference. | ||
| StatusCreatorLogin | String | The username of the actor who created the status value. | ||
| StatusCreatedAt | Datetime | The date and time when the status value was created. | ||
| StatusUpdatedAt | Datetime | The date and time when the status value was last updated. | ||
| StatusName | String | The name of the selected single-select option for the status. | ||
| StatusNameHTML | String | The HTML-formatted name of the selected single-select option for the status. | ||
| StatusDescription | String | A plain-text description explaining the meaning of the selected single-select option for the status. | ||
| StatusDescriptionHTML | String | The HTML-formatted description of the selected single-select option for the status. | ||
| StatusColor | String | The color code associated with the selected single-select option for the status. | ||
| StatusOptionId | String | The unique identifier for the selected single-select option for the status. | ||
| MilestoneId | String | A unique identifier for the milestone associated with the item. | ||
| MilestoneTitle | String | The title of the milestone, summarizing its purpose or scope. | ||
| MilestoneClosed | Bool | Indicates whether the milestone is closed. The definition of 'closed' may depend on the context. | ||
| MilestoneProgressPercentage | Double | The progress percentage for this milestone, typically based on completed tasks or issues. | ||
| MilestoneDescription | String | The description of the milestone, providing additional context or details. | ||
| MilestoneNumber | Int | The unique number assigned to the milestone. | ||
| MilestoneState | String | The current state of the milestone, such as 'OPEN' or 'CLOSED'.
The allowed values are OPEN, CLOSED. | ||
| MilestoneResourcePath | String | The relative HTTP path for accessing the milestone on GitHub. | ||
| MilestoneUrl | String | The full HTTP URL for accessing the milestone on GitHub. | ||
| MilestoneViewerCanClose | Bool | Indicates whether the viewer has permission to close this milestone. | ||
| MilestoneViewerCanReopen | Bool | Indicates whether the viewer has permission to reopen this milestone after it has been closed. | ||
| MilestoneDueOn | Datetime | The due date of the milestone, if one is set. | ||
| MilestoneClosedAt | Datetime | The date and time when the milestone was closed. | ||
| MilestoneUpdatedAt | Datetime | The date and time when the milestone or its details were last updated. | ||
| MilestoneCreatedAt | Datetime | The date and time when the milestone was created. | ||
| RepositoryId | String | A unique identifier for the repository. | ||
| RepositoryDatabaseId | Int | The primary key of the repository in the database, used for internal reference. | ||
| RepositoryName | String | The name of the repository. | ||
| RepositoryNameWithOwner | String | The full name of the repository, including the owner's login (for example, 'owner/repository-name'). | ||
| RepositoryOwnerId | String | The unique identifier for the owner of the repository. | ||
| RepositoryOwnerLogin | String | The login name of the repository's owner, which could be a user or an organization. | ||
| RepositoryVisibility | String | The visibility level of the repository, such as 'PUBLIC', 'PRIVATE', or 'INTERNAL'. | ||
| RepositoryDiskUsage | Int | The size of the repository on disk, in kilobytes. | ||
| RepositoryForkCount | Int | The total number of forks of this repository in the entire network. | ||
| RepositoryStargazerCount | Int | The total number of users who have starred this repository. | ||
| RepositoryWatcherCount | Int | The total number of users watching this repository for updates. | ||
| RepositoryTopicCount | Int | The number of topics applied to the repository for categorization. | ||
| RepositoryTempCloneToken | String | A temporary authentication token that allows cloning this repository. | ||
| RepositoryWebCommitSignoffRequired | Bool | Indicates whether contributors are required to sign off on commits made via the web interface. | ||
| RepositoryUsesCustomOpenGraphImage | Bool | Indicates whether the repository uses a custom image for Open Graph representation instead of the owner's avatar. | ||
| RepositoryDescription | String | The textual description of the repository provided by the owner. | ||
| RepositoryDescriptionHTML | String | The HTML-rendered version of the repository's description. | ||
| RepositoryShortDescriptionHTML | String | A short, HTML-rendered description of the repository without any links. | ||
| RepositoryResourcePath | String | The relative HTTP path for accessing this repository on GitHub. | ||
| RepositoryProjectsResourcePath | String | The relative HTTP path for accessing the projects associated with this repository. | ||
| RepositoryUrl | String | The full HTTP URL for accessing this repository on GitHub. | ||
| RepositoryHomepageUrl | String | The URL for the repository's homepage, if provided. | ||
| RepositoryMirrorUrl | String | The original URL of the repository if it is a mirror. | ||
| RepositoryProjectsUrl | String | The full HTTP URL for accessing the projects associated with this repository. | ||
| RepositorySecurityPolicyUrl | String | The URL of the repository's security policy, if available. | ||
| RepositorySSHUrl | String | The SSH URL for cloning this repository. | ||
| RepositoryOpenGraphImageUrl | String | The URL of the image used to represent this repository in Open Graph data. | ||
| RepositoryMergeCommitTitle | String | Specifies how the default commit title is generated when merging a pull request. | ||
| RepositoryMergeCommitMessage | String | Specifies how the default commit message is generated when merging a pull request. | ||
| RepositorySquashMergeCommitTitle | String | Specifies how the default commit title is generated when squash-merging a pull request. | ||
| RepositorySquashMergeCommitMessage | String | Specifies how the default commit message is generated when squash-merging a pull request. | ||
| RepositoryDeleteBranchOnMerge | Bool | Indicates whether branches are automatically deleted after being merged in this repository. | ||
| RepositoryHasDiscussionsEnabled | Bool | Indicates whether the Discussions feature is enabled for this repository. | ||
| RepositoryHasIssuesEnabled | Bool | Indicates whether the Issues feature is enabled for this repository. | ||
| RepositoryHasProjectsEnabled | Bool | Indicates whether the Projects feature is enabled for this repository. | ||
| RepositoryHasWikiEnabled | Bool | Indicates whether the Wiki feature is enabled for this repository. | ||
| RepositoryHasVulnerabilityAlertsEnabled | Bool | Indicates whether vulnerability alerts are enabled for this repository. | ||
| RepositoryHasSponsorshipsEnabled | Bool | Indicates whether the repository displays a 'Sponsor' button for financial contributions. | ||
| RepositoryIsInOrganization | Bool | Indicates whether the repository is owned by an organization or is a private fork of an organization repository. | ||
| RepositoryIsBlankIssuesEnabled | Bool | Indicates whether creating blank issues is allowed in this repository. | ||
| RepositoryIsSecurityPolicyEnabled | Bool | Indicates whether this repository has a security policy configured. | ||
| RepositoryIsUserConfigurationRepository | Bool | Indicates whether this repository is designated as a user configuration repository. | ||
| RepositoryIsArchived | Bool | Indicates whether the repository is archived and unmaintained. | ||
| RepositoryIsDisabled | Bool | Indicates whether the repository is disabled. | ||
| RepositoryIsEmpty | Bool | Indicates whether the repository is empty and has no content. | ||
| RepositoryIsFork | Bool | Indicates whether the repository is a fork of another repository. | ||
| RepositoryIsLocked | Bool | Indicates whether the repository is locked, preventing modifications. | ||
| RepositoryIsMirror | Bool | Indicates whether the repository is a mirror of another repository. | ||
| RepositoryIsPrivate | Bool | Indicates whether the repository is private and not publicly accessible. | ||
| RepositoryIsTemplate | Bool | Indicates whether the repository is a template that can be used to generate new repositories. | ||
| RepositoryLockReason | String | The reason why the repository has been locked, such as 'MIGRATING' or 'BILLING'.
The allowed values are BILLING, MIGRATING, MOVING, RENAME. | ||
| RepositoryTemplateRepositoryId | String | The unique identifier of the template repository from which this repository was generated, if applicable. | ||
| RepositoryParentId | String | The unique identifier of the parent repository if this repository is a fork. | ||
| RepositoryForkingAllowed | Bool | Indicates whether forking is allowed for this repository. | ||
| RepositoryAutoMergeAllowed | Bool | Indicates whether Auto-merge can be enabled for pull requests in this repository. | ||
| RepositorySquashMergeAllowed | Bool | Indicates whether squash-merging is enabled for pull requests in this repository. | ||
| RepositoryRebaseMergeAllowed | Bool | Indicates whether rebase-merging is enabled for pull requests in this repository. | ||
| RepositoryMergeCommitAllowed | Bool | Indicates whether pull requests can be merged with a merge commit in this repository. | ||
| RepositoryAllowUpdateBranch | Bool | Indicates whether pull request head branches that are behind their base branches can be updated, even if not required to be up-to-date before merging. | ||
| RepositoryViewerPermission | String | The permission level of the authenticated user on the repository. Returns null if authenticated as a GitHub App.
The allowed values are ADMIN, MAINTAIN, READ, TRIAGE, WRITE. | ||
| RepositoryViewerSubscription | String | Indicates whether the viewer is watching, not watching, or ignoring updates from this repository.
The allowed values are IGNORED, SUBSCRIBED, UNSUBSCRIBED. | ||
| RepositoryViewerHasStarred | Bool | Indicates whether the currently authenticated viewer has starred this repository. | ||
| RepositoryViewerDefaultCommitEmail | String | The email address the viewer used for their last commit in this repository. | ||
| RepositoryViewerDefaultMergeMethod | String | The last merge method used by the viewer or the default merge method for the repository (for example, 'MERGE', 'SQUASH', 'REBASE'). | ||
| RepositoryViewerPossibleCommitEmails | String | A list of email addresses the viewer can use for commits in this repository. | ||
| RepositoryViewerCanAdminister | Bool | Indicates whether the viewer has administrative permissions on this repository. | ||
| RepositoryViewerCanSubscribe | Bool | Indicates whether the viewer can change their subscription status for this repository. | ||
| RepositoryViewerCanCreateProjects | Bool | Indicates whether the viewer has permission to create new projects for this repository. | ||
| RepositoryViewerCanUpdateTopics | Bool | Indicates whether the viewer can update the topics associated with this repository. | ||
| RepositoryCodeOfConductId | String | The unique identifier for the repository's Code of Conduct. | ||
| RepositoryCodeOfConductName | String | The formal name of the Code of Conduct associated with this repository. | ||
| RepositoryCodeOfConductBody | String | The full text of the repository's Code of Conduct. | ||
| RepositoryCodeOfConductKey | String | The unique key representing the repository's Code of Conduct. | ||
| RepositoryCodeOfConductUrl | String | The full HTTP URL for accessing the repository's Code of Conduct. | ||
| RepositoryCodeOfConductResourcePath | String | The relative HTTP path for accessing the repository's Code of Conduct. | ||
| RepositoryDefaultBranchRefId | String | The unique identifier for the default branch reference of the repository. | ||
| RepositoryDefaultBranchRefName | String | The name of the default branch of the repository (for example, 'main', 'master'). | ||
| RepositoryInteractionAbilityLimit | String | The current interaction restrictions enabled on this repository, such as limiting interactions to collaborators only. | ||
| RepositoryInteractionAbilityOrigin | String | The origin or reason for the currently active interaction restrictions on this repository. | ||
| RepositoryInteractionAbilityExpiresAt | Datetime | The expiration date and time for the currently active interaction restrictions on this repository. | ||
| RepositoryLatestReleaseId | String | The unique identifier for the latest release in this repository. | ||
| RepositoryLatestReleaseName | String | The title of the latest release in this repository. | ||
| RepositoryLicenseId | String | The unique identifier for the license associated with this repository. | ||
| RepositoryLicenseKey | String | The key representing the license associated with this repository (for example, 'MIT', 'GPL-3.0'). | ||
| RepositoryLanguageId | String | The unique identifier for the repository's primary programming language. | ||
| RepositoryLanguageName | String | The name of the repository's primary programming language. | ||
| RepositoryLanguageColor | String | The color associated with the repository's primary programming language, often used for visualizations. | ||
| RepositoryPushedAt | Datetime | The date and time when the repository was last pushed to. | ||
| RepositoryArchivedAt | Datetime | The date and time when the repository was archived. | ||
| RepositoryCreatedAt | Datetime | The date and time when the repository was created. | ||
| RepositoryUpdatedAt | Datetime | The date and time when the repository's details were last updated. | ||
| RepositoryPlanFeaturesCodeOwners | Bool | Indicates whether reviews can be automatically requested and enforced using a CODEOWNERS file in this repository. | ||
| RepositoryPlanFeaturesDraftPullRequests | Bool | Indicates whether pull requests can be created as drafts or converted to draft status. | ||
| RepositoryPlanFeaturesMaximumAssignees | Int | The maximum number of users that can be assigned to a single issue or pull request. | ||
| RepositoryPlanFeaturesMaximumManualReviewRequests | Int | The maximum number of manually requested reviews allowed on a pull request. | ||
| RepositoryPlanFeaturesTeamReviewRequests | Bool | Indicates whether teams can be requested to review pull requests. | ||
| CustomTextId | String | A unique identifier for the custom text field. | ||
| CustomTextDatabaseId | Int | The primary key of the custom text field in the database, used for internal reference. | ||
| CustomTextCreatorLogin | String | The username of the actor who created the custom text field. | ||
| CustomTextCreatedAt | Datetime | The date and time when the custom text field was created. | ||
| CustomTextUpdatedAt | Datetime | The date and time when the custom text field was last updated. | ||
| CustomTextText | String | The text value of the custom field. | ||
| CustomNumberId | String | A unique identifier for the custom number field. | ||
| CustomNumberDatabaseId | Int | The primary key of the custom number field in the database, used for internal reference. | ||
| CustomNumberCreatorLogin | String | The username of the actor who created the custom number field. | ||
| CustomNumberCreatedAt | Datetime | The date and time when the custom number field was created. | ||
| CustomNumberUpdatedAt | Datetime | The date and time when the custom number field was last updated. | ||
| CustomNumberNumber | Double | A numeric value represented as a floating-point number in the custom field. | ||
| CustomDateId | String | A unique identifier for the custom date field. | ||
| CustomDateDatabaseId | Int | The primary key of the custom date field in the database, used for internal reference. | ||
| CustomDateCreatorLogin | String | The username of the actor who created the custom date field. | ||
| CustomDateCreatedAt | Datetime | The date and time when the custom date field was created. | ||
| CustomDateUpdatedAt | Datetime | The date and time when the custom date field was last updated. | ||
| CustomDateDate | Date | The date value stored in the custom date field. | ||
| CustomSingleSelectId | String | A unique identifier for the custom single-select field. | ||
| CustomSingleSelectDatabaseId | Int | The primary key of the custom single-select field in the database, used for internal reference. | ||
| CustomSingleSelectCreatorLogin | String | The username of the actor who created the custom single-select field. | ||
| CustomSingleSelectCreatedAt | Datetime | The date and time when the custom single-select field was created. | ||
| CustomSingleSelectUpdatedAt | Datetime | The date and time when the custom single-select field was last updated. | ||
| CustomSingleSelectName | String | The name of the selected option in the custom single-select field. | ||
| CustomSingleSelectNameHTML | String | The HTML-rendered name of the selected option in the custom single-select field. | ||
| CustomSingleSelectDescription | String | A plain-text description explaining the meaning of the selected option in the custom single-select field. | ||
| CustomSingleSelectDescriptionHTML | String | The HTML-rendered description of the selected option in the custom single-select field. | ||
| CustomSingleSelectColor | String | The color associated with the selected option in the custom single-select field. | ||
| CustomSingleSelectOptionId | String | The unique identifier for the selected option in the custom single-select field. | ||
| CustomIterationId | String | A unique identifier for the custom iteration field. | ||
| CustomIterationDatabaseId | Int | The primary key of the custom iteration field in the database, used for internal reference. | ||
| CustomIterationCreatorLogin | String | The username of the actor who created the custom iteration field. | ||
| CustomIterationCreatedAt | Datetime | The date and time when the custom iteration field was created. | ||
| CustomIterationUpdatedAt | Datetime | The date and time when the custom iteration field was last updated. | ||
| CustomIterationTitle | String | The title of the custom iteration. | ||
| CustomIterationTitleHTML | String | The title of the custom iteration, rendered in HTML. | ||
| CustomIterationStartDate | Date | The start date for the custom iteration. | ||
| CustomIterationDuration | Int | The duration of the custom iteration, measured in days. | ||
| CustomIterationIterationId | String | The unique identifier for the iteration associated with the custom iteration field. |
Offers a complete and unfiltered view of all project items, facilitating comprehensive project analysis.
The Sync App processes all filters client-side within the Sync App. The following query is the only one processed server-side:
SELECT * FROM [ItemsView]
| Name | Type | References | OrderBySupport | Description |
| ItemId [KEY] | String | A unique identifier for the item. | ||
| FullDatabaseId | Long | The primary key of the item in the database, represented as a BigInt for scalability. | ||
| UpdatedAt | Datetime | The date and time when the item or its details were last updated. | ||
| CreatedAt | Datetime | The date and time when the item was created. | ||
| IsArchived | Bool | Indicates whether the item is archived and no longer actively managed. | ||
| Type | String | The type of the item, such as 'Issue', 'Pull Request', or another classification. | ||
| PullRequestState | String | The current state of the pull request, such as 'OPEN', 'CLOSED', or 'MERGED'. | ||
| IssueState | String | The current state of the issue, such as 'OPEN', 'CLOSED', or 'IN_PROGRESS'. | ||
| Reason | String | The reason for the current state of the issue, such as 'COMPLETED' or 'NOT_PLANNED'. | ||
| Title | String | The text value representing the title of the item. | ||
| Assignees | String | A comma-separated list of usernames assigned to the item. | ||
| Status | String | The name of the selected option in a single-select status field. | ||
| Labels | String | A comma-separated list of labels applied to the item. | ||
| Linked pull requests | String | A comma-separated list of pull request numbers linked to this item. | ||
| Milestone | String | The title of the milestone associated with this item. | ||
| Repository | String | The full name of the repository containing this item, including the owner's login (for example, 'owner/repository-name'). | ||
| Reviewers | String | A comma-separated list of usernames assigned as reviewers for this item. | ||
| CustomText | String | A text value stored in a custom text field. | ||
| CustomNumber | Double | A numeric value stored in a custom number field, represented as a float. | ||
| CustomDate | Date | A date value stored in a custom date field. | ||
| CustomSingleSelect | String | The name of the selected option in a custom single-select field. | ||
| CustomIteration | String | The title of the iteration associated with this item. | ||
| DatabaseId | Int | (Deprecated) The primary key of the item in the database, represented as an integer. |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| OwnerLogin | A username used for an individual user account or a login name designated for an organization account. |
| Property | Description |
| OAuthClientId | Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. |
| OAuthClientSecret | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Schema | Restricts access to data within the specified schema. |
| Property | Description |
| MaxPointsPerCall | Specifies a target limit on the complexity cost of API calls made by the driver. |
| MaxRows | Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
| MaxThreads | Specifies the number of concurrent requests. |
| Other | Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |
This section provides a complete list of the Connection properties you can configure in the connection string for this provider.
| Property | Description |
| OwnerLogin | A username used for an individual user account or a login name designated for an organization account. |
A username used for an individual user account or a login name designated for an organization account.
You can set this connection property to have the Sync App list repositories and projects owned by a specific user or organization in GitHub.
All table default OwnerLogin filters or similar, where possible, will be set to the value of this property unless explicitly specified in the SQL query.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. |
| OAuthClientSecret | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server. |
Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.
Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
The following table provides port number information for each of the supported protocols.
| Protocol | Default Port | Description |
| TUNNEL | 80 | The port where the Sync App opens a connection to GitHub. Traffic flows back and forth via the proxy at this location. |
| SOCKS4 | 1080 | The port where the Sync App opens a connection to GitHub. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted. |
| SOCKS5 | 1080 | The port where the Sync App sends data to GitHub. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the TCP port to be used for a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Identifies the user ID of the account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the password of the user account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).
This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of the proxy server that you want to route HTTP traffic through.
The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.
For other proxy types, see FirewallType.
Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
The authentication type can be one of the following:
For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
The username of a user account registered with the proxy server specified in the ProxyServer connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyUser |
| BASIC | The user name of a user registered with the proxy server. |
| DIGEST | The user name of a user registered with the proxy server. |
| NEGOTIATE | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NTLM | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NONE | Do not set the ProxyPassword connection property. |
The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.
The password associated with the user specified in the ProxyUser connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyPassword |
| BASIC | The password associated with the proxy server user specified in ProxyUser. |
| DIGEST | The password associated with the proxy server user specified in ProxyUser. |
| NEGOTIATE | The password associated with the Windows user account specified in ProxyUser. |
| NTLM | The password associated with the Windows user account specified in ProxyUser. |
| NONE | Do not set the ProxyPassword connection property. |
For SOCKS 5 authentication or tunneling, see FirewallType.
The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.
The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :
| AUTO | Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.
For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.
The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.
For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Schema | Restricts access to data within the specified schema. |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is %APPDATA%\\CData\\GitHub Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.
If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.
If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.
Restricts access to data within the specified schema.
By default, the Sync App exposes all repositories and projects in the connected account as separate schemas. To restrict access to a specific schema, set this property to the desired schema name. This limits access to only that schema's objects, such as tables, views, and procedures.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| MaxPointsPerCall | Specifies a target limit on the complexity cost of API calls made by the driver. |
| MaxRows | Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
| MaxThreads | Specifies the number of concurrent requests. |
| Other | Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |
Specifies a target limit on the complexity cost of API calls made by the driver.
The Sync App translates your SQL queries to GitHub API calls. The GitHub API assigns a certain number of complexity points to all API calls. It limits the number of complex points worth of calls you can request under various circumstances. The Sync App ensures that all API calls executed consume at or below the number of complexity points set in this connection property, where possible.
The total points used per hour determine your rate limit. Generally, users have a limit of 5,000 points per hour on the GitHub platform.
Specifies the maximum rows returned for queries without aggregation or GROUP BY.
This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.
When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies the number of concurrent requests.
This property allows you to issue multiple requests simultaneously, thereby improving performance.
Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.
Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.
Specify multiple properties in a semicolon-separated list.
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
This property allows you to define which pseudocolumns the Sync App exposes as table columns.
To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"
To include all pseudocolumns for all tables use: "*=*"
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:
{
"MyView": {
"query": "SELECT * FROM Repositories WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.
Refer to User Defined Views for more information.