Get fork

Fetch a repo's upstream fork record, or fetch the fork record for a specific user or team fork of an upstream repo.

Use GET /api/v1/forks/{fork_uuid} to poll a specific async fork operation returned by create-fork. The endpoints documented here are for repo/fork discovery lookups.

Endpoints

GET /api/v1/teams/{team_slug}/repos/{repo_slug}/fork
GET /api/v1/users/{username}/repos/{repo_slug}/fork
GET /api/v1/teams/{team_slug}/repos/{repo_slug}/forks/user/{fork_username}
GET /api/v1/users/{username}/repos/{repo_slug}/forks/user/{fork_username}
GET /api/v1/teams/{team_slug}/repos/{repo_slug}/forks/team/{fork_team_slug}
GET /api/v1/users/{username}/repos/{repo_slug}/forks/team/{fork_team_slug}

Authenticated

Usage

# Repo is itself a fork: get its upstream fork record
curl --header "Authorization: Bearer $PEARING_API_TOKEN" \
  "$PEARING_API_URL/v1/users/alice/repos/website-fork/fork"

# Upstream repo: get a specific user's fork record
curl --header "Authorization: Bearer $PEARING_API_TOKEN" \
  "$PEARING_API_URL/v1/teams/platform/repos/website/forks/user/alice"

# Upstream repo: get a specific team's fork record
curl --header "Authorization: Bearer $PEARING_API_TOKEN" \
  "$PEARING_API_URL/v1/users/alice/repos/website/forks/team/platform-forks"

The CLI presents these as one get-fork command with an optional --owner flag, but the HTTP API keeps separate endpoints for upstream lookup versus owner-specific fork lookup.

Success

200 OK with the fork record, including created_by_uuid and created_by_username.

{
  "uuid": "...",
  "status": "completed",
  "created_at": "2026-03-09T12:00:00Z"
}

Errors

403 Forbidden when caller lacks access to the repo.
404 Not Found when the repo or fork record does not exist.

Common auth errors are documented on the API overview page.