Working with Custom API Path

The Custom API Path is a relative path that starts with /. Use it to filter which repositories Git Integration for Jira retrieves from your git service. The maximum length is 2,000 characters.

Git Integration for Jira calls the Custom API Path during:

• Initial integration setup
• Settings changes
• Scheduled reindexing
• Manual reindexing

On this page:

• Access Custom API Path settings
• GitHub.com examples
• GitHub Enterprise examples
• GitLab.com and GitLab CE/EE examples
• Bitbucket Cloud examples

Access Custom API Path Settings

During Integration Setup

1. Go to Manage Git repositories ➜ Add integration ➜ select a supported git service.
2. On the Connect screen, expand Advanced.
3. Enter your path in the Custom API Path field.

From Integration Settings

1. Go to Manage Git repositories.
2. Click Actions ➜ Edit integration settings (or Edit repository settings).
3. Scroll to Integration settings ➜ Custom API Path.

GitHub.com Examples

List All Repositories (Default)

/user/repos

Returns all repositories. This is the default behavior when no API path is specified.

List Repositories for a Specific User

/users/<username>/repos

Returns public repositories for the specified user.

Example: /users/johnsmith/repos

List Starred Repositories

/user/starred

Returns repositories the authenticated user has starred.

/users/<username>/starred

Returns starred repositories (public and private) for the specified user.

Example: /users/johnsmith/starred

List Repositories for an Organization

/orgs/<org>/repos

Returns repositories for the specified organization.

Example: /orgs/BigBrassBand/repos returns only repositories within the BigBrassBand organization.

GitHub Enterprise Examples

List All Repositories (Default)

/api/v3/user/repos

Returns repositories for the authenticated user.

List Repositories for a Specific User

/api/v3/users/<username>/repos

Returns public repositories for the specified user.

Example: /api/v3/users/johnsmith/repos

List Starred Repositories

/api/v3/user/starred

Returns repositories the authenticated user has starred.

/api/v3/users/<username>/starred

Returns starred repositories (public and private) for the specified user.

Example: /api/v3/users/johnsmith/starred

List Repositories for an Organization

/api/v3/orgs/<org>/repos

Returns repositories for the specified organization.

Example: /api/v3/orgs/BigBrassBand/repos

GitLab.com and GitLab CE/EE Examples

List All Projects (Default)

/api/v4/projects?membership=true

Returns all projects. This is the default behavior when no API path is specified.

List Projects for a Specific User

/api/v4/users/<user_id>/projects

Returns projects for the specified user.

Example: /api/v4/users/johnsmith/projects

List Starred Projects

/api/v4/projects?starred=true

Returns projects the authenticated user has starred.

List Owned Projects Only

/api/v4/projects?owned=true

Returns only projects the authenticated user explicitly owns.

List Projects from a Group

/api/v4/groups/<group_id>/projects

Returns projects within a GitLab Group or Subgroup.

Examples:

• /api/v4/groups/5245789/projects (using group ID)
• /api/v4/groups/BigBrassBand/projects (using group name)

List Projects Including Subgroups

/api/v4/groups/<group_id>/projects?include_subgroups=true

Returns projects within a group and all its nested subgroups.

Examples:

• /api/v4/groups/5245789/projects?include_subgroups=true
• /api/v4/groups/BigBrassBand/projects?include_subgroups=true

For more information, see the GitLab API documentation.

Bitbucket Cloud Examples

List Repositories for a Specific User (Default)

/!api/2.0/repositories/<username>

Returns repositories for the specified user. This is the default behavior when no API path is specified.

Example: /!api/2.0/repositories/wcoyote

List Repositories for a Workspace

/!api/2.0/repositories/<workspaceID>

Returns repositories for the specified workspace ID.

Example: /!api/2.0/repositories/acmegroup

Last updated: December 2025