Official GitCode API Reference

This section follows the public English GitCode documentation published at GitCode Help Docs. The pages here are manually corrected and extended from that official material (terminology, tables, examples, and cross-references) and are not a verbatim dump. When you regenerate in bulk, use scripts/build_gitcode_sphinx_docs.py (see project AGENTS guidance) and then re-apply any intentional local edits as needed.

• GitCode REST API
  • Effective API Requests
  • Authentication
  • Response Codes
• OAuth authorizations
  • 1. OAuth Authentication Endpoint
  • 2. Redirection
  • 3. Obtaining an Authorization Token
  • 4. Using an Access Token to Access the User Information API
  • 5. Refreshing the Access Token
• Organization API
  • 1. List the organizations a user belongs to
  • 2. List the organizations an authorized user belongs to
  • 3. Get details of an organization member
  • 4. Get information about an organization
  • 5. Get the repo list of an organization
  • 6. Create a repository for an organization
  • 7. Get a specific member of a enterprise
  • 8. Get the member profile of an authorized user in an organization
  • 9.List all members of an organization
  • 10. List all members of a enterprise
  • 11. Remove a member from an organization managed by the authorized user
  • 12. List all followers of a specific organization
  • 13. Get extended issue configuration
  • 14. Invite an Organization Member
  • 15. Modify Enterprise Member Permissions
  • 16. Update the organizational information managed by authorized users
  • 17. Exit an organization
• Repository API
  • 1. Get a tree
  • 2. Retrieve Contents Under a Specific Repository Path
  • 3. Get File List
  • 4. Create File
  • 5. Update File
  • 6. Delete File
  • 7. Get File Blob
  • 8. Get Repository Languages
  • 9. Get Repository Contributors
  • 10. Set Repository Modules
  • 11. Update Repository Settings
  • 12. Modify Repository Code Review Settings
  • 13. Archive Repository
  • 14. Transfer Repository
  • 15. Get Repository Permission Mode
  • 16. Update Repository Permission Mode
  • 17. Set Repository Push Rules
  • 18. Get Repository Push Rules
  • 19. Delete a Repository
  • 20. Create Organization Repository
  • 21. Fork a Repository
  • 22. List Forks of a Repository
  • 23. Upload Image
  • 24. Upload File
  • 25. List Users Watching a Repository
  • 26. List Users Starring a Repository
  • 27. Update Repository Settings
  • 28. Get Repository Settings
  • 29. Get Pull Request Settings
  • 30. Update Pull Request Settings
  • 31. Create Personal Repository
  • 32. Update Repository Member Roles
  • 33. Transfer Repository
  • 34. Get Custom Roles of a Repository
  • 35. Download Statistics
  • 36. Get Raw File
  • 37. Get Repository Contributor Statistics
  • 38. Get Repository events
• Branch API Documentation
  • 1. Get All Branches of a Repository
  • 2. Create a Branch
  • 3. Get a Branch
  • 4. Create a Protected Branch Rule
  • 5. Delete a Protected Branch Rule
  • 6. Get List of Protected Branch Rules
  • 7. Update a Protected Branch Rule
• Commit API Documentation
  • 1. Get All Commits of a Repository
  • 2. Get a Specific Commit of a Repository
  • 3. Compare Commits
  • 4. Create a Commit Comment
  • 5. Delete a Commit Comment
  • 6. Get Commit Comments of a Repository
  • 7. Get a Specific Commit Comment of a Repository
  • 8. Update a Commit Comment
  • 9. Get Code Contribution Statistics
  • 10. Get a Single Commit Comment
• Issues API Documentation
  • 1. Create an Issue
  • 2. Update an Issue
  • 3. Get a Issue of a Repository
  • 4. Get All Issues of a Repository
  • 5. Get All Comments of an Issue in a Repository
  • 6. Get All Issue Comments of a Repository
  • 7. Get Pull Requests Associated with an Issue
  • 8. Get All Labels of an Issue in an Enterprise
  • 9. Create an Issue Label
  • 10. Delete an Issue Label
  • 11. Create an Issue Comment
  • 12. Get the Events Log of a Issue
  • 13. Get All Issues of an Enterprise
  • 14. Get All Issues of the Authorized User
  • 15. Update an Issue Comment
  • 16. Delete an Issue Comment
  • 17. Get an Issue Comment of a Repository
  • 18. Get Issues of a Organization for the Current User
  • 19. Get All Comments for an Enterprise Issue
  • 20. Get a Specific Issue for an Enterprise
• Tag API Documentation
  • 1. Update a Label for a Repository
  • 2. Get All Labels of a Repository
  • 3. Create a Label for a Repository
  • 4. Delete a Label from a Repository
  • 5. Delete All Labels of an Issue
  • 6. Replace All Labels of an Issue
  • 7. Get All Labels of an Enterprise(v5)
  • 8. Get the List of Labels for an Enterprise(v8)
• Member API Documentation
  • 1. Add or Update Repository Member Permissions
  • 2. Remove a Repository Member
  • 3. Get All Members of a Repository
  • 4. Check if a User is a Member of a Repository
  • 5. View the Permissions of a Repository Member
• Milestone API Documentation
  • 1. Get All Milestones of a Repository
  • 2. Get a Specific Milestone of a Repository
  • 3. Delete a Specific Milestone of a Repository
  • 4. Update a Milestone of a Repository
  • 5. Create a Milestone for a Repository
• Pull Request API Documentation
  • 1. Get the List of Pull Requests
  • 2. Merge a Pull Request
  • 3. Get Issues Associated with a Pull Request
  • 4. Submit a Pull Request Comment
  • 5. List Files in a Pull Request Commit
  • 6. Get All Comments for a Specific Pull Request
  • 7. Create a Pull Request
  • 8. Update a Pull Request
  • 9. Get a Pull Request
  • 10. Get Commits for a Specific Pull Request
  • 11. Create a Pull Request Label
  • 12. Delete a Pull Request Label
  • 13. Process Pull Request Test
  • 14. Process Pull Request Approval
  • 15. Get the events Log of a Pull Request
  • 16. Get All Labels of a Pull Request
  • 17. Reset the Pull Request Test Status
  • 18. Reset the Pull Request Approval Status
  • 19. Get File Changes in a Pull Request
  • 20. Get File Content
  • 21. Get the List of Enterprise Pull Requests
  • 22. Get a Comment of Pull Request
  • 23. Check if a Pull Request is Merged
  • 24. Assign a User to Approve a Pull Request
  • 25. Cancel a User’s Approval on a Pull Request
  • 26. Edit a Comment
  • 27. Delete a Comment
  • 28. Replace All Labels on a Pull Request
  • 29. Assign a User to Test a Pull Request
  • 30. Get the List of Organization Pull Requests
  • 31. Get Pull Requests Associated with an Enterprise Issue
• Release API Documentation
  • 1. Create Repository Release
  • 2. Update Repository Release
  • 3. Get URL and Request Headers for Release Attachment Upload
  • 4. Get All Releases of a Repository
  • 5. Get the Latest Release of a Repository
  • 6. Get Single Release of a Repository
  • 7. Get Repository Release by Tag Name
  • 8. Download Release Attachment from a Repository
• Tag API Documentation
  • 1. List All Tags of a Repository
  • 2. Create a Tag for a Repository
  • 3. List Protected Tags for a Repository
  • 4. Delete Protected Tag
  • 5. Get Protected Tag Details
  • 6. Create Protected Tag
  • 7. Update Protected Tag
• Webhook API Documentation
  • 1. List WebHooks of a Repository
  • 2. Create a WebHook for a Repository
  • 3. Get a Specific WebHook of a Repository
  • 4. Update a WebHook of a Repository
  • 5. Delete a WebHook of a Repository
  • 6. Test if a WebHook is Successfully Sent
• Search API Documentation
  • 1. Search Users
  • 2. Search Issues
  • 3. Search Repositories
• User API Documentation
  • 1. Get a user
  • 2. Get the profile of the authorized user
  • 3. Get all emails of the authorized user
  • 4. Get the personal activity of a user
  • 5. Get the public repositories of a user
  • 6. Create a personal project repository
  • 7. List all repositories of the authorized user
  • 8. Get a specific repository of a user
  • 9. Add a public key
  • 10. List all public keys of the authorized user
  • 11. Delete a public key
  • 12. Get a specific public key
  • 13. Obtain a namespace for authorized users
  • 14. List the repository where authorized user star has been listed