Skip to main content
GET
/
api
/
repos
/
{id}
Get Repository
curl --request GET \
  --url https://api.example.com/api/repos/{id}
{
  "success": true,
  "data": {
    "id": "<string>",
    "user_id": "<string>",
    "org_id": "<string>",
    "name": "<string>",
    "source_type": "<string>",
    "remote_url": "<string>",
    "default_branch": "<string>",
    "last_commit_sha": "<string>",
    "oauth_connection_id": "<string>",
    "issue_auto_create_enabled": true,
    "issue_auto_create_min_severity": "<string>",
    "created_at": {},
    "updated_at": {},
    "deleted_at": {}
  },
  "error": {
    "success": true,
    "code": 123,
    "message": "<string>"
  }
}

Authentication

This endpoint does not require authentication in the current implementation, but it’s recommended to use authenticated requests for production deployments.

Path Parameters

id
uuid
required
The unique identifier of the repository to retrieve.

Response

success
boolean
Indicates whether the request was successful.
data
object
The repository object.

Example Request

curl -X GET https://api.heimdall.example.com/api/repos/01936d2f-8c4e-7890-b123-456789abcdef \
  -H "Cookie: session=your_session_token"

Example Response

{
  "success": true,
  "data": {
    "id": "01936d2f-8c4e-7890-b123-456789abcdef",
    "user_id": "01936d2e-1234-5678-9abc-def012345678",
    "org_id": null,
    "name": "my-web-app",
    "source_type": "git_url",
    "remote_url": "https://github.com/example/my-web-app.git",
    "default_branch": "main",
    "last_commit_sha": "abc123def456789012345678901234567890abcd",
    "oauth_connection_id": null,
    "issue_auto_create_enabled": true,
    "issue_auto_create_min_severity": "high",
    "created_at": "2026-03-12T10:30:00Z",
    "updated_at": "2026-03-12T15:45:00Z",
    "deleted_at": null
  }
}

Error Responses

error
object
Error information when the request fails.

404 Not Found

Returned when the repository with the specified ID does not exist.
{
  "success": false,
  "code": 404,
  "message": "Repo '01936d2f-8c4e-7890-b123-456789abcdef' not found"
}

500 Internal Server Error

Returned when the server encounters an error retrieving the repository.
{
  "success": false,
  "code": 500,
  "message": "Failed to fetch repo: database connection error"
}

Build docs developers (and LLMs) love