Skip to content

REST API Reference

View the complete API spec in Swagger UI format.

주요 엔드포인트

Schedules

GET    /v1/schedules                    # Get schedules by date range
POST   /v1/schedules                    # Create new schedule
GET    /v1/schedules/{id}               # Get specific schedule
PATCH  /v1/schedules/{id}               # Update schedule
DELETE /v1/schedules/{id}               # Delete schedule
GET    /v1/schedules/{id}/timers        # Get timers for schedule
GET    /v1/schedules/{id}/timers/active # Get active timer

Timers

GET    /v1/timers/{id}           # Get timer
PATCH  /v1/timers/{id}           # Update timer
DELETE /v1/timers/{id}           # Delete timer

Warning

Note: Timer creation and control (create, pause, resume, stop) are handled via WebSocket API.

Todos

GET    /v1/todos          # List todos
POST   /v1/todos          # Create todo
GET    /v1/todos/{id}     # Get specific todo
PATCH  /v1/todos/{id}     # Update todo
DELETE /v1/todos/{id}     # Delete todo
GET    /v1/todos/stats    # Get statistics

Tags

GET    /v1/tags/groups           # List tag groups
POST   /v1/tags/groups           # Create tag group
GET    /v1/tags/groups/{id}      # Get specific group
PATCH  /v1/tags/groups/{id}      # Update group
DELETE /v1/tags/groups/{id}      # Delete group
GET    /v1/tags                  # List tags
POST   /v1/tags                  # Create tag
DELETE /v1/tags/{id}             # Delete tag

Visibility

PUT    /v1/visibility/{resource_type}/{resource_id}   # Set/update visibility
GET    /v1/visibility/{resource_type}/{resource_id}   # Get visibility settings
DELETE /v1/visibility/{resource_type}/{resource_id}   # Delete visibility (revert to PRIVATE)

resource_type

One of schedule, timer, todo, meeting.

Friends

GET    /v1/friends                       # Friend list (includes display_name, avatar_url)
GET    /v1/friends/ids                    # Friend id list
GET    /v1/friends/check/{user_id}        # Check friendship
POST   /v1/friends/requests               # Friend request (email or friend_code)
GET    /v1/friends/requests/received      # Received requests (includes requester_display_name)
GET    /v1/friends/requests/sent          # Sent requests
POST   /v1/friends/requests/{id}/accept   # Accept request
POST   /v1/friends/requests/{id}/reject   # Reject request
DELETE /v1/friends/requests/{id}          # Cancel sent request
DELETE /v1/friends/{id}                   # Remove friend
POST   /v1/friends/block/{user_id}        # Block user
DELETE /v1/friends/block/{user_id}        # Unblock user

Friend request (POST /v1/friends/requests)

The body provides exactly one of { "email": "..." } or { "friend_code": "..." } — an email (validated; matched against stored verified emails; always returns a uniform 202 to prevent account enumeration) or a friend code (random share code; 404 if unknown). Sending both, neither, or null returns 422. No user search/directory is provided. Get your friend code from GET /v1/users/me.

Users

GET    /v1/users/me                       # Own display info + friend code (for sharing)

Holidays

GET    /v1/holidays              # List holidays

상세 가이드

각 API에 대한 상세한 사용법은 다음 가이드를 참조하세요: