| title | Companies API |
|---|---|
| description | Endpoint reference for companies in the Operately API. |
Get, list, update and manage company settings, members, and permissions
</tbody>
| Endpoint | Method | Type | Path |
|---|---|---|---|
| Convert member to guest | POST |
mutation |
/api/external/v1/companies/convert_member_to_guest |
| Create | POST |
mutation |
/api/external/v1/companies/create |
| Create admins | POST |
mutation |
/api/external/v1/companies/create_admins |
| Create member | POST |
mutation |
/api/external/v1/companies/create_member |
| Delete admin | POST |
mutation |
/api/external/v1/companies/delete_admin |
| Delete member | POST |
mutation |
/api/external/v1/companies/delete_member |
| Delete owner | POST |
mutation |
/api/external/v1/companies/delete_owner |
| Delete trusted email domain | POST |
mutation |
/api/external/v1/companies/delete_trusted_email_domain |
| Get | GET |
query |
/api/external/v1/companies/get |
| Get activity | GET |
query |
/api/external/v1/companies/get_activity |
| Get flat work map | GET |
query |
/api/external/v1/companies/get_flat_work_map |
| Get work map | GET |
query |
/api/external/v1/companies/get_work_map |
| Global search | GET |
query |
/api/external/v1/companies/global_search |
| Grant resource access | POST |
mutation |
/api/external/v1/companies/grant_resource_access |
| Invite guest | POST |
mutation |
/api/external/v1/companies/invite_guest |
| List | GET |
query |
/api/external/v1/companies/list |
| List activities | GET |
query |
/api/external/v1/companies/list_activities |
| Restore member | POST |
mutation |
/api/external/v1/companies/restore_member |
| Update | POST |
mutation |
/api/external/v1/companies/update |
| Update members permissions | POST |
mutation |
/api/external/v1/companies/update_members_permissions |