# Open Mercato API Version: 0.6.5 Auto-generated OpenAPI definition for all enabled modules. ## Servers - https://om.3.74.75.141.nip.io/api – Default environment ## GET `/ai_assistant/ai/actions/{id}` GET /ai_assistant/ai/actions/{id} Requires features: ai_assistant.view **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/actions/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/ai_assistant/ai/actions/{id}/cancel` POST /ai_assistant/ai/actions/{id}/cancel Requires features: ai_assistant.view **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/actions/:id/cancel" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/ai_assistant/ai/actions/{id}/confirm` POST /ai_assistant/ai/actions/{id}/confirm Requires features: ai_assistant.view **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/actions/:id/confirm" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/ai_assistant/ai/agents` GET /ai_assistant/ai/agents Requires features: ai_assistant.view **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/agents" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/ai_assistant/ai/agents/{agentId}/loop-override` DELETE /ai_assistant/ai/agents/{agentId}/loop-override Requires features: ai_assistant.settings.manage **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.settings.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | agentId | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/agents/:agentId/loop-override" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/ai_assistant/ai/agents/{agentId}/loop-override` GET /ai_assistant/ai/agents/{agentId}/loop-override Requires features: ai_assistant.view **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | agentId | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/agents/:agentId/loop-override" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/ai_assistant/ai/agents/{agentId}/loop-override` PUT /ai_assistant/ai/agents/{agentId}/loop-override Requires features: ai_assistant.settings.manage **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.settings.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | agentId | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/agents/:agentId/loop-override" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/ai_assistant/ai/agents/{agentId}/models` GET /ai_assistant/ai/agents/{agentId}/models Requires features: ai_assistant.view **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | agentId | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/agents/:agentId/models" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/ai_assistant/ai/agents/{agentId}/mutation-policy` DELETE /ai_assistant/ai/agents/{agentId}/mutation-policy Requires features: ai_assistant.settings.manage **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.settings.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | agentId | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/agents/:agentId/mutation-policy" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/ai_assistant/ai/agents/{agentId}/mutation-policy` GET /ai_assistant/ai/agents/{agentId}/mutation-policy Requires features: ai_assistant.view **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | agentId | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/agents/:agentId/mutation-policy" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/ai_assistant/ai/agents/{agentId}/mutation-policy` POST /ai_assistant/ai/agents/{agentId}/mutation-policy Requires features: ai_assistant.settings.manage **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.settings.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | agentId | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/agents/:agentId/mutation-policy" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/ai_assistant/ai/agents/{agentId}/prompt-override` GET /ai_assistant/ai/agents/{agentId}/prompt-override **Tags:** AI Assistant ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | agentId | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/agents/:agentId/prompt-override" \ -H "Accept: application/json" ``` ## POST `/ai_assistant/ai/agents/{agentId}/prompt-override` POST /ai_assistant/ai/agents/{agentId}/prompt-override **Tags:** AI Assistant ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | agentId | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/agents/:agentId/prompt-override" \ -H "Accept: application/json" ``` ## POST `/ai_assistant/ai/chat` POST /ai_assistant/ai/chat Requires features: ai_assistant.view **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.view ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/chat" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/ai_assistant/ai/conversations` GET /ai_assistant/ai/conversations Requires features: ai_assistant.view **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/conversations" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/ai_assistant/ai/conversations` POST /ai_assistant/ai/conversations Requires features: ai_assistant.view **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.view ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/conversations" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/ai_assistant/ai/conversations/{conversationId}` DELETE /ai_assistant/ai/conversations/{conversationId} Requires features: ai_assistant.view **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | conversationId | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/conversations/:conversationId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/ai_assistant/ai/conversations/{conversationId}` GET /ai_assistant/ai/conversations/{conversationId} Requires features: ai_assistant.view **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | conversationId | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/conversations/:conversationId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/ai_assistant/ai/conversations/{conversationId}` PATCH /ai_assistant/ai/conversations/{conversationId} Requires features: ai_assistant.view **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | conversationId | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PATCH "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/conversations/:conversationId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/ai_assistant/ai/conversations/{conversationId}/participants` GET /ai_assistant/ai/conversations/{conversationId}/participants Requires features: ai_assistant.view **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | conversationId | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/conversations/:conversationId/participants" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/ai_assistant/ai/conversations/{conversationId}/participants` POST /ai_assistant/ai/conversations/{conversationId}/participants Requires features: ai_assistant.view **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | conversationId | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/conversations/:conversationId/participants" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/ai_assistant/ai/conversations/{conversationId}/participants/{userId}` DELETE /ai_assistant/ai/conversations/{conversationId}/participants/{userId} Requires features: ai_assistant.view **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | conversationId | path | any | Required | | userId | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/conversations/:conversationId/participants/:userId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/ai_assistant/ai/conversations/import` POST /ai_assistant/ai/conversations/import Requires features: ai_assistant.view **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.view ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/conversations/import" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/ai_assistant/ai/run-object` POST /ai_assistant/ai/run-object Requires features: ai_assistant.view **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.view ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/ai_assistant/ai/run-object" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/ai_assistant/chat` POST /ai_assistant/chat Requires features: ai_assistant.view **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.view ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/ai_assistant/chat" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/ai_assistant/health` GET /ai_assistant/health Requires features: ai_assistant.view **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/ai_assistant/health" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/ai_assistant/mcp-key` POST /ai_assistant/mcp-key Requires features: api_keys.create **Tags:** AI Assistant **Requires authentication.** **Features:** api_keys.create ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/ai_assistant/mcp-key" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/ai_assistant/route` POST /ai_assistant/route Requires features: ai_assistant.view **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.view ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/ai_assistant/route" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/ai_assistant/session-key` POST /ai_assistant/session-key Requires features: ai_assistant.view **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.view ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/ai_assistant/session-key" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/ai_assistant/settings` DELETE /ai_assistant/settings Requires features: ai_assistant.settings.manage **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.settings.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/ai_assistant/settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/ai_assistant/settings` GET /ai_assistant/settings Requires features: ai_assistant.view **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/ai_assistant/settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/ai_assistant/settings` PUT /ai_assistant/settings Requires features: ai_assistant.settings.manage **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/ai_assistant/settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/ai_assistant/settings/allowlist` DELETE /ai_assistant/settings/allowlist Requires features: ai_assistant.settings.manage **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.settings.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/ai_assistant/settings/allowlist" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/ai_assistant/settings/allowlist` PUT /ai_assistant/settings/allowlist Requires features: ai_assistant.settings.manage **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/ai_assistant/settings/allowlist" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/ai_assistant/tools` GET /ai_assistant/tools Requires features: ai_assistant.view **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/ai_assistant/tools" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/ai_assistant/tools/execute` POST /ai_assistant/tools/execute Requires features: ai_assistant.view **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.view ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/ai_assistant/tools/execute" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/ai_assistant/usage/daily` GET /ai_assistant/usage/daily Requires features: ai_assistant.settings.manage **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/ai_assistant/usage/daily" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/ai_assistant/usage/sessions` GET /ai_assistant/usage/sessions Requires features: ai_assistant.settings.manage **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/ai_assistant/usage/sessions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/ai_assistant/usage/sessions/{sessionId}` GET /ai_assistant/usage/sessions/{sessionId} Requires features: ai_assistant.settings.manage **Tags:** AI Assistant **Requires authentication.** **Features:** ai_assistant.settings.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | sessionId | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/ai_assistant/usage/sessions/:sessionId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/api_keys/keys` DELETE /api_keys/keys Requires features: api_keys.delete **Tags:** API Keys **Requires authentication.** **Features:** api_keys.delete ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/api_keys/keys" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/api_keys/keys` GET /api_keys/keys Requires features: api_keys.view **Tags:** API Keys **Requires authentication.** **Features:** api_keys.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/api_keys/keys" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/api_keys/keys` POST /api_keys/keys Requires features: api_keys.create **Tags:** API Keys **Requires authentication.** **Features:** api_keys.create ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/api_keys/keys" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/attachments` DELETE /attachments Requires features: attachments.manage **Tags:** Attachments **Requires authentication.** **Features:** attachments.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/attachments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/attachments` GET /attachments Requires features: attachments.view **Tags:** Attachments **Requires authentication.** **Features:** attachments.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/attachments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/attachments` POST /attachments Requires features: attachments.manage **Tags:** Attachments **Requires authentication.** **Features:** attachments.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/attachments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/attachments/file/{id}` GET /attachments/file/{id} **Tags:** Attachments ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/attachments/file/:id" \ -H "Accept: application/json" ``` ## GET `/attachments/image/{id}/{slug}` GET /attachments/image/{id}/{slug} **Tags:** Attachments ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | slug | path | any | Optional | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/attachments/image/:id/:slug" \ -H "Accept: application/json" ``` ## GET `/attachments/library` GET /attachments/library Requires features: attachments.view **Tags:** Attachments **Requires authentication.** **Features:** attachments.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/attachments/library" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/attachments/library/{id}` DELETE /attachments/library/{id} Requires features: attachments.manage **Tags:** Attachments **Requires authentication.** **Features:** attachments.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/attachments/library/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/attachments/library/{id}` GET /attachments/library/{id} Requires features: attachments.view **Tags:** Attachments **Requires authentication.** **Features:** attachments.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/attachments/library/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/attachments/library/{id}` PATCH /attachments/library/{id} Requires features: attachments.manage **Tags:** Attachments **Requires authentication.** **Features:** attachments.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PATCH "https://om.3.74.75.141.nip.io/api/attachments/library/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/attachments/partitions` DELETE /attachments/partitions Requires features: attachments.manage **Tags:** Attachments **Requires authentication.** **Features:** attachments.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/attachments/partitions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/attachments/partitions` GET /attachments/partitions Requires features: attachments.manage **Tags:** Attachments **Requires authentication.** **Features:** attachments.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/attachments/partitions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/attachments/partitions` POST /attachments/partitions Requires features: attachments.manage **Tags:** Attachments **Requires authentication.** **Features:** attachments.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/attachments/partitions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/attachments/partitions` PUT /attachments/partitions Requires features: attachments.manage **Tags:** Attachments **Requires authentication.** **Features:** attachments.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/attachments/partitions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/attachments/transfer` POST /attachments/transfer Requires features: attachments.manage **Tags:** Attachments **Requires authentication.** **Features:** attachments.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/attachments/transfer" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/audit_logs/audit-logs/access` GET /audit_logs/audit-logs/access Requires features: audit_logs.view_self **Tags:** Audit & Action Logs **Requires authentication.** **Features:** audit_logs.view_self ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/audit_logs/audit-logs/access" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/audit_logs/audit-logs/actions` GET /audit_logs/audit-logs/actions Requires features: audit_logs.view_self **Tags:** Audit & Action Logs **Requires authentication.** **Features:** audit_logs.view_self ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/audit_logs/audit-logs/actions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/audit_logs/audit-logs/actions/export` GET /audit_logs/audit-logs/actions/export Requires features: audit_logs.view_self **Tags:** Audit & Action Logs **Requires authentication.** **Features:** audit_logs.view_self ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/audit_logs/audit-logs/actions/export" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/audit_logs/audit-logs/actions/redo` POST /audit_logs/audit-logs/actions/redo Requires features: audit_logs.redo_self **Tags:** Audit & Action Logs **Requires authentication.** **Features:** audit_logs.redo_self ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/audit_logs/audit-logs/actions/redo" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/audit_logs/audit-logs/actions/undo` POST /audit_logs/audit-logs/actions/undo Requires features: audit_logs.undo_self **Tags:** Audit & Action Logs **Requires authentication.** **Features:** audit_logs.undo_self ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/audit_logs/audit-logs/actions/undo" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/auth/admin/nav` GET /auth/admin/nav **Tags:** Authentication & Accounts **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/auth/admin/nav" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/auth/feature-check` POST /auth/feature-check **Tags:** Authentication & Accounts **Requires authentication.** ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/auth/feature-check" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/auth/features` GET /auth/features Requires features: auth.acl.manage **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.acl.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/auth/features" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/auth/locale` GET /auth/locale **Tags:** Authentication & Accounts ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/auth/locale" \ -H "Accept: application/json" ``` ## POST `/auth/locale` POST /auth/locale **Tags:** Authentication & Accounts ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/auth/locale" \ -H "Accept: application/json" ``` ## POST `/auth/login` POST /auth/login **Tags:** Authentication & Accounts ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/auth/login" \ -H "Accept: application/json" ``` ## POST `/auth/logout` POST /auth/logout **Tags:** Authentication & Accounts **Requires authentication.** ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/auth/logout" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/auth/profile` GET /auth/profile **Tags:** Authentication & Accounts **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/auth/profile" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/auth/profile` PUT /auth/profile **Tags:** Authentication & Accounts **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/auth/profile" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/auth/reset` POST /auth/reset **Tags:** Authentication & Accounts ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/auth/reset" \ -H "Accept: application/json" ``` ## POST `/auth/reset/confirm` POST /auth/reset/confirm **Tags:** Authentication & Accounts ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/auth/reset/confirm" \ -H "Accept: application/json" ``` ## DELETE `/auth/roles` DELETE /auth/roles Requires features: auth.roles.manage **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.roles.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/auth/roles" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/auth/roles` GET /auth/roles Requires features: auth.roles.list **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.roles.list ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/auth/roles" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/auth/roles` POST /auth/roles Requires features: auth.roles.manage **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.roles.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/auth/roles" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/auth/roles` PUT /auth/roles Requires features: auth.roles.manage **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.roles.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/auth/roles" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/auth/roles/acl` GET /auth/roles/acl Requires features: auth.acl.manage **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.acl.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/auth/roles/acl" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/auth/roles/acl` PUT /auth/roles/acl Requires features: auth.acl.manage **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.acl.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/auth/roles/acl" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/auth/session/refresh` GET /auth/session/refresh **Tags:** Authentication & Accounts ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/auth/session/refresh" \ -H "Accept: application/json" ``` ## POST `/auth/session/refresh` POST /auth/session/refresh **Tags:** Authentication & Accounts ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/auth/session/refresh" \ -H "Accept: application/json" ``` ## DELETE `/auth/sidebar/preferences` DELETE /auth/sidebar/preferences Requires features: auth.sidebar.manage **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.sidebar.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/auth/sidebar/preferences" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/auth/sidebar/preferences` GET /auth/sidebar/preferences **Tags:** Authentication & Accounts **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/auth/sidebar/preferences" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/auth/sidebar/preferences` PUT /auth/sidebar/preferences Requires features: auth.sidebar.manage **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.sidebar.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/auth/sidebar/preferences" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/auth/sidebar/variants` GET /auth/sidebar/variants **Tags:** Authentication & Accounts **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/auth/sidebar/variants" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/auth/sidebar/variants` POST /auth/sidebar/variants Requires features: auth.sidebar.manage **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.sidebar.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/auth/sidebar/variants" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/auth/sidebar/variants/{id}` DELETE /auth/sidebar/variants/{id} Requires features: auth.sidebar.manage **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.sidebar.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/auth/sidebar/variants/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/auth/sidebar/variants/{id}` GET /auth/sidebar/variants/{id} **Tags:** Authentication & Accounts **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/auth/sidebar/variants/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/auth/sidebar/variants/{id}` PUT /auth/sidebar/variants/{id} Requires features: auth.sidebar.manage **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.sidebar.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/auth/sidebar/variants/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/auth/users` DELETE /auth/users Requires features: auth.users.delete **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.users.delete ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/auth/users" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/auth/users` GET /auth/users Requires features: auth.users.list **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.users.list ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/auth/users" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/auth/users` POST /auth/users Requires features: auth.users.create **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.users.create ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/auth/users" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/auth/users` PUT /auth/users Requires features: auth.users.edit **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.users.edit ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/auth/users" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/auth/users/acl` GET /auth/users/acl Requires features: auth.acl.manage **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.acl.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/auth/users/acl" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/auth/users/acl` PUT /auth/users/acl Requires features: auth.acl.manage **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.acl.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/auth/users/acl" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/auth/users/consents` GET /auth/users/consents Requires features: auth.users.edit **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.users.edit ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/auth/users/consents" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/auth/users/resend-invite` POST /auth/users/resend-invite Requires features: auth.users.create **Tags:** Authentication & Accounts **Requires authentication.** **Features:** auth.users.create ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/auth/users/resend-invite" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/business_rules/execute` POST /business_rules/execute Requires features: business_rules.execute **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.execute ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/business_rules/execute" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/business_rules/execute/{ruleId}` POST /business_rules/execute/{ruleId} Requires features: business_rules.execute **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.execute ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | ruleId | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/business_rules/execute/:ruleId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/business_rules/logs` GET /business_rules/logs Requires features: business_rules.view_logs **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.view_logs ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/business_rules/logs" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/business_rules/logs/{id}` GET /business_rules/logs/{id} Requires features: business_rules.view_logs **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.view_logs ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/business_rules/logs/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/business_rules/rules` DELETE /business_rules/rules Requires features: business_rules.manage **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/business_rules/rules" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/business_rules/rules` GET /business_rules/rules Requires features: business_rules.view **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/business_rules/rules" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/business_rules/rules` POST /business_rules/rules Requires features: business_rules.manage **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/business_rules/rules" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/business_rules/rules` PUT /business_rules/rules Requires features: business_rules.manage **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/business_rules/rules" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/business_rules/rules/{id}` GET /business_rules/rules/{id} Requires features: business_rules.view **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/business_rules/rules/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/business_rules/sets` DELETE /business_rules/sets Requires features: business_rules.manage_sets **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.manage_sets ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/business_rules/sets" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/business_rules/sets` GET /business_rules/sets Requires features: business_rules.view **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/business_rules/sets" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/business_rules/sets` POST /business_rules/sets Requires features: business_rules.manage_sets **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.manage_sets ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/business_rules/sets" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/business_rules/sets` PUT /business_rules/sets Requires features: business_rules.manage_sets **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.manage_sets ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/business_rules/sets" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/business_rules/sets/{id}` GET /business_rules/sets/{id} Requires features: business_rules.view **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/business_rules/sets/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/business_rules/sets/{id}/members` DELETE /business_rules/sets/{id}/members Requires features: business_rules.manage_sets **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.manage_sets ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/business_rules/sets/:id/members" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/business_rules/sets/{id}/members` POST /business_rules/sets/{id}/members Requires features: business_rules.manage_sets **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.manage_sets ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/business_rules/sets/:id/members" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/business_rules/sets/{id}/members` PUT /business_rules/sets/{id}/members Requires features: business_rules.manage_sets **Tags:** Business Rules **Requires authentication.** **Features:** business_rules.manage_sets ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/business_rules/sets/:id/members" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/catalog/bulk-delete` POST /catalog/bulk-delete Requires features: catalog.products.manage **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.products.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/catalog/bulk-delete" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/catalog/categories` DELETE /catalog/categories Requires features: catalog.categories.manage **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.categories.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/catalog/categories" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/catalog/categories` GET /catalog/categories Requires features: catalog.categories.view **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.categories.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/catalog/categories" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/catalog/categories` POST /catalog/categories Requires features: catalog.categories.manage **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.categories.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/catalog/categories" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/catalog/categories` PUT /catalog/categories Requires features: catalog.categories.manage **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.categories.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/catalog/categories" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/catalog/dictionaries/{key}` GET /catalog/dictionaries/{key} Requires features: catalog.products.manage **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.products.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | key | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/catalog/dictionaries/:key" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/catalog/offers` DELETE /catalog/offers Requires features: sales.channels.manage **Tags:** Product Catalog **Requires authentication.** **Features:** sales.channels.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/catalog/offers" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/catalog/offers` GET /catalog/offers Requires features: sales.channels.manage **Tags:** Product Catalog **Requires authentication.** **Features:** sales.channels.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/catalog/offers" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/catalog/offers` POST /catalog/offers Requires features: sales.channels.manage **Tags:** Product Catalog **Requires authentication.** **Features:** sales.channels.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/catalog/offers" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/catalog/offers` PUT /catalog/offers Requires features: sales.channels.manage **Tags:** Product Catalog **Requires authentication.** **Features:** sales.channels.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/catalog/offers" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/catalog/option-schemas` DELETE /catalog/option-schemas Requires features: catalog.settings.manage **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.settings.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/catalog/option-schemas" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/catalog/option-schemas` GET /catalog/option-schemas Requires features: catalog.products.view **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.products.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/catalog/option-schemas" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/catalog/option-schemas` POST /catalog/option-schemas Requires features: catalog.settings.manage **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.settings.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/catalog/option-schemas" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/catalog/option-schemas` PUT /catalog/option-schemas Requires features: catalog.settings.manage **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/catalog/option-schemas" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/catalog/price-kinds` DELETE /catalog/price-kinds Requires features: catalog.settings.manage **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.settings.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/catalog/price-kinds" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/catalog/price-kinds` GET /catalog/price-kinds Requires features: catalog.settings.manage **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/catalog/price-kinds" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/catalog/price-kinds` POST /catalog/price-kinds Requires features: catalog.settings.manage **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.settings.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/catalog/price-kinds" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/catalog/price-kinds` PUT /catalog/price-kinds Requires features: catalog.settings.manage **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/catalog/price-kinds" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/catalog/prices` DELETE /catalog/prices Requires features: catalog.pricing.manage **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.pricing.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/catalog/prices" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/catalog/prices` GET /catalog/prices Requires features: catalog.products.view **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.products.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/catalog/prices" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/catalog/prices` POST /catalog/prices Requires features: catalog.pricing.manage **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.pricing.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/catalog/prices" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/catalog/prices` PUT /catalog/prices Requires features: catalog.pricing.manage **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.pricing.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/catalog/prices" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/catalog/product-media` GET /catalog/product-media Requires features: catalog.products.view **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.products.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/catalog/product-media" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/catalog/product-unit-conversions` DELETE /catalog/product-unit-conversions Requires features: catalog.products.manage **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.products.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/catalog/product-unit-conversions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/catalog/product-unit-conversions` GET /catalog/product-unit-conversions Requires features: catalog.products.view **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.products.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/catalog/product-unit-conversions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/catalog/product-unit-conversions` POST /catalog/product-unit-conversions Requires features: catalog.products.manage **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.products.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/catalog/product-unit-conversions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/catalog/product-unit-conversions` PUT /catalog/product-unit-conversions Requires features: catalog.products.manage **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.products.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/catalog/product-unit-conversions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/catalog/products` DELETE /catalog/products Requires features: catalog.products.manage **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.products.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/catalog/products" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/catalog/products` GET /catalog/products Requires features: catalog.products.view **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.products.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/catalog/products" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/catalog/products` POST /catalog/products Requires features: catalog.products.manage **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.products.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/catalog/products" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/catalog/products` PUT /catalog/products Requires features: catalog.products.manage **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.products.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/catalog/products" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/catalog/tags` GET /catalog/tags Requires features: catalog.products.view **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.products.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/catalog/tags" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/catalog/variants` DELETE /catalog/variants Requires features: catalog.variants.manage **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.variants.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/catalog/variants" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/catalog/variants` GET /catalog/variants Requires features: catalog.products.view **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.products.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/catalog/variants" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/catalog/variants` POST /catalog/variants Requires features: catalog.variants.manage **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.variants.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/catalog/variants" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/catalog/variants` PUT /catalog/variants Requires features: catalog.variants.manage **Tags:** Product Catalog **Requires authentication.** **Features:** catalog.variants.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/catalog/variants" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/checkout/links` GET /checkout/links Requires features: checkout.view **Tags:** Checkout **Requires authentication.** **Features:** checkout.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/checkout/links" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/checkout/links` POST /checkout/links Requires features: checkout.create **Tags:** Checkout **Requires authentication.** **Features:** checkout.create ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/checkout/links" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/checkout/links/{id}` DELETE /checkout/links/{id} Requires features: checkout.delete **Tags:** Checkout **Requires authentication.** **Features:** checkout.delete ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/checkout/links/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/checkout/links/{id}` GET /checkout/links/{id} Requires features: checkout.view **Tags:** Checkout **Requires authentication.** **Features:** checkout.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/checkout/links/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/checkout/links/{id}` PUT /checkout/links/{id} Requires features: checkout.edit **Tags:** Checkout **Requires authentication.** **Features:** checkout.edit ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/checkout/links/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/checkout/pay/{slug}` GET /checkout/pay/{slug} **Tags:** Checkout ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | slug | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/checkout/pay/:slug" \ -H "Accept: application/json" ``` ## GET `/checkout/pay/{slug}/status/{transactionId}` GET /checkout/pay/{slug}/status/{transactionId} **Tags:** Checkout ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | slug | path | any | Required | | transactionId | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/checkout/pay/:slug/status/:transactionId" \ -H "Accept: application/json" ``` ## POST `/checkout/pay/{slug}/submit` POST /checkout/pay/{slug}/submit **Tags:** Checkout ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | slug | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/checkout/pay/:slug/submit" \ -H "Accept: application/json" ``` ## POST `/checkout/pay/{slug}/verify-password` POST /checkout/pay/{slug}/verify-password **Tags:** Checkout ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | slug | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/checkout/pay/:slug/verify-password" \ -H "Accept: application/json" ``` ## GET `/checkout/templates` GET /checkout/templates Requires features: checkout.view **Tags:** Checkout **Requires authentication.** **Features:** checkout.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/checkout/templates" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/checkout/templates` POST /checkout/templates Requires features: checkout.create **Tags:** Checkout **Requires authentication.** **Features:** checkout.create ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/checkout/templates" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/checkout/templates/{id}` DELETE /checkout/templates/{id} Requires features: checkout.delete **Tags:** Checkout **Requires authentication.** **Features:** checkout.delete ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/checkout/templates/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/checkout/templates/{id}` GET /checkout/templates/{id} Requires features: checkout.view **Tags:** Checkout **Requires authentication.** **Features:** checkout.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/checkout/templates/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/checkout/templates/{id}` PUT /checkout/templates/{id} Requires features: checkout.edit **Tags:** Checkout **Requires authentication.** **Features:** checkout.edit ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/checkout/templates/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/checkout/templates/{id}/preview` GET /checkout/templates/{id}/preview Requires features: checkout.view **Tags:** Checkout **Requires authentication.** **Features:** checkout.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/checkout/templates/:id/preview" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/checkout/transactions` GET /checkout/transactions Requires features: checkout.view **Tags:** Checkout **Requires authentication.** **Features:** checkout.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/checkout/transactions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/checkout/transactions/{id}` GET /checkout/transactions/{id} Requires features: checkout.view **Tags:** Checkout **Requires authentication.** **Features:** checkout.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/checkout/transactions/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/checkout/transactions/by-gateway/{gatewayTransactionId}` GET /checkout/transactions/by-gateway/{gatewayTransactionId} Requires features: checkout.view **Tags:** Checkout **Requires authentication.** **Features:** checkout.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | gatewayTransactionId | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/checkout/transactions/by-gateway/:gatewayTransactionId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/communication_channels/channels` GET /communication_channels/channels Requires features: communication_channels.view **Tags:** Communication Channels **Requires authentication.** **Features:** communication_channels.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/communication_channels/channels" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/communication_channels/channels/{id}` DELETE /communication_channels/channels/{id} Requires features: communication_channels.connect_user_channel **Tags:** Communication Channels **Requires authentication.** **Features:** communication_channels.connect_user_channel ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/communication_channels/channels/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/communication_channels/channels/{id}` GET /communication_channels/channels/{id} Requires features: communication_channels.view **Tags:** Communication Channels **Requires authentication.** **Features:** communication_channels.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/communication_channels/channels/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/communication_channels/channels/{id}/health` GET /communication_channels/channels/{id}/health Requires features: communication_channels.view **Tags:** Communication Channels **Requires authentication.** **Features:** communication_channels.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/communication_channels/channels/:id/health" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/communication_channels/channels/{id}/import-history` POST /communication_channels/channels/{id}/import-history Requires features: communication_channels.connect_user_channel **Tags:** Communication Channels **Requires authentication.** **Features:** communication_channels.connect_user_channel ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/communication_channels/channels/:id/import-history" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/communication_channels/channels/{id}/poll-now` POST /communication_channels/channels/{id}/poll-now Requires features: communication_channels.connect_user_channel **Tags:** Communication Channels **Requires authentication.** **Features:** communication_channels.connect_user_channel ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/communication_channels/channels/:id/poll-now" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/communication_channels/channels/{id}/push/register` POST /communication_channels/channels/{id}/push/register Requires features: communication_channels.connect_user_channel **Tags:** Communication Channels **Requires authentication.** **Features:** communication_channels.connect_user_channel ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/communication_channels/channels/:id/push/register" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/communication_channels/channels/{id}/set-primary` POST /communication_channels/channels/{id}/set-primary Requires features: communication_channels.connect_user_channel **Tags:** Communication Channels **Requires authentication.** **Features:** communication_channels.connect_user_channel ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/communication_channels/channels/:id/set-primary" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/communication_channels/channels/{id}/test-send` POST /communication_channels/channels/{id}/test-send Requires features: communication_channels.connect_user_channel **Tags:** Communication Channels **Requires authentication.** **Features:** communication_channels.connect_user_channel ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/communication_channels/channels/:id/test-send" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/communication_channels/channels/connect/credentials` POST /communication_channels/channels/connect/credentials Requires features: communication_channels.connect_user_channel **Tags:** Communication Channels **Requires authentication.** **Features:** communication_channels.connect_user_channel ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/communication_channels/channels/connect/credentials" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/communication_channels/me/channels` GET /communication_channels/me/channels Requires features: communication_channels.connect_user_channel **Tags:** Communication Channels **Requires authentication.** **Features:** communication_channels.connect_user_channel ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/communication_channels/me/channels" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/communication_channels/messages/{messageId}/reactions` POST /communication_channels/messages/{messageId}/reactions Requires features: communication_channels.react **Tags:** Communication Channels **Requires authentication.** **Features:** communication_channels.react ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | messageId | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/communication_channels/messages/:messageId/reactions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/communication_channels/messages/{messageId}/reactions/{reactionId}` DELETE /communication_channels/messages/{messageId}/reactions/{reactionId} Requires features: communication_channels.react **Tags:** Communication Channels **Requires authentication.** **Features:** communication_channels.react ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | messageId | path | any | Required | | reactionId | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/communication_channels/messages/:messageId/reactions/:reactionId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/communication_channels/oauth/{provider}/callback` GET /communication_channels/oauth/{provider}/callback **Tags:** Communication Channels **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | provider | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/communication_channels/oauth/:provider/callback" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/communication_channels/oauth/{provider}/initiate` POST /communication_channels/oauth/{provider}/initiate Requires features: communication_channels.connect_user_channel **Tags:** Communication Channels **Requires authentication.** **Features:** communication_channels.connect_user_channel ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | provider | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/communication_channels/oauth/:provider/initiate" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/communication_channels/send-as-user` POST /communication_channels/send-as-user Requires features: communication_channels.manage **Tags:** Communication Channels **Requires authentication.** **Features:** communication_channels.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/communication_channels/send-as-user" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/communication_channels/test-seed` POST /communication_channels/test-seed Requires features: communication_channels.connect_user_channel **Tags:** Communication Channels **Requires authentication.** **Features:** communication_channels.connect_user_channel ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/communication_channels/test-seed" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/communication_channels/threads/{threadId}/assign` PUT /communication_channels/threads/{threadId}/assign Requires features: communication_channels.assign **Tags:** Communication Channels **Requires authentication.** **Features:** communication_channels.assign ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | threadId | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/communication_channels/threads/:threadId/assign" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/communication_channels/webhook/{provider}` POST /communication_channels/webhook/{provider} **Tags:** Communication Channels ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | provider | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/communication_channels/webhook/:provider" \ -H "Accept: application/json" ``` ## POST `/communication_channels/webhooks/gmail` POST /communication_channels/webhooks/gmail **Tags:** Communication Channels ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/communication_channels/webhooks/gmail" \ -H "Accept: application/json" ``` ## GET `/configs/cache` GET /configs/cache Requires features: configs.cache.view **Tags:** Configuration **Requires authentication.** **Features:** configs.cache.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/configs/cache" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/configs/cache` POST /configs/cache Requires features: configs.cache.manage **Tags:** Configuration **Requires authentication.** **Features:** configs.cache.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/configs/cache" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/configs/system-status` GET /configs/system-status Requires features: configs.system_status.view **Tags:** Configuration **Requires authentication.** **Features:** configs.system_status.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/configs/system-status" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/configs/system-status` POST /configs/system-status Requires features: configs.manage **Tags:** Configuration **Requires authentication.** **Features:** configs.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/configs/system-status" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/configs/upgrade-actions` GET /configs/upgrade-actions Requires features: configs.manage **Tags:** Configuration **Requires authentication.** **Features:** configs.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/configs/upgrade-actions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/configs/upgrade-actions` POST /configs/upgrade-actions Requires features: configs.manage **Tags:** Configuration **Requires authentication.** **Features:** configs.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/configs/upgrade-actions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/currencies/currencies` DELETE /currencies/currencies Requires features: currencies.manage **Tags:** Currencies **Requires authentication.** **Features:** currencies.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/currencies/currencies" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/currencies/currencies` GET /currencies/currencies Requires features: currencies.view **Tags:** Currencies **Requires authentication.** **Features:** currencies.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/currencies/currencies" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/currencies/currencies` POST /currencies/currencies Requires features: currencies.manage **Tags:** Currencies **Requires authentication.** **Features:** currencies.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/currencies/currencies" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/currencies/currencies` PUT /currencies/currencies Requires features: currencies.manage **Tags:** Currencies **Requires authentication.** **Features:** currencies.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/currencies/currencies" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/currencies/currencies/options` GET /currencies/currencies/options Requires features: currencies.view **Tags:** Currencies **Requires authentication.** **Features:** currencies.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/currencies/currencies/options" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/currencies/exchange-rates` DELETE /currencies/exchange-rates Requires features: currencies.rates.manage **Tags:** Currencies **Requires authentication.** **Features:** currencies.rates.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/currencies/exchange-rates" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/currencies/exchange-rates` GET /currencies/exchange-rates Requires features: currencies.rates.view **Tags:** Currencies **Requires authentication.** **Features:** currencies.rates.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/currencies/exchange-rates" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/currencies/exchange-rates` POST /currencies/exchange-rates Requires features: currencies.rates.manage **Tags:** Currencies **Requires authentication.** **Features:** currencies.rates.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/currencies/exchange-rates" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/currencies/exchange-rates` PUT /currencies/exchange-rates Requires features: currencies.rates.manage **Tags:** Currencies **Requires authentication.** **Features:** currencies.rates.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/currencies/exchange-rates" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/currencies/fetch-configs` DELETE /currencies/fetch-configs **Tags:** Currencies ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/currencies/fetch-configs" \ -H "Accept: application/json" ``` ## GET `/currencies/fetch-configs` GET /currencies/fetch-configs **Tags:** Currencies ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/currencies/fetch-configs" \ -H "Accept: application/json" ``` ## POST `/currencies/fetch-configs` POST /currencies/fetch-configs **Tags:** Currencies ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/currencies/fetch-configs" \ -H "Accept: application/json" ``` ## PUT `/currencies/fetch-configs` PUT /currencies/fetch-configs **Tags:** Currencies ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/currencies/fetch-configs" \ -H "Accept: application/json" ``` ## POST `/currencies/fetch-rates` POST /currencies/fetch-rates **Tags:** Currencies ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/currencies/fetch-rates" \ -H "Accept: application/json" ``` ## DELETE `/customer_accounts/admin/domain-mappings` DELETE /customer_accounts/admin/domain-mappings Requires features: customer_accounts.domain.manage **Tags:** Customer Identity & Portal Authentication **Requires authentication.** **Features:** customer_accounts.domain.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/domain-mappings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customer_accounts/admin/domain-mappings` GET /customer_accounts/admin/domain-mappings Requires features: customer_accounts.domain.manage **Tags:** Customer Identity & Portal Authentication **Requires authentication.** **Features:** customer_accounts.domain.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/domain-mappings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customer_accounts/admin/domain-mappings` POST /customer_accounts/admin/domain-mappings Requires features: customer_accounts.domain.manage **Tags:** Customer Identity & Portal Authentication **Requires authentication.** **Features:** customer_accounts.domain.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/domain-mappings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customer_accounts/admin/domain-mappings/{id}/health-check` POST /customer_accounts/admin/domain-mappings/{id}/health-check Requires features: customer_accounts.domain.manage **Tags:** Customer Identity & Portal Authentication **Requires authentication.** **Features:** customer_accounts.domain.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/domain-mappings/:id/health-check" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customer_accounts/admin/domain-mappings/{id}/verify` POST /customer_accounts/admin/domain-mappings/{id}/verify Requires features: customer_accounts.domain.manage **Tags:** Customer Identity & Portal Authentication **Requires authentication.** **Features:** customer_accounts.domain.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/domain-mappings/:id/verify" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customer_accounts/admin/roles` GET /customer_accounts/admin/roles **Tags:** Customer Identity & Portal Authentication ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/roles" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/admin/roles` POST /customer_accounts/admin/roles **Tags:** Customer Identity & Portal Authentication ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/roles" \ -H "Accept: application/json" ``` ## DELETE `/customer_accounts/admin/roles/{id}` DELETE /customer_accounts/admin/roles/{id} **Tags:** Customer Identity & Portal Authentication ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/roles/:id" \ -H "Accept: application/json" ``` ## GET `/customer_accounts/admin/roles/{id}` GET /customer_accounts/admin/roles/{id} **Tags:** Customer Identity & Portal Authentication ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/roles/:id" \ -H "Accept: application/json" ``` ## PUT `/customer_accounts/admin/roles/{id}` PUT /customer_accounts/admin/roles/{id} **Tags:** Customer Identity & Portal Authentication ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/roles/:id" \ -H "Accept: application/json" ``` ## PUT `/customer_accounts/admin/roles/{id}/acl` PUT /customer_accounts/admin/roles/{id}/acl **Tags:** Customer Identity & Portal Authentication ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/roles/:id/acl" \ -H "Accept: application/json" ``` ## GET `/customer_accounts/admin/users` GET /customer_accounts/admin/users **Tags:** Customer Identity & Portal Authentication ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/users" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/admin/users` POST /customer_accounts/admin/users **Tags:** Customer Identity & Portal Authentication ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/users" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/admin/users-invite` POST /customer_accounts/admin/users-invite **Tags:** Customer Identity & Portal Authentication ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/users-invite" \ -H "Accept: application/json" ``` ## DELETE `/customer_accounts/admin/users/{id}` DELETE /customer_accounts/admin/users/{id} **Tags:** Customer Identity & Portal Authentication ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/users/:id" \ -H "Accept: application/json" ``` ## GET `/customer_accounts/admin/users/{id}` GET /customer_accounts/admin/users/{id} **Tags:** Customer Identity & Portal Authentication ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/users/:id" \ -H "Accept: application/json" ``` ## PUT `/customer_accounts/admin/users/{id}` PUT /customer_accounts/admin/users/{id} **Tags:** Customer Identity & Portal Authentication ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/users/:id" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/admin/users/{id}/reset-password` POST /customer_accounts/admin/users/{id}/reset-password **Tags:** Customer Identity & Portal Authentication ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/users/:id/reset-password" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/admin/users/{id}/send-reset-link` POST /customer_accounts/admin/users/{id}/send-reset-link **Tags:** Customer Identity & Portal Authentication ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/users/:id/send-reset-link" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/admin/users/{id}/verify-email` POST /customer_accounts/admin/users/{id}/verify-email **Tags:** Customer Identity & Portal Authentication ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/admin/users/:id/verify-email" \ -H "Accept: application/json" ``` ## GET `/customer_accounts/domain-check` GET /customer_accounts/domain-check **Tags:** Customer Identity & Portal Authentication ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customer_accounts/domain-check" \ -H "Accept: application/json" ``` ## GET `/customer_accounts/domain-resolve` GET /customer_accounts/domain-resolve **Tags:** Customer Identity & Portal Authentication ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customer_accounts/domain-resolve" \ -H "Accept: application/json" ``` ## GET `/customer_accounts/domain-resolve/all` GET /customer_accounts/domain-resolve/all **Tags:** Customer Identity & Portal Authentication ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customer_accounts/domain-resolve/all" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/email/verify` POST /customer_accounts/email/verify **Tags:** Customer Identity & Portal Authentication ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/email/verify" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/invitations/accept` POST /customer_accounts/invitations/accept **Tags:** Customer Identity & Portal Authentication ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/invitations/accept" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/login` POST /customer_accounts/login **Tags:** Customer Identity & Portal Authentication ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/login" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/magic-link/request` POST /customer_accounts/magic-link/request **Tags:** Customer Identity & Portal Authentication ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/magic-link/request" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/magic-link/verify` POST /customer_accounts/magic-link/verify **Tags:** Customer Identity & Portal Authentication ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/magic-link/verify" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/password/reset-confirm` POST /customer_accounts/password/reset-confirm **Tags:** Customer Identity & Portal Authentication ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/password/reset-confirm" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/password/reset-request` POST /customer_accounts/password/reset-request **Tags:** Customer Identity & Portal Authentication ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/password/reset-request" \ -H "Accept: application/json" ``` ## GET `/customer_accounts/portal/events/stream` GET /customer_accounts/portal/events/stream **Tags:** Customer Identity & Portal Authentication ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customer_accounts/portal/events/stream" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/portal/feature-check` POST /customer_accounts/portal/feature-check **Tags:** Customer Identity & Portal Authentication ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/portal/feature-check" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/portal/logout` POST /customer_accounts/portal/logout **Tags:** Customer Identity & Portal Authentication ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/portal/logout" \ -H "Accept: application/json" ``` ## GET `/customer_accounts/portal/nav` GET /customer_accounts/portal/nav **Tags:** Customer Identity & Portal Authentication ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customer_accounts/portal/nav" \ -H "Accept: application/json" ``` ## GET `/customer_accounts/portal/notifications` GET /customer_accounts/portal/notifications **Tags:** Customer Identity & Portal Authentication ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customer_accounts/portal/notifications" \ -H "Accept: application/json" ``` ## PUT `/customer_accounts/portal/notifications/{id}/dismiss` PUT /customer_accounts/portal/notifications/{id}/dismiss **Tags:** Customer Identity & Portal Authentication ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/customer_accounts/portal/notifications/:id/dismiss" \ -H "Accept: application/json" ``` ## PUT `/customer_accounts/portal/notifications/{id}/read` PUT /customer_accounts/portal/notifications/{id}/read **Tags:** Customer Identity & Portal Authentication ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/customer_accounts/portal/notifications/:id/read" \ -H "Accept: application/json" ``` ## PUT `/customer_accounts/portal/notifications/mark-all-read` PUT /customer_accounts/portal/notifications/mark-all-read **Tags:** Customer Identity & Portal Authentication ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/customer_accounts/portal/notifications/mark-all-read" \ -H "Accept: application/json" ``` ## GET `/customer_accounts/portal/notifications/unread-count` GET /customer_accounts/portal/notifications/unread-count **Tags:** Customer Identity & Portal Authentication ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customer_accounts/portal/notifications/unread-count" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/portal/password-change` POST /customer_accounts/portal/password-change **Tags:** Customer Identity & Portal Authentication ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/portal/password-change" \ -H "Accept: application/json" ``` ## GET `/customer_accounts/portal/profile` GET /customer_accounts/portal/profile **Tags:** Customer Identity & Portal Authentication ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customer_accounts/portal/profile" \ -H "Accept: application/json" ``` ## PUT `/customer_accounts/portal/profile` PUT /customer_accounts/portal/profile **Tags:** Customer Identity & Portal Authentication ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/customer_accounts/portal/profile" \ -H "Accept: application/json" ``` ## GET `/customer_accounts/portal/sessions` GET /customer_accounts/portal/sessions **Tags:** Customer Identity & Portal Authentication ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customer_accounts/portal/sessions" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/portal/sessions-refresh` POST /customer_accounts/portal/sessions-refresh **Tags:** Customer Identity & Portal Authentication ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/portal/sessions-refresh" \ -H "Accept: application/json" ``` ## DELETE `/customer_accounts/portal/sessions/{id}` DELETE /customer_accounts/portal/sessions/{id} **Tags:** Customer Identity & Portal Authentication ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/customer_accounts/portal/sessions/:id" \ -H "Accept: application/json" ``` ## GET `/customer_accounts/portal/users` GET /customer_accounts/portal/users **Tags:** Customer Identity & Portal Authentication ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customer_accounts/portal/users" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/portal/users-invite` POST /customer_accounts/portal/users-invite **Tags:** Customer Identity & Portal Authentication ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/portal/users-invite" \ -H "Accept: application/json" ``` ## DELETE `/customer_accounts/portal/users/{id}` DELETE /customer_accounts/portal/users/{id} **Tags:** Customer Identity & Portal Authentication ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/customer_accounts/portal/users/:id" \ -H "Accept: application/json" ``` ## PUT `/customer_accounts/portal/users/{id}/roles` PUT /customer_accounts/portal/users/{id}/roles **Tags:** Customer Identity & Portal Authentication ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/customer_accounts/portal/users/:id/roles" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/signup` POST /customer_accounts/signup **Tags:** Customer Identity & Portal Authentication ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customer_accounts/signup" \ -H "Accept: application/json" ``` ## DELETE `/customers/activities` DELETE /customers/activities Requires features: customers.activities.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.activities.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/customers/activities" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/activities` GET /customers/activities Requires features: customers.activities.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.activities.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/activities" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/activities` POST /customers/activities Requires features: customers.activities.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.activities.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customers/activities" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/customers/activities` PUT /customers/activities Requires features: customers.activities.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.activities.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/customers/activities" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/customers/addresses` DELETE /customers/addresses Requires features: customers.activities.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.activities.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/customers/addresses" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/addresses` GET /customers/addresses Requires features: customers.activities.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.activities.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/addresses" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/addresses` POST /customers/addresses Requires features: customers.activities.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.activities.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customers/addresses" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/customers/addresses` PUT /customers/addresses Requires features: customers.activities.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.activities.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/customers/addresses" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/assignable-staff` GET /customers/assignable-staff Requires features: customers.roles.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.roles.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/assignable-staff" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/customers/comments` DELETE /customers/comments Requires features: customers.activities.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.activities.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/customers/comments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/comments` GET /customers/comments Requires features: customers.activities.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.activities.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/comments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/comments` POST /customers/comments Requires features: customers.activities.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.activities.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customers/comments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/customers/comments` PUT /customers/comments Requires features: customers.activities.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.activities.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/customers/comments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/customers/companies` DELETE /customers/companies Requires features: customers.companies.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.companies.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/customers/companies" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/companies` GET /customers/companies Requires features: customers.companies.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.companies.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/companies" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/companies` POST /customers/companies Requires features: customers.companies.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.companies.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customers/companies" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/customers/companies` PUT /customers/companies Requires features: customers.companies.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.companies.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/customers/companies" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/companies/{id}` GET /customers/companies/{id} Requires features: customers.companies.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.companies.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/companies/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/companies/{id}/people` GET /customers/companies/{id}/people Requires features: customers.companies.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.companies.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/companies/:id/people" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/customers/companies/{id}/roles` DELETE /customers/companies/{id}/roles Requires features: customers.roles.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.roles.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/customers/companies/:id/roles" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/companies/{id}/roles` GET /customers/companies/{id}/roles Requires features: customers.roles.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.roles.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/companies/:id/roles" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/companies/{id}/roles` POST /customers/companies/{id}/roles Requires features: customers.roles.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.roles.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customers/companies/:id/roles" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/customers/companies/{id}/roles` PUT /customers/companies/{id}/roles Requires features: customers.roles.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.roles.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/customers/companies/:id/roles" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/dashboard/widgets/customer-todos` GET /customers/dashboard/widgets/customer-todos Requires features: dashboards.view, customers.widgets.todos **Tags:** Customer Relationship Management **Requires authentication.** **Features:** dashboards.view, customers.widgets.todos ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/dashboard/widgets/customer-todos" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/dashboard/widgets/new-customers` GET /customers/dashboard/widgets/new-customers Requires features: dashboards.view, customers.widgets.new-customers **Tags:** Customer Relationship Management **Requires authentication.** **Features:** dashboards.view, customers.widgets.new-customers ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/dashboard/widgets/new-customers" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/dashboard/widgets/new-deals` GET /customers/dashboard/widgets/new-deals Requires features: dashboards.view, customers.widgets.new-deals **Tags:** Customer Relationship Management **Requires authentication.** **Features:** dashboards.view, customers.widgets.new-deals ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/dashboard/widgets/new-deals" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/dashboard/widgets/next-interactions` GET /customers/dashboard/widgets/next-interactions Requires features: dashboards.view, customers.widgets.next-interactions **Tags:** Customer Relationship Management **Requires authentication.** **Features:** dashboards.view, customers.widgets.next-interactions ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/dashboard/widgets/next-interactions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/customers/deals` DELETE /customers/deals Requires features: customers.deals.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.deals.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/customers/deals" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/deals` GET /customers/deals Requires features: customers.deals.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.deals.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/deals" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/deals` POST /customers/deals Requires features: customers.deals.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.deals.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customers/deals" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/customers/deals` PUT /customers/deals Requires features: customers.deals.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.deals.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/customers/deals" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/deals/{id}` GET /customers/deals/{id} Requires features: customers.deals.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.deals.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/deals/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/deals/{id}/companies` GET /customers/deals/{id}/companies Requires features: customers.deals.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.deals.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/deals/:id/companies" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/deals/{id}/people` GET /customers/deals/{id}/people Requires features: customers.deals.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.deals.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/deals/:id/people" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/deals/{id}/stats` GET /customers/deals/{id}/stats Requires features: customers.deals.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.deals.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/deals/:id/stats" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/deals/aggregate` GET /customers/deals/aggregate Requires features: customers.deals.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.deals.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/deals/aggregate" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/deals/bulk-update-owner` POST /customers/deals/bulk-update-owner Requires features: customers.deals.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.deals.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customers/deals/bulk-update-owner" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/deals/bulk-update-stage` POST /customers/deals/bulk-update-stage Requires features: customers.deals.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.deals.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customers/deals/bulk-update-stage" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/deals/summary` GET /customers/deals/summary Requires features: customers.deals.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.deals.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/deals/summary" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/dictionaries/{kind}` GET /customers/dictionaries/{kind} Requires features: customers.people.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.people.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | kind | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/dictionaries/:kind" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/dictionaries/{kind}` POST /customers/dictionaries/{kind} Requires features: customers.settings.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.settings.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | kind | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customers/dictionaries/:kind" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/customers/dictionaries/{kind}/{id}` DELETE /customers/dictionaries/{kind}/{id} Requires features: customers.settings.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.settings.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | kind | path | any | Required | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/customers/dictionaries/:kind/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/customers/dictionaries/{kind}/{id}` PATCH /customers/dictionaries/{kind}/{id} Requires features: customers.settings.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.settings.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | kind | path | any | Required | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PATCH "https://om.3.74.75.141.nip.io/api/customers/dictionaries/:kind/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/dictionaries/currency` GET /customers/dictionaries/currency Requires features: customers.people.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.people.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/dictionaries/currency" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/dictionaries/kind-settings` GET /customers/dictionaries/kind-settings Requires features: customers.people.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.people.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/dictionaries/kind-settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/customers/dictionaries/kind-settings` PATCH /customers/dictionaries/kind-settings Requires features: customers.settings.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PATCH "https://om.3.74.75.141.nip.io/api/customers/dictionaries/kind-settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/customers/interactions` DELETE /customers/interactions Requires features: customers.interactions.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.interactions.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/customers/interactions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/interactions` GET /customers/interactions Requires features: customers.interactions.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.interactions.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/interactions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/interactions` POST /customers/interactions Requires features: customers.interactions.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.interactions.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customers/interactions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/customers/interactions` PUT /customers/interactions Requires features: customers.interactions.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.interactions.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/customers/interactions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/customers/interactions/{id}/visibility` PATCH /customers/interactions/{id}/visibility Requires features: customers.email.compose **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.email.compose ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PATCH "https://om.3.74.75.141.nip.io/api/customers/interactions/:id/visibility" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/interactions/cancel` POST /customers/interactions/cancel Requires features: customers.interactions.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.interactions.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customers/interactions/cancel" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/interactions/complete` POST /customers/interactions/complete Requires features: customers.interactions.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.interactions.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customers/interactions/complete" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/interactions/conflicts` GET /customers/interactions/conflicts Requires features: customers.interactions.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.interactions.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/interactions/conflicts" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/interactions/counts` GET /customers/interactions/counts Requires features: customers.interactions.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.interactions.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/interactions/counts" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/interactions/tasks` GET /customers/interactions/tasks Requires features: customers.interactions.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.interactions.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/interactions/tasks" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/labels` GET /customers/labels Requires features: customers.people.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.people.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/labels" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/labels` POST /customers/labels Requires features: customers.people.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.people.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customers/labels" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/labels/assign` POST /customers/labels/assign **Tags:** Customer Relationship Management **Requires authentication.** ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customers/labels/assign" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/labels/unassign` POST /customers/labels/unassign **Tags:** Customer Relationship Management **Requires authentication.** ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customers/labels/unassign" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/customers/people` DELETE /customers/people Requires features: customers.people.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.people.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/customers/people" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/people` GET /customers/people Requires features: customers.people.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.people.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/people" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/people` POST /customers/people Requires features: customers.people.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.people.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customers/people" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/customers/people` PUT /customers/people Requires features: customers.people.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.people.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/customers/people" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/people/{id}` GET /customers/people/{id} Requires features: customers.people.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.people.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/people/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/people/{id}/companies` GET /customers/people/{id}/companies Requires features: customers.people.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.people.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/people/:id/companies" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/people/{id}/companies` POST /customers/people/{id}/companies Requires features: customers.people.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.people.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customers/people/:id/companies" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/customers/people/{id}/companies/{linkId}` DELETE /customers/people/{id}/companies/{linkId} Requires features: customers.people.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.people.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | linkId | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/customers/people/:id/companies/:linkId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/customers/people/{id}/companies/{linkId}` PATCH /customers/people/{id}/companies/{linkId} Requires features: customers.people.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.people.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | linkId | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PATCH "https://om.3.74.75.141.nip.io/api/customers/people/:id/companies/:linkId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/people/{id}/companies/enriched` GET /customers/people/{id}/companies/enriched Requires features: customers.people.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.people.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/people/:id/companies/enriched" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/people/{id}/email-threads` GET /customers/people/{id}/email-threads Requires features: customers.people.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.people.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/people/:id/email-threads" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/people/{id}/emails` POST /customers/people/{id}/emails Requires features: customers.email.compose **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.email.compose ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customers/people/:id/emails" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/customers/people/{id}/roles` DELETE /customers/people/{id}/roles Requires features: customers.roles.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.roles.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/customers/people/:id/roles" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/people/{id}/roles` GET /customers/people/{id}/roles Requires features: customers.roles.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.roles.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/people/:id/roles" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/people/{id}/roles` POST /customers/people/{id}/roles Requires features: customers.roles.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.roles.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customers/people/:id/roles" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/customers/people/{id}/roles` PUT /customers/people/{id}/roles Requires features: customers.roles.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.roles.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/customers/people/:id/roles" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/people/check-phone` GET /customers/people/check-phone Requires features: customers.people.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.people.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/people/check-phone" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/customers/pipeline-stages` DELETE /customers/pipeline-stages Requires features: customers.pipelines.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.pipelines.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/customers/pipeline-stages" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/pipeline-stages` GET /customers/pipeline-stages Requires features: customers.pipelines.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.pipelines.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/pipeline-stages" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/pipeline-stages` POST /customers/pipeline-stages Requires features: customers.pipelines.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.pipelines.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customers/pipeline-stages" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/customers/pipeline-stages` PUT /customers/pipeline-stages Requires features: customers.pipelines.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.pipelines.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/customers/pipeline-stages" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/pipeline-stages/reorder` POST /customers/pipeline-stages/reorder Requires features: customers.pipelines.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.pipelines.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customers/pipeline-stages/reorder" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/customers/pipelines` DELETE /customers/pipelines Requires features: customers.pipelines.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.pipelines.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/customers/pipelines" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/pipelines` GET /customers/pipelines Requires features: customers.pipelines.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.pipelines.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/pipelines" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/pipelines` POST /customers/pipelines Requires features: customers.pipelines.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.pipelines.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customers/pipelines" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/customers/pipelines` PUT /customers/pipelines Requires features: customers.pipelines.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.pipelines.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/customers/pipelines" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/settings/address-format` GET /customers/settings/address-format Requires features: customers.settings.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/settings/address-format" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/customers/settings/address-format` PUT /customers/settings/address-format Requires features: customers.settings.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/customers/settings/address-format" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/settings/dictionary-sort-modes` GET /customers/settings/dictionary-sort-modes Requires features: customers.settings.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/settings/dictionary-sort-modes" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/customers/settings/dictionary-sort-modes` PATCH /customers/settings/dictionary-sort-modes Requires features: customers.settings.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PATCH "https://om.3.74.75.141.nip.io/api/customers/settings/dictionary-sort-modes" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/settings/stuck-threshold` GET /customers/settings/stuck-threshold Requires features: customers.deals.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.deals.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/settings/stuck-threshold" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/customers/settings/stuck-threshold` PUT /customers/settings/stuck-threshold Requires features: customers.deals.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.deals.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/customers/settings/stuck-threshold" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/customers/tags` DELETE /customers/tags Requires features: customers.activities.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.activities.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/customers/tags" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/tags` GET /customers/tags Requires features: customers.activities.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.activities.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/tags" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/tags` POST /customers/tags Requires features: customers.activities.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.activities.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customers/tags" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/customers/tags` PUT /customers/tags Requires features: customers.activities.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.activities.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/customers/tags" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/tags/assign` POST /customers/tags/assign Requires features: customers.activities.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.activities.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customers/tags/assign" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/tags/unassign` POST /customers/tags/unassign Requires features: customers.activities.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.activities.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customers/tags/unassign" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/customers/todos` DELETE /customers/todos Requires features: customers.interactions.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.interactions.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/customers/todos" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/todos` GET /customers/todos Requires features: customers.view **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/customers/todos" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/todos` POST /customers/todos Requires features: customers.interactions.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.interactions.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/customers/todos" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/customers/todos` PUT /customers/todos Requires features: customers.interactions.manage **Tags:** Customer Relationship Management **Requires authentication.** **Features:** customers.interactions.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/customers/todos" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/dashboards/layout` GET /dashboards/layout Requires features: dashboards.view **Tags:** Admin Dashboards **Requires authentication.** **Features:** dashboards.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/dashboards/layout" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/dashboards/layout` PUT /dashboards/layout Requires features: dashboards.configure **Tags:** Admin Dashboards **Requires authentication.** **Features:** dashboards.configure ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/dashboards/layout" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/dashboards/layout/{itemId}` PATCH /dashboards/layout/{itemId} Requires features: dashboards.configure **Tags:** Admin Dashboards **Requires authentication.** **Features:** dashboards.configure ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | itemId | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PATCH "https://om.3.74.75.141.nip.io/api/dashboards/layout/:itemId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/dashboards/roles/widgets` GET /dashboards/roles/widgets Requires features: dashboards.admin.assign-widgets **Tags:** Admin Dashboards **Requires authentication.** **Features:** dashboards.admin.assign-widgets ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/dashboards/roles/widgets" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/dashboards/roles/widgets` PUT /dashboards/roles/widgets Requires features: dashboards.admin.assign-widgets **Tags:** Admin Dashboards **Requires authentication.** **Features:** dashboards.admin.assign-widgets ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/dashboards/roles/widgets" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/dashboards/users/widgets` GET /dashboards/users/widgets Requires features: dashboards.admin.assign-widgets **Tags:** Admin Dashboards **Requires authentication.** **Features:** dashboards.admin.assign-widgets ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/dashboards/users/widgets" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/dashboards/users/widgets` PUT /dashboards/users/widgets Requires features: dashboards.admin.assign-widgets **Tags:** Admin Dashboards **Requires authentication.** **Features:** dashboards.admin.assign-widgets ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/dashboards/users/widgets" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/dashboards/widgets/catalog` GET /dashboards/widgets/catalog Requires features: dashboards.admin.assign-widgets **Tags:** Admin Dashboards **Requires authentication.** **Features:** dashboards.admin.assign-widgets ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/dashboards/widgets/catalog" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/dashboards/widgets/data` POST /dashboards/widgets/data Requires features: analytics.view **Tags:** Admin Dashboards **Requires authentication.** **Features:** analytics.view ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/dashboards/widgets/data" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/dashboards/widgets/data/batch` POST /dashboards/widgets/data/batch Requires features: analytics.view **Tags:** Admin Dashboards **Requires authentication.** **Features:** analytics.view ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/dashboards/widgets/data/batch" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/data_sync/mappings` GET /data_sync/mappings Requires features: data_sync.configure **Tags:** Data Sync **Requires authentication.** **Features:** data_sync.configure ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/data_sync/mappings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/data_sync/mappings` POST /data_sync/mappings Requires features: data_sync.configure **Tags:** Data Sync **Requires authentication.** **Features:** data_sync.configure ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/data_sync/mappings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/data_sync/mappings/{id}` DELETE /data_sync/mappings/{id} Requires features: data_sync.configure **Tags:** Data Sync **Requires authentication.** **Features:** data_sync.configure ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/data_sync/mappings/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/data_sync/mappings/{id}` GET /data_sync/mappings/{id} Requires features: data_sync.configure **Tags:** Data Sync **Requires authentication.** **Features:** data_sync.configure ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/data_sync/mappings/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/data_sync/mappings/{id}` PUT /data_sync/mappings/{id} Requires features: data_sync.configure **Tags:** Data Sync **Requires authentication.** **Features:** data_sync.configure ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/data_sync/mappings/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/data_sync/options` GET /data_sync/options Requires features: data_sync.view **Tags:** Data Sync **Requires authentication.** **Features:** data_sync.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/data_sync/options" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/data_sync/run` POST /data_sync/run Requires features: data_sync.run **Tags:** Data Sync **Requires authentication.** **Features:** data_sync.run ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/data_sync/run" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/data_sync/runs` GET /data_sync/runs Requires features: data_sync.view **Tags:** Data Sync **Requires authentication.** **Features:** data_sync.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/data_sync/runs" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/data_sync/runs/{id}` GET /data_sync/runs/{id} Requires features: data_sync.view **Tags:** Data Sync **Requires authentication.** **Features:** data_sync.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/data_sync/runs/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/data_sync/runs/{id}/cancel` POST /data_sync/runs/{id}/cancel Requires features: data_sync.run **Tags:** Data Sync **Requires authentication.** **Features:** data_sync.run ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/data_sync/runs/:id/cancel" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/data_sync/runs/{id}/retry` POST /data_sync/runs/{id}/retry Requires features: data_sync.run **Tags:** Data Sync **Requires authentication.** **Features:** data_sync.run ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/data_sync/runs/:id/retry" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/data_sync/schedules` GET /data_sync/schedules Requires features: data_sync.configure **Tags:** Data Sync **Requires authentication.** **Features:** data_sync.configure ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/data_sync/schedules" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/data_sync/schedules` POST /data_sync/schedules Requires features: data_sync.configure **Tags:** Data Sync **Requires authentication.** **Features:** data_sync.configure ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/data_sync/schedules" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/data_sync/schedules/{id}` DELETE /data_sync/schedules/{id} Requires features: data_sync.configure **Tags:** Data Sync **Requires authentication.** **Features:** data_sync.configure ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/data_sync/schedules/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/data_sync/schedules/{id}` GET /data_sync/schedules/{id} Requires features: data_sync.configure **Tags:** Data Sync **Requires authentication.** **Features:** data_sync.configure ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/data_sync/schedules/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/data_sync/schedules/{id}` PUT /data_sync/schedules/{id} Requires features: data_sync.configure **Tags:** Data Sync **Requires authentication.** **Features:** data_sync.configure ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/data_sync/schedules/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/data_sync/validate` POST /data_sync/validate Requires features: data_sync.configure **Tags:** Data Sync **Requires authentication.** **Features:** data_sync.configure ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/data_sync/validate" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/dictionaries` GET /dictionaries Requires features: dictionaries.view **Tags:** Shared Dictionaries **Requires authentication.** **Features:** dictionaries.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/dictionaries" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/dictionaries` POST /dictionaries Requires features: dictionaries.manage **Tags:** Shared Dictionaries **Requires authentication.** **Features:** dictionaries.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/dictionaries" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/dictionaries/{dictionaryId}` DELETE /dictionaries/{dictionaryId} Requires features: dictionaries.manage **Tags:** Shared Dictionaries **Requires authentication.** **Features:** dictionaries.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dictionaryId | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/dictionaries/:dictionaryId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/dictionaries/{dictionaryId}` GET /dictionaries/{dictionaryId} Requires features: dictionaries.view **Tags:** Shared Dictionaries **Requires authentication.** **Features:** dictionaries.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dictionaryId | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/dictionaries/:dictionaryId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/dictionaries/{dictionaryId}` PATCH /dictionaries/{dictionaryId} Requires features: dictionaries.manage **Tags:** Shared Dictionaries **Requires authentication.** **Features:** dictionaries.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dictionaryId | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PATCH "https://om.3.74.75.141.nip.io/api/dictionaries/:dictionaryId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/dictionaries/{dictionaryId}/entries` GET /dictionaries/{dictionaryId}/entries Requires features: dictionaries.view **Tags:** Shared Dictionaries **Requires authentication.** **Features:** dictionaries.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dictionaryId | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/dictionaries/:dictionaryId/entries" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/dictionaries/{dictionaryId}/entries` POST /dictionaries/{dictionaryId}/entries Requires features: dictionaries.manage **Tags:** Shared Dictionaries **Requires authentication.** **Features:** dictionaries.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dictionaryId | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/dictionaries/:dictionaryId/entries" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/dictionaries/{dictionaryId}/entries/{entryId}` DELETE /dictionaries/{dictionaryId}/entries/{entryId} Requires features: dictionaries.manage **Tags:** Shared Dictionaries **Requires authentication.** **Features:** dictionaries.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dictionaryId | path | any | Required | | entryId | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/dictionaries/:dictionaryId/entries/:entryId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/dictionaries/{dictionaryId}/entries/{entryId}` PATCH /dictionaries/{dictionaryId}/entries/{entryId} Requires features: dictionaries.manage **Tags:** Shared Dictionaries **Requires authentication.** **Features:** dictionaries.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dictionaryId | path | any | Required | | entryId | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PATCH "https://om.3.74.75.141.nip.io/api/dictionaries/:dictionaryId/entries/:entryId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/dictionaries/{dictionaryId}/entries/reorder` POST /dictionaries/{dictionaryId}/entries/reorder Requires features: dictionaries.manage **Tags:** Shared Dictionaries **Requires authentication.** **Features:** dictionaries.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dictionaryId | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/dictionaries/:dictionaryId/entries/reorder" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/dictionaries/{dictionaryId}/entries/set-default` POST /dictionaries/{dictionaryId}/entries/set-default Requires features: dictionaries.manage **Tags:** Shared Dictionaries **Requires authentication.** **Features:** dictionaries.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dictionaryId | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/dictionaries/:dictionaryId/entries/set-default" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/directory/organization-branding` GET /directory/organization-branding Requires features: directory.organizations.view **Tags:** Directory (Tenants & Organizations) **Requires authentication.** **Features:** directory.organizations.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/directory/organization-branding" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/directory/organization-branding` PUT /directory/organization-branding Requires features: directory.organizations.manage **Tags:** Directory (Tenants & Organizations) **Requires authentication.** **Features:** directory.organizations.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/directory/organization-branding" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/directory/organization-switcher` GET /directory/organization-switcher **Tags:** Directory (Tenants & Organizations) **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/directory/organization-switcher" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/directory/organizations` DELETE /directory/organizations Requires features: directory.organizations.manage **Tags:** Directory (Tenants & Organizations) **Requires authentication.** **Features:** directory.organizations.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/directory/organizations" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/directory/organizations` GET /directory/organizations Requires features: directory.organizations.view **Tags:** Directory (Tenants & Organizations) **Requires authentication.** **Features:** directory.organizations.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/directory/organizations" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/directory/organizations` POST /directory/organizations Requires features: directory.organizations.manage **Tags:** Directory (Tenants & Organizations) **Requires authentication.** **Features:** directory.organizations.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/directory/organizations" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/directory/organizations` PUT /directory/organizations Requires features: directory.organizations.manage **Tags:** Directory (Tenants & Organizations) **Requires authentication.** **Features:** directory.organizations.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/directory/organizations" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/directory/organizations/lookup` GET /directory/organizations/lookup **Tags:** Directory (Tenants & Organizations) ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/directory/organizations/lookup" \ -H "Accept: application/json" ``` ## DELETE `/directory/tenants` DELETE /directory/tenants Requires features: directory.tenants.manage **Tags:** Directory (Tenants & Organizations) **Requires authentication.** **Features:** directory.tenants.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/directory/tenants" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/directory/tenants` GET /directory/tenants Requires features: directory.tenants.view **Tags:** Directory (Tenants & Organizations) **Requires authentication.** **Features:** directory.tenants.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/directory/tenants" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/directory/tenants` POST /directory/tenants Requires features: directory.tenants.manage **Tags:** Directory (Tenants & Organizations) **Requires authentication.** **Features:** directory.tenants.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/directory/tenants" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/directory/tenants` PUT /directory/tenants Requires features: directory.tenants.manage **Tags:** Directory (Tenants & Organizations) **Requires authentication.** **Features:** directory.tenants.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/directory/tenants" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/directory/tenants/lookup` GET /directory/tenants/lookup **Tags:** Directory (Tenants & Organizations) ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/directory/tenants/lookup" \ -H "Accept: application/json" ``` ## DELETE `/entities/definitions` DELETE /entities/definitions Requires features: entities.definitions.manage **Tags:** Custom Entities & Fields **Requires authentication.** **Features:** entities.definitions.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/entities/definitions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/entities/definitions` GET /entities/definitions **Tags:** Custom Entities & Fields **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/entities/definitions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/entities/definitions` POST /entities/definitions Requires features: entities.definitions.manage **Tags:** Custom Entities & Fields **Requires authentication.** **Features:** entities.definitions.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/entities/definitions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/entities/definitions.batch` POST /entities/definitions.batch Requires features: entities.definitions.manage **Tags:** Custom Entities & Fields **Requires authentication.** **Features:** entities.definitions.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/entities/definitions.batch" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/entities/definitions.manage` GET /entities/definitions.manage Requires features: entities.definitions.manage **Tags:** Custom Entities & Fields **Requires authentication.** **Features:** entities.definitions.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/entities/definitions.manage" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/entities/definitions.restore` POST /entities/definitions.restore Requires features: entities.definitions.manage **Tags:** Custom Entities & Fields **Requires authentication.** **Features:** entities.definitions.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/entities/definitions.restore" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/entities/encryption` GET /entities/encryption Requires features: entities.definitions.manage **Tags:** Custom Entities & Fields **Requires authentication.** **Features:** entities.definitions.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/entities/encryption" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/entities/encryption` POST /entities/encryption Requires features: entities.definitions.manage **Tags:** Custom Entities & Fields **Requires authentication.** **Features:** entities.definitions.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/entities/encryption" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/entities/entities` DELETE /entities/entities Requires features: entities.definitions.manage **Tags:** Custom Entities & Fields **Requires authentication.** **Features:** entities.definitions.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/entities/entities" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/entities/entities` GET /entities/entities **Tags:** Custom Entities & Fields **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/entities/entities" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/entities/entities` POST /entities/entities Requires features: entities.definitions.manage **Tags:** Custom Entities & Fields **Requires authentication.** **Features:** entities.definitions.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/entities/entities" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/entities/records` DELETE /entities/records Requires features: entities.records.manage **Tags:** Custom Entities & Fields **Requires authentication.** **Features:** entities.records.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/entities/records" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/entities/records` GET /entities/records Requires features: entities.records.view **Tags:** Custom Entities & Fields **Requires authentication.** **Features:** entities.records.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/entities/records" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/entities/records` POST /entities/records Requires features: entities.records.manage **Tags:** Custom Entities & Fields **Requires authentication.** **Features:** entities.records.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/entities/records" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/entities/records` PUT /entities/records Requires features: entities.records.manage **Tags:** Custom Entities & Fields **Requires authentication.** **Features:** entities.records.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/entities/records" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/entities/relations/options` GET /entities/relations/options Requires features: entities.definitions.view **Tags:** Custom Entities & Fields **Requires authentication.** **Features:** entities.definitions.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/entities/relations/options" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/entities/sidebar-entities` GET /entities/sidebar-entities **Tags:** Custom Entities & Fields **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/entities/sidebar-entities" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/events` GET /events **Tags:** Events **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/events" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/events/stream` GET /events/stream **Tags:** Events **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/events/stream" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/example-customers-sync/mappings` GET /example-customers-sync/mappings **Tags:** Example Customers Sync ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/example-customers-sync/mappings" \ -H "Accept: application/json" ``` ## POST `/example-customers-sync/reconcile` POST /example-customers-sync/reconcile **Tags:** Example Customers Sync ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/example-customers-sync/reconcile" \ -H "Accept: application/json" ``` ## GET `/example/assignees` GET /example/assignees Requires features: example.todos.view **Tags:** Example Module **Requires authentication.** **Features:** example.todos.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/example/assignees" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/example/assignees` POST /example/assignees Requires features: example.todos.manage **Tags:** Example Module **Requires authentication.** **Features:** example.todos.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/example/assignees" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/example/blog/{id}` GET /example/blog/{id} Requires features: example.todos.view **Tags:** Example Module **Requires authentication.** **Features:** example.todos.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/example/blog/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/example/blog/{id}` POST /example/blog/{id} Requires features: example.todos.view **Tags:** Example Module **Requires authentication.** **Features:** example.todos.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/example/blog/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/example/customer-priorities` DELETE /example/customer-priorities Requires features: example.todos.manage **Tags:** Example Module **Requires authentication.** **Features:** example.todos.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/example/customer-priorities" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/example/customer-priorities` GET /example/customer-priorities Requires features: example.view **Tags:** Example Module **Requires authentication.** **Features:** example.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/example/customer-priorities" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/example/customer-priorities` POST /example/customer-priorities Requires features: example.todos.manage **Tags:** Example Module **Requires authentication.** **Features:** example.todos.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/example/customer-priorities" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/example/customer-priorities` PUT /example/customer-priorities Requires features: example.todos.manage **Tags:** Example Module **Requires authentication.** **Features:** example.todos.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/example/customer-priorities" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/example/notifications` POST /example/notifications Requires features: example.todos.manage **Tags:** Example Module **Requires authentication.** **Features:** example.todos.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/example/notifications" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/example/organizations` GET /example/organizations Requires features: example.todos.view **Tags:** Example Module **Requires authentication.** **Features:** example.todos.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/example/organizations" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/example/override-probe` GET /example/override-probe **Tags:** Example Module ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/example/override-probe" \ -H "Accept: application/json" ``` ## DELETE `/example/qa-events` DELETE /example/qa-events Requires features: example.view **Tags:** Example Module **Requires authentication.** **Features:** example.view ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/example/qa-events" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/example/qa-events` GET /example/qa-events Requires features: example.view **Tags:** Example Module **Requires authentication.** **Features:** example.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/example/qa-events" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/example/tags` GET /example/tags Requires features: example.todos.view **Tags:** Example Module **Requires authentication.** **Features:** example.todos.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/example/tags" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/example/todos` DELETE /example/todos Requires features: example.todos.manage **Tags:** Example Module **Requires authentication.** **Features:** example.todos.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/example/todos" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/example/todos` GET /example/todos Requires features: example.todos.view **Tags:** Example Module **Requires authentication.** **Features:** example.todos.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/example/todos" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/example/todos` POST /example/todos Requires features: example.todos.manage **Tags:** Example Module **Requires authentication.** **Features:** example.todos.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/example/todos" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/example/todos` PUT /example/todos Requires features: example.todos.manage **Tags:** Example Module **Requires authentication.** **Features:** example.todos.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/example/todos" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/feature_toggles/check/boolean` GET /feature_toggles/check/boolean **Tags:** Feature Toggles **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/feature_toggles/check/boolean" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/feature_toggles/check/json` GET /feature_toggles/check/json **Tags:** Feature Toggles **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/feature_toggles/check/json" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/feature_toggles/check/number` GET /feature_toggles/check/number **Tags:** Feature Toggles **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/feature_toggles/check/number" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/feature_toggles/check/string` GET /feature_toggles/check/string **Tags:** Feature Toggles **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/feature_toggles/check/string" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/feature_toggles/global` DELETE /feature_toggles/global Requires features: feature_toggles.global.manage **Tags:** Feature Toggles **Requires authentication.** **Features:** feature_toggles.global.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/feature_toggles/global" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/feature_toggles/global` GET /feature_toggles/global Requires features: feature_toggles.view **Tags:** Feature Toggles **Requires authentication.** **Features:** feature_toggles.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/feature_toggles/global" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/feature_toggles/global` POST /feature_toggles/global Requires features: feature_toggles.global.manage **Tags:** Feature Toggles **Requires authentication.** **Features:** feature_toggles.global.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/feature_toggles/global" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/feature_toggles/global` PUT /feature_toggles/global Requires features: feature_toggles.global.manage **Tags:** Feature Toggles **Requires authentication.** **Features:** feature_toggles.global.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/feature_toggles/global" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/feature_toggles/global/{id}` GET /feature_toggles/global/{id} Requires features: feature_toggles.view **Tags:** Feature Toggles **Requires authentication.** **Features:** feature_toggles.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/feature_toggles/global/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/feature_toggles/global/{id}/override` GET /feature_toggles/global/{id}/override Requires features: feature_toggles.view **Tags:** Feature Toggles **Requires authentication.** **Features:** feature_toggles.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/feature_toggles/global/:id/override" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/feature_toggles/overrides` GET /feature_toggles/overrides Requires features: feature_toggles.view **Tags:** Feature Toggles **Requires authentication.** **Features:** feature_toggles.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/feature_toggles/overrides" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/feature_toggles/overrides` PUT /feature_toggles/overrides Requires features: feature_toggles.manage **Tags:** Feature Toggles **Requires authentication.** **Features:** feature_toggles.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/feature_toggles/overrides" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/inbox_ops/emails` GET /inbox_ops/emails Requires features: inbox_ops.log.view **Tags:** InboxOps — Email-to-ERP Agent **Requires authentication.** **Features:** inbox_ops.log.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/inbox_ops/emails" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/inbox_ops/emails/{id}` DELETE /inbox_ops/emails/{id} Requires features: inbox_ops.proposals.manage **Tags:** InboxOps — Email-to-ERP Agent **Requires authentication.** **Features:** inbox_ops.proposals.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/inbox_ops/emails/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/inbox_ops/emails/{id}` GET /inbox_ops/emails/{id} Requires features: inbox_ops.log.view **Tags:** InboxOps — Email-to-ERP Agent **Requires authentication.** **Features:** inbox_ops.log.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/inbox_ops/emails/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/inbox_ops/emails/{id}/reprocess` POST /inbox_ops/emails/{id}/reprocess Requires features: inbox_ops.proposals.manage **Tags:** InboxOps — Email-to-ERP Agent **Requires authentication.** **Features:** inbox_ops.proposals.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/inbox_ops/emails/:id/reprocess" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/inbox_ops/extract` POST /inbox_ops/extract Requires features: inbox_ops.proposals.manage **Tags:** InboxOps — Email-to-ERP Agent **Requires authentication.** **Features:** inbox_ops.proposals.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/inbox_ops/extract" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/inbox_ops/proposals` GET /inbox_ops/proposals Requires features: inbox_ops.proposals.view **Tags:** InboxOps — Email-to-ERP Agent **Requires authentication.** **Features:** inbox_ops.proposals.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/inbox_ops/proposals" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/inbox_ops/proposals/{id}` GET /inbox_ops/proposals/{id} Requires features: inbox_ops.proposals.view **Tags:** InboxOps — Email-to-ERP Agent **Requires authentication.** **Features:** inbox_ops.proposals.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/inbox_ops/proposals/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/inbox_ops/proposals/{id}/accept-all` POST /inbox_ops/proposals/{id}/accept-all Requires features: inbox_ops.proposals.manage **Tags:** InboxOps — Email-to-ERP Agent **Requires authentication.** **Features:** inbox_ops.proposals.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/inbox_ops/proposals/:id/accept-all" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/inbox_ops/proposals/{id}/actions/{actionId}` PATCH /inbox_ops/proposals/{id}/actions/{actionId} Requires features: inbox_ops.proposals.manage **Tags:** InboxOps — Email-to-ERP Agent **Requires authentication.** **Features:** inbox_ops.proposals.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | actionId | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PATCH "https://om.3.74.75.141.nip.io/api/inbox_ops/proposals/:id/actions/:actionId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/inbox_ops/proposals/{id}/actions/{actionId}/accept` POST /inbox_ops/proposals/{id}/actions/{actionId}/accept Requires features: inbox_ops.proposals.manage **Tags:** InboxOps — Email-to-ERP Agent **Requires authentication.** **Features:** inbox_ops.proposals.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | actionId | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/inbox_ops/proposals/:id/actions/:actionId/accept" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/inbox_ops/proposals/{id}/actions/{actionId}/complete` PATCH /inbox_ops/proposals/{id}/actions/{actionId}/complete Requires features: inbox_ops.proposals.manage **Tags:** InboxOps — Email-to-ERP Agent **Requires authentication.** **Features:** inbox_ops.proposals.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | actionId | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PATCH "https://om.3.74.75.141.nip.io/api/inbox_ops/proposals/:id/actions/:actionId/complete" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/inbox_ops/proposals/{id}/actions/{actionId}/reject` POST /inbox_ops/proposals/{id}/actions/{actionId}/reject Requires features: inbox_ops.proposals.manage **Tags:** InboxOps — Email-to-ERP Agent **Requires authentication.** **Features:** inbox_ops.proposals.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | actionId | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/inbox_ops/proposals/:id/actions/:actionId/reject" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/inbox_ops/proposals/{id}/categorize` POST /inbox_ops/proposals/{id}/categorize Requires features: inbox_ops.proposals.manage **Tags:** InboxOps — Email-to-ERP Agent **Requires authentication.** **Features:** inbox_ops.proposals.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/inbox_ops/proposals/:id/categorize" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/inbox_ops/proposals/{id}/reject` POST /inbox_ops/proposals/{id}/reject Requires features: inbox_ops.proposals.manage **Tags:** InboxOps — Email-to-ERP Agent **Requires authentication.** **Features:** inbox_ops.proposals.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/inbox_ops/proposals/:id/reject" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/inbox_ops/proposals/{id}/replies/{replyId}/send` POST /inbox_ops/proposals/{id}/replies/{replyId}/send Requires features: inbox_ops.replies.send **Tags:** InboxOps — Email-to-ERP Agent **Requires authentication.** **Features:** inbox_ops.replies.send ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | replyId | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/inbox_ops/proposals/:id/replies/:replyId/send" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/inbox_ops/proposals/{id}/translate` POST /inbox_ops/proposals/{id}/translate Requires features: inbox_ops.proposals.view **Tags:** InboxOps — Email-to-ERP Agent **Requires authentication.** **Features:** inbox_ops.proposals.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/inbox_ops/proposals/:id/translate" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/inbox_ops/proposals/counts` GET /inbox_ops/proposals/counts Requires features: inbox_ops.proposals.view **Tags:** InboxOps — Email-to-ERP Agent **Requires authentication.** **Features:** inbox_ops.proposals.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/inbox_ops/proposals/counts" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/inbox_ops/settings` GET /inbox_ops/settings Requires features: inbox_ops.settings.manage **Tags:** InboxOps — Email-to-ERP Agent **Requires authentication.** **Features:** inbox_ops.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/inbox_ops/settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/inbox_ops/settings` PATCH /inbox_ops/settings Requires features: inbox_ops.settings.manage **Tags:** InboxOps — Email-to-ERP Agent **Requires authentication.** **Features:** inbox_ops.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PATCH "https://om.3.74.75.141.nip.io/api/inbox_ops/settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/inbox_ops/webhook/inbound` POST /inbox_ops/webhook/inbound **Tags:** InboxOps — Email-to-ERP Agent ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/inbox_ops/webhook/inbound" \ -H "Accept: application/json" ``` ## GET `/integrations` GET /integrations Requires features: integrations.view **Tags:** Integrations **Requires authentication.** **Features:** integrations.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/integrations" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/integrations/{id}` GET /integrations/{id} Requires features: integrations.view **Tags:** Integrations **Requires authentication.** **Features:** integrations.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/integrations/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/integrations/{id}/credentials` GET /integrations/{id}/credentials Requires features: integrations.credentials.manage **Tags:** Integrations **Requires authentication.** **Features:** integrations.credentials.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/integrations/:id/credentials" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/integrations/{id}/credentials` PUT /integrations/{id}/credentials Requires features: integrations.credentials.manage **Tags:** Integrations **Requires authentication.** **Features:** integrations.credentials.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/integrations/:id/credentials" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/integrations/{id}/health` POST /integrations/{id}/health Requires features: integrations.manage **Tags:** Integrations **Requires authentication.** **Features:** integrations.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/integrations/:id/health" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/integrations/{id}/state` PUT /integrations/{id}/state Requires features: integrations.manage **Tags:** Integrations **Requires authentication.** **Features:** integrations.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/integrations/:id/state" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/integrations/{id}/version` PUT /integrations/{id}/version Requires features: integrations.manage **Tags:** Integrations **Requires authentication.** **Features:** integrations.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/integrations/:id/version" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/integrations/logs` GET /integrations/logs Requires features: integrations.manage **Tags:** Integrations **Requires authentication.** **Features:** integrations.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/integrations/logs" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/messages` GET /messages **Tags:** Messages **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/messages" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/messages` POST /messages Requires features: messages.compose **Tags:** Messages **Requires authentication.** **Features:** messages.compose ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/messages" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/messages/{id}` DELETE /messages/{id} Requires features: messages.view **Tags:** Messages **Requires authentication.** **Features:** messages.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/messages/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/messages/{id}` GET /messages/{id} **Tags:** Messages **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/messages/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/messages/{id}` PATCH /messages/{id} Requires features: messages.compose **Tags:** Messages **Requires authentication.** **Features:** messages.compose ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PATCH "https://om.3.74.75.141.nip.io/api/messages/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/messages/{id}/actions/{actionId}` POST /messages/{id}/actions/{actionId} Requires features: messages.actions **Tags:** Messages **Requires authentication.** **Features:** messages.actions ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | actionId | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/messages/:id/actions/:actionId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/messages/{id}/archive` DELETE /messages/{id}/archive Requires features: messages.view **Tags:** Messages **Requires authentication.** **Features:** messages.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/messages/:id/archive" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/messages/{id}/archive` PUT /messages/{id}/archive Requires features: messages.view **Tags:** Messages **Requires authentication.** **Features:** messages.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/messages/:id/archive" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/messages/{id}/attachments` DELETE /messages/{id}/attachments Requires features: messages.attach_files **Tags:** Messages **Requires authentication.** **Features:** messages.attach_files ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/messages/:id/attachments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/messages/{id}/attachments` GET /messages/{id}/attachments **Tags:** Messages **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/messages/:id/attachments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/messages/{id}/attachments` POST /messages/{id}/attachments Requires features: messages.attach_files **Tags:** Messages **Requires authentication.** **Features:** messages.attach_files ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/messages/:id/attachments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/messages/{id}/confirmation` GET /messages/{id}/confirmation **Tags:** Messages **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/messages/:id/confirmation" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/messages/{id}/conversation` DELETE /messages/{id}/conversation Requires features: messages.view **Tags:** Messages **Requires authentication.** **Features:** messages.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/messages/:id/conversation" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/messages/{id}/conversation/archive` PUT /messages/{id}/conversation/archive Requires features: messages.view **Tags:** Messages **Requires authentication.** **Features:** messages.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/messages/:id/conversation/archive" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/messages/{id}/conversation/read` DELETE /messages/{id}/conversation/read Requires features: messages.view **Tags:** Messages **Requires authentication.** **Features:** messages.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/messages/:id/conversation/read" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/messages/{id}/forward` POST /messages/{id}/forward Requires features: messages.compose **Tags:** Messages **Requires authentication.** **Features:** messages.compose ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/messages/:id/forward" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/messages/{id}/forward-preview` GET /messages/{id}/forward-preview Requires features: messages.compose **Tags:** Messages **Requires authentication.** **Features:** messages.compose ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/messages/:id/forward-preview" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/messages/{id}/read` DELETE /messages/{id}/read Requires features: messages.view **Tags:** Messages **Requires authentication.** **Features:** messages.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/messages/:id/read" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/messages/{id}/read` PUT /messages/{id}/read Requires features: messages.view **Tags:** Messages **Requires authentication.** **Features:** messages.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/messages/:id/read" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/messages/{id}/reply` POST /messages/{id}/reply Requires features: messages.compose **Tags:** Messages **Requires authentication.** **Features:** messages.compose ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/messages/:id/reply" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/messages/object-types` GET /messages/object-types Requires features: messages.compose **Tags:** Messages **Requires authentication.** **Features:** messages.compose ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/messages/object-types" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/messages/token/{token}` GET /messages/token/{token} **Tags:** Messages ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | token | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/messages/token/:token" \ -H "Accept: application/json" ``` ## GET `/messages/types` GET /messages/types Requires features: messages.view **Tags:** Messages **Requires authentication.** **Features:** messages.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/messages/types" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/messages/unread-count` GET /messages/unread-count **Tags:** Messages **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/messages/unread-count" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/notifications` GET /notifications **Tags:** Notifications **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/notifications" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/notifications` POST /notifications Requires features: notifications.create **Tags:** Notifications **Requires authentication.** **Features:** notifications.create ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/notifications" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/notifications/{id}/action` POST /notifications/{id}/action **Tags:** Notifications **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/notifications/:id/action" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/notifications/{id}/dismiss` PUT /notifications/{id}/dismiss **Tags:** Notifications **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/notifications/:id/dismiss" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/notifications/{id}/read` PUT /notifications/{id}/read **Tags:** Notifications **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/notifications/:id/read" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/notifications/{id}/restore` PUT /notifications/{id}/restore **Tags:** Notifications **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/notifications/:id/restore" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/notifications/batch` POST /notifications/batch Requires features: notifications.create **Tags:** Notifications **Requires authentication.** **Features:** notifications.create ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/notifications/batch" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/notifications/feature` POST /notifications/feature Requires features: notifications.create **Tags:** Notifications **Requires authentication.** **Features:** notifications.create ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/notifications/feature" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/notifications/mark-all-read` PUT /notifications/mark-all-read **Tags:** Notifications **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/notifications/mark-all-read" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/notifications/role` POST /notifications/role Requires features: notifications.create **Tags:** Notifications **Requires authentication.** **Features:** notifications.create ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/notifications/role" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/notifications/settings` GET /notifications/settings Requires features: notifications.manage **Tags:** Notifications **Requires authentication.** **Features:** notifications.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/notifications/settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/notifications/settings` POST /notifications/settings Requires features: notifications.manage **Tags:** Notifications **Requires authentication.** **Features:** notifications.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/notifications/settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/notifications/unread-count` GET /notifications/unread-count **Tags:** Notifications **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/notifications/unread-count" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/onboarding/demo-feedback` POST /onboarding/demo-feedback **Tags:** Onboarding ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/onboarding/demo-feedback" \ -H "Accept: application/json" ``` ## POST `/onboarding/onboarding` POST /onboarding/onboarding **Tags:** Onboarding ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/onboarding/onboarding" \ -H "Accept: application/json" ``` ## GET `/onboarding/onboarding/status` GET /onboarding/onboarding/status **Tags:** Onboarding ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/onboarding/onboarding/status" \ -H "Accept: application/json" ``` ## GET `/onboarding/onboarding/verify` GET /onboarding/onboarding/verify **Tags:** Onboarding ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/onboarding/onboarding/verify" \ -H "Accept: application/json" ``` ## POST `/payment_gateways/cancel` POST /payment_gateways/cancel Requires features: payment_gateways.manage **Tags:** Payment Gateways **Requires authentication.** **Features:** payment_gateways.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/payment_gateways/cancel" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/payment_gateways/capture` POST /payment_gateways/capture Requires features: payment_gateways.capture **Tags:** Payment Gateways **Requires authentication.** **Features:** payment_gateways.capture ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/payment_gateways/capture" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/payment_gateways/providers` GET /payment_gateways/providers Requires features: payment_gateways.view **Tags:** Payment Gateways **Requires authentication.** **Features:** payment_gateways.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/payment_gateways/providers" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/payment_gateways/providers/{providerKey}` GET /payment_gateways/providers/{providerKey} Requires features: payment_gateways.view **Tags:** Payment Gateways **Requires authentication.** **Features:** payment_gateways.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | providerKey | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/payment_gateways/providers/:providerKey" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/payment_gateways/refund` POST /payment_gateways/refund Requires features: payment_gateways.refund **Tags:** Payment Gateways **Requires authentication.** **Features:** payment_gateways.refund ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/payment_gateways/refund" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/payment_gateways/sessions` POST /payment_gateways/sessions Requires features: payment_gateways.manage **Tags:** Payment Gateways **Requires authentication.** **Features:** payment_gateways.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/payment_gateways/sessions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/payment_gateways/status` GET /payment_gateways/status Requires features: payment_gateways.view **Tags:** Payment Gateways **Requires authentication.** **Features:** payment_gateways.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/payment_gateways/status" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/payment_gateways/transactions` GET /payment_gateways/transactions Requires features: payment_gateways.view **Tags:** Payment Gateways **Requires authentication.** **Features:** payment_gateways.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/payment_gateways/transactions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/payment_gateways/transactions/{id}` GET /payment_gateways/transactions/{id} Requires features: payment_gateways.view **Tags:** Payment Gateways **Requires authentication.** **Features:** payment_gateways.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/payment_gateways/transactions/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/payment_gateways/webhook/{provider}` POST /payment_gateways/webhook/{provider} **Tags:** Payment Gateways ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | provider | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/payment_gateways/webhook/:provider" \ -H "Accept: application/json" ``` ## GET `/perspectives/{tableId}` GET /perspectives/{tableId} Requires features: perspectives.use **Tags:** Table perspectives **Requires authentication.** **Features:** perspectives.use ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | tableId | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/perspectives/:tableId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/perspectives/{tableId}` POST /perspectives/{tableId} Requires features: perspectives.use **Tags:** Table perspectives **Requires authentication.** **Features:** perspectives.use ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | tableId | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/perspectives/:tableId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/perspectives/{tableId}/{perspectiveId}` DELETE /perspectives/{tableId}/{perspectiveId} Requires features: perspectives.use **Tags:** Table perspectives **Requires authentication.** **Features:** perspectives.use ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | tableId | path | any | Required | | perspectiveId | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/perspectives/:tableId/:perspectiveId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/perspectives/{tableId}/roles/{roleId}` DELETE /perspectives/{tableId}/roles/{roleId} Requires features: perspectives.role_defaults **Tags:** Table perspectives **Requires authentication.** **Features:** perspectives.role_defaults ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | tableId | path | any | Required | | roleId | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/perspectives/:tableId/roles/:roleId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/planner/availability` DELETE /planner/availability **Tags:** Worktime / Availabilities **Requires authentication.** ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/planner/availability" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/planner/availability` GET /planner/availability Requires features: planner.view **Tags:** Worktime / Availabilities **Requires authentication.** **Features:** planner.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/planner/availability" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/planner/availability` POST /planner/availability **Tags:** Worktime / Availabilities **Requires authentication.** ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/planner/availability" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/planner/availability` PUT /planner/availability **Tags:** Worktime / Availabilities **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/planner/availability" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/planner/availability-date-specific` POST /planner/availability-date-specific **Tags:** Worktime / Availabilities **Requires authentication.** ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/planner/availability-date-specific" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/planner/availability-rule-sets` DELETE /planner/availability-rule-sets Requires features: planner.manage_availability **Tags:** Worktime / Availabilities **Requires authentication.** **Features:** planner.manage_availability ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/planner/availability-rule-sets" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/planner/availability-rule-sets` GET /planner/availability-rule-sets Requires features: planner.view **Tags:** Worktime / Availabilities **Requires authentication.** **Features:** planner.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/planner/availability-rule-sets" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/planner/availability-rule-sets` POST /planner/availability-rule-sets Requires features: planner.manage_availability **Tags:** Worktime / Availabilities **Requires authentication.** **Features:** planner.manage_availability ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/planner/availability-rule-sets" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/planner/availability-rule-sets` PUT /planner/availability-rule-sets Requires features: planner.manage_availability **Tags:** Worktime / Availabilities **Requires authentication.** **Features:** planner.manage_availability ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/planner/availability-rule-sets" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/planner/availability-weekly` POST /planner/availability-weekly **Tags:** Worktime / Availabilities **Requires authentication.** ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/planner/availability-weekly" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/progress/active` GET /progress/active **Tags:** Progress **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/progress/active" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/progress/jobs` GET /progress/jobs **Tags:** Progress **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/progress/jobs" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/progress/jobs` POST /progress/jobs Requires features: progress.create **Tags:** Progress **Requires authentication.** **Features:** progress.create ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/progress/jobs" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/progress/jobs/{id}` DELETE /progress/jobs/{id} Requires features: progress.cancel **Tags:** Progress **Requires authentication.** **Features:** progress.cancel ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/progress/jobs/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/progress/jobs/{id}` GET /progress/jobs/{id} **Tags:** Progress **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/progress/jobs/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/progress/jobs/{id}` PUT /progress/jobs/{id} Requires features: progress.update **Tags:** Progress **Requires authentication.** **Features:** progress.update ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/progress/jobs/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/query_index/purge` POST /query_index/purge Requires features: query_index.purge **Tags:** Query Indexes **Requires authentication.** **Features:** query_index.purge ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/query_index/purge" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/query_index/reindex` POST /query_index/reindex Requires features: query_index.reindex **Tags:** Query Indexes **Requires authentication.** **Features:** query_index.reindex ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/query_index/reindex" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/query_index/status` GET /query_index/status Requires features: query_index.status.view **Tags:** Query Indexes **Requires authentication.** **Features:** query_index.status.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/query_index/status" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/ratelimit_probe/ping` POST /ratelimit_probe/ping **Tags:** Ratelimit Probe ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/ratelimit_probe/ping" \ -H "Accept: application/json" ``` ## DELETE `/resources/activities` DELETE /resources/activities **Tags:** Resource planning ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/resources/activities" \ -H "Accept: application/json" ``` ## GET `/resources/activities` GET /resources/activities **Tags:** Resource planning ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/resources/activities" \ -H "Accept: application/json" ``` ## POST `/resources/activities` POST /resources/activities **Tags:** Resource planning ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/resources/activities" \ -H "Accept: application/json" ``` ## PUT `/resources/activities` PUT /resources/activities **Tags:** Resource planning ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/resources/activities" \ -H "Accept: application/json" ``` ## DELETE `/resources/comments` DELETE /resources/comments Requires features: resources.manage_resources **Tags:** Resource planning **Requires authentication.** **Features:** resources.manage_resources ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/resources/comments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/resources/comments` GET /resources/comments Requires features: resources.view **Tags:** Resource planning **Requires authentication.** **Features:** resources.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/resources/comments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/resources/comments` POST /resources/comments Requires features: resources.manage_resources **Tags:** Resource planning **Requires authentication.** **Features:** resources.manage_resources ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/resources/comments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/resources/comments` PUT /resources/comments Requires features: resources.manage_resources **Tags:** Resource planning **Requires authentication.** **Features:** resources.manage_resources ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/resources/comments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/resources/resource-types` DELETE /resources/resource-types Requires features: resources.manage_resources **Tags:** Resource planning **Requires authentication.** **Features:** resources.manage_resources ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/resources/resource-types" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/resources/resource-types` GET /resources/resource-types Requires features: resources.view **Tags:** Resource planning **Requires authentication.** **Features:** resources.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/resources/resource-types" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/resources/resource-types` POST /resources/resource-types Requires features: resources.manage_resources **Tags:** Resource planning **Requires authentication.** **Features:** resources.manage_resources ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/resources/resource-types" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/resources/resource-types` PUT /resources/resource-types Requires features: resources.manage_resources **Tags:** Resource planning **Requires authentication.** **Features:** resources.manage_resources ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/resources/resource-types" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/resources/resources` DELETE /resources/resources Requires features: resources.manage_resources **Tags:** Resource planning **Requires authentication.** **Features:** resources.manage_resources ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/resources/resources" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/resources/resources` GET /resources/resources Requires features: resources.view **Tags:** Resource planning **Requires authentication.** **Features:** resources.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/resources/resources" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/resources/resources` POST /resources/resources Requires features: resources.manage_resources **Tags:** Resource planning **Requires authentication.** **Features:** resources.manage_resources ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/resources/resources" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/resources/resources` PUT /resources/resources Requires features: resources.manage_resources **Tags:** Resource planning **Requires authentication.** **Features:** resources.manage_resources ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/resources/resources" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/resources/resources/tags/assign` POST /resources/resources/tags/assign Requires features: resources.manage_resources **Tags:** Resource planning **Requires authentication.** **Features:** resources.manage_resources ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/resources/resources/tags/assign" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/resources/resources/tags/unassign` POST /resources/resources/tags/unassign Requires features: resources.manage_resources **Tags:** Resource planning **Requires authentication.** **Features:** resources.manage_resources ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/resources/resources/tags/unassign" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/resources/tags` DELETE /resources/tags Requires features: resources.manage_resources **Tags:** Resource planning **Requires authentication.** **Features:** resources.manage_resources ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/resources/tags" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/resources/tags` GET /resources/tags Requires features: resources.view **Tags:** Resource planning **Requires authentication.** **Features:** resources.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/resources/tags" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/resources/tags` POST /resources/tags Requires features: resources.manage_resources **Tags:** Resource planning **Requires authentication.** **Features:** resources.manage_resources ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/resources/tags" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/resources/tags` PUT /resources/tags Requires features: resources.manage_resources **Tags:** Resource planning **Requires authentication.** **Features:** resources.manage_resources ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/resources/tags" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/sales/adjustment-kinds` DELETE /sales/adjustment-kinds Requires features: sales.settings.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.settings.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/adjustment-kinds" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sales/adjustment-kinds` GET /sales/adjustment-kinds Requires features: sales.orders.view **Tags:** Sales Management **Requires authentication.** **Features:** sales.orders.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/adjustment-kinds" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/adjustment-kinds` POST /sales/adjustment-kinds Requires features: sales.settings.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.settings.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/adjustment-kinds" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/sales/adjustment-kinds` PUT /sales/adjustment-kinds Requires features: sales.settings.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/adjustment-kinds" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/sales/channels` DELETE /sales/channels Requires features: sales.channels.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.channels.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/channels" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sales/channels` GET /sales/channels Requires features: sales.channels.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.channels.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/channels" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/channels` POST /sales/channels Requires features: sales.channels.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.channels.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/channels" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/sales/channels` PUT /sales/channels Requires features: sales.channels.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.channels.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/channels" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/sales/credit-memos` DELETE /sales/credit-memos Requires features: sales.credit_memos.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.credit_memos.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/credit-memos" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sales/credit-memos` GET /sales/credit-memos Requires features: sales.credit_memos.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.credit_memos.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/credit-memos" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/credit-memos` POST /sales/credit-memos Requires features: sales.credit_memos.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.credit_memos.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/credit-memos" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/sales/credit-memos` PUT /sales/credit-memos Requires features: sales.credit_memos.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.credit_memos.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/credit-memos" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sales/dashboard/widgets/new-orders` GET /sales/dashboard/widgets/new-orders **Tags:** Sales Management ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/dashboard/widgets/new-orders" \ -H "Accept: application/json" ``` ## GET `/sales/dashboard/widgets/new-quotes` GET /sales/dashboard/widgets/new-quotes **Tags:** Sales Management ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/dashboard/widgets/new-quotes" \ -H "Accept: application/json" ``` ## DELETE `/sales/delivery-windows` DELETE /sales/delivery-windows Requires features: sales.settings.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.settings.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/delivery-windows" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sales/delivery-windows` GET /sales/delivery-windows Requires features: sales.settings.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/delivery-windows" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/delivery-windows` POST /sales/delivery-windows Requires features: sales.settings.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.settings.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/delivery-windows" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/sales/delivery-windows` PUT /sales/delivery-windows Requires features: sales.settings.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/delivery-windows" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/sales/document-addresses` DELETE /sales/document-addresses **Tags:** Sales Management **Requires authentication.** ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/document-addresses" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sales/document-addresses` GET /sales/document-addresses **Tags:** Sales Management **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/document-addresses" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/document-addresses` POST /sales/document-addresses **Tags:** Sales Management **Requires authentication.** ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/document-addresses" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/sales/document-addresses` PUT /sales/document-addresses **Tags:** Sales Management **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/document-addresses" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sales/document-history` GET /sales/document-history **Tags:** Sales Management **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/document-history" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/document-numbers` POST /sales/document-numbers **Tags:** Sales Management **Requires authentication.** ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/document-numbers" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/sales/invoices` DELETE /sales/invoices Requires features: sales.invoices.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.invoices.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/invoices" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sales/invoices` GET /sales/invoices Requires features: sales.invoices.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.invoices.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/invoices" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/invoices` POST /sales/invoices Requires features: sales.invoices.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.invoices.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/invoices" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/sales/invoices` PUT /sales/invoices Requires features: sales.invoices.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.invoices.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/invoices" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/sales/notes` DELETE /sales/notes **Tags:** Sales Management **Requires authentication.** ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/notes" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sales/notes` GET /sales/notes **Tags:** Sales Management **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/notes" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/notes` POST /sales/notes **Tags:** Sales Management **Requires authentication.** ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/notes" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/sales/notes` PUT /sales/notes **Tags:** Sales Management **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/notes" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/sales/order-adjustments` DELETE /sales/order-adjustments Requires features: sales.orders.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.orders.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/order-adjustments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sales/order-adjustments` GET /sales/order-adjustments Requires features: sales.orders.view **Tags:** Sales Management **Requires authentication.** **Features:** sales.orders.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/order-adjustments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/order-adjustments` POST /sales/order-adjustments Requires features: sales.orders.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.orders.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/order-adjustments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/sales/order-adjustments` PUT /sales/order-adjustments Requires features: sales.orders.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.orders.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/order-adjustments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/sales/order-line-statuses` DELETE /sales/order-line-statuses **Tags:** Sales Management ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/order-line-statuses" \ -H "Accept: application/json" ``` ## GET `/sales/order-line-statuses` GET /sales/order-line-statuses **Tags:** Sales Management ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/order-line-statuses" \ -H "Accept: application/json" ``` ## POST `/sales/order-line-statuses` POST /sales/order-line-statuses **Tags:** Sales Management ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/order-line-statuses" \ -H "Accept: application/json" ``` ## PUT `/sales/order-line-statuses` PUT /sales/order-line-statuses **Tags:** Sales Management ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/order-line-statuses" \ -H "Accept: application/json" ``` ## DELETE `/sales/order-lines` DELETE /sales/order-lines **Tags:** Sales Management ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/order-lines" \ -H "Accept: application/json" ``` ## GET `/sales/order-lines` GET /sales/order-lines **Tags:** Sales Management ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/order-lines" \ -H "Accept: application/json" ``` ## POST `/sales/order-lines` POST /sales/order-lines **Tags:** Sales Management ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/order-lines" \ -H "Accept: application/json" ``` ## PUT `/sales/order-lines` PUT /sales/order-lines **Tags:** Sales Management ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/order-lines" \ -H "Accept: application/json" ``` ## DELETE `/sales/order-statuses` DELETE /sales/order-statuses **Tags:** Sales Management ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/order-statuses" \ -H "Accept: application/json" ``` ## GET `/sales/order-statuses` GET /sales/order-statuses **Tags:** Sales Management ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/order-statuses" \ -H "Accept: application/json" ``` ## POST `/sales/order-statuses` POST /sales/order-statuses **Tags:** Sales Management ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/order-statuses" \ -H "Accept: application/json" ``` ## PUT `/sales/order-statuses` PUT /sales/order-statuses **Tags:** Sales Management ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/order-statuses" \ -H "Accept: application/json" ``` ## DELETE `/sales/orders` DELETE /sales/orders **Tags:** Sales Management ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/orders" \ -H "Accept: application/json" ``` ## GET `/sales/orders` GET /sales/orders **Tags:** Sales Management ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/orders" \ -H "Accept: application/json" ``` ## POST `/sales/orders` POST /sales/orders **Tags:** Sales Management ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/orders" \ -H "Accept: application/json" ``` ## PUT `/sales/orders` PUT /sales/orders **Tags:** Sales Management ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/orders" \ -H "Accept: application/json" ``` ## DELETE `/sales/payment-methods` DELETE /sales/payment-methods Requires features: sales.settings.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.settings.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/payment-methods" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sales/payment-methods` GET /sales/payment-methods Requires features: sales.settings.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/payment-methods" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/payment-methods` POST /sales/payment-methods Requires features: sales.settings.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.settings.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/payment-methods" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/sales/payment-methods` PUT /sales/payment-methods Requires features: sales.settings.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/payment-methods" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/sales/payment-statuses` DELETE /sales/payment-statuses **Tags:** Sales Management ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/payment-statuses" \ -H "Accept: application/json" ``` ## GET `/sales/payment-statuses` GET /sales/payment-statuses **Tags:** Sales Management ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/payment-statuses" \ -H "Accept: application/json" ``` ## POST `/sales/payment-statuses` POST /sales/payment-statuses **Tags:** Sales Management ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/payment-statuses" \ -H "Accept: application/json" ``` ## PUT `/sales/payment-statuses` PUT /sales/payment-statuses **Tags:** Sales Management ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/payment-statuses" \ -H "Accept: application/json" ``` ## DELETE `/sales/payments` DELETE /sales/payments Requires features: sales.payments.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.payments.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/payments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sales/payments` GET /sales/payments Requires features: sales.orders.view **Tags:** Sales Management **Requires authentication.** **Features:** sales.orders.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/payments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/payments` POST /sales/payments Requires features: sales.payments.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.payments.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/payments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/sales/payments` PUT /sales/payments Requires features: sales.payments.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.payments.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/payments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sales/price-kinds` GET /sales/price-kinds Requires features: sales.channels.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.channels.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/price-kinds" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/sales/quote-adjustments` DELETE /sales/quote-adjustments Requires features: sales.quotes.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.quotes.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/quote-adjustments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sales/quote-adjustments` GET /sales/quote-adjustments Requires features: sales.quotes.view **Tags:** Sales Management **Requires authentication.** **Features:** sales.quotes.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/quote-adjustments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/quote-adjustments` POST /sales/quote-adjustments Requires features: sales.quotes.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.quotes.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/quote-adjustments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/sales/quote-adjustments` PUT /sales/quote-adjustments Requires features: sales.quotes.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.quotes.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/quote-adjustments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/sales/quote-lines` DELETE /sales/quote-lines **Tags:** Sales Management ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/quote-lines" \ -H "Accept: application/json" ``` ## GET `/sales/quote-lines` GET /sales/quote-lines **Tags:** Sales Management ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/quote-lines" \ -H "Accept: application/json" ``` ## POST `/sales/quote-lines` POST /sales/quote-lines **Tags:** Sales Management ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/quote-lines" \ -H "Accept: application/json" ``` ## PUT `/sales/quote-lines` PUT /sales/quote-lines **Tags:** Sales Management ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/quote-lines" \ -H "Accept: application/json" ``` ## DELETE `/sales/quotes` DELETE /sales/quotes **Tags:** Sales Management ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/quotes" \ -H "Accept: application/json" ``` ## GET `/sales/quotes` GET /sales/quotes **Tags:** Sales Management ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/quotes" \ -H "Accept: application/json" ``` ## POST `/sales/quotes` POST /sales/quotes **Tags:** Sales Management ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/quotes" \ -H "Accept: application/json" ``` ## PUT `/sales/quotes` PUT /sales/quotes **Tags:** Sales Management ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/quotes" \ -H "Accept: application/json" ``` ## POST `/sales/quotes/accept` POST /sales/quotes/accept **Tags:** Sales Management ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/quotes/accept" \ -H "Accept: application/json" ``` ## POST `/sales/quotes/convert` POST /sales/quotes/convert Requires features: sales.quotes.manage, sales.orders.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.quotes.manage, sales.orders.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/quotes/convert" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sales/quotes/public/{token}` GET /sales/quotes/public/{token} **Tags:** Sales Management ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | token | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/quotes/public/:token" \ -H "Accept: application/json" ``` ## POST `/sales/quotes/send` POST /sales/quotes/send Requires features: sales.quotes.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.quotes.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/quotes/send" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sales/returns` GET /sales/returns Requires features: sales.returns.view **Tags:** Sales Management **Requires authentication.** **Features:** sales.returns.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/returns" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/returns` POST /sales/returns Requires features: sales.returns.create **Tags:** Sales Management **Requires authentication.** **Features:** sales.returns.create ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/returns" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sales/returns/{id}` GET /sales/returns/{id} Requires features: sales.returns.view **Tags:** Sales Management **Requires authentication.** **Features:** sales.returns.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/returns/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sales/settings/document-numbers` GET /sales/settings/document-numbers Requires features: sales.settings.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/settings/document-numbers" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/sales/settings/document-numbers` PUT /sales/settings/document-numbers Requires features: sales.settings.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/settings/document-numbers" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sales/settings/order-editing` GET /sales/settings/order-editing Requires features: sales.settings.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/settings/order-editing" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/sales/settings/order-editing` PUT /sales/settings/order-editing Requires features: sales.settings.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/settings/order-editing" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/sales/shipment-statuses` DELETE /sales/shipment-statuses **Tags:** Sales Management ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/shipment-statuses" \ -H "Accept: application/json" ``` ## GET `/sales/shipment-statuses` GET /sales/shipment-statuses **Tags:** Sales Management ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/shipment-statuses" \ -H "Accept: application/json" ``` ## POST `/sales/shipment-statuses` POST /sales/shipment-statuses **Tags:** Sales Management ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/shipment-statuses" \ -H "Accept: application/json" ``` ## PUT `/sales/shipment-statuses` PUT /sales/shipment-statuses **Tags:** Sales Management ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/shipment-statuses" \ -H "Accept: application/json" ``` ## DELETE `/sales/shipments` DELETE /sales/shipments Requires features: sales.shipments.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.shipments.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/shipments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sales/shipments` GET /sales/shipments Requires features: sales.orders.view **Tags:** Sales Management **Requires authentication.** **Features:** sales.orders.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/shipments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/shipments` POST /sales/shipments Requires features: sales.shipments.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.shipments.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/shipments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/sales/shipments` PUT /sales/shipments Requires features: sales.shipments.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.shipments.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/shipments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/sales/shipping-methods` DELETE /sales/shipping-methods Requires features: sales.settings.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.settings.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/shipping-methods" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sales/shipping-methods` GET /sales/shipping-methods Requires features: sales.settings.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/shipping-methods" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/shipping-methods` POST /sales/shipping-methods Requires features: sales.settings.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.settings.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/shipping-methods" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/sales/shipping-methods` PUT /sales/shipping-methods Requires features: sales.settings.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/shipping-methods" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/sales/tags` DELETE /sales/tags Requires features: sales.orders.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.orders.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/tags" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sales/tags` GET /sales/tags Requires features: sales.orders.view **Tags:** Sales Management **Requires authentication.** **Features:** sales.orders.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/tags" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/tags` POST /sales/tags Requires features: sales.orders.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.orders.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/tags" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/sales/tags` PUT /sales/tags Requires features: sales.orders.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.orders.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/tags" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/sales/tax-rates` DELETE /sales/tax-rates Requires features: sales.settings.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.settings.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/sales/tax-rates" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sales/tax-rates` GET /sales/tax-rates Requires features: sales.settings.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sales/tax-rates" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sales/tax-rates` POST /sales/tax-rates Requires features: sales.settings.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.settings.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sales/tax-rates" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/sales/tax-rates` PUT /sales/tax-rates Requires features: sales.settings.manage **Tags:** Sales Management **Requires authentication.** **Features:** sales.settings.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/sales/tax-rates" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/scheduler/jobs` DELETE /scheduler/jobs Requires features: scheduler.jobs.manage **Tags:** Scheduler **Requires authentication.** **Features:** scheduler.jobs.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/scheduler/jobs" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/scheduler/jobs` GET /scheduler/jobs Requires features: scheduler.jobs.view **Tags:** Scheduler **Requires authentication.** **Features:** scheduler.jobs.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/scheduler/jobs" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/scheduler/jobs` POST /scheduler/jobs Requires features: scheduler.jobs.manage **Tags:** Scheduler **Requires authentication.** **Features:** scheduler.jobs.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/scheduler/jobs" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/scheduler/jobs` PUT /scheduler/jobs Requires features: scheduler.jobs.manage **Tags:** Scheduler **Requires authentication.** **Features:** scheduler.jobs.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/scheduler/jobs" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/scheduler/jobs/{id}/executions` GET /scheduler/jobs/{id}/executions **Tags:** Scheduler ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/scheduler/jobs/:id/executions" \ -H "Accept: application/json" ``` ## GET `/scheduler/queue-jobs/{jobId}` GET /scheduler/queue-jobs/{jobId} **Tags:** Scheduler ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | jobId | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/scheduler/queue-jobs/:jobId" \ -H "Accept: application/json" ``` ## GET `/scheduler/targets` GET /scheduler/targets **Tags:** Scheduler ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/scheduler/targets" \ -H "Accept: application/json" ``` ## POST `/scheduler/trigger` POST /scheduler/trigger **Tags:** Scheduler ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/scheduler/trigger" \ -H "Accept: application/json" ``` ## GET `/search/embeddings` GET /search/embeddings Requires features: search.embeddings.view **Tags:** Search **Requires authentication.** **Features:** search.embeddings.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/search/embeddings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/search/embeddings` POST /search/embeddings Requires features: search.embeddings.manage **Tags:** Search **Requires authentication.** **Features:** search.embeddings.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/search/embeddings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/search/embeddings/reindex` POST /search/embeddings/reindex Requires features: search.embeddings.manage **Tags:** Search **Requires authentication.** **Features:** search.embeddings.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/search/embeddings/reindex" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/search/embeddings/reindex/cancel` POST /search/embeddings/reindex/cancel Requires features: search.embeddings.manage **Tags:** Search **Requires authentication.** **Features:** search.embeddings.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/search/embeddings/reindex/cancel" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/search/index` DELETE /search/index Requires features: search.embeddings.manage **Tags:** Search **Requires authentication.** **Features:** search.embeddings.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/search/index" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/search/index` GET /search/index Requires features: search.view **Tags:** Search **Requires authentication.** **Features:** search.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/search/index" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/search/reindex` POST /search/reindex Requires features: search.reindex **Tags:** Search **Requires authentication.** **Features:** search.reindex ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/search/reindex" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/search/reindex/cancel` POST /search/reindex/cancel Requires features: search.reindex **Tags:** Search **Requires authentication.** **Features:** search.reindex ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/search/reindex/cancel" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/search/search` GET /search/search Requires features: search.view **Tags:** Search **Requires authentication.** **Features:** search.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/search/search" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/search/search/global` GET /search/search/global Requires features: search.view **Tags:** Search **Requires authentication.** **Features:** search.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/search/search/global" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/search/settings` GET /search/settings Requires features: search.view **Tags:** Search **Requires authentication.** **Features:** search.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/search/settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/search/settings/fulltext` GET /search/settings/fulltext Requires features: search.view **Tags:** Search **Requires authentication.** **Features:** search.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/search/settings/fulltext" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/search/settings/global-search` GET /search/settings/global-search Requires features: search.view **Tags:** Search **Requires authentication.** **Features:** search.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/search/settings/global-search" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/search/settings/global-search` POST /search/settings/global-search Requires features: search.manage **Tags:** Search **Requires authentication.** **Features:** search.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/search/settings/global-search" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/search/settings/vector-store` GET /search/settings/vector-store Requires features: search.view **Tags:** Search **Requires authentication.** **Features:** search.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/search/settings/vector-store" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/shipping-carriers/cancel` POST /shipping-carriers/cancel Requires features: shipping_carriers.manage **Tags:** Shipping Carriers **Requires authentication.** **Features:** shipping_carriers.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/shipping-carriers/cancel" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/shipping-carriers/points` GET /shipping-carriers/points Requires features: shipping_carriers.view **Tags:** Shipping Carriers **Requires authentication.** **Features:** shipping_carriers.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/shipping-carriers/points" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/shipping-carriers/providers` GET /shipping-carriers/providers Requires features: shipping_carriers.manage **Tags:** Shipping Carriers **Requires authentication.** **Features:** shipping_carriers.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/shipping-carriers/providers" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/shipping-carriers/rates` POST /shipping-carriers/rates Requires features: shipping_carriers.manage **Tags:** Shipping Carriers **Requires authentication.** **Features:** shipping_carriers.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/shipping-carriers/rates" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/shipping-carriers/shipments` POST /shipping-carriers/shipments Requires features: shipping_carriers.manage **Tags:** Shipping Carriers **Requires authentication.** **Features:** shipping_carriers.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/shipping-carriers/shipments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/shipping-carriers/tracking` GET /shipping-carriers/tracking Requires features: shipping_carriers.view **Tags:** Shipping Carriers **Requires authentication.** **Features:** shipping_carriers.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/shipping-carriers/tracking" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/shipping-carriers/webhook/{provider}` POST /shipping-carriers/webhook/{provider} **Tags:** Shipping Carriers ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | provider | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/shipping-carriers/webhook/:provider" \ -H "Accept: application/json" ``` ## DELETE `/staff/activities` DELETE /staff/activities **Tags:** Employees ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/staff/activities" \ -H "Accept: application/json" ``` ## GET `/staff/activities` GET /staff/activities **Tags:** Employees ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/staff/activities" \ -H "Accept: application/json" ``` ## POST `/staff/activities` POST /staff/activities **Tags:** Employees ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/staff/activities" \ -H "Accept: application/json" ``` ## PUT `/staff/activities` PUT /staff/activities **Tags:** Employees ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/staff/activities" \ -H "Accept: application/json" ``` ## DELETE `/staff/addresses` DELETE /staff/addresses Requires features: staff.manage_team **Tags:** Employees **Requires authentication.** **Features:** staff.manage_team ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/staff/addresses" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/staff/addresses` GET /staff/addresses Requires features: staff.view **Tags:** Employees **Requires authentication.** **Features:** staff.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/staff/addresses" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/staff/addresses` POST /staff/addresses Requires features: staff.manage_team **Tags:** Employees **Requires authentication.** **Features:** staff.manage_team ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/staff/addresses" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/staff/addresses` PUT /staff/addresses Requires features: staff.manage_team **Tags:** Employees **Requires authentication.** **Features:** staff.manage_team ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/staff/addresses" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/staff/comments` DELETE /staff/comments Requires features: staff.manage_team **Tags:** Employees **Requires authentication.** **Features:** staff.manage_team ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/staff/comments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/staff/comments` GET /staff/comments Requires features: staff.view **Tags:** Employees **Requires authentication.** **Features:** staff.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/staff/comments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/staff/comments` POST /staff/comments Requires features: staff.manage_team **Tags:** Employees **Requires authentication.** **Features:** staff.manage_team ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/staff/comments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/staff/comments` PUT /staff/comments Requires features: staff.manage_team **Tags:** Employees **Requires authentication.** **Features:** staff.manage_team ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/staff/comments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/staff/job-histories` DELETE /staff/job-histories Requires features: staff.manage_team **Tags:** Employees **Requires authentication.** **Features:** staff.manage_team ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/staff/job-histories" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/staff/job-histories` GET /staff/job-histories Requires features: staff.view **Tags:** Employees **Requires authentication.** **Features:** staff.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/staff/job-histories" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/staff/job-histories` POST /staff/job-histories Requires features: staff.manage_team **Tags:** Employees **Requires authentication.** **Features:** staff.manage_team ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/staff/job-histories" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/staff/job-histories` PUT /staff/job-histories Requires features: staff.manage_team **Tags:** Employees **Requires authentication.** **Features:** staff.manage_team ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/staff/job-histories" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/staff/leave-requests` DELETE /staff/leave-requests **Tags:** Employees **Requires authentication.** ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/staff/leave-requests" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/staff/leave-requests` GET /staff/leave-requests **Tags:** Employees **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/staff/leave-requests" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/staff/leave-requests` POST /staff/leave-requests **Tags:** Employees **Requires authentication.** ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/staff/leave-requests" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/staff/leave-requests` PUT /staff/leave-requests **Tags:** Employees **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/staff/leave-requests" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/staff/leave-requests/accept` POST /staff/leave-requests/accept Requires features: staff.leave_requests.manage **Tags:** Employees **Requires authentication.** **Features:** staff.leave_requests.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/staff/leave-requests/accept" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/staff/leave-requests/reject` POST /staff/leave-requests/reject Requires features: staff.leave_requests.manage **Tags:** Employees **Requires authentication.** **Features:** staff.leave_requests.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/staff/leave-requests/reject" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/staff/team-members` DELETE /staff/team-members Requires features: staff.manage_team **Tags:** Employees **Requires authentication.** **Features:** staff.manage_team ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/staff/team-members" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/staff/team-members` GET /staff/team-members Requires features: staff.view **Tags:** Employees **Requires authentication.** **Features:** staff.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/staff/team-members" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/staff/team-members` POST /staff/team-members Requires features: staff.manage_team **Tags:** Employees **Requires authentication.** **Features:** staff.manage_team ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/staff/team-members" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/staff/team-members` PUT /staff/team-members Requires features: staff.manage_team **Tags:** Employees **Requires authentication.** **Features:** staff.manage_team ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/staff/team-members" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/staff/team-members/assignable` GET /staff/team-members/assignable Requires features: customers.roles.view **Tags:** Employees **Requires authentication.** **Features:** customers.roles.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/staff/team-members/assignable" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/staff/team-members/self` GET /staff/team-members/self Requires features: staff.leave_requests.send **Tags:** Employees **Requires authentication.** **Features:** staff.leave_requests.send ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/staff/team-members/self" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/staff/team-members/self` POST /staff/team-members/self Requires features: staff.leave_requests.send **Tags:** Employees **Requires authentication.** **Features:** staff.leave_requests.send ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/staff/team-members/self" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/staff/team-members/tags/assign` POST /staff/team-members/tags/assign Requires features: staff.manage_team **Tags:** Employees **Requires authentication.** **Features:** staff.manage_team ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/staff/team-members/tags/assign" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/staff/team-members/tags/unassign` POST /staff/team-members/tags/unassign Requires features: staff.manage_team **Tags:** Employees **Requires authentication.** **Features:** staff.manage_team ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/staff/team-members/tags/unassign" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/staff/team-roles` DELETE /staff/team-roles Requires features: staff.manage_team **Tags:** Employees **Requires authentication.** **Features:** staff.manage_team ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/staff/team-roles" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/staff/team-roles` GET /staff/team-roles Requires features: staff.view **Tags:** Employees **Requires authentication.** **Features:** staff.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/staff/team-roles" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/staff/team-roles` POST /staff/team-roles Requires features: staff.manage_team **Tags:** Employees **Requires authentication.** **Features:** staff.manage_team ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/staff/team-roles" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/staff/team-roles` PUT /staff/team-roles Requires features: staff.manage_team **Tags:** Employees **Requires authentication.** **Features:** staff.manage_team ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/staff/team-roles" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/staff/teams` DELETE /staff/teams Requires features: staff.manage_team **Tags:** Employees **Requires authentication.** **Features:** staff.manage_team ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/staff/teams" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/staff/teams` GET /staff/teams Requires features: staff.view **Tags:** Employees **Requires authentication.** **Features:** staff.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/staff/teams" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/staff/teams` POST /staff/teams Requires features: staff.manage_team **Tags:** Employees **Requires authentication.** **Features:** staff.manage_team ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/staff/teams" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/staff/teams` PUT /staff/teams Requires features: staff.manage_team **Tags:** Employees **Requires authentication.** **Features:** staff.manage_team ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/staff/teams" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/staff/timesheets/my-projects` GET /staff/timesheets/my-projects Requires features: staff.timesheets.view **Tags:** Employees **Requires authentication.** **Features:** staff.timesheets.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/staff/timesheets/my-projects" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/staff/timesheets/my-projects/{projectId}` PATCH /staff/timesheets/my-projects/{projectId} Requires features: staff.timesheets.manage_own **Tags:** Employees **Requires authentication.** **Features:** staff.timesheets.manage_own ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | projectId | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PATCH "https://om.3.74.75.141.nip.io/api/staff/timesheets/my-projects/:projectId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/staff/timesheets/projects/kpis` GET /staff/timesheets/projects/kpis Requires features: staff.timesheets.projects.view **Tags:** Employees **Requires authentication.** **Features:** staff.timesheets.projects.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/staff/timesheets/projects/kpis" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/staff/timesheets/time-entries` DELETE /staff/timesheets/time-entries Requires features: staff.timesheets.manage_own **Tags:** Employees **Requires authentication.** **Features:** staff.timesheets.manage_own ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/staff/timesheets/time-entries" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/staff/timesheets/time-entries` GET /staff/timesheets/time-entries Requires features: staff.timesheets.view **Tags:** Employees **Requires authentication.** **Features:** staff.timesheets.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/staff/timesheets/time-entries" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/staff/timesheets/time-entries` POST /staff/timesheets/time-entries Requires features: staff.timesheets.manage_own **Tags:** Employees **Requires authentication.** **Features:** staff.timesheets.manage_own ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/staff/timesheets/time-entries" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/staff/timesheets/time-entries` PUT /staff/timesheets/time-entries Requires features: staff.timesheets.manage_own **Tags:** Employees **Requires authentication.** **Features:** staff.timesheets.manage_own ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/staff/timesheets/time-entries" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/staff/timesheets/time-entries/{id}/segments` POST /staff/timesheets/time-entries/{id}/segments Requires features: staff.timesheets.manage_own **Tags:** Employees **Requires authentication.** **Features:** staff.timesheets.manage_own ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/staff/timesheets/time-entries/:id/segments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/staff/timesheets/time-entries/{id}/segments/{segmentId}` PATCH /staff/timesheets/time-entries/{id}/segments/{segmentId} Requires features: staff.timesheets.manage_own **Tags:** Employees **Requires authentication.** **Features:** staff.timesheets.manage_own ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | segmentId | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PATCH "https://om.3.74.75.141.nip.io/api/staff/timesheets/time-entries/:id/segments/:segmentId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/staff/timesheets/time-entries/{id}/timer-start` POST /staff/timesheets/time-entries/{id}/timer-start Requires features: staff.timesheets.manage_own **Tags:** Employees **Requires authentication.** **Features:** staff.timesheets.manage_own ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/staff/timesheets/time-entries/:id/timer-start" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/staff/timesheets/time-entries/{id}/timer-stop` POST /staff/timesheets/time-entries/{id}/timer-stop Requires features: staff.timesheets.manage_own **Tags:** Employees **Requires authentication.** **Features:** staff.timesheets.manage_own ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/staff/timesheets/time-entries/:id/timer-stop" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/staff/timesheets/time-entries/bulk` POST /staff/timesheets/time-entries/bulk Requires features: staff.timesheets.manage_own **Tags:** Employees **Requires authentication.** **Features:** staff.timesheets.manage_own ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/staff/timesheets/time-entries/bulk" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/staff/timesheets/time-projects` DELETE /staff/timesheets/time-projects Requires features: staff.timesheets.projects.manage **Tags:** Employees **Requires authentication.** **Features:** staff.timesheets.projects.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/staff/timesheets/time-projects" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/staff/timesheets/time-projects` GET /staff/timesheets/time-projects Requires features: staff.timesheets.projects.view **Tags:** Employees **Requires authentication.** **Features:** staff.timesheets.projects.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/staff/timesheets/time-projects" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/staff/timesheets/time-projects` POST /staff/timesheets/time-projects Requires features: staff.timesheets.projects.manage **Tags:** Employees **Requires authentication.** **Features:** staff.timesheets.projects.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/staff/timesheets/time-projects" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/staff/timesheets/time-projects` PUT /staff/timesheets/time-projects Requires features: staff.timesheets.projects.manage **Tags:** Employees **Requires authentication.** **Features:** staff.timesheets.projects.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/staff/timesheets/time-projects" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/staff/timesheets/time-projects/{id}/employees` DELETE /staff/timesheets/time-projects/{id}/employees Requires features: staff.timesheets.projects.manage **Tags:** Employees **Requires authentication.** **Features:** staff.timesheets.projects.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/staff/timesheets/time-projects/:id/employees" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/staff/timesheets/time-projects/{id}/employees` GET /staff/timesheets/time-projects/{id}/employees Requires features: staff.timesheets.projects.view **Tags:** Employees **Requires authentication.** **Features:** staff.timesheets.projects.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/staff/timesheets/time-projects/:id/employees" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/staff/timesheets/time-projects/{id}/employees` POST /staff/timesheets/time-projects/{id}/employees Requires features: staff.timesheets.projects.manage **Tags:** Employees **Requires authentication.** **Features:** staff.timesheets.projects.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/staff/timesheets/time-projects/:id/employees" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sync_akeneo/custom-fields` GET /sync_akeneo/custom-fields Requires features: data_sync.configure **Tags:** Akeneo Product Sync **Requires authentication.** **Features:** data_sync.configure ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sync_akeneo/custom-fields" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sync_akeneo/custom-fields` POST /sync_akeneo/custom-fields Requires features: data_sync.configure **Tags:** Akeneo Product Sync **Requires authentication.** **Features:** data_sync.configure ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sync_akeneo/custom-fields" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sync_akeneo/delete-products` POST /sync_akeneo/delete-products Requires features: data_sync.configure **Tags:** Akeneo Product Sync **Requires authentication.** **Features:** data_sync.configure ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sync_akeneo/delete-products" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sync_akeneo/discovery` GET /sync_akeneo/discovery Requires features: data_sync.configure **Tags:** Akeneo Product Sync **Requires authentication.** **Features:** data_sync.configure ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sync_akeneo/discovery" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sync_akeneo/first-import` GET /sync_akeneo/first-import Requires features: data_sync.configure **Tags:** Akeneo Product Sync **Requires authentication.** **Features:** data_sync.configure ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sync_akeneo/first-import" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sync_akeneo/first-import` POST /sync_akeneo/first-import Requires features: data_sync.run **Tags:** Akeneo Product Sync **Requires authentication.** **Features:** data_sync.run ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sync_akeneo/first-import" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sync_excel/import` POST /sync_excel/import Requires features: sync_excel.run **Tags:** Excel / CSV Import **Requires authentication.** **Features:** sync_excel.run ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sync_excel/import" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/sync_excel/preview` GET /sync_excel/preview Requires features: sync_excel.view **Tags:** Excel / CSV Import **Requires authentication.** **Features:** sync_excel.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/sync_excel/preview" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/sync_excel/upload` POST /sync_excel/upload Requires features: sync_excel.run **Tags:** Excel / CSV Import **Requires authentication.** **Features:** sync_excel.run ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/sync_excel/upload" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/translations/{entityType}/{entityId}` DELETE /translations/{entityType}/{entityId} Requires features: translations.manage **Tags:** Entity Translations **Requires authentication.** **Features:** translations.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | entityType | path | any | Required | | entityId | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/translations/:entityType/:entityId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/translations/{entityType}/{entityId}` GET /translations/{entityType}/{entityId} Requires features: translations.view **Tags:** Entity Translations **Requires authentication.** **Features:** translations.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | entityType | path | any | Required | | entityId | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/translations/:entityType/:entityId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/translations/{entityType}/{entityId}` PUT /translations/{entityType}/{entityId} Requires features: translations.manage **Tags:** Entity Translations **Requires authentication.** **Features:** translations.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | entityType | path | any | Required | | entityId | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/translations/:entityType/:entityId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/translations/locales` GET /translations/locales **Tags:** Entity Translations ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/translations/locales" \ -H "Accept: application/json" ``` ## PUT `/translations/locales` PUT /translations/locales **Tags:** Entity Translations ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/translations/locales" \ -H "Accept: application/json" ``` ## GET `/version` GET /version **Tags:** API Documentation ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/version" \ -H "Accept: application/json" ``` ## GET `/webhooks` GET /webhooks Requires features: webhooks.view **Tags:** Webhooks **Requires authentication.** **Features:** webhooks.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/webhooks" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/webhooks` POST /webhooks Requires features: webhooks.manage **Tags:** Webhooks **Requires authentication.** **Features:** webhooks.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/webhooks" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/webhooks/{id}` DELETE /webhooks/{id} **Tags:** Webhooks ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/webhooks/:id" \ -H "Accept: application/json" ``` ## GET `/webhooks/{id}` GET /webhooks/{id} **Tags:** Webhooks ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/webhooks/:id" \ -H "Accept: application/json" ``` ## PUT `/webhooks/{id}` PUT /webhooks/{id} **Tags:** Webhooks ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/webhooks/:id" \ -H "Accept: application/json" ``` ## POST `/webhooks/{id}/rotate-secret` POST /webhooks/{id}/rotate-secret **Tags:** Webhooks ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/webhooks/:id/rotate-secret" \ -H "Accept: application/json" ``` ## POST `/webhooks/{id}/test` POST /webhooks/{id}/test **Tags:** Webhooks ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/webhooks/:id/test" \ -H "Accept: application/json" ``` ## GET `/webhooks/deliveries` GET /webhooks/deliveries **Tags:** Webhooks ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/webhooks/deliveries" \ -H "Accept: application/json" ``` ## GET `/webhooks/deliveries/{id}` GET /webhooks/deliveries/{id} **Tags:** Webhooks ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/webhooks/deliveries/:id" \ -H "Accept: application/json" ``` ## POST `/webhooks/deliveries/{id}/retry` POST /webhooks/deliveries/{id}/retry **Tags:** Webhooks ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/webhooks/deliveries/:id/retry" \ -H "Accept: application/json" ``` ## GET `/webhooks/events` GET /webhooks/events Requires features: webhooks.view **Tags:** Webhooks **Requires authentication.** **Features:** webhooks.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/webhooks/events" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/webhooks/inbound/{endpointId}` POST /webhooks/inbound/{endpointId} **Tags:** Webhooks ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | endpointId | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/webhooks/inbound/:endpointId" \ -H "Accept: application/json" ``` ## GET `/webhooks/webhook-deliveries` GET /webhooks/webhook-deliveries Requires features: webhooks.view **Tags:** Webhooks **Requires authentication.** **Features:** webhooks.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/webhooks/webhook-deliveries" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/webhooks/webhook-deliveries/{id}` GET /webhooks/webhook-deliveries/{id} Requires features: webhooks.view **Tags:** Webhooks **Requires authentication.** **Features:** webhooks.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/webhooks/webhook-deliveries/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/webhooks/webhook-deliveries/{id}/retry` POST /webhooks/webhook-deliveries/{id}/retry Requires features: webhooks.manage **Tags:** Webhooks **Requires authentication.** **Features:** webhooks.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/webhooks/webhook-deliveries/:id/retry" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/webhooks/webhooks` DELETE /webhooks/webhooks Requires features: webhooks.manage **Tags:** Webhooks **Requires authentication.** **Features:** webhooks.manage ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/webhooks/webhooks" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/webhooks/webhooks` GET /webhooks/webhooks Requires features: webhooks.view **Tags:** Webhooks **Requires authentication.** **Features:** webhooks.view ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/webhooks/webhooks" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/webhooks/webhooks` POST /webhooks/webhooks Requires features: webhooks.manage **Tags:** Webhooks **Requires authentication.** **Features:** webhooks.manage ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/webhooks/webhooks" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/webhooks/webhooks` PUT /webhooks/webhooks Requires features: webhooks.manage **Tags:** Webhooks **Requires authentication.** **Features:** webhooks.manage ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/webhooks/webhooks" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/webhooks/webhooks/{id}` DELETE /webhooks/webhooks/{id} Requires features: webhooks.manage **Tags:** Webhooks **Requires authentication.** **Features:** webhooks.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/webhooks/webhooks/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/webhooks/webhooks/{id}` GET /webhooks/webhooks/{id} Requires features: webhooks.view **Tags:** Webhooks **Requires authentication.** **Features:** webhooks.view ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/webhooks/webhooks/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/webhooks/webhooks/{id}` PUT /webhooks/webhooks/{id} Requires features: webhooks.manage **Tags:** Webhooks **Requires authentication.** **Features:** webhooks.manage ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/webhooks/webhooks/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/webhooks/webhooks/{id}/rotate-secret` POST /webhooks/webhooks/{id}/rotate-secret Requires features: webhooks.secrets **Tags:** Webhooks **Requires authentication.** **Features:** webhooks.secrets ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/webhooks/webhooks/:id/rotate-secret" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/webhooks/webhooks/{id}/test` POST /webhooks/webhooks/{id}/test Requires features: webhooks.test **Tags:** Webhooks **Requires authentication.** **Features:** webhooks.test ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/webhooks/webhooks/:id/test" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/workflows/definitions` GET /workflows/definitions **Tags:** Workflow Engine ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/workflows/definitions" \ -H "Accept: application/json" ``` ## POST `/workflows/definitions` POST /workflows/definitions **Tags:** Workflow Engine ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/workflows/definitions" \ -H "Accept: application/json" ``` ## DELETE `/workflows/definitions/{id}` DELETE /workflows/definitions/{id} **Tags:** Workflow Engine ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://om.3.74.75.141.nip.io/api/workflows/definitions/:id" \ -H "Accept: application/json" ``` ## GET `/workflows/definitions/{id}` GET /workflows/definitions/{id} **Tags:** Workflow Engine ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/workflows/definitions/:id" \ -H "Accept: application/json" ``` ## PUT `/workflows/definitions/{id}` PUT /workflows/definitions/{id} **Tags:** Workflow Engine ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://om.3.74.75.141.nip.io/api/workflows/definitions/:id" \ -H "Accept: application/json" ``` ## POST `/workflows/definitions/{id}/customize` POST /workflows/definitions/{id}/customize **Tags:** Workflow Engine ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/workflows/definitions/:id/customize" \ -H "Accept: application/json" ``` ## POST `/workflows/definitions/{id}/reset-to-code` POST /workflows/definitions/{id}/reset-to-code **Tags:** Workflow Engine ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/workflows/definitions/:id/reset-to-code" \ -H "Accept: application/json" ``` ## GET `/workflows/events` GET /workflows/events **Tags:** Workflow Engine ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/workflows/events" \ -H "Accept: application/json" ``` ## GET `/workflows/events/{id}` GET /workflows/events/{id} **Tags:** Workflow Engine ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/workflows/events/:id" \ -H "Accept: application/json" ``` ## GET `/workflows/instances` GET /workflows/instances **Tags:** Workflow Engine ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/workflows/instances" \ -H "Accept: application/json" ``` ## POST `/workflows/instances` POST /workflows/instances **Tags:** Workflow Engine ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/workflows/instances" \ -H "Accept: application/json" ``` ## GET `/workflows/instances/{id}` GET /workflows/instances/{id} **Tags:** Workflow Engine ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/workflows/instances/:id" \ -H "Accept: application/json" ``` ## POST `/workflows/instances/{id}/advance` POST /workflows/instances/{id}/advance **Tags:** Workflow Engine ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/workflows/instances/:id/advance" \ -H "Accept: application/json" ``` ## POST `/workflows/instances/{id}/cancel` POST /workflows/instances/{id}/cancel **Tags:** Workflow Engine ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/workflows/instances/:id/cancel" \ -H "Accept: application/json" ``` ## GET `/workflows/instances/{id}/events` GET /workflows/instances/{id}/events **Tags:** Workflow Engine ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/workflows/instances/:id/events" \ -H "Accept: application/json" ``` ## POST `/workflows/instances/{id}/retry` POST /workflows/instances/{id}/retry **Tags:** Workflow Engine ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/workflows/instances/:id/retry" \ -H "Accept: application/json" ``` ## POST `/workflows/instances/{id}/signal` POST /workflows/instances/{id}/signal **Tags:** Workflow Engine ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/workflows/instances/:id/signal" \ -H "Accept: application/json" ``` ## POST `/workflows/instances/validate-start` POST /workflows/instances/validate-start **Tags:** Workflow Engine ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/workflows/instances/validate-start" \ -H "Accept: application/json" ``` ## POST `/workflows/signals` POST /workflows/signals **Tags:** Workflow Engine ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/workflows/signals" \ -H "Accept: application/json" ``` ## GET `/workflows/tasks` GET /workflows/tasks **Tags:** Workflow Engine ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/workflows/tasks" \ -H "Accept: application/json" ``` ## GET `/workflows/tasks/{id}` GET /workflows/tasks/{id} **Tags:** Workflow Engine ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://om.3.74.75.141.nip.io/api/workflows/tasks/:id" \ -H "Accept: application/json" ``` ## POST `/workflows/tasks/{id}/claim` POST /workflows/tasks/{id}/claim **Tags:** Workflow Engine ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/workflows/tasks/:id/claim" \ -H "Accept: application/json" ``` ## POST `/workflows/tasks/{id}/complete` POST /workflows/tasks/{id}/complete **Tags:** Workflow Engine ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://om.3.74.75.141.nip.io/api/workflows/tasks/:id/complete" \ -H "Accept: application/json" ```