jprdonnelly/airbyte
1
0
Fork 0
mirror of synced 2025-12-19 18:14:56 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
b2afd6e91e8a074b0aacd11e442f941d788ffced
airbyte/docs/ai-agents/connectors/github/REFERENCE.md
devin-ai-integration[bot] b2afd6e91e docs: update terminology - Platform and AI agents (#70910) 
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: ian.alton@airbyte.io <ian.alton@airbyte.io>
Co-authored-by: octavia-bot[bot] <108746235+octavia-bot[bot]@users.noreply.github.com>
2025-12-13 22:26:24 +00:00

1617 lines
37 KiB
Markdown
Raw Blame History

# Github
## Supported Entities and Actions
| Entity | Actions |
|--------|---------|
| Repositories | [Get](#repositories-get), [List](#repositories-list), [Search](#repositories-search) |
| Org Repositories | [List](#org-repositories-list) |
| Branches | [List](#branches-list), [Get](#branches-get) |
| Commits | [List](#commits-list), [Get](#commits-get) |
| Releases | [List](#releases-list), [Get](#releases-get) |
| Issues | [List](#issues-list), [Get](#issues-get), [Search](#issues-search) |
| Pull Requests | [List](#pull-requests-list), [Get](#pull-requests-get), [Search](#pull-requests-search) |
| Reviews | [List](#reviews-list) |
| Comments | [List](#comments-list), [Get](#comments-get) |
| Pr Comments | [List](#pr-comments-list), [Get](#pr-comments-get) |
| Labels | [List](#labels-list), [Get](#labels-get) |
| Milestones | [List](#milestones-list), [Get](#milestones-get) |
| Organizations | [Get](#organizations-get), [List](#organizations-list) |
| Users | [Get](#users-get), [List](#users-list), [Search](#users-search) |
| Teams | [List](#teams-list), [Get](#teams-get) |
| Tags | [List](#tags-list), [Get](#tags-get) |
| Stargazers | [List](#stargazers-list) |
| Viewer | [Get](#viewer-get) |
| Viewer Repositories | [List](#viewer-repositories-list) |
### Repositories
#### Repositories Get
Gets information about a specific GitHub repository using GraphQL
**Python SDK**
```python
github.repositories.get(
owner="<str>",
repo="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "repositories",
"action": "get",
"params": {
"owner": "<str>",
"repo": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `owner` | `string` | Yes | The account owner of the repository (username or organization) |
| `repo` | `string` | Yes | The name of the repository |
| `fields` | `array<string>` | No | Optional array of field names to select.
If not provided, uses default fields.
|
#### Repositories List
Returns a list of repositories for the specified user using GraphQL
**Python SDK**
```python
github.repositories.list(
username="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "repositories",
"action": "list",
"params": {
"username": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `username` | `string` | Yes | The username of the user whose repositories to list |
| `per_page` | `integer` | No | The number of results per page |
| `after` | `string` | No | Cursor for pagination (from previous response's endCursor) |
| `fields` | `array<string>` | No | Optional array of field names to select.
If not provided, uses default fields.
|
#### Repositories Search
Search for GitHub repositories using GitHub's powerful search syntax.
Examples: "language:python stars:>1000", "topic:machine-learning", "org:facebook is:public"
**Python SDK**
```python
github.repositories.search(
query="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "repositories",
"action": "search",
"params": {
"query": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `query` | `string` | Yes | GitHub repository search query. Examples:
- "language:python stars:>1000"
- "topic:machine-learning"
- "org:facebook is:public"
|
| `limit` | `integer` | No | Number of results to return |
| `after` | `string` | No | Cursor for pagination (from previous response's endCursor) |
| `fields` | `array<string>` | No | Optional array of field names to select.
If not provided, uses default fields.
|
### Org Repositories
#### Org Repositories List
Returns a list of repositories for the specified organization using GraphQL
**Python SDK**
```python
github.org_repositories.list(
org="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "org_repositories",
"action": "list",
"params": {
"org": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `org` | `string` | Yes | The organization login/username |
| `per_page` | `integer` | No | The number of results per page |
| `after` | `string` | No | Cursor for pagination |
| `fields` | `array<string>` | No | Optional array of field names to select |
### Branches
#### Branches List
Returns a list of branches for the specified repository using GraphQL
**Python SDK**
```python
github.branches.list(
owner="<str>",
repo="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "branches",
"action": "list",
"params": {
"owner": "<str>",
"repo": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `owner` | `string` | Yes | The account owner of the repository |
| `repo` | `string` | Yes | The name of the repository |
| `per_page` | `integer` | No | The number of results per page |
| `after` | `string` | No | Cursor for pagination |
| `fields` | `array<string>` | No | Optional array of field names to select |
#### Branches Get
Gets information about a specific branch using GraphQL
**Python SDK**
```python
github.branches.get(
owner="<str>",
repo="<str>",
branch="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "branches",
"action": "get",
"params": {
"owner": "<str>",
"repo": "<str>",
"branch": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `owner` | `string` | Yes | The account owner of the repository |
| `repo` | `string` | Yes | The name of the repository |
| `branch` | `string` | Yes | The branch name |
| `fields` | `array<string>` | No | Optional array of field names to select |
### Commits
#### Commits List
Returns a list of commits for the default branch using GraphQL
**Python SDK**
```python
github.commits.list(
owner="<str>",
repo="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "commits",
"action": "list",
"params": {
"owner": "<str>",
"repo": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `owner` | `string` | Yes | The account owner of the repository |
| `repo` | `string` | Yes | The name of the repository |
| `per_page` | `integer` | No | The number of results per page |
| `after` | `string` | No | Cursor for pagination |
| `fields` | `array<string>` | No | Optional array of field names to select |
#### Commits Get
Gets information about a specific commit by SHA using GraphQL
**Python SDK**
```python
github.commits.get(
owner="<str>",
repo="<str>",
sha="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "commits",
"action": "get",
"params": {
"owner": "<str>",
"repo": "<str>",
"sha": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `owner` | `string` | Yes | The account owner of the repository |
| `repo` | `string` | Yes | The name of the repository |
| `sha` | `string` | Yes | The commit SHA |
| `fields` | `array<string>` | No | Optional array of field names to select |
### Releases
#### Releases List
Returns a list of releases for the specified repository using GraphQL
**Python SDK**
```python
github.releases.list(
owner="<str>",
repo="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "releases",
"action": "list",
"params": {
"owner": "<str>",
"repo": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `owner` | `string` | Yes | The account owner of the repository |
| `repo` | `string` | Yes | The name of the repository |
| `per_page` | `integer` | No | The number of results per page |
| `after` | `string` | No | Cursor for pagination |
| `fields` | `array<string>` | No | Optional array of field names to select |
#### Releases Get
Gets information about a specific release by tag name using GraphQL
**Python SDK**
```python
github.releases.get(
owner="<str>",
repo="<str>",
tag="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "releases",
"action": "get",
"params": {
"owner": "<str>",
"repo": "<str>",
"tag": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `owner` | `string` | Yes | The account owner of the repository |
| `repo` | `string` | Yes | The name of the repository |
| `tag` | `string` | Yes | The release tag name |
| `fields` | `array<string>` | No | Optional array of field names to select |
### Issues
#### Issues List
Returns a list of issues for the specified repository using GraphQL
**Python SDK**
```python
github.issues.list(
owner="<str>",
repo="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "issues",
"action": "list",
"params": {
"owner": "<str>",
"repo": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `owner` | `string` | Yes | The account owner of the repository |
| `repo` | `string` | Yes | The name of the repository |
| `states` | `array<"OPEN" \| "CLOSED">` | No | Filter by issue state |
| `per_page` | `integer` | No | The number of results per page |
| `after` | `string` | No | Cursor for pagination |
| `fields` | `array<string>` | No | Optional array of field names to select |
#### Issues Get
Gets information about a specific issue using GraphQL
**Python SDK**
```python
github.issues.get(
owner="<str>",
repo="<str>",
number=0
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "issues",
"action": "get",
"params": {
"owner": "<str>",
"repo": "<str>",
"number": 0
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `owner` | `string` | Yes | The account owner of the repository |
| `repo` | `string` | Yes | The name of the repository |
| `number` | `integer` | Yes | The issue number |
| `fields` | `array<string>` | No | Optional array of field names to select |
#### Issues Search
Search for issues using GitHub's search syntax
**Python SDK**
```python
github.issues.search(
query="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "issues",
"action": "search",
"params": {
"query": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `query` | `string` | Yes | GitHub issue search query. Examples:
- "repo:owner/name is:issue is:open"
- "repo:owner/name is:issue label:bug"
|
| `per_page` | `integer` | No | The number of results per page |
| `after` | `string` | No | Cursor for pagination |
| `fields` | `array<string>` | No | Optional array of field names to select |
### Pull Requests
#### Pull Requests List
Returns a list of pull requests for the specified repository using GraphQL
**Python SDK**
```python
github.pull_requests.list(
owner="<str>",
repo="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "pull_requests",
"action": "list",
"params": {
"owner": "<str>",
"repo": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `owner` | `string` | Yes | The account owner of the repository |
| `repo` | `string` | Yes | The name of the repository |
| `states` | `array<"OPEN" \| "CLOSED" \| "MERGED">` | No | Filter by pull request state |
| `per_page` | `integer` | No | The number of results per page |
| `after` | `string` | No | Cursor for pagination |
| `fields` | `array<string>` | No | Optional array of field names to select |
#### Pull Requests Get
Gets information about a specific pull request using GraphQL
**Python SDK**
```python
github.pull_requests.get(
owner="<str>",
repo="<str>",
number=0
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "pull_requests",
"action": "get",
"params": {
"owner": "<str>",
"repo": "<str>",
"number": 0
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `owner` | `string` | Yes | The account owner of the repository |
| `repo` | `string` | Yes | The name of the repository |
| `number` | `integer` | Yes | The pull request number |
| `fields` | `array<string>` | No | Optional array of field names to select |
#### Pull Requests Search
Search for pull requests using GitHub's search syntax
**Python SDK**
```python
github.pull_requests.search(
query="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "pull_requests",
"action": "search",
"params": {
"query": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `query` | `string` | Yes | GitHub PR search query. Examples:
- "repo:owner/name type:pr is:open"
- "repo:owner/name type:pr author:username"
|
| `per_page` | `integer` | No | The number of results per page |
| `after` | `string` | No | Cursor for pagination |
| `fields` | `array<string>` | No | Optional array of field names to select |
### Reviews
#### Reviews List
Returns a list of reviews for the specified pull request using GraphQL
**Python SDK**
```python
github.reviews.list(
owner="<str>",
repo="<str>",
number=0
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "reviews",
"action": "list",
"params": {
"owner": "<str>",
"repo": "<str>",
"number": 0
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `owner` | `string` | Yes | The account owner of the repository |
| `repo` | `string` | Yes | The name of the repository |
| `number` | `integer` | Yes | The pull request number |
| `per_page` | `integer` | No | The number of results per page |
| `after` | `string` | No | Cursor for pagination |
| `fields` | `array<string>` | No | Optional array of field names to select |
### Comments
#### Comments List
Returns a list of comments for the specified issue using GraphQL
**Python SDK**
```python
github.comments.list(
owner="<str>",
repo="<str>",
number=0
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "comments",
"action": "list",
"params": {
"owner": "<str>",
"repo": "<str>",
"number": 0
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `owner` | `string` | Yes | The account owner of the repository |
| `repo` | `string` | Yes | The name of the repository |
| `number` | `integer` | Yes | The issue number |
| `per_page` | `integer` | No | The number of results per page |
| `after` | `string` | No | Cursor for pagination |
| `fields` | `array<string>` | No | Optional array of field names to select |
#### Comments Get
Gets information about a specific issue comment by its GraphQL node ID.
Note: This endpoint requires a GraphQL node ID (e.g., 'IC_kwDOBZtLds6YWTMj'),
not a numeric database ID. You can obtain node IDs from the Comments_List response,
where each comment includes both 'id' (node ID) and 'databaseId' (numeric ID).
**Python SDK**
```python
github.comments.get(
id="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "comments",
"action": "get",
"params": {
"id": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `id` | `string` | Yes | The GraphQL node ID of the comment |
| `fields` | `array<string>` | No | Optional array of field names to select |
### Pr Comments
#### Pr Comments List
Returns a list of comments for the specified pull request using GraphQL
**Python SDK**
```python
github.pr_comments.list(
owner="<str>",
repo="<str>",
number=0
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "pr_comments",
"action": "list",
"params": {
"owner": "<str>",
"repo": "<str>",
"number": 0
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `owner` | `string` | Yes | The account owner of the repository |
| `repo` | `string` | Yes | The name of the repository |
| `number` | `integer` | Yes | The pull request number |
| `per_page` | `integer` | No | The number of results per page |
| `after` | `string` | No | Cursor for pagination |
| `fields` | `array<string>` | No | Optional array of field names to select |
#### Pr Comments Get
Gets information about a specific pull request comment by its GraphQL node ID.
Note: This endpoint requires a GraphQL node ID (e.g., 'IC_kwDOBZtLds6YWTMj'),
not a numeric database ID. You can obtain node IDs from the PRComments_List response,
where each comment includes both 'id' (node ID) and 'databaseId' (numeric ID).
**Python SDK**
```python
github.pr_comments.get(
id="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "pr_comments",
"action": "get",
"params": {
"id": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `id` | `string` | Yes | The GraphQL node ID of the comment |
| `fields` | `array<string>` | No | Optional array of field names to select |
### Labels
#### Labels List
Returns a list of labels for the specified repository using GraphQL
**Python SDK**
```python
github.labels.list(
owner="<str>",
repo="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "labels",
"action": "list",
"params": {
"owner": "<str>",
"repo": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `owner` | `string` | Yes | The account owner of the repository |
| `repo` | `string` | Yes | The name of the repository |
| `per_page` | `integer` | No | The number of results per page |
| `after` | `string` | No | Cursor for pagination |
| `fields` | `array<string>` | No | Optional array of field names to select |
#### Labels Get
Gets information about a specific label by name using GraphQL
**Python SDK**
```python
github.labels.get(
owner="<str>",
repo="<str>",
name="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "labels",
"action": "get",
"params": {
"owner": "<str>",
"repo": "<str>",
"name": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `owner` | `string` | Yes | The account owner of the repository |
| `repo` | `string` | Yes | The name of the repository |
| `name` | `string` | Yes | The label name |
| `fields` | `array<string>` | No | Optional array of field names to select |
### Milestones
#### Milestones List
Returns a list of milestones for the specified repository using GraphQL
**Python SDK**
```python
github.milestones.list(
owner="<str>",
repo="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "milestones",
"action": "list",
"params": {
"owner": "<str>",
"repo": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `owner` | `string` | Yes | The account owner of the repository |
| `repo` | `string` | Yes | The name of the repository |
| `states` | `array<"OPEN" \| "CLOSED">` | No | Filter by milestone state |
| `per_page` | `integer` | No | The number of results per page |
| `after` | `string` | No | Cursor for pagination |
| `fields` | `array<string>` | No | Optional array of field names to select |
#### Milestones Get
Gets information about a specific milestone by number using GraphQL
**Python SDK**
```python
github.milestones.get(
owner="<str>",
repo="<str>",
number=0
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "milestones",
"action": "get",
"params": {
"owner": "<str>",
"repo": "<str>",
"number": 0
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `owner` | `string` | Yes | The account owner of the repository |
| `repo` | `string` | Yes | The name of the repository |
| `number` | `integer` | Yes | The milestone number |
| `fields` | `array<string>` | No | Optional array of field names to select |
### Organizations
#### Organizations Get
Gets information about a specific organization using GraphQL
**Python SDK**
```python
github.organizations.get(
org="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "organizations",
"action": "get",
"params": {
"org": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `org` | `string` | Yes | The organization login/username |
| `fields` | `array<string>` | No | Optional array of field names to select |
#### Organizations List
Returns a list of organizations the user belongs to using GraphQL
**Python SDK**
```python
github.organizations.list(
username="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "organizations",
"action": "list",
"params": {
"username": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `username` | `string` | Yes | The username of the user |
| `per_page` | `integer` | No | The number of results per page |
| `after` | `string` | No | Cursor for pagination |
| `fields` | `array<string>` | No | Optional array of field names to select |
### Users
#### Users Get
Gets information about a specific user using GraphQL
**Python SDK**
```python
github.users.get(
username="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "users",
"action": "get",
"params": {
"username": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `username` | `string` | Yes | The username of the user |
| `fields` | `array<string>` | No | Optional array of field names to select |
#### Users List
Returns a list of members for the specified organization using GraphQL
**Python SDK**
```python
github.users.list(
org="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "users",
"action": "list",
"params": {
"org": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `org` | `string` | Yes | The organization login/username |
| `per_page` | `integer` | No | The number of results per page |
| `after` | `string` | No | Cursor for pagination |
| `fields` | `array<string>` | No | Optional array of field names to select |
#### Users Search
Search for GitHub users using search syntax
**Python SDK**
```python
github.users.search(
query="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "users",
"action": "search",
"params": {
"query": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `query` | `string` | Yes | GitHub user search query. Examples:
- "location:san francisco"
- "followers:>1000"
|
| `limit` | `integer` | No | Number of results to return |
| `after` | `string` | No | Cursor for pagination |
| `fields` | `array<string>` | No | Optional array of field names to select |
### Teams
#### Teams List
Returns a list of teams for the specified organization using GraphQL
**Python SDK**
```python
github.teams.list(
org="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "teams",
"action": "list",
"params": {
"org": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `org` | `string` | Yes | The organization login/username |
| `per_page` | `integer` | No | The number of results per page |
| `after` | `string` | No | Cursor for pagination |
| `fields` | `array<string>` | No | Optional array of field names to select |
#### Teams Get
Gets information about a specific team using GraphQL
**Python SDK**
```python
github.teams.get(
org="<str>",
team_slug="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "teams",
"action": "get",
"params": {
"org": "<str>",
"team_slug": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `org` | `string` | Yes | The organization login/username |
| `team_slug` | `string` | Yes | The team slug |
| `fields` | `array<string>` | No | Optional array of field names to select |
### Tags
#### Tags List
Returns a list of tags for the specified repository using GraphQL
**Python SDK**
```python
github.tags.list(
owner="<str>",
repo="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "tags",
"action": "list",
"params": {
"owner": "<str>",
"repo": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `owner` | `string` | Yes | The account owner of the repository |
| `repo` | `string` | Yes | The name of the repository |
| `per_page` | `integer` | No | The number of results per page |
| `after` | `string` | No | Cursor for pagination |
| `fields` | `array<string>` | No | Optional array of field names to select |
#### Tags Get
Gets information about a specific tag by name using GraphQL
**Python SDK**
```python
github.tags.get(
owner="<str>",
repo="<str>",
tag="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "tags",
"action": "get",
"params": {
"owner": "<str>",
"repo": "<str>",
"tag": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `owner` | `string` | Yes | The account owner of the repository |
| `repo` | `string` | Yes | The name of the repository |
| `tag` | `string` | Yes | The tag name |
| `fields` | `array<string>` | No | Optional array of field names to select |
### Stargazers
#### Stargazers List
Returns a list of users who have starred the repository using GraphQL
**Python SDK**
```python
github.stargazers.list(
owner="<str>",
repo="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "stargazers",
"action": "list",
"params": {
"owner": "<str>",
"repo": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `owner` | `string` | Yes | The account owner of the repository |
| `repo` | `string` | Yes | The name of the repository |
| `per_page` | `integer` | No | The number of results per page |
| `after` | `string` | No | Cursor for pagination |
| `fields` | `array<string>` | No | Optional array of field names to select |
### Viewer
#### Viewer Get
Gets information about the currently authenticated user.
This is useful when you don't know the username but need to access
the current user's profile, permissions, or associated resources.
**Python SDK**
```python
github.viewer.get()
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "viewer",
"action": "get"
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `fields` | `array<string>` | No | Optional array of field names to select |
### Viewer Repositories
#### Viewer Repositories List
Returns a list of repositories owned by the authenticated user.
Unlike Repositories_List which requires a username, this endpoint
automatically lists repositories for the current authenticated user.
**Python SDK**
```python
github.viewer_repositories.list()
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "viewer_repositories",
"action": "list"
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `per_page` | `integer` | No | The number of results per page |
| `after` | `string` | No | Cursor for pagination (from previous response's endCursor) |
| `fields` | `array<string>` | No | Optional array of field names to select |
## Authentication
The Github connector supports the following authentication methods:
### Authentication
| Field Name | Type | Required | Description |
|------------|------|----------|-------------|
| `access_token` | `str` | No | OAuth2 access token |
| `refresh_token` | `str` | No | OAuth2 refresh token (optional) |
| `client_id` | `str` | No | OAuth2 client ID (optional) |
| `client_secret` | `str` | No | OAuth2 client secret (optional) |
#### Example
**Python SDK**
```python
GithubConnector(
auth_config=GithubAuthConfig(
access_token="<OAuth2 access token>",
refresh_token="<OAuth2 refresh token (optional)>",
client_id="<OAuth2 client ID (optional)>",
client_secret="<OAuth2 client secret (optional)>"
)
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"connector_definition_id": "ef69ef6e-aa7f-4af1-a01d-ef775033524e",
"auth_config": {
"access_token": "<OAuth2 access token>",
"refresh_token": "<OAuth2 refresh token (optional)>",
"client_id": "<OAuth2 client ID (optional)>",
"client_secret": "<OAuth2 client secret (optional)>"
},
"name": "My Github Connector"
}'
```
Reference in New Issue View Git Blame Copy Permalink