가이드 콘솔
WithMe

Open API

WithMe Open API를 활용하여 외부 시스템과 연동합니다.

인증
API 키를 사용하여 인증합니다. 모든 요청에 Bearer 토큰을 포함해야 합니다.
1

API 키 생성

프로필 > API 키 메뉴에서 새 API 키를 생성합니다. 워크스페이스를 선택하세요.

2

요청에 토큰 포함

Authorization 헤더에 Bearer 토큰으로 API 키를 포함합니다.

요청 예시

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.withme.team/v1/tickets
티켓 API
티켓을 조회, 생성, 수정, 삭제합니다.
GET/v1/tickets

워크스페이스의 티켓 목록을 조회합니다.

쿼리 파라미터

statusId     - string  (선택)
assigneeId   - string  (선택)
sprintId     - string  (선택)
releaseId    - string  (선택)
priority     - URGENT | HIGH | MEDIUM | LOW | NONE  (선택)
type         - EPIC | STORY | TASK | BUG  (선택)
limit        - number  (기본값: 50, max: 100)
offset       - number  (기본값: 0)
POST/v1/tickets

새 티켓을 생성합니다.

요청 본문

{
  "title": "string (필수)",
  "description": "string",
  "priority": "URGENT | HIGH | MEDIUM | LOW | NONE",
  "type": "EPIC | STORY | TASK | BUG",
  "statusId": "string",
  "assigneeId": "string",
  "sprintId": "string",
  "releaseId": "string",
  "storyPoints": "number",
  "startDate": "ISO 8601",
  "dueDate": "ISO 8601"
}
PUT/v1/tickets/:id

기존 티켓을 수정합니다.

DELETE/v1/tickets/:id

티켓을 삭제합니다.

스프린트 API
스프린트를 조회하고 관리합니다.
GET/v1/sprints

워크스페이스의 스프린트 목록을 조회합니다.

쿼리 파라미터

status  - PLANNING | ACTIVE | COMPLETED  (선택)
limit   - number  (기본값: 50)
offset  - number  (기본값: 0)
POST/v1/sprints

새 스프린트를 생성합니다.

릴리즈 API
릴리즈를 조회하고 관리합니다.
GET/v1/releases

워크스페이스의 릴리즈 목록을 조회합니다.

POST/v1/releases

새 릴리즈를 생성합니다.

라벨 API
라벨을 조회하고 관리합니다.
GET/v1/labels

워크스페이스의 라벨 목록을 조회합니다.

POST/v1/labels

새 라벨을 생성합니다.

상태 API
워크스페이스의 티켓 상태를 조회합니다.
GET/v1/statuses

사용 가능한 상태 목록을 조회합니다.

MCP 연동
MCP를 통해 Cursor, Claude Code 등 AI 도구에서 WithMe를 사용합니다.
1

API 키 준비

프로필 > API 키에서 MCP용 API 키를 생성합니다.

2

MCP 설정 파일 구성

.cursor/mcp.json 또는 claude_desktop_config.json에 설정을 추가합니다.

MCP 설정 예시

{
  "mcpServers": {
    "withme": {
      "command": "npx",
      "args": ["-y", "@withme/mcp-server"],
      "env": {
        "WITHME_API_KEY": "YOUR_API_KEY",
        "WITHME_URL": "https://app.withme.com"
      }
    }
  }
}
3

AI 도구에서 사용

설정 후 Cursor나 Claude Code에서 자연어로 티켓을 관리할 수 있습니다.

MCP로 사용 가능한 기능

  • 티켓 조회, 생성, 수정 (제목, 설명, 우선순위, 타입, 담당자)
  • 티켓 상태 변경 (워크플로우 상태 전환)
  • 티켓에 댓글 추가 (작업 내역, 메모)
  • 스프린트 및 릴리즈 조회
  • 문서 조회, 생성, 수정
  • 통합 검색 (티켓, 문서, 스프린트, 멤버)
  • OKR 목표 관리
  • 워크스페이스 멤버 조회

하네스 기반 협업

Claude Code

Claude Code에서 자동화된 워크플로우로 프로젝트를 관리할 수 있습니다.

API

GET /api/v1/harness
Authorization: Bearer <your-api-key>
  • 코드 작업 시 티켓 상태 자동 동기화
  • 커밋 시 관련 티켓에 자동 코멘트
  • 스프린트 계획 워크플로우 (백로그 정리, 포인트 배분)
  • 코드 리뷰 시 티켓 연결 자동 확인