List registered user journeys

curl --request GET \
  --url https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/journeys \
  --header 'x-coderabbitai-api-key: <api-key>'

import requests

url = "https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/journeys"

headers = {"x-coderabbitai-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-coderabbitai-api-key': '<api-key>'}};

fetch('https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/journeys', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "<string>",
      "revision": 123,
      "position": 123,
      "archived_at": "<string>",
      "definition": {
        "title": "<string>",
        "user": "<string>",
        "goal": "<string>",
        "tasks": [
          "<string>"
        ],
        "assertions": [
          "<string>"
        ],
        "tags": [
          "<string>"
        ]
      }
    }
  ]
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "head_changed",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "precondition_failed",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "payload_too_large",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "internal_error",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "unavailable",
    "message": "<string>",
    "retry_after": 1
  }
}

GET

verify

repositories

{repository_id}

journeys

List registered user journeys

curl --request GET \
  --url https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/journeys \
  --header 'x-coderabbitai-api-key: <api-key>'

import requests

url = "https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/journeys"

headers = {"x-coderabbitai-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-coderabbitai-api-key': '<api-key>'}};

fetch('https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/journeys', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "<string>",
      "revision": 123,
      "position": 123,
      "archived_at": "<string>",
      "definition": {
        "title": "<string>",
        "user": "<string>",
        "goal": "<string>",
        "tasks": [
          "<string>"
        ],
        "assertions": [
          "<string>"
        ],
        "tags": [
          "<string>"
        ]
      }
    }
  ]
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "head_changed",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "precondition_failed",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "payload_too_large",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "internal_error",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "unavailable",
    "message": "<string>",
    "retry_after": 1
  }
}

CLI Tool
MCP Server

coderabbit api request "/verify/repositories/$REPOSITORY_ID/journeys"

To install and sign in to the CLI, see Call from the CLI.

An agent connected to the CodeRabbit MCP server runs this operation as the list_verify_journeys tool. The connection selects the organization, so the arguments have no org_id or org_name.

{
  "method": "tools/call",
  "params": {
    "name": "list_verify_journeys",
    "arguments": {
      "repository_id": "<repository_id>"
    }
  }
}

Authorizations

x-coderabbitai-api-key

string

header

required

See Authentication for the key types and where to create a key.

Path Parameters

repository_id

string<uuid>

required

Verify registration UUID returned as id by list_verify_repositories; not the provider repository ID.

Query Parameters

org_id

string

Organization for a workspace key: the Git-provider organization ID (scope.provider_organization_id) or the CodeRabbit organization ID (scope.id, or id from list organizations). Supply either org_id or org_name, never both. Omit for organization keys and MCP connections.

Minimum string length: 1

org_name

string

GitHub organization login, such as coderabbitai, not its display name. Matched case-insensitively within the authenticated workspace. Supply either org_name or org_id, never both; omit for organization keys and MCP connections.

Pattern: ^[A-Za-z0-9][A-Za-z0-9-]{0,38}$

Response

data

object[]

required

Show child attributes

Basics

Clients

Guides

API reference

List registered user journeys

Authorizations

Path Parameters

Query Parameters

Response