cyberwave.rest.CRMApi
All URIs are relative to http://localhost| Method | HTTP request | Description |
|---|---|---|
| src_app_api_crm_create_opportunity | POST /api/v1/crm | Create Opportunity |
| src_app_api_crm_delete_opportunity | DELETE /api/v1/crm/{uuid} | Delete Opportunity |
| src_app_api_crm_get_opportunity | GET /api/v1/crm/{uuid} | Get Opportunity |
| src_app_api_crm_get_pipeline_config | GET /api/v1/crm/pipeline-config | Get Pipeline Config |
| src_app_api_crm_get_workspace_users | GET /api/v1/crm/workspace/{workspace_uuid}/users | Get Workspace Users |
| src_app_api_crm_list_opportunities | GET /api/v1/crm | List Opportunities |
| src_app_api_crm_update_opportunity | PUT /api/v1/crm/{uuid} | Update Opportunity |
src_app_api_crm_create_opportunity
OpportunitySchema src_app_api_crm_create_opportunity(opportunity_create_schema)Create Opportunity Create a new opportunity.
Example
- Api Key Authentication (CustomTokenAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| opportunity_create_schema | OpportunityCreateSchema |
Return type
OpportunitySchemaAuthorization
CustomTokenAuthenticationHTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
src_app_api_crm_delete_opportunity
src_app_api_crm_delete_opportunity(uuid)Delete Opportunity Soft delete an opportunity.
Example
- Api Key Authentication (CustomTokenAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| uuid | str |
Return type
void (empty response body)Authorization
CustomTokenAuthenticationHTTP request headers
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
src_app_api_crm_get_opportunity
OpportunitySchema src_app_api_crm_get_opportunity(uuid)Get Opportunity Get a specific opportunity by UUID.
Example
- Api Key Authentication (CustomTokenAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| uuid | str |
Return type
OpportunitySchemaAuthorization
CustomTokenAuthenticationHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
src_app_api_crm_get_pipeline_config
PipelineConfigSchema src_app_api_crm_get_pipeline_config()Get Pipeline Config Get the pipeline stages configuration for all opportunity types.
Example
Parameters
This endpoint does not need any parameter.Return type
PipelineConfigSchemaAuthorization
No authorization requiredHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
src_app_api_crm_get_workspace_users
List[WorkspaceUsersSchema] src_app_api_crm_get_workspace_users(workspace_uuid)Get Workspace Users Get all users in a workspace for assignment dropdowns.
Example
- Api Key Authentication (CustomTokenAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| workspace_uuid | str |
Return type
List[WorkspaceUsersSchema]Authorization
CustomTokenAuthenticationHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
src_app_api_crm_list_opportunities
List[OpportunitySchema] src_app_api_crm_list_opportunities(opportunity_type=opportunity_type, year=year, is_archived=is_archived, workspace_uuid=workspace_uuid)List Opportunities List all opportunities for workspaces the user belongs to. Query params:
- opportunity_type: Filter by type (commercial, partnership, vendor, asset)
- year: Filter by year (e.g., 2026)
- is_archived: Filter by archived status (true/false). Defaults to false if not specified.
- workspace_uuid: Filter by specific workspace
Example
- Api Key Authentication (CustomTokenAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| opportunity_type | str | [optional] | |
| year | int | [optional] | |
| is_archived | bool | [optional] | |
| workspace_uuid | str | [optional] |
Return type
List[OpportunitySchema]Authorization
CustomTokenAuthenticationHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
src_app_api_crm_update_opportunity
OpportunitySchema src_app_api_crm_update_opportunity(uuid, opportunity_update_schema)Update Opportunity Update an existing opportunity.
Example
- Api Key Authentication (CustomTokenAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| uuid | str | ||
| opportunity_update_schema | OpportunityUpdateSchema |
Return type
OpportunitySchemaAuthorization
CustomTokenAuthenticationHTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |