REST API
Users

User API Documentation

1. Get a user

Request

GET https://api.gitcode.com/api/v5/users/{username}

Parameters

ParameterDescriptionTypeData Type
access_tokenpersonal access tokenquerystring
username*usernamepathstring

Response

{
  "avatar_url": "https://cdn-img.gitcode.com/ec/fb/430ecf07b9ee91bbbbf341d92a36783d06e69086f82ce8cf5a6406f79f1c9cf4.png",
  "followers_url": "https://api.gitcode.com/api/v5users/dengmengmian/followers",
  "html_url": "https://gitcode.com/dengmengmian",
  "id": "650d67fbae6d795139b49b41",
  "login": "dengmengmian",
  "name": "麻凡",
  "type": "User",
  "url": "https://api.gitcode.com/api/v5/dengmengmian",
  "bio": "Nacos是由阿里巴巴开源的服务治理中间件，集成了动态服务发现、配置管理和服务元数据管理功能，广泛应用于微服务架构中，简化服务治理过程。",
  "blog": "https://www.dengmengmian.com",
  "company": "开发者",
  "email": "my@dengmengmian.com",
  "followers": 0,
  "following": 6,
  "top_languages": ["Python", "Shell"]
}

Demo

curl --location 'https://api.gitcode.com/api/v5/users/dengmengmian' \
--header 'Authorization: Bearer {your-token}'

2. Get the profile of the authorized user

Request

GET https://api.gitcode.com/api/v5/user

Parameters

ParameterDescriptionTypeData Type
access_token*personal access tokenquerystring

Response

{
  "avatar_url": "https://cdn-img.gitcode.com/fa/be/2fa2be6d3ffd01599dbc0a3c71ee9ec4cadb82f63a7a8489187645064ad95e59.png?time=1694709764757",
  "followers_url": "https://api.gitcode.com/api/v5users/gitcode-xxm/followers",
  "html_url": "https://gitcode.com/gitcode-xxm",
  "id": "64e5ed8f7e20aa73efcbc302",
  "login": "gitcode-xxm",
  "name": "xxm",
  "type": "User",
  "url": "https://api.gitcode.com/api/v5/gitcode-xxm",
  "bio": "a PM ",
  "blog": "https://gitcode.com",
  "company": "",
  "email": "xiongjiamu@163.com",
  "followers": 8,
  "following": 35,
  "top_languages": ["Python", "Markdown", "C++", "C", "HTML"]
}

DEMO

curl --location 'https://api.gitcode.com/api/v5/user' \
--header 'Authorization: Bearer {your-token}'

3. Get all emails of the authorized user

Request

GET https://api.gitcode.com/api/v5/emails

Parameters

ParameterDescriptionTypeData Type
access_token*personal access tokenquerystring

Response

[
  {
    "email": "my@dengmengmian.com",
    "state": "confirmed"
  },
  {
    "email": "xxxx@qq.com",
    "state": "confirmed"
  }
]

Demo

curl --location --request GET 'https://api.gitcode.com/api/v5/emails?access_token={your-token}' \

4. Get the personal activity of a user

Request

GET https://api.gitcode.com/api/v5/users/{username}/events

Parameters

ParameterDescriptionTypeData Type
usernameusernamepathstring
access_token*personal access tokenquerystring
yearStart Year（2024）querystring
nextEnd Datequerystring

Response

{
  "events": {
    "2024-08-27": [
      {
        "action": 5,
        "action_name": "pushed to",
        "author": {
          "id": 704,
          "iam_id": "5c340cab034d455992541f00f9936fb4",
          "username": "dengmengmian",
          "state": "active",
          "avatar_url": "https://gitcode-img.obs.cn-south-1.myhuaweicloud.com:443/fa/fe/f32a9fecc53e890afbd48fd098b0f6c5f20f062581400c76c85e5baab3f0d5b2.png",
          "email": "",
          "name": "dengmengmian",
          "name_cn": "dengmengmian",
          "web_url": "https://test.gitcode.net/dengmengmian"
        },
        "author_id": 704,
        "author_username": "dengmengmian",
        "created_at": "2024-08-27T10:34:05.093Z",
        "project": {
          "main_repository_language": [null, null],
          "star_count": 0,
          "forks_count": 0,
          "develop_mode": "normal",
          "stared": false
        },
        "project_id": 507167,
        "project_name": "mactribe/midsommarcartoon",
        "push_data": {
          "commit_count": 1,
          "action": "pushed",
          "ref_type": "branch",
          "commit_from": "2ce472fec073f77804c3480ccf128219a6172e54",
          "commit_to": "14b742fe434797fb073ba536804011f735f2f430",
          "ref": "main",
          "commit_title": "文件title"
        },
        "_links": {
          "project": "https://test.gitcode.net/mactribe/midsommarcartoon",
          "action_type": ""
        }
      },
      {
        "action": 5,
        "action_name": "pushed to",
        "author": {
          "id": 704,
          "iam_id": "5c340cab034d455992541f00f9936fb4",
          "username": "dengmengmian",
          "state": "active",
          "avatar_url": "https://gitcode-img.obs.cn-south-1.myhuaweicloud.com:443/fa/fe/f32a9fecc53e890afbd48fd098b0f6c5f20f062581400c76c85e5baab3f0d5b2.png",
          "email": "",
          "name": "dengmengmian",
          "name_cn": "dengmengmian",
          "web_url": "https://test.gitcode.net/dengmengmian"
        },
        "author_id": 704,
        "author_username": "dengmengmian",
        "created_at": "2024-08-27T10:31:17.494Z",
        "project": {
          "main_repository_language": [null, null],
          "star_count": 0,
          "forks_count": 0,
          "develop_mode": "normal",
          "stared": false
        },
        "project_id": 507167,
        "project_name": "mactribe/midsommarcartoon",
        "push_data": {
          "commit_count": 1,
          "action": "pushed",
          "ref_type": "branch",
          "commit_from": "ee25b0353dae9bf19f5e3e733e651e7870020386",
          "commit_to": "2ce472fec073f77804c3480ccf128219a6172e54",
          "ref": "main",
          "commit_title": "文件title"
        },
        "_links": {
          "project": "https://test.gitcode.net/mactribe/midsommarcartoon",
          "action_type": ""
        }
      }
    ]
  },
  "next": "2024-08-01T10:10:40.370Z"
}

Demo

curl --location -g --request GET 'https://api.gitcode.com/api/v5/users/dengmengmian/events?access_token={your-token}&year=2024&next=2024-09-05T13%3A48%3A47.370Z'

5. Get the public repositories of a user

Request

GET https://api.gitcode.com/api/v5/users/{username}/repos

Parameters

ParameterDescriptionTypeData Type
access_token*personal access tokenquerystring
username*username(username/login)pathstring
type用户创建的仓库(owner)，用户个人仓库(personal)，用户为仓库成员(member)，所有(all)。Default: 所有(all) Repository Ownership Types: Owner(Repositories created by the user), Personal(The user’s personal repositories), Member(Repositories where the user is a member), All(All repositories).Default: allquerystring
sortSorting Options: Created(Sort by creation time), Updated(Sort by update time), Pushed(Sort by last pushed time), Full Name(Sort by repository’s full name). Default: full_namequerystring
directionIf the sort parameter is set to full_name, the sorting will be in ascending order (asc). Otherwise, it will be in descending order (desc).querystring
pageCurrent Page Numberqueryint
per_pageItems Per Page, Maximum 100queryint

Response

[
  {
    "id": 2734882,
    "full_name": "dengmengmian/manifest",
    "human_name": "dengmengmian / manifest",
    "url": "https://api.gitcode.com/api/v5/repos/dengmengmian/manifest",
    "namespace": {
      "id": 199940,
      "type": "user",
      "name": "dengmengmian",
      "path": "dengmengmian",
      "html_url": "https://gitcode.com/dengmengmian"
    },
    "path": "manifest",
    "name": "manifest",
    "description": "manifest",
    "status": "开始",
    "ssh_url_to_repo": "git@gitcode.com:dengmengmian/manifest.git",
    "http_url_to_repo": "https://gitcode.com/dengmengmian/manifest.git",
    "web_url": "https://gitcode.com/dengmengmian/manifest",
    "homepage": "https://gitcode.com/dengmengmian/manifest",
    "members": ["dengmengmian"],
    "assignee": [
      {
        "id": "268",
        "login": "dengmengmian",
        "name": "麻凡",
        "avatar_url": "https://cdn-img.gitcode.com/ec/fb/430ecf07b9ee91bbbbf341d92a36783d06e69086f82ce8cf5a6406f79f1c9cf4.png",
        "html_url": "https://gitcode.com/dengmengmian",
        "type": "User"
      }
    ],
    "forks_count": 0,
    "stargazers_count": 0,
    "project_labels": [],
    "relation": "master",
    "permission": {
      "pull": true,
      "push": true,
      "admin": true
    },
    "internal": false,
    "open_issues_count": 0,
    "has_issue": false,
    "watched": false,
    "watchers_count": 0,
    "assignees_number": 1,
    "enterprise": {
      "id": 199940,
      "path": "dengmengmian",
      "html_url": "https://gitcode.com/dengmengmian",
      "type": "user"
    },
    "default_branch": "master",
    "fork": false,
    "owner": {
      "id": "268",
      "login": "dengmengmian",
      "name": "麻凡",
      "type": "User"
    },
    "assigner": {
      "id": "268",
      "login": "dengmengmian",
      "name": "麻凡",
      "type": "User"
    },
    "issue_template_source": "project",
    "private": false,
    "public": true,
    "gitee": {
      "star": 10,
      "fork": 15,
      "watch": 1
    }
  }
]

Demo

curl --location -g --request GET 'https://api.gitcode.com/api/v5/users/dengmengmian/repos?access_token=yuBy&type=all&sort=full_name&page=1&pre_page=20'

6. Create a personal project repository

Request

POST https://api.gitcode.com/api/v5/user/repos

Parameters

ParameterDescriptionTypeData Type
access_token*personal access tokenquerystring
name*Repository NameformDatastring
descriptionRepository DescriptionformDatastring
has_issuesAllow Issues to Be Created (Enabled/Disabled). Default: trueformDataboolean
has_wikiProvide Wiki (Enabled/Disabled). Default: trueformDataboolean
auto_initIf the value is true, the repository will be initialized with a README. Default: Not Initialized (false)formDataboolean
gitignore_templategitignore templateformDatastring
license_templatelicense templateformDatastring
pathRepository PathformDatastring
privateIs PrivateformDataboolean
default_branchDefault Branch Name when Initializing a Repository.Default: mainformDatastring

*表示必填项。

Response

返回 “success” 表示成功，其他为失败

{
  "id": 4106383,
  "full_name": "dengmengmian/wunian-prj",
  "human_name": "dengmengmian / wunian-prj",
  "url": "https://api.gitcode.com/api/v5/user/repos",
  "namespace": {
    "id": 199940,
    "name": "dengmengmian",
    "path": "dengmengmian",
    "develop_mode": "normal",
    "kind": "user",
    "full_path": "dengmengmian",
    "full_name": "dengmengmian",
    "visibility_level": 20,
    "enable_file_control": false,
    "owner_id": 268
  },
  "path": "wunian-prj",
  "name": "wunian-prj",
  "description": "wunian-prj",
  "private": true,
  "public": false,
  "visibility": "private"
}

Demo

curl --location -g --request POST 'https://api.gitcode.com/api/v5/user/repos?access_token={your-token}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "wunian-prj",
  "description": "wunian-prj",
  "has_issues": true,
  "has_wiki": true,
  "can_comment": true,
  "public": 0,
  "private": true,
  "auto_init": true,
  "gitignore_template": "string",
  "license_template": "string",
  "path": "wunian-prj"
}'

7. List all repositories of the authorized user

Request

GET https://api.gitcode.com/api/v5/user/repos

Parameters

ParameterDescriptionTypeData Type
access_token*personal access tokenquerystring
visibility公开(public)、私有(private)或者所有(all)，Default: 所有(all)querystring
affiliationowner(授权用户拥有的仓库)、collaborator(授权用户为仓库成员)、organization_member(授权用户为仓库所在组织并有访问仓库权限)、enterprise_member(授权用户所在企业并有访问仓库权限)、admin(所有有权限的，包括所管理的组织中所有仓库、所管理的企业的所有仓库)。可以用逗号分隔符组合。如: owner, organization_member 或 owner, collaborator, organization_memberquerystring
type筛选用户仓库: 其创建(owner)、个人(personal)、其为成员(member)、公开(public)、私有(private)，不能与 affiliation 参数一并使用，否则会报 422 错误，与visibility参数一起使用，visibility参数拥有更高的优先级querystring
sort排序方式: 创建时间(created)，update time(updated)，最后推送时间(pushed)，仓库所属与名称(full_name)。Default: full_namequerystring
direction如果sort参数为full_name，用升序(asc)。否则降序(desc)querystring
qkeywordsquerystring
pageCurrent Page Numberqueryint
per_pageItems Per Page, Maximum 100,default:20 100queryint

*表示必填项。

Response

返回 “success” 表示成功，其他为失败

[
  {
    "id": 4028329,
    "full_name": "tiandi/test_yf_repo",
    "human_name": "洪门 / test_yf_repo",
    "url": "https://api.gitcode.com/api/v5/repos/tiandi/test_yf_repo",
    "namespace": {
      "id": 1420034,
      "type": "enterprise",
      "name": "洪门",
      "path": "tiandi",
      "html_url": "https://gitcode.com/tiandi"
    },
    "path": "test_yf_repo",
    "name": "test_yf_repo",
    "description": "",
    "status": "开始",
    "ssh_url_to_repo": "git@gitcode.com:tiandi/test_yf_repo.git",
    "http_url_to_repo": "https://gitcode.com/tiandi/test_yf_repo.git",
    "web_url": "https://gitcode.com/tiandi/test_yf_repo",
    "homepage": "https://gitcode.com/tiandi/test_yf_repo",
    "members": ["aron1"],
    "assignee": [
      {
        "id": "332008",
        "login": "aron1",
        "name": "yanfan",
        "avatar_url": "https://cdn-img.gitcode.com/bd/ca/0115343247b338d0c53589a145501e84a58464272f2fb09b372cc3d2311b2b39.png?time=1722525295285",
        "html_url": "https://gitcode.com/aron1",
        "type": "User"
      }
    ],
    "forks_count": 0,
    "stargazers_count": 0,
    "project_labels": [],
    "relation": "master",
    "permission": {
      "pull": true,
      "push": true,
      "admin": true
    },
    "internal": false,
    "open_issues_count": 0,
    "has_issue": false,
    "watched": false,
    "watchers_count": 0,
    "assignees_number": 1,
    "enterprise": {
      "id": 1420034,
      "path": "tiandi",
      "html_url": "https://gitcode.com/tiandi",
      "type": "enterprise"
    },
    "default_branch": "main",
    "fork": false,
    "owner": {
      "id": "444601",
      "login": "yanfan",
      "name": "yanfan是随时随地送达啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊实打实",
      "type": "User"
    },
    "assigner": {
      "id": "444601",
      "login": "yanfan",
      "name": "yanfan是随时随地送达啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊实打实",
      "type": "User"
    },
    "private": true,
    "public": false
  }
]

Demo

curl --location --request GET 'https://api.gitcode.com/api/v5/user/repos?access_token={your-token}&visibility=private&affiliation=owner%2Ccollaborator%2Corganization_member&sort=created&direction=desc&q=yf&page=1&per_page=2'

8. Get a specific repository of a user

Request

GET https://api.gitcode.com/api/v5/repos/{owner}/{repo}

ParameterDescriptionTypeData Type
access_token*personal access tokenquerystring
owner*Repository Owner Path (Organization or User Path)pathstring
repo*Repository Path(path)pathstring

Response

{
  "id": 34165823,
  "full_name": "daming_1/zhu_di",
  "human_name": "daming/zhu_di",
  "url": "https://gitcode.com/api/v5/repos/daming_1/zhu_di",
  "namespace": {
    "id": 13386953,
    "name": "daming",
    "path": "daming_1",
    "html_url": "https://gicode.com/daming_1"
  },
  "path": "zhu_di",
  "name": "zhu_di",
  "description": "朱棣",
  "private": false,
  "public": true,
  "status": "开始",
  "ssh_url_to_repo": "ssh://git@gitcode.com/group11111/repocc12.git",
  "http_url_to_repo": "https://gitcode.com/group11111/repocc12.git",
  "web_url": "https://gitcode.com/group11111/repocc12",
  "readme_url": "https://gitcode.com/group11111/repocc12/blob/main/README.md",
  "created_at": "2023-09-15T16:45:09.502+08:00",
  "updated_at": "2023-09-15T16:45:09.502+08:00",
  "creator": {
    "id": 80,
    "username": "CodeHub_beta_dev",
    "arts_id": "11",
    "nickname": "",
    "email": "CodeHub_beta_dev@huawei.com",
    "photo": "https://gitcode-user-img.obs.cn-north-4.myhuaweicloud.com:443/de%2Fdd%2F0de6d190dd41c0167427a5982dab156498b05573e7163ae5698d7f4fc0562ce0.png"
  },
  "homepage": "https://gitcode.com"
}

Demo

curl --location 'https://api.gitcode.com/api/v5/repos/xiaogang/test?access_token=?' \

9. Add a public key

Request

POST https://api.gitcode.com/api/v5/user/keys

Parameters

ParameterDescriptionTypeData Type
access_token*personal access tokenquerystring
key*Public Key Contentbodystring
title*Public Key Namebodystring

Response

{
  "id": 311915,
  "title": "555555",
  "key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIa6IyTGuI8V5wrhANDFyezQqL73dY9ctLGHgpOggp7E Gitee",
  "created_at": "2024-11-14T03:34:40.318+00:00",
  "url": "https://api.gitcode.com/v5/user/keys/311915"
}

Demo

curl --location --request POST 'https://api.gitcode.com/api/v5/user/keys?access_token=?' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data '{
    "key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIa6IyTGuI8V5wrhANDFyezQqL73dY9ctLGHgpOggp7E Gitee SSH Key",
    "title": "555555"
}'

10. List all public keys of the authorized user

Request

GET https://api.gitcode.com/api/v5/user/keys

Parameters

ParameterDescriptionTypeData Type
access_token*personal access tokenquerystring
pageCurrent Page Numberqueryint
per_pageItems Per Page, Maximum 100,default:20queryint

Response

[
  {
    "id": 308357,
    "title": "xiaogang@csdn.net\r\n",
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCwT9UXXtGfLa16tbxV+0RQ6m+BaAG2wJvqApr+juVNEmnM0lKNt1tyxY/V9SsCRf38UprPLTp71+btRpFIH9TLrGhkvT3tJOouYDXVUpSaigi7OO+6eLc+Cn0TZSLj4RmwVe/w93kmsCUzgqkeHk14K3S+2oCCm1rbpBAvpPhSKHhAH9LcTBecDoZ+NA2dsEDyfsloVH5cMJQO9n2W1QYduMuuaVHHpehSdDohN7cDI799Rwofaqqyz6ZJrc6eBjSVi1W+JPDTT6NW0+eFBYXo3KWybffixH4cAWdbS1Ms5Pe9Xh+G4WqFuhFh9zCoXlRUUrArLo5pYfpy5gv4iUVmniM0Pb0/Y5x8RJyGaPdS/2c68s8LQsm/9Ees8aeE5TcT5isDEvh+wy7jp1xi5nONk9QvOy7EdYYeHQtkw/0rklsz7UvAIjjHObNNYpY6RLQRT+dqN/lAb7stT047FSxqcNMCX/cybapLygs1y2ClcgU42p16RfgCH0NKA5emRhM= xiaogang@csdn.net",
    "created_at": "2024-07-23T10:29:42.119+00:00",
    "url": "https://api.gitcode.com/v5/user/keys/308357"
  },
  {
    "id": 311915,
    "title": "555555",
    "key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIa6IyTGuI8V5wrhANDFyezQqL73dY9ctLGHgpOggp7E Gitee",
    "created_at": "2024-11-14T03:34:40.318+00:00",
    "url": "https://api.gitcode.com/v5/user/keys/311915"
  }
]

Demo

curl --location 'https://api.gitcode.com/api/v5/user/keys?access_token=?'

11. Delete a public key

Request

DELETE https://api.gitcode.com/api/v5/user/keys/{id}

Parameters

ParameterDescriptionTypeData Type
access_token*personal access tokenquerystring
id*Public Key IDpathstring

Response

无

Demo

curl --location --request DELETE 'https://api.gitcode.com/api/v5/user/keys/311914?access_token=?'

12. Get a specific public key

Request

GET https://api.gitcode.com/api/v5/user/keys/{id}

Parameters

ParameterDescriptionTypeData Type
access_token*personal access tokenquerystring
id*Public Key IDpathstring

Response

[
  {
    "id": 308357,
    "title": "xiaogang@csdn.net\r\n",
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCwT9UXXtGfLa16tbxV+0RQ6m+BaAG2wJvqApr+juVNEmnM0lKNt1tyxY/V9SsCRf38UprPLTp71+btRpFIH9TLrGhkvT3tJOouYDXVUpSaigi7OO+6eLc+Cn0TZSLj4RmwVe/w93kmsCUzgqkeHk14K3S+2oCCm1rbpBAvpPhSKHhAH9LcTBecDoZ+NA2dsEDyfsloVH5cMJQO9n2W1QYduMuuaVHHpehSdDohN7cDI799Rwofaqqyz6ZJrc6eBjSVi1W+JPDTT6NW0+eFBYXo3KWybffixH4cAWdbS1Ms5Pe9Xh+G4WqFuhFh9zCoXlRUUrArLo5pYfpy5gv4iUVmniM0Pb0/Y5x8RJyGaPdS/2c68s8LQsm/9Ees8aeE5TcT5isDEvh+wy7jp1xi5nONk9QvOy7EdYYeHQtkw/0rklsz7UvAIjjHObNNYpY6RLQRT+dqN/lAb7stT047FSxqcNMCX/cybapLygs1y2ClcgU42p16RfgCH0NKA5emRhM= xiaogang@csdn.net",
    "created_at": "2024-07-23T10:29:42.119+00:00",
    "url": "https://api.gitcode.com/v5/user/keys/308357"
  }
]

Demo

curl --location  'https://api.gitcode.com/api/v5/user/keys/311914?access_token=?'