Manual
CLI
API
Log in Get started free

Get the repository link

Shows the repository a project is linked to, or `null` when it has none.

Shows the repository a project is linked to, or null when it has none.

HTTP
GET /projects/{projectId}/repository

Access: Session token only. API keys get 403 with insufficient_scope.

Role: Project manager (organisation owners and admins are managers of every project).

Path parameters #

ParameterDescription
projectIdThe id of the project.

Response 200 #

The link, or null.

JSON
{
  "provider": "github",
  "repository": "acme/shop",
  "url": "https://github.com/acme/shop",
  "defaultBranch": "main",
  "source": "locales/en.json",
  "translations": "locales/{lang}.json",
  "pullRequestUrl": "https://github.com/acme/shop/pull/1",
  "connected": true
}

Response fields #

FieldTypeDescription
providerstringgithub or gitlab.
repositorystringThe repository, such as acme/shop.
urlstringIts web address.
defaultBranchstringIts default branch.
sourcestringPath of the source file.
translationsstringPattern of the translation files.
pullRequestUrlstring or nullThe setup pull or merge request.
connectedbooleanWhether the connected account is still there.

Errors #

StatuserrorWhen
401unauthenticatedThe token is missing or not valid.
404not_foundThe project does not exist in your organisation, you have no access to it, or projectId is not a UUID.
403forbiddenYou are a member of the project, but not a manager.
429rate_limitedToo many requests, see Rate limiting.

See Errors for the error format.