現在APIはベータ版です。仕様が変更になる可能性がありますのでご了承ください。

リソース

Calendars

リソース 記述
GET /api/v1/calendar Get daily calendar for a user

Categories

リソース 記述
GET /api/v1/categories List categories for the authenticated user

Colors

リソース 記述
GET /api/v1/colors List colors

Employs

リソース 記述
POST /api/v1/teams/:team_id/employs Create a employ
PATCH /api/v1/teams/:team_id/employs/:id Edit a employ
DELETE /api/v1/teams/:team_id/employs/:id Destroy a employ

Memberships

リソース 記述
POST /api/v1/teams/:team_id/memberships Create a membership
PATCH /api/v1/teams/:team_id/memberships/:id Update a membership
DELETE /api/v1/teams/:team_id/memberships/:id Destroy a membership

Report recipients

リソース 記述
GET /api/v1/report_recipients List report recipients for the authenticated user
POST /api/v1/report_recipients Create a report recipient
DELETE /api/v1/report_recipients/:id Delete a report recipient

Reports

リソース 記述
GET /api/v1/teams/:id/report/team Get a team report
GET /api/v1/reports/periods List periods

Tasks

リソース 記述
GET /api/v1/tasks List tasks for the authenticated user
GET /api/v1/teams/:team_id/tasks/:id/ancestors Get a parents for task
GET /api/v1/teams/:team_id/tasks/:id Get a task for team
GET /api/v1/teams/:team_id/tasks/search Search tasks for a team
GET /api/v1/teams/:team_id/tasks/parents Get id, path, title of children for parent_id
GET /api/v1/teams/:team_id/tasks/categories Get categories for a team
POST /api/v1/teams/:team_id/tasks Create a task
POST /api/v1/teams/:team_id/tasks/:id/start Start a task
PATCH /api/v1/teams/:team_id/tasks/:id Edit a task
GET /api/v1/teams/:team_id/tasks/:id/time_entries Get time entries for a task
GET /api/v1/teams/:team_id/tasks/:id/users Get worked users for a task
DELETE /api/v1/teams/:team_id/tasks/:id Destroy a task
PATCH /api/v1/teams/:team_id/tasks/:id/trash Trash a task
PATCH /api/v1/teams/:team_id/tasks/:id/restore Restore a task
GET /api/v1/tasks/starred List starred tasks for the authenticated user
POST /api/v1/teams/:team_id/tasks/:id/star Add a star to task
DELETE /api/v1/teams/:team_id/tasks/:id/unstar Remove a star from task

Tasks-suggestions

リソース 記述
GET /api/v1/tasks/suggestions List all matched tasks of the authenticated user

Tasks-time entries

リソース 記述
GET /api/v1/tasks/:task_id/time_entries List time entries

Teams

リソース 記述
GET /api/v1/teams List teams
GET /api/v1/teams/:id Get team
POST /api/v1/teams Create team
PATCH /api/v1/teams/:id Update team
PATCH /api/v1/teams/:id/renew Renew invite url of the team
GET /api/v1/teams/:id/report Get team report
GET /api/v1/teams/:id/working_tasks Get working tasks
GET /api/v1/teams/:id/find_task Find a task with url
GET /api/v1/teams/:id/user_summary Get user summary
GET /api/v1/teams/:id/member_summaries Get member sumaries
GET /api/v1/teams/:id/daily_report Get daily reports
GET /api/v1/teams/:id/monthly_report Get monthly reports
POST /api/v1/teams/:id/calendar_tasks Create tasks from Google Calendar
GET /api/v1/teams/:id/time_entries Get time entries for a team
DELETE /api/v1/teams/:id Destroy the team

Teams-categories

リソース 記述
GET /api/v1/teams/:team_id/categories Get team categories
POST /api/v1/teams/:team_id/categories Create a team category
PATCH /api/v1/teams/:team_id/categories/:id Update a team category
DELETE /api/v1/teams/:team_id/categories/:id Delete a team category

Teams-payments

リソース 記述
GET /api/v1/teams/:id/payment Get payment info for a team
POST /api/v1/teams/:id/payment Create a payment for a team

Teams-tasks

リソース 記述
GET /api/v1/teams/:team_id/tasks List tasks for a team

Teams-users

リソース 記述
GET /api/v1/teams/:id/users Get users

Teams-web hooks

リソース 記述
GET /api/v1/teams/:team_id/web_hooks List team web hooks
POST /api/v1/teams/:team_id/web_hooks Create a WebHook
DELETE /api/v1/teams/:team_id/web_hooks/:id Delete a WebHook

Time entries

リソース 記述
GET /api/v1/time_entries List time entries
GET /api/v1/time_entries/:id Get time entry
POST /api/v1/time_entries Create a time entry
PATCH /api/v1/time_entries/:id Update a time entry
DELETE /api/v1/time_entries/:id Destroy a time entry
POST /api/v1/time_entries/:id/comments Create a comment
PATCH /api/v1/time_entries/multiple_update Update multiple time entries

Time zones

リソース 記述
GET /api/v1/time_zones List of time zones

Users

リソース 記述
GET /api/v1/user Get a user
PATCH /api/v1/user Update user
GET /api/v1/user/info Get user info
GET /api/v1/user/working_users Get working users
GET /api/v1/user/working_users_count Get working users count
GET /api/v1/user/recent_entries Get recent entries
GET /api/v1/user/recent_categories Get recent categories
GET /api/v1/user/recent_tasks Get recent tasks
GET /api/v1/user/daily_activity Get daily tasks and total time for the authenticated user
GET /api/v1/user/workable_tasks Get workable tasks
GET /api/v1/user/activity Get user activity
GET /api/v1/user/working Get user working status
GET /api/v1/user/time_entries List all time entries of the authenticated user
GET /api/v1/user/reportable_teams Get reportable teams for the authenticated user
DELETE /api/v1/user Destroy the user

Users-tasks-time entries

リソース 記述
GET /api/v1/users/tasks/:task_id/time_entries List time entries