List cron tasks
Authorizations:
query Parameters
page | integer page number of results to return (1-based) |
limit | integer page size of results |
Responses
Response samples
- 200
[- {
- "exec_times": 0,
- "name": "string",
- "next": "2019-08-24T14:15:22Z",
- "prev": "2019-08-24T14:15:22Z",
- "schedule": "string"
}
]
List all emails
Authorizations:
query Parameters
page | integer page number of results to return (1-based) |
limit | integer page size of results |
Responses
Response samples
- 200
[- {
- "email": "user@example.com",
- "primary": true,
- "user_id": 0,
- "username": "string",
- "verified": true
}
]
Search all emails
Authorizations:
query Parameters
q | string keyword |
page | integer page number of results to return (1-based) |
limit | integer page size of results |
Responses
Response samples
- 200
[- {
- "email": "user@example.com",
- "primary": true,
- "user_id": 0,
- "username": "string",
- "verified": true
}
]
List system's webhooks
Authorizations:
query Parameters
page | integer page number of results to return (1-based) |
limit | integer page size of results |
Responses
Response samples
- 200
[- {
- "active": true,
- "authorization_header": "string",
- "branch_filter": "string",
- "config": {
- "property1": "string",
- "property2": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "events": [
- "string"
], - "id": 0,
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
Create a hook
Authorizations:
Request Body schema: application/jsonrequired
active | boolean Default: false |
authorization_header | string |
branch_filter | string |
required | object (CreateHookOptionConfig) CreateHookOptionConfig has all config options in it required are "content_type" and "url" Required |
events | Array of strings |
type required | string Enum: "dingtalk" "discord" "gitea" "gogs" "msteams" "slack" "telegram" "feishu" "wechatwork" "packagist" |
Responses
Request samples
- Payload
{- "active": false,
- "authorization_header": "string",
- "branch_filter": "string",
- "config": {
- "property1": "string",
- "property2": "string"
}, - "events": [
- "string"
], - "type": "dingtalk"
}
Response samples
- 201
{- "active": true,
- "authorization_header": "string",
- "branch_filter": "string",
- "config": {
- "property1": "string",
- "property2": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "events": [
- "string"
], - "id": 0,
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
Get a hook
Authorizations:
path Parameters
id required | integer <int64> id of the hook to get |
Responses
Response samples
- 200
{- "active": true,
- "authorization_header": "string",
- "branch_filter": "string",
- "config": {
- "property1": "string",
- "property2": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "events": [
- "string"
], - "id": 0,
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
Update a hook
Authorizations:
path Parameters
id required | integer <int64> id of the hook to update |
Request Body schema: application/json
active | boolean |
authorization_header | string |
branch_filter | string |
object | |
events | Array of strings |
Responses
Request samples
- Payload
{- "active": true,
- "authorization_header": "string",
- "branch_filter": "string",
- "config": {
- "property1": "string",
- "property2": "string"
}, - "events": [
- "string"
]
}
Response samples
- 200
{- "active": true,
- "authorization_header": "string",
- "branch_filter": "string",
- "config": {
- "property1": "string",
- "property2": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "events": [
- "string"
], - "id": 0,
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
List all organizations
Authorizations:
query Parameters
page | integer page number of results to return (1-based) |
limit | integer page size of results |
Responses
Response samples
- 200
[- {
- "avatar_url": "string",
- "description": "string",
- "email": "string",
- "full_name": "string",
- "id": 0,
- "location": "string",
- "name": "string",
- "repo_admin_change_team_access": true,
- "username": "string",
- "visibility": "string",
- "website": "string"
}
]
List unadopted repositories
Authorizations:
query Parameters
page | integer page number of results to return (1-based) |
limit | integer page size of results |
pattern | string pattern of repositories to search for |
Responses
Response samples
- 200
[- "string"
]
Search users according filter conditions
Authorizations:
query Parameters
source_id | integer <int64> ID of the user's login source to search for |
login_name | string user's login name to search for |
page | integer page number of results to return (1-based) |
limit | integer page size of results |
Responses
Response samples
- 200
[- {
- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}
]
Create a user
Authorizations:
Request Body schema: application/json
created_at | string <date-time> For explicitly setting the user creation timestamp. Useful when users are migrated from other systems. When omitted, the user's creation timestamp will be set to "now". |
email required | string <email> |
full_name | string |
login_name | string |
must_change_password | boolean |
password | string |
restricted | boolean |
send_notify | boolean |
source_id | integer <int64> |
username required | string |
visibility | string |
Responses
Request samples
- Payload
{- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "full_name": "string",
- "login_name": "string",
- "must_change_password": true,
- "password": "string",
- "restricted": true,
- "send_notify": true,
- "source_id": 0,
- "username": "string",
- "visibility": "string"
}
Response samples
- 201
{- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}
Edit an existing user
Authorizations:
path Parameters
username required | string username of user to edit |
Request Body schema: application/json
active | boolean |
admin | boolean |
allow_create_organization | boolean |
allow_git_hook | boolean |
allow_import_local | boolean |
description | string |
string <email> | |
full_name | string |
location | string |
login_name required | string |
max_repo_creation | integer <int64> |
must_change_password | boolean |
password | string |
prohibit_login | boolean |
restricted | boolean |
source_id required | integer <int64> |
visibility | string |
website | string |
Responses
Request samples
- Payload
{- "active": true,
- "admin": true,
- "allow_create_organization": true,
- "allow_git_hook": true,
- "allow_import_local": true,
- "description": "string",
- "email": "user@example.com",
- "full_name": "string",
- "location": "string",
- "login_name": "string",
- "max_repo_creation": 0,
- "must_change_password": true,
- "password": "string",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "visibility": "string",
- "website": "string"
}
Response samples
- 200
{- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}
Add a badge to a user
Authorizations:
path Parameters
username required | string username of user |
Request Body schema: application/json
badge_slugs | Array of strings |
Responses
Request samples
- Payload
{- "badge_slugs": [
- "badge1",
- "badge2"
]
}
Remove a badge from a user
Authorizations:
path Parameters
username required | string username of user |
Request Body schema:
badge_slugs | Array of strings |
Responses
Request samples
- Payload
{- "badge_slugs": [
- "badge1",
- "badge2"
]
}
Add a public key on behalf of a user
Authorizations:
path Parameters
username required | string username of the user |
Request Body schema: application/json
key required | string unique An armored SSH key to add |
read_only | boolean Describe if the key has only read access or read/write |
title required | string unique Title of the key to add |
Responses
Request samples
- Payload
{- "key": "string",
- "read_only": true,
- "title": "string"
}
Response samples
- 201
{- "created_at": "2019-08-24T14:15:22Z",
- "fingerprint": "string",
- "id": 0,
- "key": "string",
- "key_type": "string",
- "read_only": true,
- "title": "string",
- "url": "string",
- "user": {
- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}
}
Create an organization
Authorizations:
path Parameters
username required | string username of the user that will own the created organization |
Request Body schema: application/jsonrequired
description | string |
string | |
full_name | string |
location | string |
repo_admin_change_team_access | boolean |
username required | string |
visibility | string Enum: "public" "limited" "private" possible values are |
website | string |
Responses
Request samples
- Payload
{- "description": "string",
- "email": "string",
- "full_name": "string",
- "location": "string",
- "repo_admin_change_team_access": true,
- "username": "string",
- "visibility": "public",
- "website": "string"
}
Response samples
- 201
{- "avatar_url": "string",
- "description": "string",
- "email": "string",
- "full_name": "string",
- "id": 0,
- "location": "string",
- "name": "string",
- "repo_admin_change_team_access": true,
- "username": "string",
- "visibility": "string",
- "website": "string"
}
Rename a user
Authorizations:
path Parameters
username required | string existing username of user |
Request Body schema: required
new_username required | string unique New username for this user. This name cannot be in use yet by any other user. |
Responses
Request samples
- Payload
{- "new_username": "string"
}
Create a repository on behalf of a user
Authorizations:
path Parameters
username required | string username of the user. This user will own the created repository |
Request Body schema: application/jsonrequired
auto_init | boolean Whether the repository should be auto-initialized? |
default_branch | string DefaultBranch of the repository (used when initializes and in template) |
description | string Description of the repository to create |
gitignores | string Gitignores to use |
issue_labels | string Label-Set to use |
license | string License to use |
name required | string unique Name of the repository to create |
object_format_name | string Enum: "sha1" "sha256" ObjectFormatName of the underlying git repository |
private | boolean Whether the repository is private |
readme | string Readme of the repository to create |
template | boolean Whether the repository is template |
trust_model | string Enum: "default" "collaborator" "committer" "collaboratorcommitter" TrustModel of the repository |
Responses
Request samples
- Payload
{- "auto_init": true,
- "default_branch": "string",
- "description": "string",
- "gitignores": "string",
- "issue_labels": "string",
- "license": "string",
- "name": "string",
- "object_format_name": "sha1",
- "private": true,
- "readme": "string",
- "template": true,
- "trust_model": "default"
}
Response samples
- 201
{- "allow_fast_forward_only_merge": true,
- "allow_merge_commits": true,
- "allow_rebase": true,
- "allow_rebase_explicit": true,
- "allow_rebase_update": true,
- "allow_squash_merge": true,
- "archived": true,
- "archived_at": "2019-08-24T14:15:22Z",
- "avatar_url": "string",
- "clone_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "default_allow_maintainer_edit": true,
- "default_branch": "string",
- "default_delete_branch_after_merge": true,
- "default_merge_style": "string",
- "description": "string",
- "empty": true,
- "external_tracker": {
- "external_tracker_format": "string",
- "external_tracker_regexp_pattern": "string",
- "external_tracker_style": "string",
- "external_tracker_url": "string"
}, - "external_wiki": {
- "external_wiki_url": "string"
}, - "fork": true,
- "forks_count": 0,
- "full_name": "string",
- "has_actions": true,
- "has_issues": true,
- "has_packages": true,
- "has_projects": true,
- "has_pull_requests": true,
- "has_releases": true,
- "has_wiki": true,
- "html_url": "string",
- "id": 0,
- "ignore_whitespace_conflicts": true,
- "internal": true,
- "internal_tracker": {
- "allow_only_contributors_to_track_time": true,
- "enable_issue_dependencies": true,
- "enable_time_tracker": true
}, - "language": "string",
- "languages_url": "string",
- "link": "string",
- "mirror": true,
- "mirror_interval": "string",
- "mirror_updated": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_format_name": "sha1",
- "open_issues_count": 0,
- "open_pr_counter": 0,
- "original_url": "string",
- "owner": {
- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}, - "parent": { },
- "permissions": {
- "admin": true,
- "pull": true,
- "push": true
}, - "private": true,
- "projects_mode": "string",
- "release_counter": 0,
- "repo_transfer": {
- "doer": {
- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}, - "recipient": {
- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}, - "teams": [
- {
- "can_create_org_repo": true,
- "description": "string",
- "id": 0,
- "includes_all_repositories": true,
- "name": "string",
- "organization": {
- "avatar_url": "string",
- "description": "string",
- "email": "string",
- "full_name": "string",
- "id": 0,
- "location": "string",
- "name": "string",
- "repo_admin_change_team_access": true,
- "username": "string",
- "visibility": "string",
- "website": "string"
}, - "permission": "none",
- "units": [
- "repo.code",
- "repo.issues",
- "repo.ext_issues",
- "repo.wiki",
- "repo.pulls",
- "repo.releases",
- "repo.projects",
- "repo.ext_wiki"
], - "units_map": {
- "repo.code": "read",
- "repo.ext_issues": "none",
- "repo.ext_wiki": "none",
- "repo.issues": "write",
- "repo.projects": "none",
- "repo.pulls": "owner",
- "repo.releases": "none",
- "repo.wiki": "admin"
}
}
]
}, - "size": 0,
- "ssh_url": "string",
- "stars_count": 0,
- "template": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "watchers_count": 0,
- "website": "string"
}
Returns all labels in a template
Authorizations:
path Parameters
name required | string name of the template |
Responses
Response samples
- 200
[- {
- "color": "00aabb",
- "description": "string",
- "exclusive": false,
- "name": "string"
}
]
Returns information about a license template
Authorizations:
path Parameters
name required | string name of the license |
Responses
Response samples
- 200
{- "body": "string",
- "implementation": "string",
- "key": "string",
- "name": "string",
- "url": "string"
}
Render a markdown document as HTML
Authorizations:
Request Body schema: application/json
Context | string Context to render in: body |
Mode | string Mode to render (comment, gfm, markdown) in: body |
Text | string Text markdown to render in: body |
Wiki | boolean Is it a wiki page ? in: body |
Responses
Request samples
- Payload
{- "Context": "string",
- "Mode": "string",
- "Text": "string",
- "Wiki": true
}
Response samples
- 200
"string"
Render a markup document as HTML
Authorizations:
Request Body schema: application/json
Context | string Context to render in: body |
FilePath | string File path for detecting extension in file mode in: body |
Mode | string Mode to render (comment, gfm, markdown, file) in: body |
Text | string Text markup to render in: body |
Wiki | boolean Is it a wiki page ? in: body |
Responses
Request samples
- Payload
{- "Context": "string",
- "FilePath": "string",
- "Mode": "string",
- "Text": "string",
- "Wiki": true
}
Response samples
- 200
"string"
Returns the nodeinfo of the Gitea application
Authorizations:
Responses
Response samples
- 200
{- "metadata": { },
- "openRegistrations": true,
- "protocols": [
- "string"
], - "services": {
- "inbound": [
- "string"
], - "outbound": [
- "string"
]
}, - "software": {
- "homepage": "string",
- "name": "string",
- "repository": "string",
- "version": "string"
}, - "usage": {
- "localComments": 0,
- "localPosts": 0,
- "users": {
- "activeHalfyear": 0,
- "activeMonth": 0,
- "total": 0
}
}, - "version": "string"
}
List users's notification threads
Authorizations:
query Parameters
all | boolean If true, show notifications marked as read. Default value is false |
status-types | Array of strings Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned. |
subject-type | Array of strings Items Enum: "issue" "pull" "commit" "repository" filter notifications by subject type |
since | string <date-time> Only show notifications updated after the given time. This is a timestamp in RFC 3339 format |
before | string <date-time> Only show notifications updated before the given time. This is a timestamp in RFC 3339 format |
page | integer page number of results to return (1-based) |
limit | integer page size of results |
Responses
Response samples
- 200
[- {
- "id": 0,
- "pinned": true,
- "repository": {
- "allow_fast_forward_only_merge": true,
- "allow_merge_commits": true,
- "allow_rebase": true,
- "allow_rebase_explicit": true,
- "allow_rebase_update": true,
- "allow_squash_merge": true,
- "archived": true,
- "archived_at": "2019-08-24T14:15:22Z",
- "avatar_url": "string",
- "clone_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "default_allow_maintainer_edit": true,
- "default_branch": "string",
- "default_delete_branch_after_merge": true,
- "default_merge_style": "string",
- "description": "string",
- "empty": true,
- "external_tracker": {
- "external_tracker_format": "string",
- "external_tracker_regexp_pattern": "string",
- "external_tracker_style": "string",
- "external_tracker_url": "string"
}, - "external_wiki": {
- "external_wiki_url": "string"
}, - "fork": true,
- "forks_count": 0,
- "full_name": "string",
- "has_actions": true,
- "has_issues": true,
- "has_packages": true,
- "has_projects": true,
- "has_pull_requests": true,
- "has_releases": true,
- "has_wiki": true,
- "html_url": "string",
- "id": 0,
- "ignore_whitespace_conflicts": true,
- "internal": true,
- "internal_tracker": {
- "allow_only_contributors_to_track_time": true,
- "enable_issue_dependencies": true,
- "enable_time_tracker": true
}, - "language": "string",
- "languages_url": "string",
- "link": "string",
- "mirror": true,
- "mirror_interval": "string",
- "mirror_updated": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_format_name": "sha1",
- "open_issues_count": 0,
- "open_pr_counter": 0,
- "original_url": "string",
- "owner": {
- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}, - "parent": { },
- "permissions": {
- "admin": true,
- "pull": true,
- "push": true
}, - "private": true,
- "projects_mode": "string",
- "release_counter": 0,
- "repo_transfer": {
- "doer": {
- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}, - "recipient": {
- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}, - "teams": [
- {
- "can_create_org_repo": true,
- "description": "string",
- "id": 0,
- "includes_all_repositories": true,
- "name": "string",
- "organization": {
- "avatar_url": "string",
- "description": "string",
- "email": "string",
- "full_name": "string",
- "id": 0,
- "location": "string",
- "name": "string",
- "repo_admin_change_team_access": true,
- "username": "string",
- "visibility": "string",
- "website": "string"
}, - "permission": "none",
- "units": [
- "repo.code",
- "repo.issues",
- "repo.ext_issues",
- "repo.wiki",
- "repo.pulls",
- "repo.releases",
- "repo.projects",
- "repo.ext_wiki"
], - "units_map": {
- "repo.code": "read",
- "repo.ext_issues": "none",
- "repo.ext_wiki": "none",
- "repo.issues": "write",
- "repo.projects": "none",
- "repo.pulls": "owner",
- "repo.releases": "none",
- "repo.wiki": "admin"
}
}
]
}, - "size": 0,
- "ssh_url": "string",
- "stars_count": 0,
- "template": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "watchers_count": 0,
- "website": "string"
}, - "subject": {
- "html_url": "string",
- "latest_comment_html_url": "string",
- "latest_comment_url": "string",
- "state": "string",
- "title": "string",
- "type": "string",
- "url": "string"
}, - "unread": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string"
}
]
Mark notification threads as read, pinned or unread
Authorizations:
query Parameters
last_read_at | string <date-time> Describes the last point that notifications were checked. Anything updated since this time will not be updated. |
all | string If true, mark all notifications on this repo. Default value is false |
status-types | Array of strings Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. |
to-status | string Status to mark notifications as, Defaults to read. |
Responses
Response samples
- 205
[- {
- "id": 0,
- "pinned": true,
- "repository": {
- "allow_fast_forward_only_merge": true,
- "allow_merge_commits": true,
- "allow_rebase": true,
- "allow_rebase_explicit": true,
- "allow_rebase_update": true,
- "allow_squash_merge": true,
- "archived": true,
- "archived_at": "2019-08-24T14:15:22Z",
- "avatar_url": "string",
- "clone_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "default_allow_maintainer_edit": true,
- "default_branch": "string",
- "default_delete_branch_after_merge": true,
- "default_merge_style": "string",
- "description": "string",
- "empty": true,
- "external_tracker": {
- "external_tracker_format": "string",
- "external_tracker_regexp_pattern": "string",
- "external_tracker_style": "string",
- "external_tracker_url": "string"
}, - "external_wiki": {
- "external_wiki_url": "string"
}, - "fork": true,
- "forks_count": 0,
- "full_name": "string",
- "has_actions": true,
- "has_issues": true,
- "has_packages": true,
- "has_projects": true,
- "has_pull_requests": true,
- "has_releases": true,
- "has_wiki": true,
- "html_url": "string",
- "id": 0,
- "ignore_whitespace_conflicts": true,
- "internal": true,
- "internal_tracker": {
- "allow_only_contributors_to_track_time": true,
- "enable_issue_dependencies": true,
- "enable_time_tracker": true
}, - "language": "string",
- "languages_url": "string",
- "link": "string",
- "mirror": true,
- "mirror_interval": "string",
- "mirror_updated": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_format_name": "sha1",
- "open_issues_count": 0,
- "open_pr_counter": 0,
- "original_url": "string",
- "owner": {
- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}, - "parent": { },
- "permissions": {
- "admin": true,
- "pull": true,
- "push": true
}, - "private": true,
- "projects_mode": "string",
- "release_counter": 0,
- "repo_transfer": {
- "doer": {
- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}, - "recipient": {
- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}, - "teams": [
- {
- "can_create_org_repo": true,
- "description": "string",
- "id": 0,
- "includes_all_repositories": true,
- "name": "string",
- "organization": {
- "avatar_url": "string",
- "description": "string",
- "email": "string",
- "full_name": "string",
- "id": 0,
- "location": "string",
- "name": "string",
- "repo_admin_change_team_access": true,
- "username": "string",
- "visibility": "string",
- "website": "string"
}, - "permission": "none",
- "units": [
- "repo.code",
- "repo.issues",
- "repo.ext_issues",
- "repo.wiki",
- "repo.pulls",
- "repo.releases",
- "repo.projects",
- "repo.ext_wiki"
], - "units_map": {
- "repo.code": "read",
- "repo.ext_issues": "none",
- "repo.ext_wiki": "none",
- "repo.issues": "write",
- "repo.projects": "none",
- "repo.pulls": "owner",
- "repo.releases": "none",
- "repo.wiki": "admin"
}
}
]
}, - "size": 0,
- "ssh_url": "string",
- "stars_count": 0,
- "template": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "watchers_count": 0,
- "website": "string"
}, - "subject": {
- "html_url": "string",
- "latest_comment_html_url": "string",
- "latest_comment_url": "string",
- "state": "string",
- "title": "string",
- "type": "string",
- "url": "string"
}, - "unread": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string"
}
]
Get notification thread by ID
Authorizations:
path Parameters
id required | string id of notification thread |
Responses
Response samples
- 200
{- "id": 0,
- "pinned": true,
- "repository": {
- "allow_fast_forward_only_merge": true,
- "allow_merge_commits": true,
- "allow_rebase": true,
- "allow_rebase_explicit": true,
- "allow_rebase_update": true,
- "allow_squash_merge": true,
- "archived": true,
- "archived_at": "2019-08-24T14:15:22Z",
- "avatar_url": "string",
- "clone_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "default_allow_maintainer_edit": true,
- "default_branch": "string",
- "default_delete_branch_after_merge": true,
- "default_merge_style": "string",
- "description": "string",
- "empty": true,
- "external_tracker": {
- "external_tracker_format": "string",
- "external_tracker_regexp_pattern": "string",
- "external_tracker_style": "string",
- "external_tracker_url": "string"
}, - "external_wiki": {
- "external_wiki_url": "string"
}, - "fork": true,
- "forks_count": 0,
- "full_name": "string",
- "has_actions": true,
- "has_issues": true,
- "has_packages": true,
- "has_projects": true,
- "has_pull_requests": true,
- "has_releases": true,
- "has_wiki": true,
- "html_url": "string",
- "id": 0,
- "ignore_whitespace_conflicts": true,
- "internal": true,
- "internal_tracker": {
- "allow_only_contributors_to_track_time": true,
- "enable_issue_dependencies": true,
- "enable_time_tracker": true
}, - "language": "string",
- "languages_url": "string",
- "link": "string",
- "mirror": true,
- "mirror_interval": "string",
- "mirror_updated": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_format_name": "sha1",
- "open_issues_count": 0,
- "open_pr_counter": 0,
- "original_url": "string",
- "owner": {
- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}, - "parent": { },
- "permissions": {
- "admin": true,
- "pull": true,
- "push": true
}, - "private": true,
- "projects_mode": "string",
- "release_counter": 0,
- "repo_transfer": {
- "doer": {
- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}, - "recipient": {
- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}, - "teams": [
- {
- "can_create_org_repo": true,
- "description": "string",
- "id": 0,
- "includes_all_repositories": true,
- "name": "string",
- "organization": {
- "avatar_url": "string",
- "description": "string",
- "email": "string",
- "full_name": "string",
- "id": 0,
- "location": "string",
- "name": "string",
- "repo_admin_change_team_access": true,
- "username": "string",
- "visibility": "string",
- "website": "string"
}, - "permission": "none",
- "units": [
- "repo.code",
- "repo.issues",
- "repo.ext_issues",
- "repo.wiki",
- "repo.pulls",
- "repo.releases",
- "repo.projects",
- "repo.ext_wiki"
], - "units_map": {
- "repo.code": "read",
- "repo.ext_issues": "none",
- "repo.ext_wiki": "none",
- "repo.issues": "write",
- "repo.projects": "none",
- "repo.pulls": "owner",
- "repo.releases": "none",
- "repo.wiki": "admin"
}
}
]
}, - "size": 0,
- "ssh_url": "string",
- "stars_count": 0,
- "template": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "watchers_count": 0,
- "website": "string"
}, - "subject": {
- "html_url": "string",
- "latest_comment_html_url": "string",
- "latest_comment_url": "string",
- "state": "string",
- "title": "string",
- "type": "string",
- "url": "string"
}, - "unread": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string"
}
Mark notification thread as read by ID
Authorizations:
path Parameters
id required | string id of notification thread |
query Parameters
to-status | string Default: "read" Status to mark notifications as |
Responses
Response samples
- 205
{- "id": 0,
- "pinned": true,
- "repository": {
- "allow_fast_forward_only_merge": true,
- "allow_merge_commits": true,
- "allow_rebase": true,
- "allow_rebase_explicit": true,
- "allow_rebase_update": true,
- "allow_squash_merge": true,
- "archived": true,
- "archived_at": "2019-08-24T14:15:22Z",
- "avatar_url": "string",
- "clone_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "default_allow_maintainer_edit": true,
- "default_branch": "string",
- "default_delete_branch_after_merge": true,
- "default_merge_style": "string",
- "description": "string",
- "empty": true,
- "external_tracker": {
- "external_tracker_format": "string",
- "external_tracker_regexp_pattern": "string",
- "external_tracker_style": "string",
- "external_tracker_url": "string"
}, - "external_wiki": {
- "external_wiki_url": "string"
}, - "fork": true,
- "forks_count": 0,
- "full_name": "string",
- "has_actions": true,
- "has_issues": true,
- "has_packages": true,
- "has_projects": true,
- "has_pull_requests": true,
- "has_releases": true,
- "has_wiki": true,
- "html_url": "string",
- "id": 0,
- "ignore_whitespace_conflicts": true,
- "internal": true,
- "internal_tracker": {
- "allow_only_contributors_to_track_time": true,
- "enable_issue_dependencies": true,
- "enable_time_tracker": true
}, - "language": "string",
- "languages_url": "string",
- "link": "string",
- "mirror": true,
- "mirror_interval": "string",
- "mirror_updated": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_format_name": "sha1",
- "open_issues_count": 0,
- "open_pr_counter": 0,
- "original_url": "string",
- "owner": {
- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}, - "parent": { },
- "permissions": {
- "admin": true,
- "pull": true,
- "push": true
}, - "private": true,
- "projects_mode": "string",
- "release_counter": 0,
- "repo_transfer": {
- "doer": {
- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}, - "recipient": {
- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}, - "teams": [
- {
- "can_create_org_repo": true,
- "description": "string",
- "id": 0,
- "includes_all_repositories": true,
- "name": "string",
- "organization": {
- "avatar_url": "string",
- "description": "string",
- "email": "string",
- "full_name": "string",
- "id": 0,
- "location": "string",
- "name": "string",
- "repo_admin_change_team_access": true,
- "username": "string",
- "visibility": "string",
- "website": "string"
}, - "permission": "none",
- "units": [
- "repo.code",
- "repo.issues",
- "repo.ext_issues",
- "repo.wiki",
- "repo.pulls",
- "repo.releases",
- "repo.projects",
- "repo.ext_wiki"
], - "units_map": {
- "repo.code": "read",
- "repo.ext_issues": "none",
- "repo.ext_wiki": "none",
- "repo.issues": "write",
- "repo.projects": "none",
- "repo.pulls": "owner",
- "repo.releases": "none",
- "repo.wiki": "admin"
}
}
]
}, - "size": 0,
- "ssh_url": "string",
- "stars_count": 0,
- "template": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "watchers_count": 0,
- "website": "string"
}, - "subject": {
- "html_url": "string",
- "latest_comment_html_url": "string",
- "latest_comment_url": "string",
- "state": "string",
- "title": "string",
- "type": "string",
- "url": "string"
}, - "unread": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string"
}
List users's notification threads on a specific repo
Authorizations:
path Parameters
owner required | string owner of the repo |
repo required | string name of the repo |
query Parameters
all | boolean If true, show notifications marked as read. Default value is false |
status-types | Array of strings Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned |
subject-type | Array of strings Items Enum: "issue" "pull" "commit" "repository" filter notifications by subject type |
since | string <date-time> Only show notifications updated after the given time. This is a timestamp in RFC 3339 format |
before | string <date-time> Only show notifications updated before the given time. This is a timestamp in RFC 3339 format |
page | integer page number of results to return (1-based) |
limit | integer page size of results |
Responses
Response samples
- 200
[- {
- "id": 0,
- "pinned": true,
- "repository": {
- "allow_fast_forward_only_merge": true,
- "allow_merge_commits": true,
- "allow_rebase": true,
- "allow_rebase_explicit": true,
- "allow_rebase_update": true,
- "allow_squash_merge": true,
- "archived": true,
- "archived_at": "2019-08-24T14:15:22Z",
- "avatar_url": "string",
- "clone_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "default_allow_maintainer_edit": true,
- "default_branch": "string",
- "default_delete_branch_after_merge": true,
- "default_merge_style": "string",
- "description": "string",
- "empty": true,
- "external_tracker": {
- "external_tracker_format": "string",
- "external_tracker_regexp_pattern": "string",
- "external_tracker_style": "string",
- "external_tracker_url": "string"
}, - "external_wiki": {
- "external_wiki_url": "string"
}, - "fork": true,
- "forks_count": 0,
- "full_name": "string",
- "has_actions": true,
- "has_issues": true,
- "has_packages": true,
- "has_projects": true,
- "has_pull_requests": true,
- "has_releases": true,
- "has_wiki": true,
- "html_url": "string",
- "id": 0,
- "ignore_whitespace_conflicts": true,
- "internal": true,
- "internal_tracker": {
- "allow_only_contributors_to_track_time": true,
- "enable_issue_dependencies": true,
- "enable_time_tracker": true
}, - "language": "string",
- "languages_url": "string",
- "link": "string",
- "mirror": true,
- "mirror_interval": "string",
- "mirror_updated": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_format_name": "sha1",
- "open_issues_count": 0,
- "open_pr_counter": 0,
- "original_url": "string",
- "owner": {
- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}, - "parent": { },
- "permissions": {
- "admin": true,
- "pull": true,
- "push": true
}, - "private": true,
- "projects_mode": "string",
- "release_counter": 0,
- "repo_transfer": {
- "doer": {
- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}, - "recipient": {
- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}, - "teams": [
- {
- "can_create_org_repo": true,
- "description": "string",
- "id": 0,
- "includes_all_repositories": true,
- "name": "string",
- "organization": {
- "avatar_url": "string",
- "description": "string",
- "email": "string",
- "full_name": "string",
- "id": 0,
- "location": "string",
- "name": "string",
- "repo_admin_change_team_access": true,
- "username": "string",
- "visibility": "string",
- "website": "string"
}, - "permission": "none",
- "units": [
- "repo.code",
- "repo.issues",
- "repo.ext_issues",
- "repo.wiki",
- "repo.pulls",
- "repo.releases",
- "repo.projects",
- "repo.ext_wiki"
], - "units_map": {
- "repo.code": "read",
- "repo.ext_issues": "none",
- "repo.ext_wiki": "none",
- "repo.issues": "write",
- "repo.projects": "none",
- "repo.pulls": "owner",
- "repo.releases": "none",
- "repo.wiki": "admin"
}
}
]
}, - "size": 0,
- "ssh_url": "string",
- "stars_count": 0,
- "template": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "watchers_count": 0,
- "website": "string"
}, - "subject": {
- "html_url": "string",
- "latest_comment_html_url": "string",
- "latest_comment_url": "string",
- "state": "string",
- "title": "string",
- "type": "string",
- "url": "string"
}, - "unread": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string"
}
]
Mark notification threads as read, pinned or unread on a specific repo
Authorizations:
path Parameters
owner required | string owner of the repo |
repo required | string name of the repo |
query Parameters
all | string If true, mark all notifications on this repo. Default value is false |
status-types | Array of strings Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. |
to-status | string Status to mark notifications as. Defaults to read. |
last_read_at | string <date-time> Describes the last point that notifications were checked. Anything updated since this time will not be updated. |
Responses
Response samples
- 205
[- {
- "id": 0,
- "pinned": true,
- "repository": {
- "allow_fast_forward_only_merge": true,
- "allow_merge_commits": true,
- "allow_rebase": true,
- "allow_rebase_explicit": true,
- "allow_rebase_update": true,
- "allow_squash_merge": true,
- "archived": true,
- "archived_at": "2019-08-24T14:15:22Z",
- "avatar_url": "string",
- "clone_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "default_allow_maintainer_edit": true,
- "default_branch": "string",
- "default_delete_branch_after_merge": true,
- "default_merge_style": "string",
- "description": "string",
- "empty": true,
- "external_tracker": {
- "external_tracker_format": "string",
- "external_tracker_regexp_pattern": "string",
- "external_tracker_style": "string",
- "external_tracker_url": "string"
}, - "external_wiki": {
- "external_wiki_url": "string"
}, - "fork": true,
- "forks_count": 0,
- "full_name": "string",
- "has_actions": true,
- "has_issues": true,
- "has_packages": true,
- "has_projects": true,
- "has_pull_requests": true,
- "has_releases": true,
- "has_wiki": true,
- "html_url": "string",
- "id": 0,
- "ignore_whitespace_conflicts": true,
- "internal": true,
- "internal_tracker": {
- "allow_only_contributors_to_track_time": true,
- "enable_issue_dependencies": true,
- "enable_time_tracker": true
}, - "language": "string",
- "languages_url": "string",
- "link": "string",
- "mirror": true,
- "mirror_interval": "string",
- "mirror_updated": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_format_name": "sha1",
- "open_issues_count": 0,
- "open_pr_counter": 0,
- "original_url": "string",
- "owner": {
- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}, - "parent": { },
- "permissions": {
- "admin": true,
- "pull": true,
- "push": true
}, - "private": true,
- "projects_mode": "string",
- "release_counter": 0,
- "repo_transfer": {
- "doer": {
- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}, - "recipient": {
- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}, - "teams": [
- {
- "can_create_org_repo": true,
- "description": "string",
- "id": 0,
- "includes_all_repositories": true,
- "name": "string",
- "organization": {
- "avatar_url": "string",
- "description": "string",
- "email": "string",
- "full_name": "string",
- "id": 0,
- "location": "string",
- "name": "string",
- "repo_admin_change_team_access": true,
- "username": "string",
- "visibility": "string",
- "website": "string"
}, - "permission": "none",
- "units": [
- "repo.code",
- "repo.issues",
- "repo.ext_issues",
- "repo.wiki",
- "repo.pulls",
- "repo.releases",
- "repo.projects",
- "repo.ext_wiki"
], - "units_map": {
- "repo.code": "read",
- "repo.ext_issues": "none",
- "repo.ext_wiki": "none",
- "repo.issues": "write",
- "repo.projects": "none",
- "repo.pulls": "owner",
- "repo.releases": "none",
- "repo.wiki": "admin"
}
}
]
}, - "size": 0,
- "ssh_url": "string",
- "stars_count": 0,
- "template": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "watchers_count": 0,
- "website": "string"
}, - "subject": {
- "html_url": "string",
- "latest_comment_html_url": "string",
- "latest_comment_url": "string",
- "state": "string",
- "title": "string",
- "type": "string",
- "url": "string"
}, - "unread": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string"
}
]
Create a repository in an organization Deprecated
Authorizations:
path Parameters
org required | string name of organization |
Request Body schema: application/json
auto_init | boolean Whether the repository should be auto-initialized? |
default_branch | string DefaultBranch of the repository (used when initializes and in template) |
description | string Description of the repository to create |
gitignores | string Gitignores to use |
issue_labels | string Label-Set to use |
license | string License to use |
name required | string unique Name of the repository to create |
object_format_name | string Enum: "sha1" "sha256" ObjectFormatName of the underlying git repository |
private | boolean Whether the repository is private |
readme | string Readme of the repository to create |
template | boolean Whether the repository is template |
trust_model | string Enum: "default" "collaborator" "committer" "collaboratorcommitter" TrustModel of the repository |
Responses
Request samples
- Payload
{- "auto_init": true,
- "default_branch": "string",
- "description": "string",
- "gitignores": "string",
- "issue_labels": "string",
- "license": "string",
- "name": "string",
- "object_format_name": "sha1",
- "private": true,
- "readme": "string",
- "template": true,
- "trust_model": "default"
}
Response samples
- 201
{- "allow_fast_forward_only_merge": true,
- "allow_merge_commits": true,
- "allow_rebase": true,
- "allow_rebase_explicit": true,
- "allow_rebase_update": true,
- "allow_squash_merge": true,
- "archived": true,
- "archived_at": "2019-08-24T14:15:22Z",
- "avatar_url": "string",
- "clone_url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "default_allow_maintainer_edit": true,
- "default_branch": "string",
- "default_delete_branch_after_merge": true,
- "default_merge_style": "string",
- "description": "string",
- "empty": true,
- "external_tracker": {
- "external_tracker_format": "string",
- "external_tracker_regexp_pattern": "string",
- "external_tracker_style": "string",
- "external_tracker_url": "string"
}, - "external_wiki": {
- "external_wiki_url": "string"
}, - "fork": true,
- "forks_count": 0,
- "full_name": "string",
- "has_actions": true,
- "has_issues": true,
- "has_packages": true,
- "has_projects": true,
- "has_pull_requests": true,
- "has_releases": true,
- "has_wiki": true,
- "html_url": "string",
- "id": 0,
- "ignore_whitespace_conflicts": true,
- "internal": true,
- "internal_tracker": {
- "allow_only_contributors_to_track_time": true,
- "enable_issue_dependencies": true,
- "enable_time_tracker": true
}, - "language": "string",
- "languages_url": "string",
- "link": "string",
- "mirror": true,
- "mirror_interval": "string",
- "mirror_updated": "2019-08-24T14:15:22Z",
- "name": "string",
- "object_format_name": "sha1",
- "open_issues_count": 0,
- "open_pr_counter": 0,
- "original_url": "string",
- "owner": {
- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}, - "parent": { },
- "permissions": {
- "admin": true,
- "pull": true,
- "push": true
}, - "private": true,
- "projects_mode": "string",
- "release_counter": 0,
- "repo_transfer": {
- "doer": {
- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}, - "recipient": {
- "active": true,
- "avatar_url": "string",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "email": "user@example.com",
- "followers_count": 0,
- "following_count": 0,
- "full_name": "string",
- "id": 0,
- "is_admin": true,
- "language": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "location": "string",
- "login": "string",
- "login_name": "empty",
- "prohibit_login": true,
- "restricted": true,
- "source_id": 0,
- "starred_repos_count": 0,
- "visibility": "string",
- "website": "string"
}, - "teams": [
- {
- "can_create_org_repo": true,
- "description": "string",
- "id": 0,
- "includes_all_repositories": true,
- "name": "string",
- "organization": {
- "avatar_url": "string",
- "description": "string",
- "email": "string",
- "full_name": "string",
- "id": 0,
- "location": "string",
- "name": "string",
- "repo_admin_change_team_access": true,
- "username": "string",
- "visibility": "string",
- "website": "string"
}, - "permission": "none",
- "units": [
- "repo.code",
- "repo.issues",
- "repo.ext_issues",
- "repo.wiki",
- "repo.pulls",
- "repo.releases",
- "repo.projects",
- "repo.ext_wiki"
], - "units_map": {
- "repo.code": "read",
- "repo.ext_issues": "none",
- "repo.ext_wiki": "none",
- "repo.issues": "write",
- "repo.projects": "none",
- "repo.pulls": "owner",
- "repo.releases": "none",
- "repo.wiki": "admin"
}
}
]
}, - "size": 0,
- "ssh_url": "string",
- "stars_count": 0,
- "template": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "watchers_count": 0,
- "website": "string"
}
Get list of organizations
Authorizations:
query Parameters
page | integer page number of results to return (1-based) |
limit | integer page size of results |
Responses
Response samples
- 200
[- {
- "avatar_url": "string",
- "description": "string",
- "email": "string",
- "full_name": "string",
- "id": 0,
- "location": "string",
- "name": "string",
- "repo_admin_change_team_access": true,
- "username": "string",
- "visibility": "string",
- "website": "string"
}
]
Create an organization
Authorizations:
Request Body schema: application/jsonrequired
description | string |
string | |
full_name | string |
location | string |
repo_admin_change_team_access | boolean |
username required | string |
visibility | string Enum: "public" "limited" "private" possible values are |
website | string |
Responses
Request samples
- Payload
{- "description": "string",
- "email": "string",
- "full_name": "string",
- "location": "string",
- "repo_admin_change_team_access": true,
- "username": "string",
- "visibility": "public",
- "website": "string"
}
Response samples
- 201
{- "avatar_url": "string",
- "description": "string",
- "email": "string",
- "full_name": "string",
- "id": 0,
- "location": "string",
- "name": "string",
- "repo_admin_change_team_access": true,
- "username": "string",
- "visibility": "string",
- "website": "string"
}
Get an organization
Authorizations:
path Parameters
org required | string name of the organization to get |
Responses
Response samples
- 200
{- "avatar_url": "string",
- "description": "string",
- "email": "string",
- "full_name": "string",
- "id": 0,
- "location": "string",
- "name": "string",
- "repo_admin_change_team_access": true,
- "username": "string",
- "visibility": "string",
- "website": "string"
}
Edit an organization
Authorizations:
path Parameters
org required | string name of the organization to edit |
Request Body schema: application/jsonrequired
description | string |
string | |
full_name | string |
location | string |
repo_admin_change_team_access | boolean |
visibility | string Enum: "public" "limited" "private" possible values are |
website | string |
Responses
Request samples
- Payload
{- "description": "string",
- "email": "string",
- "full_name": "string",
- "location": "string",
- "repo_admin_change_team_access": true,
- "visibility": "public",
- "website": "string"
}
Response samples
- 200
{- "avatar_url": "string",
- "description": "string",
- "email": "string",
- "full_name": "string",
- "id": 0,
- "location": "string",
- "name": "string",
- "repo_admin_change_team_access": true,
- "username": "string",
- "visibility": "string",
- "website": "string"
}
List an organization's actions secrets
Authorizations:
path Parameters
org required | string name of the organization |
query Parameters
page | integer page number of results to return (1-based) |
limit | integer page size of results |
Responses
Response samples
- 200
[- {
- "created_at": "2019-08-24T14:15:22Z",
- "name": "string"
}
]
Create or Update a secret value in an organization
Authorizations:
path Parameters
org required | string name of organization |
secretname required | string name of the secret |
Request Body schema: application/json
data required | string Data of the secret to update |
Responses
Request samples
- Payload
{- "data": "string"
}
Get an org-level variables list
Authorizations:
path Parameters
org required | string name of the organization |
query Parameters
page | integer page number of results to return (1-based) |
limit | integer page size of results |
Responses
Response samples
- 200
[- {
- "data": "string",
- "name": "string",
- "owner_id": 0,
- "repo_id": 0
}
]
Get an org-level variable
Authorizations:
path Parameters
org required | string name of the organization |
variablename required | string name of the variable |
Responses
Response samples
- 200
{- "data": "string",
- "name": "string",
- "owner_id": 0,
- "repo_id": 0
}
Update an org-level variable
Authorizations:
path Parameters
org required | string name of the organization |
variablename required | string name of the variable |
Request Body schema: application/json
name | string New name for the variable. If the field is empty, the variable name won't be updated. |
value required | string Value of the variable to update |
Responses
Request samples
- Payload
{- "name": "string",
- "value": "string"
}
Create an org-level variable
Authorizations:
path Parameters
org required | string name of the organization |
variablename required | string name of the variable |
Request Body schema: application/json
value required | string Value of the variable to create |