API docs
Operately API provides HTTP endpoints for querying and mutating Operately resources.
- Every endpoint is authenticated with an API token.
- Use the header
Authorization: Bearer <token>. - Queries are read operations (
GET). - Mutations are write operations (
POST). - Read-only tokens cannot execute mutations and return
403.
Endpoint Namespaces#
| Namespace | Queries | Mutations | Total |
|---|---|---|---|
| Goals | 4 | 22 | 26 |
| Project discussions | 2 | 2 | 4 |
| Project milestones | 1 | 6 | 7 |
| Projects | 5 | 10 | 15 |
| Spaces | 4 | 3 | 7 |
| Tasks | 1 | 9 | 10 |
Other Endpoints#
These endpoints do not belong to a namespace and are available directly under /help/api/*.
| Endpoint | Method | Type | Path |
|---|---|---|---|
| acknowledge_goal_progress_update | POST | mutation | /api/external/v1/acknowledge_goal_progress_update |
| acknowledge_project_check_in | POST | mutation | /api/external/v1/acknowledge_project_check_in |
| add_company | POST | mutation | /api/external/v1/add_company |
| add_company_admins | POST | mutation | /api/external/v1/add_company_admins |
| add_company_member | POST | mutation | /api/external/v1/add_company_member |
| add_key_resource | POST | mutation | /api/external/v1/add_key_resource |
| add_project_contributor | POST | mutation | /api/external/v1/add_project_contributor |
| add_project_contributors | POST | mutation | /api/external/v1/add_project_contributors |
| add_reaction | POST | mutation | /api/external/v1/add_reaction |
| add_space_members | POST | mutation | /api/external/v1/add_space_members |
| archive_message | POST | mutation | /api/external/v1/archive_message |
| change_goal_parent | POST | mutation | /api/external/v1/change_goal_parent |
| close_goal | POST | mutation | /api/external/v1/close_goal |
| close_project | POST | mutation | /api/external/v1/close_project |
| convert_company_member_to_guest | POST | mutation | /api/external/v1/convert_company_member_to_guest |
| copy_resource_hub_folder | POST | mutation | /api/external/v1/copy_resource_hub_folder |
| create_comment | POST | mutation | /api/external/v1/create_comment |
| create_goal | POST | mutation | /api/external/v1/create_goal |
| create_goal_discussion | POST | mutation | /api/external/v1/create_goal_discussion |
| create_project | POST | mutation | /api/external/v1/create_project |
| create_resource_hub | POST | mutation | /api/external/v1/create_resource_hub |
| create_resource_hub_document | POST | mutation | /api/external/v1/create_resource_hub_document |
| create_resource_hub_file | POST | mutation | /api/external/v1/create_resource_hub_file |
| create_resource_hub_folder | POST | mutation | /api/external/v1/create_resource_hub_folder |
| create_resource_hub_link | POST | mutation | /api/external/v1/create_resource_hub_link |
| create_space | POST | mutation | /api/external/v1/create_space |
| delete_comment | POST | mutation | /api/external/v1/delete_comment |
| delete_goal | POST | mutation | /api/external/v1/delete_goal |
| delete_resource_hub_document | POST | mutation | /api/external/v1/delete_resource_hub_document |
| delete_resource_hub_file | POST | mutation | /api/external/v1/delete_resource_hub_file |
| delete_resource_hub_folder | POST | mutation | /api/external/v1/delete_resource_hub_folder |
| delete_resource_hub_link | POST | mutation | /api/external/v1/delete_resource_hub_link |
| delete_space | POST | mutation | /api/external/v1/delete_space |
| edit_comment | POST | mutation | /api/external/v1/edit_comment |
| edit_company | POST | mutation | /api/external/v1/edit_company |
| edit_company_members_permissions | POST | mutation | /api/external/v1/edit_company_members_permissions |
| edit_discussion | POST | mutation | /api/external/v1/edit_discussion |
| edit_goal_discussion | POST | mutation | /api/external/v1/edit_goal_discussion |
| edit_goal_progress_update | POST | mutation | /api/external/v1/edit_goal_progress_update |
| edit_key_resource | POST | mutation | /api/external/v1/edit_key_resource |
| edit_parent_folder_in_resource_hub | POST | mutation | /api/external/v1/edit_parent_folder_in_resource_hub |
| edit_project_check_in | POST | mutation | /api/external/v1/edit_project_check_in |
| edit_project_name | POST | mutation | /api/external/v1/edit_project_name |
| edit_project_permissions | POST | mutation | /api/external/v1/edit_project_permissions |
| edit_project_retrospective | POST | mutation | /api/external/v1/edit_project_retrospective |
| edit_resource_hub_document | POST | mutation | /api/external/v1/edit_resource_hub_document |
| edit_resource_hub_file | POST | mutation | /api/external/v1/edit_resource_hub_file |
| edit_resource_hub_link | POST | mutation | /api/external/v1/edit_resource_hub_link |
| edit_space | POST | mutation | /api/external/v1/edit_space |
| edit_space_members_permissions | POST | mutation | /api/external/v1/edit_space_members_permissions |
| edit_space_permissions | POST | mutation | /api/external/v1/edit_space_permissions |
| edit_subscriptions_list | POST | mutation | /api/external/v1/edit_subscriptions_list |
| get_account | GET | query | /api/external/v1/get_account |
| get_activities | GET | query | /api/external/v1/get_activities |
| get_activity | GET | query | /api/external/v1/get_activity |
| get_assignments | GET | query | /api/external/v1/get_assignments |
| get_assignments_count | GET | query | /api/external/v1/get_assignments_count |
| get_binded_people | GET | query | /api/external/v1/get_binded_people |
| get_comments | GET | query | /api/external/v1/get_comments |
| get_companies | GET | query | /api/external/v1/get_companies |
| get_company | GET | query | /api/external/v1/get_company |
| get_discussion | GET | query | /api/external/v1/get_discussion |
| get_discussions | GET | query | /api/external/v1/get_discussions |
| get_flat_work_map | GET | query | /api/external/v1/get_flat_work_map |
| get_goal | GET | query | /api/external/v1/get_goal |
| get_goal_progress_update | GET | query | /api/external/v1/get_goal_progress_update |
| get_goals | GET | query | /api/external/v1/get_goals |
| get_key_resource | GET | query | /api/external/v1/get_key_resource |
| get_me | GET | query | /api/external/v1/get_me |
| get_milestone | GET | query | /api/external/v1/get_milestone |
| get_notifications | GET | query | /api/external/v1/get_notifications |
| get_people | GET | query | /api/external/v1/get_people |
| get_person | GET | query | /api/external/v1/get_person |
| get_project | GET | query | /api/external/v1/get_project |
| get_project_check_in | GET | query | /api/external/v1/get_project_check_in |
| get_project_check_ins | GET | query | /api/external/v1/get_project_check_ins |
| get_project_contributor | GET | query | /api/external/v1/get_project_contributor |
| get_project_retrospective | GET | query | /api/external/v1/get_project_retrospective |
| get_projects | GET | query | /api/external/v1/get_projects |
| get_resource_hub | GET | query | /api/external/v1/get_resource_hub |
| get_resource_hub_document | GET | query | /api/external/v1/get_resource_hub_document |
| get_resource_hub_file | GET | query | /api/external/v1/get_resource_hub_file |
| get_resource_hub_folder | GET | query | /api/external/v1/get_resource_hub_folder |
| get_resource_hub_link | GET | query | /api/external/v1/get_resource_hub_link |
| get_space | GET | query | /api/external/v1/get_space |
| get_spaces | GET | query | /api/external/v1/get_spaces |
| get_task | GET | query | /api/external/v1/get_task |
| get_tasks | GET | query | /api/external/v1/get_tasks |
| get_unread_notification_count | GET | query | /api/external/v1/get_unread_notification_count |
| get_work_map | GET | query | /api/external/v1/get_work_map |
| global_search | GET | query | /api/external/v1/global_search |
| grant_resource_access | POST | mutation | /api/external/v1/grant_resource_access |
| invite_guest | POST | mutation | /api/external/v1/invite_guest |
| is_subscribed_to_resource | GET | query | /api/external/v1/is_subscribed_to_resource |
| join_space | POST | mutation | /api/external/v1/join_space |
| list_goal_contributors | GET | query | /api/external/v1/list_goal_contributors |
| list_possible_managers | GET | query | /api/external/v1/list_possible_managers |
| list_resource_hub_nodes | GET | query | /api/external/v1/list_resource_hub_nodes |
| list_space_tools | GET | query | /api/external/v1/list_space_tools |
| list_task_assignable_people | GET | query | /api/external/v1/list_task_assignable_people |
| mark_all_notifications_as_read | POST | mutation | /api/external/v1/mark_all_notifications_as_read |
| mark_notification_as_read | POST | mutation | /api/external/v1/mark_notification_as_read |
| mark_notifications_as_read | POST | mutation | /api/external/v1/mark_notifications_as_read |
| move_project_to_space | POST | mutation | /api/external/v1/move_project_to_space |
| move_task | POST | mutation | /api/external/v1/move_task |
| pause_project | POST | mutation | /api/external/v1/pause_project |
| post_discussion | POST | mutation | /api/external/v1/post_discussion |
| post_goal_progress_update | POST | mutation | /api/external/v1/post_goal_progress_update |
| post_milestone_comment | POST | mutation | /api/external/v1/post_milestone_comment |
| post_project_check_in | POST | mutation | /api/external/v1/post_project_check_in |
| publish_discussion | POST | mutation | /api/external/v1/publish_discussion |
| publish_resource_hub_document | POST | mutation | /api/external/v1/publish_resource_hub_document |
| remove_company_admin | POST | mutation | /api/external/v1/remove_company_admin |
| remove_company_member | POST | mutation | /api/external/v1/remove_company_member |
| remove_company_owner | POST | mutation | /api/external/v1/remove_company_owner |
| remove_company_trusted_email_domain | POST | mutation | /api/external/v1/remove_company_trusted_email_domain |
| remove_group_member | POST | mutation | /api/external/v1/remove_group_member |
| remove_key_resource | POST | mutation | /api/external/v1/remove_key_resource |
| remove_project_contributor | POST | mutation | /api/external/v1/remove_project_contributor |
| remove_reaction | POST | mutation | /api/external/v1/remove_reaction |
| rename_resource_hub_folder | POST | mutation | /api/external/v1/rename_resource_hub_folder |
| reopen_goal | POST | mutation | /api/external/v1/reopen_goal |
| restore_company_member | POST | mutation | /api/external/v1/restore_company_member |
| resume_project | POST | mutation | /api/external/v1/resume_project |
| search_people | GET | query | /api/external/v1/search_people |
| search_potential_space_members | GET | query | /api/external/v1/search_potential_space_members |
| search_project_contributor_candidates | GET | query | /api/external/v1/search_project_contributor_candidates |
| subscribe_to_notifications | POST | mutation | /api/external/v1/subscribe_to_notifications |
| unsubscribe_from_notifications | POST | mutation | /api/external/v1/unsubscribe_from_notifications |
| update_profile | POST | mutation | /api/external/v1/update_profile |
| update_profile_picture | POST | mutation | /api/external/v1/update_profile_picture |
| update_project_contributor | POST | mutation | /api/external/v1/update_project_contributor |
| update_project_description | POST | mutation | /api/external/v1/update_project_description |
| update_theme | POST | mutation | /api/external/v1/update_theme |