GitCode API
  • Home

Browse documentation

  • General index
  • GitCode Python SDK
    • Quickstart
      • Create a sync client
      • Create an async client
      • Encrypted tokens
      • Context managers
      • Repository-scoped defaults
      • Working with response objects
      • Common workflows
      • OAuth helper methods
      • Examples
    • Client API Reference
      • Synchronous client
        • Repository resources
        • Collaboration resources
        • Account and discovery resources
        • Miscellaneous repository resources
      • Asynchronous client
        • Repository resources
        • Collaboration resources
        • Account and discovery resources
        • Miscellaneous repository resources
    • SDK Reference
      • Module index
        • gitcode_api
        • gitcode_api._base_client
        • gitcode_api._client
        • gitcode_api._exceptions
        • gitcode_api._models
        • gitcode_api.resources
        • gitcode_api.resources._shared
        • gitcode_api.resources.account
        • gitcode_api.resources.collaboration
        • gitcode_api.resources.misc
        • gitcode_api.resources.repositories
    • Highlights
    • Install
    • Authentication
    • Client lifecycle
    • Available resources
    • Next steps
  • Official GitCode API Reference
    • GitCode REST API
      • Effective API Requests
      • Authentication
        • Authorization
        • PRIVATE-TOKEN
        • access_token
      • Response Codes
    • OAuth authorizations
      • 1. OAuth Authentication Endpoint
        • Request
      • 2. Redirection
      • 3. Obtaining an Authorization Token
        • Response
      • 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
        • Request
        • Parameters
        • Response
        • Demo
      • 2. List the organizations an authorized user belongs to
        • Request
        • Parameters
        • Response
        • Demo
      • 3. Get details of an organization member
        • Request
        • Parameters
        • Response
        • Demo
      • 4. Get information about an organization
        • Request
        • Parameters
        • Response
        • Demo
      • 5. Get the repo list of an organization
        • Request
        • Parameters
        • Response
        • Demo
      • 6. Create a repository for an organization
        • Request
        • Response
        • Demo
      • 7. Get a specific member of a enterprise
        • Request
        • Parameters
        • Response
        • Demo
      • 8. Get the member profile of an authorized user in an organization
        • Request
        • Parameters
        • Response
        • Demo
      • 9.List all members of an organization
        • Request
        • Parameters
        • Response
        • Demo
      • 10. List all members of a enterprise
        • Request
        • Parameters
        • Response
        • Demo
      • 11. Remove a member from an organization managed by the authorized user
        • Request
        • Parameters
        • Response
        • Demo
      • 12. List all followers of a specific organization
        • Request
        • Parameters
        • Response
        • Demo
      • 13. Get extended issue configuration
        • Request
        • Parameters
        • Response
        • Demo
      • 14. Invite an Organization Member
        • Request
        • Parameters
        • Response
        • Demo
      • 15. Modify Enterprise Member Permissions
        • Request
        • Parameters
        • Response
        • Demo
      • 16. Update the organizational information managed by authorized users
        • Request
        • Parameters
        • Response
        • Demo
      • 17. Exit an organization
        • Request
        • Parameters
        • Response
        • Demo
    • Quickstart for GitCode REST API
    • Repository API
      • 1. Get a tree
        • Request
        • Parameters
        • Response
        • Demo
      • 2. Retrieve Contents Under a Specific Repository Path
        • Request
        • Parameters
        • Response
        • Demo
      • 3. Get File List
        • Request
        • Parameters
        • Response
        • Demo
      • 4. Create File
        • Request
        • Response
        • Demo
      • 5. Update File
        • Request
        • Response
        • Demo
      • 6. Delete File
        • Request
        • Response
        • Demo
      • 7. Get File Blob
        • Request
        • Response
        • Demo
      • 8. Get Repository Languages
        • Request
        • Parameters
        • Response
        • Demo
      • 9. Get Repository Contributors
        • Request
        • Parameters
        • Response
        • Demo
      • 10. Set Repository Modules
        • Request
        • Parameters
        • Response
        • Demo
      • 11. Update Repository Settings
        • Request
        • Response
        • Demo
      • 12. Modify Repository Code Review Settings
        • Request
        • Parameters
        • Response
        • Demo
      • 13. Archive Repository
        • Request
        • Response
        • Demo
      • 14. Transfer Repository
        • Request
        • Response
        • Demo
      • 15. Get Repository Permission Mode
        • Request
        • Parameters
        • Response
        • Demo
      • 16. Update Repository Permission Mode
        • Request
        • Parameters
        • Response
        • Demo
      • 17. Set Repository Push Rules
        • Request
        • Parameters
        • Response
        • Demo
      • 18. Get Repository Push Rules
        • Request
        • Parameters
        • Response
        • Demo
      • 19. Delete a Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 20. Create Organization Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 21. Fork a Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 22. List Forks of a Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 23. Upload Image
        • Request
        • Parameters
        • Response
        • Demo
      • 24. Upload File
        • Request
        • Parameters
        • Response
        • Demo
      • 25. List Users Watching a Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 26. List Users Starring a Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 27. Update Repository Settings
        • Request
        • Parameters
        • Response
        • Demo
      • 28. Get Repository Settings
        • Request
        • Parameters
        • Response
        • Demo
      • 29. Get Pull Request Settings
        • Request
        • Parameters
        • Response
        • Demo
      • 30. Update Pull Request Settings
        • Request
        • Parameters
        • Response
        • Demo
      • 31. Create Personal Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 32. Update Repository Member Roles
        • Request
        • Parameters
        • Response
        • Demo
      • 33. Transfer Repository
        • Request
        • Response
        • Demo
      • 34. Get Custom Roles of a Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 35. Download Statistics
        • Request
        • Parameters
        • Response
        • Demo
      • 36. Get Raw File
        • Request
        • Parameters
        • Response
        • Demo
      • 37. Get Repository Contributor Statistics
        • Parameters
        • Response
        • Demo
      • 38. Get Repository events
        • Parameters
        • Response
        • Demo
    • Branch API Documentation
      • 1. Get All Branches of a Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 2. Create a Branch
        • Request
        • Parameters
        • Response
        • Demo
      • 3. Get a Branch
        • Request
        • Parameters
        • Response
        • Demo
      • 4. Create a Protected Branch Rule
        • Request
        • Parameters
        • Response
        • Demo
      • 5. Delete a Protected Branch Rule
        • Request
        • Parameters
        • Demo
      • 6. Get List of Protected Branch Rules
        • Request
        • Parameters
        • Response
        • Demo
      • 7. Update a Protected Branch Rule
        • Request
        • Parameters
        • Response
        • Demo
    • Commit API Documentation
      • 1. Get All Commits of a Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 2. Get a Specific Commit of a Repository
        • Request
        • Response
        • Demo
      • 3. Compare Commits
        • Request
        • Response
        • Demo
      • 4. Create a Commit Comment
        • Request
        • Parameters
        • Response
        • Demo
      • 5. Delete a Commit Comment
        • Request
        • Parameters
        • Response
        • Demo
      • 6. Get Commit Comments of a Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 7. Get a Specific Commit Comment of a Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 8. Update a Commit Comment
        • Request
        • Parameters
        • Response
        • Demo
      • 9. Get Code Contribution Statistics
        • Request
        • Parameters
        • Response
        • Demo
      • 10. Get a Single Commit Comment
        • Request
        • Parameters
        • Response
        • Demo
    • Issues API Documentation
      • 1. Create an Issue
        • Request
        • Parameters
        • Response
        • Demo
      • 2. Update an Issue
        • Request
        • Parameters
        • Response
        • Demo
      • 3. Get a Issue of a Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 4. Get All Issues of a Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 5. Get All Comments of an Issue in a Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 6. Get All Issue Comments of a Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 7. Get Pull Requests Associated with an Issue
        • Request
        • Parameters
        • Response
        • Demo
      • 8. Get All Labels of an Issue in an Enterprise
        • Request
        • Parameters
        • Response
        • Demo
      • 9. Create an Issue Label
        • Request
        • Parameters
        • Response
        • Demo
      • 10. Delete an Issue Label
        • Request
        • Parameters
        • Response
        • Demo
      • 11. Create an Issue Comment
        • Request
        • Parameters
        • Response
        • Demo
      • 12. Get the Events Log of a Issue
        • Request
        • Parameters
        • Response
        • Demo
      • 13. Get All Issues of an Enterprise
        • Request
        • Parameters
        • Response
        • Demo
      • 14. Get All Issues of the Authorized User
        • Request
        • Parameters
        • Response
        • Demo
      • 15. Update an Issue Comment
        • Request
        • Parameters
        • Response
        • Demo
      • 16. Delete an Issue Comment
        • Request
        • Parameters
        • Response
        • Demo
      • 17. Get an Issue Comment of a Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 18. Get Issues of a Organization for the Current User
        • Request
        • Parameters
        • Response
        • Demo
      • 19. Get All Comments for an Enterprise Issue
        • Request
        • Parameters
        • Response
        • Demo
      • 20. Get a Specific Issue for an Enterprise
        • Request
        • Parameters
        • Response
        • Demo
    • Tag API Documentation
      • 1. Update a Label for a Repository
        • Request
        • Response
        • Demo
      • 2. Get All Labels of a Repository
        • Request
        • Response
        • Demo
      • 3. Create a Label for a Repository
        • Request
        • Response
        • Demo
      • 4. Delete a Label from a Repository
        • Request
        • Response
        • Demo
      • 5. Delete All Labels of an Issue
        • Request
        • Response
        • Demo
      • 6. Replace All Labels of an Issue
        • Request
        • Response
        • Demo
      • 7. Get All Labels of an Enterprise(v5)
        • Request
        • Response
        • Demo
      • 8. Get the List of Labels for an Enterprise(v8)
        • Request
        • Response
        • Demo
    • Member API Documentation
      • 1. Add or Update Repository Member Permissions
        • Request
        • Parameters
        • Response
        • Demo
      • 2. Remove a Repository Member
        • Request
        • Parameters
        • Response
        • Demo
      • 3. Get All Members of a Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 4. Check if a User is a Member of a Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 5. View the Permissions of a Repository Member
        • Request
        • Parameters
        • Response
        • Demo
    • Milestone API Documentation
      • 1. Get All Milestones of a Repository
        • Request
        • Response
        • Demo
      • 2. Get a Specific Milestone of a Repository
        • Request
        • Response
        • Demo
      • 3. Delete a Specific Milestone of a Repository
        • Request
        • Response
        • Demo
      • 4. Update a Milestone of a Repository
        • Request
        • Response
        • Demo
      • 5. Create a Milestone for a Repository
        • Request
        • Response
        • Demo
    • Pull Request API Documentation
      • 1. Get the List of Pull Requests
        • Request
        • Parameters
        • Response
        • Demo
      • 2. Merge a Pull Request
        • Request
        • Parameters
        • Response
        • Demo
      • 3. Get Issues Associated with a Pull Request
        • Request
        • Parameters
        • Response
        • Demo
      • 4. Submit a Pull Request Comment
        • Request
        • Parameters
        • Response
        • Demo
      • 5. List Files in a Pull Request Commit
        • Request
        • Parameters
        • Response
        • Demo
      • 6. Get All Comments for a Specific Pull Request
        • Request
        • Parameters
        • Response
        • Demo
      • 7. Create a Pull Request
        • Request
        • Parameters
        • Response
        • Demo
      • 8. Update a Pull Request
        • Request
        • Parameters
        • Response
        • Demo
      • 9. Get a Pull Request
        • Request
        • Parameters
        • Response
        • Demo
      • 10. Get Commits for a Specific Pull Request
        • Request
        • Parameters
        • Response
        • Demo
      • 11. Create a Pull Request Label
        • Request
        • Parameters
        • Response
        • Response Code
        • Demo
      • 12. Delete a Pull Request Label
        • Request
        • Parameters
        • Response
        • Demo
      • 13. Process Pull Request Test
        • Request
        • Parameters
        • Response
        • Demo
      • 14. Process Pull Request Approval
        • Request
        • Parameters
        • Response
        • Demo
      • 15. Get the events Log of a Pull Request
        • Request
        • Parameters
        • Response
        • Demo
      • 16. Get All Labels of a Pull Request
        • Request
        • Parameters
        • Response
        • Demo
      • 17. Reset the Pull Request Test Status
        • Request
        • Parameters
        • Response
        • Demo
      • 18. Reset the Pull Request Approval Status
        • Request
        • Parameters
        • Response
        • Demo
      • 19. Get File Changes in a Pull Request
        • Request
        • Parameters
        • Response
        • Demo
      • 20. Get File Content
        • Request
      • 21. Get the List of Enterprise Pull Requests
        • Request
        • Parameters
        • Response
        • Demo
      • 22. Get a Comment of Pull Request
        • Request
        • Parameters
        • Response
        • Demo
      • 23. Check if a Pull Request is Merged
        • Request
        • Parameters
        • Response
        • Demo
      • 24. Assign a User to Approve a Pull Request
        • Request
        • Parameters
        • Response
        • Demo
      • 25. Cancel a User’s Approval on a Pull Request
        • Request
        • Parameters
        • Response
        • Demo
      • 26. Edit a Comment
        • Request
        • Parameters
        • Response
        • Demo
      • 27. Delete a Comment
        • Request
        • Parameters
        • Response
        • Demo
      • 28. Replace All Labels on a Pull Request
        • Request
        • Parameters
        • Response
        • Demo
      • 29. Assign a User to Test a Pull Request
        • Request
        • Parameters
        • Response
        • Demo
      • 30. Get the List of Organization Pull Requests
        • Request
        • Parameters
        • Response
        • Demo
      • 31. Get Pull Requests Associated with an Enterprise Issue
        • Request
        • Parameters
        • Response
        • Demo
    • Release API Documentation
      • 1. Update Repository Release
        • Request
        • Parameters
        • Response
        • Demo
      • 2. Get Repository Release by Tag Name
        • Request
        • Parameters
        • Response
        • Demo
      • 3. Get All Releases of a Repository
        • Request
        • Parameters
        • Response
        • Demo
    • Tag API Documentation
      • 1. List All Tags of a Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 2. Create a Tag for a Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 3. List Protected Tags for a Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 4. Delete Protected Tag
        • Request
        • Parameters
        • Response
        • Demo
      • 5. Get Protected Tag Details
        • Request
        • Parameters
        • Response
        • Demo
      • 6. Create Protected Tag
        • Request
        • Parameters
        • Response
        • Demo
      • 7. Update Protected Tag
        • Request
        • Parameters
        • Response
        • Demo
    • Webhook API Documentation
      • 1. List WebHooks of a Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 2. Create a WebHook for a Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 3. Get a Specific WebHook of a Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 4. Update a WebHook of a Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 5. Delete a WebHook of a Repository
        • Request
        • Parameters
        • Response
        • Demo
      • 6. Test if a WebHook is Successfully Sent
        • Request
        • Parameters
        • Response
        • Demo
    • Search API Documentation
      • 1. Search Users
        • Request
        • Parameters
        • Response
        • Demo
      • 2. Search Issues
        • Request
        • Parameters
        • Response
        • Demo
      • 3. Search Repositories
        • Request
        • Parameters
        • Response
        • Demo
    • User API Documentation
      • 1. Get a user
        • Request
        • Parameters
        • Response
        • Demo
      • 2. Get the profile of the authorized user
        • Request
        • Parameters
        • Response
        • DEMO
      • 3. Get all emails of the authorized user
        • Request
        • Parameters
        • Response
        • Demo
      • 4. Get the personal activity of a user
        • Request
        • Parameters
        • Response
        • Demo
      • 5. Get the public repositories of a user
        • Request
        • Parameters
        • Response
        • Demo
      • 6. Create a personal project repository
        • Request
        • Parameters
        • Response
        • Demo
      • 7. List all repositories of the authorized user
        • Request
        • Parameters
        • Response
        • Demo
      • 8. Get a specific repository of a user
        • Request
        • Response
        • Demo
      • 9. Add a public key
        • Request
        • Parameters
        • Response
        • Demo
      • 10. List all public keys of the authorized user
        • Request
        • Parameters
        • Response
        • Demo
      • 11. Delete a public key
        • Request
        • Parameters
        • Response
        • Demo
      • 12. Get a specific public key
        • Request
        • Parameters
        • Response
        • Demo
      • 13. Obtain a namespace for authorized users
        • Request
        • Parameters
        • Response
        • Demo
      • 14. List the repository where authorized user star has been listed
        • Request
        • Parameters
        • Response
        • Demo
GitCode API
  • Official GitCode API Reference
  • Quickstart for GitCode REST API
  • View page source
Previous Next

Quickstart for GitCode REST API

|image1|Quickstart |image2|Users |image3|Organizations |image4|Repositories |image5|Issues |image6|Pull Requests |image7|Labels |image8|Milestones |image9|Webhooks |image10|OAuth2.0

Previous Next

© Copyright 2026, GitCode official team (REST API docs); Hugo Huang (SDK docs).

Built with Sphinx using a theme provided by Read the Docs.