{ "openapi": "3.0.3", "info": { "title": "Projetly API", "version": "1.0.0", "description": "REST API documentation for Projetly" }, "servers": [ { "url": "https://api.app.projetly.io" } ], "paths": { "/api/account/info/": { "get": { "operationId": "account_info_list", "description": "This endpoint is used to fetch all accounts in the current organization", "summary": "All Accounts", "parameters": [ { "in": "query", "name": "items_per_page", "schema": { "type": "integer" }, "description": "Items Per Page", "required": true }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "description": "Page Number", "required": true }, { "in": "query", "name": "reverse", "schema": { "type": "boolean" }, "description": "Sorting Order" }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "description": "Sorting Key" } ], "tags": [ "Accounts" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountInfo" } } } }, "description": "" } } }, "post": { "operationId": "account_info_create", "description": "This endpoint is used to save a new account for the current organization", "summary": "Creates a new account", "tags": [ "Accounts" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "CreateANewAccount": { "value": { "name": "Slack", "description": "A cloud based team communication platform", "account_owner": { "name": "Shyam", "id": "123" }, "link_projects": [ { "project": "Creation of ticket", "project_id": "PR123" }, { "project": "Creation of request", "project_id": "PR124" } ], "health_score": 10, "total_revenue": 10000, "logo_path": "" }, "summary": "Create a new Account" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "201": { "description": "No response body" } } } }, "/api/account/info/{id}/": { "get": { "operationId": "account_info_retrieve", "description": "This endpoint is used to fetch a account details for the current organization", "summary": "Gets a account with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Accounts" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountInfo" } } }, "description": "" } } }, "put": { "operationId": "account_info_update", "description": "This endpoint is used to edit an account for the current organization", "summary": "Edits the account with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Accounts" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "EditsAnExistingAccount": { "value": { "name": "Slack", "description": "A cloud based team communication platform for enterprises" }, "summary": "Edits an existing Account" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "account_info_destroy", "description": "This endpoint is used to delete an account for the current organization", "summary": "Deletes the account with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Accounts" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/api/account/info/all-accounts/": { "get": { "operationId": "account_info_all_accounts_retrieve", "description": "API endpoint that allows accounts to be created, viewed, deleted or edited.", "tags": [ "Accounts" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountInfo" } } }, "description": "" } } } }, "/api/account/info/del_vertical/": { "post": { "operationId": "account_info_del_vertical_create", "description": "API endpoint that allows accounts to be created, viewed, deleted or edited.", "tags": [ "Accounts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountInfo" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AccountInfo" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AccountInfo" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountInfo" } } }, "description": "" } } } }, "/api/account/info/journey/": { "get": { "operationId": "account_info_journey_retrieve", "description": "API endpoint that allows accounts to be created, viewed, deleted or edited.", "tags": [ "Accounts" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountInfo" } } }, "description": "" } } } }, "/api/account/info/more-activities/": { "get": { "operationId": "account_info_more_activities_retrieve", "description": "API endpoint that allows accounts to be created, viewed, deleted or edited.", "tags": [ "Accounts" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountInfo" } } }, "description": "" } } } }, "/api/account/info/options/": { "get": { "operationId": "account_info_options_retrieve", "description": "API endpoint that allows accounts to be created, viewed, deleted or edited.", "tags": [ "Accounts" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountInfo" } } }, "description": "" } } } }, "/api/account/info/overview/{id}/": { "get": { "operationId": "account_info_overview_retrieve", "description": "API endpoint that allows accounts to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "Accounts" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountInfo" } } }, "description": "" } } } }, "/api/account/info/vertical/": { "post": { "operationId": "account_info_vertical_create", "description": "API endpoint that allows accounts to be created, viewed, deleted or edited.", "tags": [ "Accounts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountInfo" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AccountInfo" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AccountInfo" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountInfo" } } }, "description": "" } } } }, "/api/activity/log/": { "get": { "operationId": "activity_log_list", "description": "API endpoint that allows activity logs to be created, viewed or edited.", "tags": [ "Activity Logs" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityLog" } } } }, "description": "" } } }, "post": { "operationId": "activity_log_create", "description": "API endpoint that allows activity logs to be created, viewed or edited.", "tags": [ "Activity Logs" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityLog" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ActivityLog" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ActivityLog" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityLog" } } }, "description": "" } } } }, "/api/activity/log/{id}/": { "get": { "operationId": "activity_log_retrieve", "description": "API endpoint that allows activity logs to be created, viewed or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Activity Logs" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityLog" } } }, "description": "" } } } }, "/api/activity/log/{module_id}/{reference_id}/": { "get": { "operationId": "activity_log_retrieve_2", "description": "This endpoint is used to fetch an activity log for the current organization", "summary": "Gets the activity log with the given id", "parameters": [ { "in": "path", "name": "module_id", "schema": { "type": "string", "pattern": "^\\w+$" }, "required": true }, { "in": "path", "name": "reference_id", "schema": { "type": "string", "pattern": "^\\w+$" }, "required": true } ], "tags": [ "Activity Logs" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityLog" } } }, "description": "" } } } }, "/api/activity/log/track/": { "post": { "operationId": "activity_log_track_create", "description": "Submit engagement tracking event. Set is_encrypted=True when Angular encrypts sensitive fields (user_obj.email, recipient_email).", "summary": "Track engagement (encrypted)", "tags": [ "Activity Logs" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "201": { "description": "No response body" }, "500": { "description": "No response body" } } } }, "/api/calendar/info/": { "get": { "operationId": "calendar_info_list", "description": "This endpoint is used to fetch all notifications in the current organization", "summary": "All Notifications", "parameters": [ { "in": "query", "name": "items_per_page", "schema": { "type": "integer" }, "description": "Items Per Page", "required": true }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "description": "Page Number", "required": true }, { "in": "query", "name": "reverse", "schema": { "type": "boolean" }, "description": "Sorting Order" }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "description": "Sorting Key" } ], "tags": [ "Calendar" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjetlyCalendar" } } } }, "description": "" } } }, "post": { "operationId": "calendar_info_create", "description": "This endpoint is used to save a new item for the current organization", "summary": "Creates a new item", "tags": [ "Calendar" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "CreateANewItem": { "summary": "Create a new Item" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "201": { "description": "No response body" } } } }, "/api/calendar/info/{id}/": { "get": { "operationId": "calendar_info_retrieve", "description": "This endpoint is used to fetch a meeting detail for the current organization", "summary": "Gets a meeting with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Calendar" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjetlyCalendar" } } }, "description": "" } } }, "put": { "operationId": "calendar_info_update", "description": "API endpoint that allows meeting calendar to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Calendar" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjetlyCalendar" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ProjetlyCalendar" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ProjetlyCalendar" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjetlyCalendar" } } }, "description": "" } } }, "delete": { "operationId": "calendar_info_destroy", "description": "This endpoint is used to delete an meeting for the current organization", "summary": "Deletes the meeting with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Calendar" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/api/calendar/info/options/": { "get": { "operationId": "calendar_info_options_retrieve", "description": "API endpoint that allows meeting calendar to be created, viewed, deleted or edited.", "tags": [ "Calendar" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjetlyCalendar" } } }, "description": "" } } } }, "/api/calendar/info/source-ref/": { "get": { "operationId": "calendar_info_source_ref_retrieve", "description": "This endpoint is used to fetch a meeting detail for the current organization by external source_ref_id", "summary": "Gets a meeting with the given source_ref_id", "parameters": [ { "in": "query", "name": "source_ref_id", "schema": { "type": "string" }, "description": "External event reference id", "required": true } ], "tags": [ "Calendar" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjetlyCalendar" } } }, "description": "" } } } }, "/api/calendar/insight/": { "get": { "operationId": "calendar_insight_list", "description": "This endpoint is used to fetch all meeting insights for the current organization", "summary": "Gets all meeting insights", "tags": [ "Meeting Insights" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MeetingInsights" } } } }, "description": "" } } }, "post": { "operationId": "calendar_insight_create", "description": "This endpoint is used to save a new meeting insight for the current organization", "summary": "Saves a new meeting insight", "tags": [ "Meeting Insights" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeetingInsights" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MeetingInsights" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MeetingInsights" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeetingInsights" } } }, "description": "" } } } }, "/api/calendar/insight/{id}/": { "get": { "operationId": "calendar_insight_retrieve", "description": "This endpoint is used to fetch a meeting insight for the current organization", "summary": "Gets a meeting insight with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Meeting Insights" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeetingInsights" } } }, "description": "" } } }, "put": { "operationId": "calendar_insight_update", "description": "API endpoint that allows meeting insights to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Meeting Insights" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeetingInsights" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MeetingInsights" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MeetingInsights" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeetingInsights" } } }, "description": "" } } }, "delete": { "operationId": "calendar_insight_destroy", "description": "API endpoint that allows meeting insights to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Meeting Insights" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/api/calendar/insight/email/": { "post": { "operationId": "calendar_insight_email_create", "description": "API endpoint that allows meeting insights to be created, viewed, deleted or edited.", "tags": [ "Meeting Insights" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeetingInsights" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MeetingInsights" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MeetingInsights" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeetingInsights" } } }, "description": "" } } } }, "/api/calendar/insight/favorite/": { "post": { "operationId": "calendar_insight_favorite_create", "description": "API endpoint that allows meeting insights to be created, viewed, deleted or edited.", "tags": [ "Meeting Insights" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeetingInsights" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MeetingInsights" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MeetingInsights" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeetingInsights" } } }, "description": "" } } } }, "/api/calendar/insight/mom_sent/": { "get": { "operationId": "calendar_insight_mom_sent_retrieve", "description": "API endpoint that allows meeting insights to be created, viewed, deleted or edited.", "tags": [ "Meeting Insights" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeetingInsights" } } }, "description": "" } } } }, "/api/calendar/insight/transcript/": { "get": { "operationId": "calendar_insight_transcript_retrieve", "description": "API endpoint that allows meeting insights to be created, viewed, deleted or edited.", "tags": [ "Meeting Insights" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeetingInsights" } } }, "description": "" } } } }, "/api/company/": { "get": { "operationId": "company_list", "description": "This endpoint is used to fetch all companies in the current organization", "summary": "All Companies", "parameters": [ { "in": "query", "name": "items_per_page", "schema": { "type": "integer" }, "description": "Items Per Page", "required": true }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "description": "Page Number", "required": true }, { "in": "query", "name": "reverse", "schema": { "type": "boolean" }, "description": "Sorting Order" }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "description": "Sorting Key" } ], "tags": [ "Companies" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyList" } } } }, "description": "" } } }, "post": { "operationId": "company_create", "description": "This endpoint is used to save a new company for the current organization", "summary": "Creates a new company", "tags": [ "Companies" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "CreateANewCompany": { "value": { "company_name": "Acme Corporation", "domain": "acme.com" }, "summary": "Create a new Company" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/company/{id}/": { "get": { "operationId": "company_retrieve", "description": "This endpoint is used to fetch a company details for the current organization", "summary": "Gets a company with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Companies" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyList" } } }, "description": "" } } }, "put": { "operationId": "company_update", "description": "This endpoint is used to edit a company for the current organization", "summary": "Edits the company with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Companies" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "EditsAnExistingCompany": { "value": { "company_id": "existing_company_id", "company_name": "Acme Corp Updated" }, "summary": "Edits an existing Company" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "company_destroy", "description": "This endpoint is used to delete a company for the current organization", "summary": "Deletes the company with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Companies" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/api/company/{id}/completed-meetings/": { "get": { "operationId": "company_completed_meetings_retrieve", "description": "Returns completed meetings (start <= now) for a company, paginated by start time descending.", "summary": "Get completed meetings for a company", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Companies" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyList" } } }, "description": "" } } } }, "/api/company/{id}/contacts/": { "get": { "operationId": "company_contacts_retrieve", "description": "This endpoint returns all contacts belonging to a given company", "summary": "Get contacts for a company", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "items_per_page", "schema": { "type": "integer" }, "description": "Items Per Page" }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "description": "Page Number" } ], "tags": [ "Companies" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyList" } } }, "description": "" } } } }, "/api/company/{id}/contacts-for-invite/": { "get": { "operationId": "company_contacts_for_invite_retrieve", "description": "Returns contacts of a company that are not yet linked to a customer user. Used for the Add Contact flow when inviting customers to a project.", "summary": "Get uninvited contacts for a company", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "items_per_page", "schema": { "type": "integer" }, "description": "Items Per Page" }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "description": "Page Number" } ], "tags": [ "Companies" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyList" } } }, "description": "" } } } }, "/api/company/{id}/deals/": { "get": { "operationId": "company_deals_retrieve", "description": "This endpoint returns deals belonging to a given company.", "summary": "Get deals for a company", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "next_cursor", "schema": { "type": "string" }, "description": "Cursor for next page" }, { "in": "query", "name": "page_size", "schema": { "type": "integer" }, "description": "Items Per Page" } ], "tags": [ "Companies" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyList" } } }, "description": "" } } } }, "/api/company/{id}/projects/": { "get": { "operationId": "company_projects_retrieve", "description": "This endpoint returns projects belonging to a given company.", "summary": "Get projects for a company", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "next_cursor", "schema": { "type": "string" }, "description": "Cursor for next page" }, { "in": "query", "name": "page_size", "schema": { "type": "integer" }, "description": "Items Per Page" } ], "tags": [ "Companies" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyList" } } }, "description": "" } } } }, "/api/company/{id}/tasks/": { "get": { "operationId": "company_tasks_retrieve", "description": "This endpoint returns tasks belonging to the account linked to a given company.", "summary": "Get tasks for a company", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "next_cursor", "schema": { "type": "string" }, "description": "Cursor for next page" }, { "in": "query", "name": "page_size", "schema": { "type": "integer" }, "description": "Items Per Page" } ], "tags": [ "Companies" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyList" } } }, "description": "" } } } }, "/api/company/{id}/upcoming-meetings/": { "get": { "operationId": "company_upcoming_meetings_retrieve", "description": "Returns upcoming meetings (start > now) for a company, paginated by start time ascending.", "summary": "Get upcoming meetings for a company", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Companies" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyList" } } }, "description": "" } } } }, "/api/company/activities/": { "get": { "operationId": "company_activities_retrieve", "description": "Returns all activities for the company id given", "summary": "Company Activities for a company", "tags": [ "Companies" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/company/bulk-delete/": { "post": { "operationId": "company_bulk_delete_create", "description": "Bulk delete companies by their IDs", "summary": "Bulk delete companies", "tags": [ "Companies" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/company/bulk-publish/": { "post": { "operationId": "company_bulk_publish_create", "description": "Publish multiple companies by setting is_draft=False", "summary": "Bulk publish companies", "tags": [ "Companies" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/company/category/": { "post": { "operationId": "company_category_create", "description": "This endpoint is used to update the name of a company category", "summary": "Updates a company category name", "tags": [ "Companies" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "UpdateCompanyCategoryName": { "value": { "value": "crm", "name": "Updated Category Name" }, "summary": "Update Company Category Name" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/company/del_category/": { "post": { "operationId": "company_del_category_create", "description": "This endpoint is used to delete a company category", "summary": "Deletes a company category", "tags": [ "Companies" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "DeleteCompanyCategory": { "value": { "value": "crm" }, "summary": "Delete Company Category" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/company/field-config/": { "get": { "operationId": "company_field_config_retrieve", "description": "Get or save custom field definitions for companies", "summary": "Company field config", "tags": [ "Companies" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "put": { "operationId": "company_field_config_update", "description": "Get or save custom field definitions for companies", "summary": "Company field config", "tags": [ "Companies" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/company/import/": { "post": { "operationId": "company_import_create", "description": "This endpoint is used to bulk import companies from a CSV-parsed array", "summary": "Bulk import companies", "tags": [ "Companies" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/company/options/": { "get": { "operationId": "company_options_retrieve", "description": "Returns all dropdown options for the company form including org verticals", "summary": "Company form options", "tags": [ "Companies" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/contact/": { "get": { "operationId": "contact_list", "description": "This endpoint is used to fetch all contacts in the current organization", "summary": "All Contacts", "parameters": [ { "in": "query", "name": "items_per_page", "schema": { "type": "integer" }, "description": "Items Per Page", "required": true }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "description": "Page Number", "required": true }, { "in": "query", "name": "reverse", "schema": { "type": "boolean" }, "description": "Sorting Order" }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "description": "Sorting Key" } ], "tags": [ "Contacts" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactList" } } } }, "description": "" } } }, "post": { "operationId": "contact_create", "description": "This endpoint is used to save a new contact for the current organization", "summary": "Creates a new contact", "tags": [ "Contacts" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "CreateANewContact": { "value": { "full_name": "John Doe", "primary_email": "john.doe@example.com" }, "summary": "Create a new Contact" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/contact/{id}/": { "get": { "operationId": "contact_retrieve", "description": "This endpoint is used to fetch a contact details for the current organization", "summary": "Gets a contact with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Contacts" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactList" } } }, "description": "" } } }, "put": { "operationId": "contact_update", "description": "This endpoint is used to edit a contact for the current organization", "summary": "Edits the contact with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Contacts" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "EditsAnExistingContact": { "value": { "contact_id": "existing_contact_id", "full_name": "John Doe", "primary_email": "john.doe.updated@example.com" }, "summary": "Edits an existing Contact" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "contact_destroy", "description": "This endpoint is used to delete a contact for the current organization", "summary": "Deletes the contact with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Contacts" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/api/contact/{id}/completed-meetings/": { "get": { "operationId": "contact_completed_meetings_retrieve", "description": "Returns completed meetings (start <= now) a contact is part of, paginated by start time descending.", "summary": "Get completed meetings for a contact", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Contacts" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactList" } } }, "description": "" } } } }, "/api/contact/{id}/deals/": { "get": { "operationId": "contact_deals_retrieve", "description": "This endpoint returns deals for a given contact based on their visibility.", "summary": "Get deals for a contact", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "next_cursor", "schema": { "type": "string" }, "description": "Cursor for next page" }, { "in": "query", "name": "page_size", "schema": { "type": "integer" }, "description": "Items Per Page" } ], "tags": [ "Contacts" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactList" } } }, "description": "" } } } }, "/api/contact/{id}/projects/": { "get": { "operationId": "contact_projects_retrieve", "description": "This endpoint returns projects for a given contact based on their visibility.", "summary": "Get projects for a contact", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "next_cursor", "schema": { "type": "string" }, "description": "Cursor for next page" }, { "in": "query", "name": "page_size", "schema": { "type": "integer" }, "description": "Items Per Page" } ], "tags": [ "Contacts" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactList" } } }, "description": "" } } } }, "/api/contact/{id}/tasks/": { "get": { "operationId": "contact_tasks_retrieve", "description": "This endpoint returns tasks assigned to or owned by a given contact.", "summary": "Get tasks for a contact", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "page_size", "schema": { "type": "integer" }, "description": "Items Per Page" } ], "tags": [ "Contacts" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactList" } } }, "description": "" } } } }, "/api/contact/{id}/upcoming-meetings/": { "get": { "operationId": "contact_upcoming_meetings_retrieve", "description": "Returns upcoming meetings (start > now) a contact is part of, paginated by start time ascending.", "summary": "Get upcoming meetings for a contact", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Contacts" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactList" } } }, "description": "" } } } }, "/api/contact/activities/": { "get": { "operationId": "contact_activities_retrieve", "description": "Returns all activities for the contact id given", "summary": "Activities for a Contact", "tags": [ "Contacts" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/contact/bulk-delete/": { "post": { "operationId": "contact_bulk_delete_create", "description": "Bulk delete contacts by their IDs", "summary": "Bulk delete contacts", "tags": [ "Contacts" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/contact/bulk-publish/": { "post": { "operationId": "contact_bulk_publish_create", "description": "Publish multiple contacts by setting is_draft=False", "summary": "Bulk publish contacts", "tags": [ "Contacts" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/contact/del_department/": { "post": { "operationId": "contact_del_department_create", "description": "API endpoint that allows contacts to be created, viewed, deleted or edited.", "tags": [ "Contacts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactList" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ContactList" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ContactList" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactList" } } }, "description": "" } } } }, "/api/contact/del_seniority_level/": { "post": { "operationId": "contact_del_seniority_level_create", "description": "API endpoint that allows contacts to be created, viewed, deleted or edited.", "tags": [ "Contacts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactList" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ContactList" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ContactList" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactList" } } }, "description": "" } } } }, "/api/contact/department/": { "post": { "operationId": "contact_department_create", "description": "API endpoint that allows contacts to be created, viewed, deleted or edited.", "tags": [ "Contacts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactList" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ContactList" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ContactList" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactList" } } }, "description": "" } } } }, "/api/contact/dropdown/": { "post": { "operationId": "contact_dropdown_create", "description": "API endpoint that allows contacts to be created, viewed, deleted or edited.", "tags": [ "Contacts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactList" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ContactList" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ContactList" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactList" } } }, "description": "" } } } }, "/api/contact/field-config/": { "get": { "operationId": "contact_field_config_retrieve", "description": "Get or save custom field definitions for contacts", "summary": "Contact field config", "tags": [ "Contacts" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "put": { "operationId": "contact_field_config_update", "description": "Get or save custom field definitions for contacts", "summary": "Contact field config", "tags": [ "Contacts" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/contact/import/": { "post": { "operationId": "contact_import_create", "description": "Bulk import contacts from a parsed + mapped CSV array", "summary": "Import contacts from CSV", "tags": [ "Contacts" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/contact/options/": { "get": { "operationId": "contact_options_retrieve", "description": "Returns all dropdown options for the contact form", "summary": "Contact form options", "tags": [ "Contacts" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/contact/seniority-level/": { "post": { "operationId": "contact_seniority_level_create", "description": "API endpoint that allows contacts to be created, viewed, deleted or edited.", "tags": [ "Contacts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactList" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ContactList" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ContactList" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactList" } } }, "description": "" } } } }, "/api/dashboards/info/": { "get": { "operationId": "dashboards_info_list", "description": "API endpoint for dashboard operations", "tags": [ "Dashboards" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Dashboard" } } } }, "description": "" } } }, "post": { "operationId": "dashboards_info_create", "description": "API endpoint for dashboard operations", "tags": [ "Dashboards" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Dashboard" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Dashboard" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } } }, "description": "" } } } }, "/api/dashboards/info/{id}/": { "get": { "operationId": "dashboards_info_retrieve", "description": "API endpoint for dashboard operations", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Dashboards" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } } }, "description": "" } } }, "put": { "operationId": "dashboards_info_update", "description": "API endpoint for dashboard operations", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Dashboards" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Dashboard" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Dashboard" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } } }, "description": "" } } }, "patch": { "operationId": "dashboards_info_partial_update", "description": "API endpoint for dashboard operations", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Dashboards" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedDashboard" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedDashboard" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedDashboard" } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } } }, "description": "" } } }, "delete": { "operationId": "dashboards_info_destroy", "description": "API endpoint for dashboard operations", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Dashboards" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/api/dashboards/info/customer-activity/": { "get": { "operationId": "dashboards_info_customer_activity_retrieve", "description": "Get customer activity heatmap data", "summary": "Get customer activity heatmap data", "parameters": [ { "in": "query", "name": "project_ids", "schema": { "type": "string" }, "description": "Comma-separated project IDs to filter" }, { "in": "query", "name": "time_range", "schema": { "type": "string", "enum": [ "all_time", "last_30_days", "last_7_days", "last_90_days" ], "default": "last_30_days" }, "description": "Time range for activity calculation" } ], "tags": [ "Dashboards" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {}, "description": "Unspecified response body" } } }, "description": "" } } } }, "/api/dashboards/info/customer-activity-detail/": { "get": { "operationId": "dashboards_info_customer_activity_detail_retrieve", "description": "Get detailed user list for specific project and idle bucket", "summary": "Get customer activity details for specific project and bucket", "parameters": [ { "in": "query", "name": "idle_bucket", "schema": { "type": "string" }, "description": "Idle bucket (3, 5, 7, 10, 15, 20, 25, 30+)", "required": true }, { "in": "query", "name": "project_id", "schema": { "type": "string" }, "description": "Project ID", "required": true } ], "tags": [ "Dashboards" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {}, "description": "Unspecified response body" } } }, "description": "" } } } }, "/api/dashboards/info/deals/": { "get": { "operationId": "dashboards_info_deals_retrieve", "description": "Get deals dashboard data", "summary": "Get deals dashboard data", "parameters": [ { "in": "query", "name": "force_refresh", "schema": { "type": "boolean" }, "description": "Force refresh cache" }, { "in": "query", "name": "time_filter", "schema": { "type": "string", "enum": [ "last_30_days", "last_7_days", "last_90_days", "this_month", "this_week" ] }, "description": "Time filter (last_7_days, last_30_days, last_90_days)" } ], "tags": [ "Dashboards" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {}, "description": "Unspecified response body" } } }, "description": "" } } } }, "/api/dashboards/info/default-tab/": { "get": { "operationId": "dashboards_info_default_tab_retrieve", "description": "Get user's default dashboard tab preference", "summary": "Get default dashboard tab preference", "tags": [ "Dashboards" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {}, "description": "Unspecified response body" } } }, "description": "" } } } }, "/api/dashboards/info/projects/": { "get": { "operationId": "dashboards_info_projects_retrieve", "description": "Get projects dashboard data", "summary": "Get projects dashboard data", "parameters": [ { "in": "query", "name": "force_refresh", "schema": { "type": "boolean" }, "description": "Force refresh cache" }, { "in": "query", "name": "time_filter", "schema": { "type": "string", "enum": [ "last_30_days", "last_7_days", "last_90_days", "this_month", "this_week" ] }, "description": "Time filter (last_7_days, last_30_days, last_90_days)" } ], "tags": [ "Dashboards" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {}, "description": "Unspecified response body" } } }, "description": "" } } } }, "/api/dashboards/info/save-default-tab/": { "post": { "operationId": "dashboards_info_save_default_tab_create", "description": "Save user's default dashboard tab preference", "summary": "Save default dashboard tab preference", "tags": [ "Dashboards" ], "requestBody": { "content": { "type": { "schema": { "type": "object", "additionalProperties": {}, "description": "Unspecified request body" } }, "properties": { "schema": { "default_tab": { "type": "string", "enum": [ "deals", "projects" ] } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {}, "description": "Unspecified response body" } } }, "description": "" } } } }, "/api/dashboards/info/update-task-status/": { "post": { "operationId": "dashboards_info_update_task_status_create", "description": "API endpoint for dashboard operations", "summary": "Update task status from dashboard", "tags": [ "Dashboards" ], "requestBody": { "content": { "type": { "schema": { "type": "object", "additionalProperties": {}, "description": "Unspecified request body" } }, "properties": { "schema": { "item_id": { "type": "string" }, "project_id": { "type": "string" }, "is_completed": { "type": "boolean" }, "source": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {}, "description": "Unspecified response body" } } }, "description": "" } } } }, "/api/dashboards/widget/": { "get": { "operationId": "dashboards_widget_retrieve", "description": "Get individual widget data", "summary": "Get widget data", "parameters": [ { "in": "query", "name": "time_filter", "schema": { "type": "string" }, "description": "Time filter" }, { "in": "query", "name": "widget_type", "schema": { "type": "string", "enum": [ "activities", "deals_overview", "my_tasks", "projects_overview", "revenue_chart" ] }, "description": "Widget type", "required": true } ], "tags": [ "Dashboard Widgets" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {}, "description": "Unspecified response body" } } }, "description": "" } } } }, "/api/documents/": { "get": { "operationId": "documents_list", "description": "This endpoint is used to fetch all documents for the current user", "summary": "All Documents", "parameters": [ { "in": "query", "name": "items_per_page", "schema": { "type": "integer" }, "description": "Items Per Page", "required": true }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "description": "Page Number", "required": true }, { "in": "query", "name": "reverse", "schema": { "type": "boolean" }, "description": "Sorting Order" }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "description": "Sorting Key" } ], "tags": [ "Documents" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } } } }, "description": "" } } }, "post": { "operationId": "documents_create", "description": "This endpoint is used to save a new document for the current organization", "summary": "Creates a new document", "tags": [ "Documents" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "CreateANewDocument": { "value": { "account": { "description": "Car Manufacturing Company", "account_name": "Tesla", "region": "Texas", "vertical": "Automotive", "segment": "Renewable Energy", "website_url": "https://www.tesla.com", "customer": { "full_name": "Elon Musk", "email": "elon@test.com", "phone": "+120112123456", "user_id": "12121323231" }, "logo": [] }, "document": { "document_name": "TestX", "document_template": { "template_name": "IT Support", "template_id": "1224235232", "template_config": { "stages": [ { "stage_id": "1", "name": "Brainstorming session", "color": "#FCEAEA", "status": { "status_id": 3, "status_key": "completed", "status_name": "Completed" } }, { "stage_id": "2", "name": "Kick-off call", "color": "#FCEAEA", "status": { "status_id": 3, "status_key": "completed", "status_name": "Completed" } }, { "stage_id": "3", "name": "Getting feedback", "color": "#EEFAF2", "status": { "status_id": 2, "status_key": "in_progress", "status_name": "In Progress" } }, { "stage_id": "4", "name": "high fidelity wireframes", "color": "#FCEAEA", "status": { "status_id": 2, "status_key": "in_progress", "status_name": "In Progress" } }, { "stage_id": "", "name": "Test12", "color": "#e7f1f7", "status": { "status_id": "", "status_key": "", "status_name": "" } } ] } }, "start_date": "2024-05-21T18:30:00.000Z", "due_date": "2025-05-27T18:30:00.000Z", "forecasted_date": "2025-05-12T18:30:00.000Z", "show_forecasted_date": true, "revenue": "1000", "is_arr": true, "document_fee": "190012", "document_owner": { "is_owner": false, "first_name": "Anita", "middle": "Dakota", "user_id": "2342135", "last": "Weber", "profile_image": "assets/images/users/avatar-8.jpg", "email": "Jett_Emard20@example.com", "phone_number": "363-334-0768 x413" } } }, "summary": "Create a new document" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "201": { "description": "No response body" } } } }, "/api/documents/{id}/": { "get": { "operationId": "documents_retrieve", "description": "This endpoint is used to fetch a document detail for the current organization", "summary": "Gets a document with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Documents" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "" } } }, "put": { "operationId": "documents_update", "description": "This endpoint is used to edit an document for the current organization", "summary": "Edits the document with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Documents" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "EditsAnExistingDocument": { "value": { "name": "Slack", "description": "A cloud based team communication platform for enterprises" }, "summary": "Edits an existing document" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "documents_destroy", "description": "This endpoint is used to delete an document for the current organization", "summary": "Deletes the document with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Documents" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/api/documents/activities/": { "get": { "operationId": "documents_activities_retrieve", "description": "API endpoint that allows documents to be created, viewed, deleted or edited.", "tags": [ "Documents" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "" } } } }, "/api/documents/analytics/": { "get": { "operationId": "documents_analytics_retrieve", "description": "API endpoint that allows documents to be created, viewed, deleted or edited.", "tags": [ "Documents" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "" } } } }, "/api/documents/bulkdelete/": { "post": { "operationId": "documents_bulkdelete_create", "description": "This endpoint is used to bulk delete documents for the current organization", "summary": "Deletes the documents with the given ids", "tags": [ "Documents" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "" } } } }, "/api/documents/chunked-upload/chunk/": { "post": { "operationId": "documents_chunked_upload_chunk_create", "description": "Upload a single chunk of the file", "summary": "Upload file chunk", "tags": [ "Documents" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/documents/chunked-upload/complete/": { "post": { "operationId": "documents_chunked_upload_complete_create", "description": "Complete the chunked upload by assembling all chunks", "summary": "Complete chunked upload", "tags": [ "Documents" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "201": { "description": "No response body" } } } }, "/api/documents/chunked-upload/init/": { "post": { "operationId": "documents_chunked_upload_init_create", "description": "Initialize a chunked file upload session for large files", "summary": "Initialize chunked upload", "tags": [ "Documents" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "201": { "description": "No response body" } } } }, "/api/documents/chunked-upload/status/": { "get": { "operationId": "documents_chunked_upload_status_retrieve", "description": "Get the status and progress of a chunked upload", "summary": "Get chunked upload status", "tags": [ "Documents" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "" } } } }, "/api/documents/decline-signature/": { "post": { "operationId": "documents_decline_signature_create", "description": "API endpoint that allows documents to be created, viewed, deleted or edited.", "tags": [ "Documents" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "" } } } }, "/api/documents/download/": { "get": { "operationId": "documents_download_retrieve", "description": "API endpoint that allows documents to be created, viewed, deleted or edited.", "tags": [ "Documents" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "" } } } }, "/api/documents/download-signed/": { "get": { "operationId": "documents_download_signed_retrieve", "description": "Download signed document for a specific signer", "summary": "Download Signed Document", "parameters": [ { "in": "query", "name": "attachment_id", "schema": { "type": "string" }, "description": "Document attachment ID", "required": true }, { "in": "query", "name": "signer_email", "schema": { "type": "string" }, "description": "Email of the signer whose signed document to download", "required": true } ], "tags": [ "Documents" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "" } } } }, "/api/documents/engagement/": { "post": { "operationId": "documents_engagement_create", "description": "API endpoint that allows documents to be created, viewed, deleted or edited.", "tags": [ "Documents" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "" } } } }, "/api/documents/initiate-esign/": { "post": { "operationId": "documents_initiate_esign_create", "description": "Initiate e-signature process for a document using DocuSeal", "summary": "Initiate E-Signature", "tags": [ "Documents" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/documents/options/": { "get": { "operationId": "documents_options_retrieve", "description": "API endpoint that allows documents to be created, viewed, deleted or edited.", "tags": [ "Documents" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "" } } } }, "/api/documents/ownership/accept/": { "post": { "operationId": "documents_ownership_accept_create", "description": "Accept document ownership transfer. Recipient must call this to become the new owner.", "summary": "Accept Transfer Ownership", "tags": [ "Documents" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "AcceptTransfer": { "value": { "transfer_token": "uuid-token" }, "summary": "Accept transfer" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/documents/ownership/initiate/": { "post": { "operationId": "documents_ownership_initiate_create", "description": "Initiate document ownership transfer to another user. Current owner sends transfer request.", "summary": "Initiate Transfer Ownership", "tags": [ "Documents" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "InitiateTransfer": { "value": { "attach_id": "doc_123", "to_user_id": "user_456" }, "summary": "Initiate transfer" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/documents/publish/": { "post": { "operationId": "documents_publish_create", "description": "Publish a draft EditorJS document", "summary": "Publish Document", "tags": [ "Documents" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/documents/save-signature-template/": { "post": { "operationId": "documents_save_signature_template_create", "description": "Save DocuSeal template_id after configuring signature fields", "summary": "Save Signature Template", "tags": [ "Documents" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/documents/send-for-signature/": { "post": { "operationId": "documents_send_for_signature_create", "description": "Send document for signature to specified recipients", "summary": "Send for Signature", "tags": [ "Documents" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/documents/send-reminder/": { "post": { "operationId": "documents_send_reminder_create", "description": "API endpoint that allows documents to be created, viewed, deleted or edited.", "tags": [ "Documents" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "" } } } }, "/api/documents/share/": { "get": { "operationId": "documents_share_retrieve", "description": "API endpoint that allows documents to be created, viewed, deleted or edited.", "tags": [ "Documents" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "" } } } }, "/api/documents/share/copy-link/": { "post": { "operationId": "documents_share_copy_link_create", "description": "API endpoint that allows documents to be created, viewed, deleted or edited.", "tags": [ "Documents" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "" } } } }, "/api/documents/share/email/": { "post": { "operationId": "documents_share_email_create", "description": "API endpoint that allows documents to be created, viewed, deleted or edited.", "tags": [ "Documents" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "" } } } }, "/api/documents/signature-builder-token/": { "get": { "operationId": "documents_signature_builder_token_retrieve", "description": "Get JWT token for DocuSeal builder to edit signature fields", "summary": "Get Signature Builder Token", "tags": [ "Documents" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/documents/signature-webhook/": { "post": { "operationId": "documents_signature_webhook_create", "description": "Public webhook endpoint for DocuSeal signature callbacks.\nNo authentication required - DocuSeal servers call this directly.", "tags": [ "Documents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/documents/signer-slug/": { "get": { "operationId": "documents_signer_slug_retrieve", "description": "Get DocuSeal signer slug for current user to sign document", "summary": "Get Signer Slug", "tags": [ "Documents" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/documents/tag/": { "post": { "operationId": "documents_tag_create", "description": "API endpoint that allows documents to be created, viewed, deleted or edited.", "tags": [ "Documents" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "" } } } }, "/api/documents/tag_delete/": { "post": { "operationId": "documents_tag_delete_create", "description": "API endpoint that allows documents to be created, viewed, deleted or edited.", "tags": [ "Documents" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "" } } } }, "/api/documents/template-roles/": { "get": { "operationId": "documents_template_roles_retrieve", "description": "Get signature roles from DocuSeal template", "summary": "Get Template Roles", "tags": [ "Documents" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/documents/validate/": { "post": { "operationId": "documents_validate_create", "description": "API endpoint that allows documents to be created, viewed, deleted or edited.", "tags": [ "Documents" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Attachment" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "" } } } }, "/api/documents/versions/": { "get": { "operationId": "documents_versions_retrieve", "description": "API endpoint that allows documents to be created, viewed, deleted or edited.", "tags": [ "Documents" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "" } } } }, "/api/filters/filter/": { "get": { "operationId": "filters_filter_retrieve", "description": "API endpoint that allows accounts to be created, viewed, deleted or edited.", "tags": [ "Filters" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "filters_filter_create", "description": "API endpoint that allows accounts to be created, viewed, deleted or edited.", "tags": [ "Filters" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "201": { "description": "No response body" } } } }, "/api/filters/filter/{id}/": { "get": { "operationId": "filters_filter_retrieve_2", "description": "API endpoint that allows accounts to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Filters" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "put": { "operationId": "filters_filter_update", "description": "API endpoint that allows accounts to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Filters" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "filters_filter_destroy", "description": "API endpoint that allows accounts to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Filters" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/api/filters/filter/attributes/": { "get": { "operationId": "filters_filter_attributes_retrieve", "description": "API endpoint that allows accounts to be created, viewed, deleted or edited.", "tags": [ "Filters" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/holidays/holinfo/": { "get": { "operationId": "holidays_holinfo_list", "description": "This endpoint is used to fetch all notifications in the current organization", "summary": "All Notifications", "parameters": [ { "in": "query", "name": "items_per_page", "schema": { "type": "integer" }, "description": "Items Per Page", "required": true }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "description": "Page Number", "required": true }, { "in": "query", "name": "reverse", "schema": { "type": "boolean" }, "description": "Sorting Order" }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "description": "Sorting Key" } ], "tags": [ "Holidays" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Holi" } } } }, "description": "" } } }, "post": { "operationId": "holidays_holinfo_create", "description": "This endpoint is used to save a new item for the current organization", "summary": "Creates a new item", "tags": [ "Holidays" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "CreateANewItem": { "summary": "Create a new Item" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "201": { "description": "No response body" } } } }, "/api/holidays/holinfo/{id}/": { "get": { "operationId": "holidays_holinfo_retrieve", "description": "API endpoint that allows Notifications to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Holidays" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Holi" } } }, "description": "" } } } }, "/api/holidays/holinfo/import/": { "get": { "operationId": "holidays_holinfo_import_retrieve", "description": "API endpoint that allows Notifications to be created, viewed, deleted or edited.", "tags": [ "Holidays" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Holi" } } }, "description": "" } } } }, "/api/interactions/info/": { "get": { "operationId": "interactions_info_list", "description": "Get interactions for a specific module and reference", "summary": "List Interactions", "parameters": [ { "in": "query", "name": "interaction_type", "schema": { "type": "string" }, "description": "Interactions Type Filter" }, { "in": "query", "name": "limit", "schema": { "type": "integer" }, "description": "Number of items per page" }, { "in": "query", "name": "module_name", "schema": { "type": "string" }, "description": "Module name (e.g. contacts)", "required": true }, { "in": "query", "name": "next_cursor", "schema": { "type": "string" }, "description": "Cursor token for the next page" }, { "in": "query", "name": "order_by", "schema": { "type": "string" }, "description": "Sort by creation_time: asc (oldest first) or desc (newest first, default)" }, { "in": "query", "name": "reference_id", "schema": { "type": "string" }, "description": "Reference ID", "required": true } ], "tags": [ "Interactions" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InteractionsList" } } } }, "description": "" } } }, "post": { "operationId": "interactions_info_create", "description": "Create a new interaction or reply", "summary": "Create Interactions", "tags": [ "Interactions" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "module_id": { "type": "integer" }, "reference_id": { "type": "string" }, "content": { "type": "string" }, "interaction_type": { "type": "string" }, "parent_interaction_id": { "type": "string" }, "mentions": { "type": "array" }, "attachment_ids": { "type": "array" } } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionsList" } } }, "description": "" } } } }, "/api/interactions/info/{id}/": { "get": { "operationId": "interactions_info_retrieve", "description": "Get a specific interaction with full details", "summary": "Get Interactions Detail", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Interactions" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionsList" } } }, "description": "" } } }, "put": { "operationId": "interactions_info_update", "description": "API endpoint for interactions and notes management", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Interactions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionsList" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InteractionsList" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/InteractionsList" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionsList" } } }, "description": "" } } }, "delete": { "operationId": "interactions_info_destroy", "description": "Delete a interaction", "summary": "Delete Interactions", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Interactions" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/api/interactions/info/add-reaction/": { "post": { "operationId": "interactions_info_add_reaction_create", "description": "Add or toggle reaction to an interaction", "tags": [ "Interactions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionsList" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InteractionsList" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/InteractionsList" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionsList" } } }, "description": "" } } } }, "/api/interactions/info/mark-read/": { "post": { "operationId": "interactions_info_mark_read_create", "description": "Mark interactions as read", "tags": [ "Interactions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionsList" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InteractionsList" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/InteractionsList" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionsList" } } }, "description": "" } } } }, "/api/interactions/info/summary/": { "get": { "operationId": "interactions_info_summary_retrieve", "description": "Get limited interactions for external module calls", "tags": [ "Interactions" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionsList" } } }, "description": "" } } } }, "/api/interactions/info/unread-counts/": { "post": { "operationId": "interactions_info_unread_counts_create", "description": "Get unread interactions count for multiple projects", "tags": [ "Interactions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionsList" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InteractionsList" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/InteractionsList" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionsList" } } }, "description": "" } } } }, "/api/notifyhub/notify-info/": { "get": { "operationId": "notifyhub_notify_info_list", "description": "This endpoint is used to fetch all notifications in the current organization", "summary": "All Notifications", "parameters": [ { "in": "query", "name": "items_per_page", "schema": { "type": "integer" }, "description": "Items Per Page", "required": true }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "description": "Page Number", "required": true }, { "in": "query", "name": "reverse", "schema": { "type": "boolean" }, "description": "Sorting Order" }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "description": "Sorting Key" } ], "tags": [ "Notifications" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotifyHub" } } } }, "description": "" } } }, "post": { "operationId": "notifyhub_notify_info_create", "description": "API endpoint that allows Notifications to be created, viewed, deleted or edited.", "tags": [ "Notifications" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotifyHub" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/NotifyHub" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/NotifyHub" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotifyHub" } } }, "description": "" } } } }, "/api/notifyhub/notify-info/{id}/": { "get": { "operationId": "notifyhub_notify_info_retrieve", "description": "API endpoint that allows Notifications to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Notifications" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotifyHub" } } }, "description": "" } } } }, "/api/project/info/": { "get": { "operationId": "project_info_list", "description": "This endpoint is used to fetch all projects for the current organization", "summary": "All Projects", "parameters": [ { "in": "query", "name": "items_per_page", "schema": { "type": "integer" }, "description": "Items Per Page", "required": true }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "description": "Page Number", "required": true }, { "in": "query", "name": "reverse", "schema": { "type": "boolean" }, "description": "Sorting Order" }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "description": "Sorting Key" } ], "tags": [ "Projects" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Projects" } } } }, "description": "" } } }, "post": { "operationId": "project_info_create", "description": "This endpoint is used to save a new project for the current organization", "summary": "Creates a new project", "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "CreateANewProject": { "value": { "account": { "description": "Car Manufacturing Company", "account_name": "Tesla", "region": "Texas", "vertical": "Automotive", "segment": "Renewable Energy", "website_url": "https://www.tesla.com", "customer": { "full_name": "Elon Musk", "email": "elon@test.com", "phone": "+120112123456", "user_id": "12121323231" }, "logo": [] }, "project": { "project_name": "TestX", "project_template": { "template_name": "IT Support", "template_id": "1224235232", "template_config": { "stages": [ { "stage_id": "1", "name": "Brainstorming session", "color": "#FCEAEA", "status": { "status_id": 3, "status_key": "completed", "status_name": "Completed" } }, { "stage_id": "2", "name": "Kick-off call", "color": "#FCEAEA", "status": { "status_id": 3, "status_key": "completed", "status_name": "Completed" } }, { "stage_id": "3", "name": "Getting feedback", "color": "#EEFAF2", "status": { "status_id": 2, "status_key": "in_progress", "status_name": "In Progress" } }, { "stage_id": "4", "name": "high fidelity wireframes", "color": "#FCEAEA", "status": { "status_id": 2, "status_key": "in_progress", "status_name": "In Progress" } }, { "stage_id": "", "name": "Test12", "color": "#e7f1f7", "status": { "status_id": "", "status_key": "", "status_name": "" } } ] } }, "start_date": "2024-05-21T18:30:00.000Z", "due_date": "2025-05-27T18:30:00.000Z", "forecasted_date": "2025-05-12T18:30:00.000Z", "show_forecasted_date": true, "revenue": "1000", "is_arr": true, "project_fee": "190012", "project_owner": { "is_owner": false, "first_name": "Anita", "middle": "Dakota", "user_id": "2342135", "last": "Weber", "profile_image": "assets/images/users/avatar-8.jpg", "email": "Jett_Emard20@example.com", "phone_number": "363-334-0768 x413" } } }, "summary": "Create a new Project" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "201": { "description": "No response body" } } } }, "/api/project/info/{id}/": { "get": { "operationId": "project_info_retrieve", "description": "This endpoint is used to fetch a project detail for the current organization", "summary": "Gets a project with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Projects" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } }, "put": { "operationId": "project_info_update", "description": "This endpoint is used to edit an project for the current organization", "summary": "Edits the project with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "EditsAnExistingProject": { "value": { "name": "Slack", "description": "A cloud based team communication platform for enterprises" }, "summary": "Edits an existing Project" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "project_info_destroy", "description": "This endpoint is used to delete an project for the current organization", "summary": "Deletes the project with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Projects" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/api/project/info/{id}/assign-partner-owner/": { "post": { "operationId": "project_info_assign_partner_owner_create", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Projects" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/{id}/custom-fields/": { "post": { "operationId": "project_info_custom_fields_create", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Projects" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } }, "put": { "operationId": "project_info_custom_fields_update", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Projects" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/{id}/custom-fields/{field_id}/": { "delete": { "operationId": "project_info_custom_fields_destroy", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "field_id", "schema": { "type": "string" }, "required": true }, { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Projects" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/api/project/info/{id}/customer-invite-status/": { "get": { "operationId": "project_info_customer_invite_status_retrieve", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Projects" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/{id}/deal-memory/": { "get": { "operationId": "project_info_deal_memory_retrieve", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Projects" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/{id}/deal-memory/detect-topics/": { "post": { "operationId": "project_info_deal_memory_detect_topics_create", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Projects" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/{id}/deal-memory/rephrase/": { "post": { "operationId": "project_info_deal_memory_rephrase_create", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Projects" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/{id}/deal-memory/save/": { "post": { "operationId": "project_info_deal_memory_save_create", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Projects" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/{id}/partner-invite-status/": { "get": { "operationId": "project_info_partner_invite_status_retrieve", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Projects" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/{id}/send-customer-invite/{user_id}/": { "post": { "operationId": "project_info_send_customer_invite_create", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, { "in": "path", "name": "user_id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Projects" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/{id}/send-customer-invites/": { "post": { "operationId": "project_info_send_customer_invites_create", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Projects" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/{id}/send-partner-invite/{user_id}/": { "post": { "operationId": "project_info_send_partner_invite_create", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, { "in": "path", "name": "user_id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Projects" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/{id}/send-partner-invites/": { "post": { "operationId": "project_info_send_partner_invites_create", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Projects" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/{id}/widget-settings/": { "get": { "operationId": "project_info_widget_settings_retrieve", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Projects" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } }, "post": { "operationId": "project_info_widget_settings_create", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Projects" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } }, "put": { "operationId": "project_info_widget_settings_update", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Projects" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/{id}/widget-settings/rotate-key/": { "post": { "operationId": "project_info_widget_settings_rotate_key_create", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Projects" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/action/": { "post": { "operationId": "project_info_action_create", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Projects" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/activities/": { "get": { "operationId": "project_info_activities_retrieve", "description": "This endpoint is used to fetch project activities with pagination and grouping", "summary": "Get Project Activities", "parameters": [ { "in": "query", "name": "account_id", "schema": { "type": "string" }, "description": "Account ID" }, { "in": "query", "name": "activity_count", "schema": { "type": "integer" }, "description": "Number of activities to fetch" }, { "in": "query", "name": "offset", "schema": { "type": "integer" }, "description": "Offset for pagination" }, { "in": "query", "name": "project_id", "schema": { "type": "string" }, "description": "Project ID" } ], "tags": [ "Projects" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/deals/": { "get": { "operationId": "project_info_deals_retrieve", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "tags": [ "Projects" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/deals-bulk-delete/": { "post": { "operationId": "project_info_deals_bulk_delete_create", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Projects" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/deals-del-ref/": { "post": { "operationId": "project_info_deals_del_ref_create", "description": "Delete a deal by ref_deal_id (external deal ID from Salesforce or HubSpot)", "summary": "Delete Deal by ref_deal_id", "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ref_deal_id": { "type": "string", "description": "External deal ID (Salesforce ref_deal_id or HubSpot hubspot_deal_id)" } } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/deals-options/": { "get": { "operationId": "project_info_deals_options_retrieve", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "tags": [ "Projects" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/getduedata/": { "post": { "operationId": "project_info_getduedata_create", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Projects" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/milestones/": { "get": { "operationId": "project_info_milestones_retrieve", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "tags": [ "Projects" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/project_owner/": { "get": { "operationId": "project_info_project_owner_retrieve", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "tags": [ "Projects" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/remove-partner-org/": { "post": { "operationId": "project_info_remove_partner_org_create", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Projects" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/settings/": { "get": { "operationId": "project_info_settings_retrieve", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "tags": [ "Projects" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/share_context/": { "get": { "operationId": "project_info_share_context_retrieve", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "tags": [ "Projects" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/summary/": { "get": { "operationId": "project_info_summary_retrieve", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "tags": [ "Projects" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/project/info/update_position/": { "post": { "operationId": "project_info_update_position_create", "description": "API endpoint that allows projects to be created, viewed, deleted or edited.", "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Projects" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "" } } } }, "/api/surveys/": { "get": { "operationId": "surveys_list", "description": "This endpoint is used to fetch all surveys in the current organization", "summary": "List All Surveys", "parameters": [ { "in": "query", "name": "account_id", "schema": { "type": "string" }, "description": "Filter by account ID" }, { "in": "query", "name": "items_per_page", "schema": { "type": "integer" }, "description": "Items Per Page" }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "description": "Page Number" }, { "in": "query", "name": "reverse", "schema": { "type": "boolean" }, "description": "Sorting Order" }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "description": "Sorting Key" }, { "in": "query", "name": "status", "schema": { "type": "string" }, "description": "Filter by status (draft, published, closed)" } ], "tags": [ "Surveys" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyDetail" } } } }, "description": "" } } }, "post": { "operationId": "surveys_create", "description": "This endpoint is used to create a new survey for the current organization", "summary": "Create Survey", "tags": [ "Surveys" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "CreateANewSurvey": { "value": { "name": "Customer Satisfaction Survey", "description": "Quarterly customer satisfaction survey", "account_id": "123", "form_structure": [ { "id": "page1", "title": "Page 1", "fields": [ { "id": "field1", "type": "short-text", "label": "What is your name?", "required": true }, { "id": "field2", "type": "ratings", "label": "How satisfied are you?", "required": true, "maxRating": 5 } ] } ], "form_style": "IN_APP", "form_container_style": "POPUP", "status": "draft" }, "summary": "Create a new Survey" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "201": { "description": "No response body" } } } }, "/api/surveys/{id}/": { "get": { "operationId": "surveys_retrieve", "description": "This endpoint is used to fetch a survey details for the current organization", "summary": "Get Survey Details", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Surveys" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyDetail" } } }, "description": "" } } }, "put": { "operationId": "surveys_update", "description": "This endpoint is used to update a survey for the current organization", "summary": "Update Survey", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Surveys" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "UpdateAnExistingSurvey": { "value": { "survey_id": "123", "name": "Updated Survey Name", "description": "Updated description", "status": "published" }, "summary": "Update an existing Survey" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "surveys_destroy", "description": "This endpoint is used to delete a survey for the current organization", "summary": "Delete Survey", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Surveys" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/api/surveys/{id}/automation-options/": { "get": { "operationId": "surveys_automation_options_retrieve", "description": "This endpoint is used to get automation options (projects and customer users) for a survey", "summary": "Get Automation Options", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Surveys" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/surveys/{id}/automations/": { "get": { "operationId": "surveys_automations_retrieve", "description": "This endpoint is used to get all automations for a survey", "summary": "Get Survey Automations", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Surveys" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/surveys/{id}/automations_save/": { "post": { "operationId": "surveys_automations_save_create", "description": "This endpoint is used to create a new survey automation", "summary": "Create Survey Automation", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Surveys" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyDetail" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SurveyDetail" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SurveyDetail" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "201": { "description": "No response body" } } } }, "/api/surveys/{id}/close/": { "post": { "operationId": "surveys_close_create", "description": "This endpoint is used to close a survey", "summary": "Close Survey", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Surveys" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/surveys/{id}/duplicate/": { "post": { "operationId": "surveys_duplicate_create", "description": "This endpoint is used to duplicate an existing survey", "summary": "Duplicate Survey", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Surveys" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "DuplicateSurvey": { "value": { "name": "Survey Name (Copy)" }, "summary": "Duplicate Survey" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/surveys/{id}/fill/": { "get": { "operationId": "surveys_fill_retrieve", "description": "Get survey details for filling (authenticated users only)", "summary": "Get Survey For Filling", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Surveys" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyDetail" } } }, "description": "" } } } }, "/api/surveys/{id}/insights/": { "get": { "operationId": "surveys_insights_retrieve", "description": "This endpoint is used to get insights/analytics for a survey", "summary": "Get Survey Insights", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Surveys" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyDetail" } } }, "description": "" } } } }, "/api/surveys/{id}/limit-status/": { "get": { "operationId": "surveys_limit_status_retrieve", "description": "Get survey response limit status including current count, blocked count, and remaining responses", "summary": "Get Survey Limit Status", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Surveys" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } }, "description": "" } } } }, "/api/surveys/{id}/publish/": { "post": { "operationId": "surveys_publish_create", "description": "This endpoint is used to publish a survey", "summary": "Publish Survey", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Surveys" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/surveys/{id}/responses/": { "get": { "operationId": "surveys_responses_retrieve", "description": "This endpoint is used to get all responses for a survey", "summary": "Get Survey Responses", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "items_per_page", "schema": { "type": "integer" }, "description": "Items Per Page" }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "description": "Page Number" }, { "in": "query", "name": "respondent_email", "schema": { "type": "string" }, "description": "Filter by respondent email" } ], "tags": [ "Surveys" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyDetail" } } }, "description": "" } } } }, "/api/surveys/{id}/save-as-template/": { "post": { "operationId": "surveys_save_as_template_create", "description": "This endpoint is used to save a survey as a template", "summary": "Save Survey as Template", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Surveys" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "SaveAsTemplate": { "value": { "name": "Customer Feedback Template" }, "summary": "Save as Template" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/surveys/{id}/schedule/": { "post": { "operationId": "surveys_schedule_create", "description": "This endpoint is used to schedule a survey to be sent at a specific date/time", "summary": "Schedule Survey Send", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Surveys" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "ScheduleSurvey": { "value": { "email_addresses": [ "user1@example.com", "user2@example.com" ], "custom_message": "Please take a moment to complete this survey", "scheduled_at": "2024-01-15T10:00:00", "timezone": "America/New_York" }, "summary": "Schedule Survey" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "201": { "description": "No response body" } } } }, "/api/surveys/{id}/schedules/": { "get": { "operationId": "surveys_schedules_retrieve", "description": "This endpoint is used to get all scheduled sends for a survey", "summary": "Get Survey Schedules", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Surveys" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/surveys/{id}/send/": { "post": { "operationId": "surveys_send_create", "description": "This endpoint is used to send a survey via email to specified recipients", "summary": "Send Survey via Email", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Surveys" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "SendSurveyToRecipients": { "value": { "email_addresses": [ "user1@example.com", "user2@example.com" ], "custom_message": "Please take a moment to complete this survey" }, "summary": "Send Survey to Recipients" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/surveys/{id}/update-with-propagation/": { "put": { "operationId": "surveys_update_with_propagation_update", "description": "This endpoint is used to update a survey and propagate changes to tasks using the form", "summary": "Update Survey with Propagation", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Surveys" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "UpdateSurveyWithPropagation": { "value": { "name": "Updated Survey Name", "form_structure": { "fields": [] }, "propagate_to_tasks": true }, "summary": "Update Survey with Propagation" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/surveys/{id}/usage-count/": { "get": { "operationId": "surveys_usage_count_retrieve", "description": "This endpoint returns the count of non-completed tasks using this form", "summary": "Get Form Usage Count", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Surveys" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyDetail" } } }, "description": "" } } } }, "/api/surveys/automations/{automation_id}/": { "put": { "operationId": "surveys_automations_update", "description": "This endpoint is used to update an existing survey automation", "summary": "Update Survey Automation", "parameters": [ { "in": "path", "name": "automation_id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Surveys" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyDetail" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SurveyDetail" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SurveyDetail" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "surveys_automations_destroy", "description": "This endpoint is used to delete a survey automation", "summary": "Delete Survey Automation", "parameters": [ { "in": "path", "name": "automation_id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Surveys" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/surveys/bulk-delete/": { "post": { "operationId": "surveys_bulk_delete_create", "description": "This endpoint is used to bulk delete surveys for the current organization", "summary": "Deletes the surveys with the given ids", "tags": [ "Surveys" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyDetail" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SurveyDetail" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SurveyDetail" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyDetail" } } }, "description": "" } } } }, "/api/surveys/counts/": { "get": { "operationId": "surveys_counts_retrieve", "description": "Get counts for surveys, templates, and forms", "summary": "Get Survey Counts", "tags": [ "Surveys" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/surveys/forms/": { "get": { "operationId": "surveys_forms_retrieve", "description": "This endpoint is used to fetch all forms in the current organization", "summary": "List All Forms", "parameters": [ { "in": "query", "name": "account_id", "schema": { "type": "string" }, "description": "Filter by account ID" }, { "in": "query", "name": "items_per_page", "schema": { "type": "integer" }, "description": "Items Per Page" }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "description": "Page Number" }, { "in": "query", "name": "reverse", "schema": { "type": "boolean" }, "description": "Sorting Order" }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "description": "Sorting Key" }, { "in": "query", "name": "status", "schema": { "type": "string" }, "description": "Filter by status (draft, published, closed)" } ], "tags": [ "Surveys" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyDetail" } } }, "description": "" } } } }, "/api/surveys/public/{encrypted_token}/": { "get": { "operationId": "surveys_public_retrieve", "description": "This endpoint is used to get survey details for public submission using encrypted token", "summary": "Get Survey for Public Submission (Encrypted Token)", "parameters": [ { "in": "path", "name": "encrypted_token", "schema": { "type": "string" }, "required": true } ], "tags": [ "Surveys" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/surveys/schedules/{schedule_id}/": { "delete": { "operationId": "surveys_schedules_destroy", "description": "This endpoint is used to cancel a scheduled survey send", "summary": "Cancel Scheduled Survey", "parameters": [ { "in": "path", "name": "schedule_id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Surveys" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/surveys/status-summary/": { "get": { "operationId": "surveys_status_summary_retrieve", "description": "This endpoint is used to get survey counts by status (total, published, draft, closed)", "summary": "Get Survey Status Summary", "tags": [ "Surveys" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/surveys/submit/": { "post": { "operationId": "surveys_submit_create", "description": "This endpoint is used to submit a response to a survey", "summary": "Submit Survey Response", "tags": [ "Surveys" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "SubmitSurveyResponse": { "value": { "responses": { "field1": "John Doe", "field2": 5 }, "respondent_email": "john@example.com", "completion_time_seconds": 120, "is_complete": true }, "summary": "Submit Survey Response" } } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/surveys/templates/": { "get": { "operationId": "surveys_templates_retrieve", "description": "This endpoint is used to get survey templates for dropdown selection", "summary": "List Survey Templates", "tags": [ "Surveys" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/tags/info/": { "get": { "operationId": "tags_info_list", "description": "This endpoint is used to fetch all tags in the current organization", "summary": "All Tags", "parameters": [ { "in": "query", "name": "items_per_page", "schema": { "type": "integer" }, "description": "Items Per Page", "required": true }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "description": "Page Number", "required": true }, { "in": "query", "name": "reverse", "schema": { "type": "boolean" }, "description": "Sorting Order" }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "description": "Sorting Key" } ], "tags": [ "Tags" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Tags" } } } }, "description": "" } } }, "post": { "operationId": "tags_info_create", "description": "This endpoint is used to save a new tag for the current organization", "summary": "Creates a new tag", "tags": [ "Tags" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "CreateANewTag": { "value": { "tag_name": "Critical", "description": "All Critical Tasks to be marked with this tag", "tag_owner": { "name": "Shyam", "id": "123" }, "tag_type": "tasks" }, "summary": "Create a new Tag" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "201": { "description": "No response body" } } } }, "/api/tags/info/{id}/": { "get": { "operationId": "tags_info_retrieve", "description": "This endpoint is used to fetch a tag details for the current organization", "summary": "Gets a tag with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Tags" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tags" } } }, "description": "" } } }, "put": { "operationId": "tags_info_update", "description": "This endpoint is used to edit an tag for the current organization", "summary": "Edits the tag with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Tags" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "EditsAnExistingTag": { "value": { "name": "UX Design", "description": "A tag for design" }, "summary": "Edits an existing Tag" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "patch": { "operationId": "tags_info_partial_update", "description": "API endpoint that allows tags to be created, viewed, deleted or edited.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Tags" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedTags" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedTags" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedTags" } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tags" } } }, "description": "" } } }, "delete": { "operationId": "tags_info_destroy", "description": "This endpoint is used to delete an tag for the current organization", "summary": "Deletes the tag with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Tags" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/api/tasks/": { "get": { "operationId": "tasks_list", "description": "This endpoint is used to fetch all items in the current organization", "summary": "All Items", "parameters": [ { "in": "query", "name": "items_per_page", "schema": { "type": "integer" }, "description": "Items Per Page", "required": true }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "description": "Page Number", "required": true }, { "in": "query", "name": "reverse", "schema": { "type": "boolean" }, "description": "Sorting Order" }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "description": "Sorting Key" } ], "tags": [ "Tasks" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Items" } } } }, "description": "" } } }, "post": { "operationId": "tasks_create", "description": "This endpoint is used to save a new item for the current organization", "summary": "Creates a new item", "tags": [ "Tasks" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "CreateANewItem": { "value": { "title": "Creating the Authentication with Google", "description": "Authentication in the application using Google", "account_id": "7200912181699809281", "project_id": "7200912182903574529", "milestone_id": "7204399057333129217", "tags": [ "Authentication", "Google Auth" ], "owner": { "name": "Shyam" } }, "summary": "Create a new Item" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "201": { "description": "No response body" } } } }, "/api/tasks/{id}/": { "get": { "operationId": "tasks_retrieve", "description": "This endpoint is used to fetch a item details for the current organization", "summary": "Gets a tag with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Tasks" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } } }, "description": "" } } }, "put": { "operationId": "tasks_update", "description": "This endpoint is used to edit an item for the current organization", "summary": "Edits the item with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Tasks" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "EditsAnExistingItem": { "value": { "title": "UX Design", "description": "A tag for design" }, "summary": "Edits an existing Item" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "tasks_destroy", "description": "This endpoint is used to delete an item for the current organization", "summary": "Deletes the item with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Tasks" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/api/tasks/activity/": { "get": { "operationId": "tasks_activity_retrieve", "description": "API endpoint that allows tags to be created, viewed, deleted or edited.", "tags": [ "Tasks" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } } }, "description": "" } } } }, "/api/tasks/attachments/": { "get": { "operationId": "tasks_attachments_retrieve", "description": "API endpoint that allows tags to be created, viewed, deleted or edited.", "tags": [ "Tasks" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } } }, "description": "" } } } }, "/api/tasks/bulk_actions/": { "post": { "operationId": "tasks_bulk_actions_create", "description": "API endpoint that allows tags to be created, viewed, deleted or edited.", "tags": [ "Tasks" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Items" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Items" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } } }, "description": "" } } } }, "/api/tasks/bulk_delete/": { "post": { "operationId": "tasks_bulk_delete_create", "description": "API endpoint that allows tags to be created, viewed, deleted or edited.", "tags": [ "Tasks" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Items" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Items" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } } }, "description": "" } } } }, "/api/tasks/by_display_id/": { "get": { "operationId": "tasks_by_display_id_retrieve", "description": "Fetch a task by display_id (e.g. TSK-123). With customer_user_id, system users only: returns the task only if it would be visible to that customer (same rules as my_tasks).", "summary": "Get task by display_id", "parameters": [ { "in": "query", "name": "customer_user_id", "schema": { "type": "string" }, "description": "When the caller has a system role, scope visibility to this customer user" }, { "in": "query", "name": "display_id", "schema": { "type": "string" }, "description": "Task display_id (required)", "required": true } ], "tags": [ "Tasks" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } } }, "description": "" } } } }, "/api/tasks/del_file/": { "post": { "operationId": "tasks_del_file_create", "description": "API endpoint that allows tags to be created, viewed, deleted or edited.", "tags": [ "Tasks" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Items" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Items" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } } }, "description": "" } } } }, "/api/tasks/options/": { "get": { "operationId": "tasks_options_retrieve", "description": "API endpoint that allows tags to be created, viewed, deleted or edited.", "tags": [ "Tasks" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } } }, "description": "" } } } }, "/api/tasks/stop_recurring/": { "post": { "operationId": "tasks_stop_recurring_create", "description": "API endpoint that allows tags to be created, viewed, deleted or edited.", "tags": [ "Tasks" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Items" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Items" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } } }, "description": "" } } } }, "/api/tasks/task_options/": { "get": { "operationId": "tasks_task_options_retrieve", "description": "API endpoint that allows tags to be created, viewed, deleted or edited.", "tags": [ "Tasks" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } } }, "description": "" } } } }, "/api/tasks/update_position/": { "post": { "operationId": "tasks_update_position_create", "description": "API endpoint that allows tags to be created, viewed, deleted or edited.", "tags": [ "Tasks" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Items" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Items" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } } }, "description": "" } } } }, "/api/tasks/update_recurring/": { "post": { "operationId": "tasks_update_recurring_create", "description": "API endpoint that allows tags to be created, viewed, deleted or edited.", "tags": [ "Tasks" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Items" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Items" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } } }, "description": "" } } } }, "/api/tasks/user_list/": { "get": { "operationId": "tasks_user_list_retrieve", "description": "API endpoint that allows tags to be created, viewed, deleted or edited.", "tags": [ "Tasks" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } } }, "description": "" } } } }, "/api/templates/template/": { "get": { "operationId": "templates_template_list", "description": "This endpoint is used to fetch all templates in the current organization", "summary": "All Templates", "parameters": [ { "in": "query", "name": "items_per_page", "schema": { "type": "integer" }, "description": "Items Per Page", "required": true }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "description": "Page Number", "required": true }, { "in": "query", "name": "reverse", "schema": { "type": "boolean" }, "description": "Sorting Order" }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "description": "Sorting Key" } ], "tags": [ "Templates" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Template" } } } }, "description": "" } } }, "post": { "operationId": "templates_template_create", "description": "This endpoint is used to save a new template for the current organization", "summary": "Creates a new template", "tags": [ "Templates" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "CreateANewTemplate": { "value": { "template_name": "New UX Design", "description": "A template for new UX design", "template_config": { "stages": [ { "stage_id": "1", "name": "Brainstorming session", "color": "#FFCCCC", "status": { "status_id": 3, "status_key": "completed", "status_name": "Completed" } }, { "stage_id": "2", "name": "Kick-off call", "color": "#FFCCCC", "status": { "status_id": 3, "status_key": "completed", "status_name": "Completed" } }, { "stage_id": "3", "name": "Getting feedback", "color": "#FFD700", "status": { "status_id": 2, "status_key": "in_progress", "status_name": "In Progress" } }, { "stage_id": "4", "name": "High fidelity wireframes", "color": "#FFD700", "status": { "status_id": 2, "status_key": "in_progress", "status_name": "In Progress" } } ] } }, "summary": "Create a new Template" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "201": { "description": "No response body" } } } }, "/api/templates/template/{id}/": { "get": { "operationId": "templates_template_retrieve", "description": "This endpoint is used to fetch a template details for the current organization", "summary": "Gets a template with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Templates" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template" } } }, "description": "" } } }, "put": { "operationId": "templates_template_update", "description": "This endpoint is used to edit an template for the current organization", "summary": "Edits the template with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Templates" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "EditsAnExistingTemplate": { "value": { "name": "UX Design", "description": "A template for design" }, "summary": "Edits an existing Template" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "templates_template_destroy", "description": "This endpoint is used to delete an template for the current organization", "summary": "Deletes the template with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Templates" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/api/templates/template/ai-milestone/": { "get": { "operationId": "templates_template_ai_milestone_retrieve", "description": "API endpoint that allows templates to be created, viewed, deleted or edited.", "tags": [ "Templates" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template" } } }, "description": "" } } } }, "/api/templates/template/ai-template/": { "get": { "operationId": "templates_template_ai_template_retrieve", "description": "API endpoint that allows templates to be created, viewed, deleted or edited.", "tags": [ "Templates" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template" } } }, "description": "" } } } }, "/api/templates/template/default/": { "get": { "operationId": "templates_template_default_retrieve", "description": "API endpoint that allows templates to be created, viewed, deleted or edited.", "tags": [ "Templates" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template" } } }, "description": "" } } } }, "/api/templates/template/paginated-templates/": { "get": { "operationId": "templates_template_paginated_templates_retrieve", "description": "API endpoint that allows templates to be created, viewed, deleted or edited.", "tags": [ "Templates" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template" } } }, "description": "" } } } }, "/api/users/profile/": { "get": { "operationId": "users_profile_list", "description": "This endpoint is used to fetch all users in the current organization", "summary": "All Users", "parameters": [ { "in": "query", "name": "items_per_page", "schema": { "type": "integer" }, "description": "Items Per Page", "required": true }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "description": "Page Number", "required": true }, { "in": "query", "name": "reverse", "schema": { "type": "boolean" }, "description": "Sorting Order" }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "description": "Sorting Key" } ], "tags": [ "Users" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Users" } } } }, "description": "" } } } }, "/api/users/profile/{id}/": { "get": { "operationId": "users_profile_retrieve", "description": "This endpoint is used to fetch a user profile for the current organization", "summary": "Gets a user detail with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Users" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Users" } } }, "description": "" } } }, "put": { "operationId": "users_profile_update", "description": "This endpoint is used to edit an user for the current organization", "summary": "Edits the user with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Users" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "EditsAnExistingAccount": { "value": { "name": "Slack", "description": "A cloud based team communication platform for enterprises" }, "summary": "Edits an existing Account" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "users_profile_destroy", "description": "This endpoint is used to delete an user for the current organization", "summary": "Deletes the user with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Users" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/api/users/profile/action/": { "post": { "operationId": "users_profile_action_create", "description": "API endpoint that allows users to be created, viewed, deleted or edited.", "tags": [ "Users" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Users" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Users" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Users" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Users" } } }, "description": "" } } } }, "/api/users/profile/activity/": { "get": { "operationId": "users_profile_activity_retrieve", "description": "API endpoint that allows users to be created, viewed, deleted or edited.", "tags": [ "Users" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Users" } } }, "description": "" } } } }, "/api/users/profile/attachfile/": { "post": { "operationId": "users_profile_attachfile_create", "description": "API endpoint that allows users to be created, viewed, deleted or edited.", "tags": [ "Users" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Users" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Users" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Users" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Users" } } }, "description": "" } } } }, "/api/users/profile/cus-details/": { "get": { "operationId": "users_profile_cus_details_retrieve", "description": "This endpoint is used to get all customer users in the organization with their details including name, designation, email, joining date, is_first_login, mapped projects, and mapped deals", "summary": "Get Customer Details", "tags": [ "Users" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/users/profile/cus-invite/": { "post": { "operationId": "users_profile_cus_invite_create", "description": "This endpoint is used to add a customer invite which creates an organization customer role for the given email and associates it with a list of project or deal IDs", "summary": "Adds a customer invite", "tags": [ "Users" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "AddCustomerInvite": { "value": { "email": "customer@example.com", "full_name": "John Doe", "project_ids": [ "proj123", "proj456" ], "deal_ids": [ "deal789" ] }, "summary": "Add Customer Invite" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "201": { "description": "No response body" } } } }, "/api/users/profile/cus-project-map/": { "post": { "operationId": "users_profile_cus_project_map_create", "description": "This endpoint updates the project mapping for a customer user based on the given user_id and list of project_ids. If the list is empty, all projects are removed from that customer.", "summary": "Update Customer Project Mapping", "tags": [ "Users" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "UpdateCustomerProjectMapping": { "value": { "user_id": "usr_12345", "project_ids": [ "proj_1", "proj_2", "deal_3" ] }, "summary": "Update Customer Project Mapping" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/users/profile/del_designation/": { "post": { "operationId": "users_profile_del_designation_create", "description": "This endpoint is used to delete a designation", "summary": "Deletes a designation", "tags": [ "Users" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "DeleteDesignation": { "value": { "value": "Senior Dev" }, "summary": "Delete Designation" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/users/profile/department-options/": { "get": { "operationId": "users_profile_department_options_retrieve", "description": "API endpoint that allows users to be created, viewed, deleted or edited.", "tags": [ "Users" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Users" } } }, "description": "" } } } }, "/api/users/profile/designation/": { "post": { "operationId": "users_profile_designation_create", "description": "This endpoint is used to update the name of a designation", "summary": "Updates a designation name", "tags": [ "Users" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "UpdateDesignationName": { "value": { "value": "Senior Dev", "name": "Senior Developer", "previous_name": "Senior Dev" }, "summary": "Update Designation Name" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/api/users/profile/designation-options/": { "get": { "operationId": "users_profile_designation_options_retrieve", "description": "This endpoint is used to get the list of designations for the current organization", "summary": "Get Designation Options", "tags": [ "Users" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Users" } } }, "description": "" } } } }, "/api/users/profile/get_notify_pre/": { "get": { "operationId": "users_profile_get_notify_pre_retrieve", "description": "API endpoint that allows users to be created, viewed, deleted or edited.", "tags": [ "Users" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Users" } } }, "description": "" } } } }, "/api/users/profile/login-session/": { "post": { "operationId": "users_profile_login_session_create", "description": "API endpoint that allows users to be created, viewed, deleted or edited.", "tags": [ "Users" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Users" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Users" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Users" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Users" } } }, "description": "" } } } }, "/api/users/profile/logout/": { "post": { "operationId": "users_profile_logout_create", "description": "API endpoint that allows users to be created, viewed, deleted or edited.", "tags": [ "Users" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Users" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Users" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Users" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Users" } } }, "description": "" } } } }, "/api/users/profile/re-invite/": { "post": { "operationId": "users_profile_re_invite_create", "description": "API endpoint that allows users to be created, viewed, deleted or edited.", "tags": [ "Users" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Users" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Users" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Users" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Users" } } }, "description": "" } } } }, "/api/users/profile/rolemap/": { "post": { "operationId": "users_profile_rolemap_create", "description": "API endpoint that allows users to be created, viewed, deleted or edited.", "tags": [ "Users" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Users" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Users" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Users" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Users" } } }, "description": "" } } } }, "/api/users/profile/save_notify_pre/": { "post": { "operationId": "users_profile_save_notify_pre_create", "description": "API endpoint that allows users to be created, viewed, deleted or edited.", "tags": [ "Users" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Users" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Users" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Users" } } }, "required": true }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Users" } } }, "description": "" } } } }, "/api/users/profile/user_option/": { "get": { "operationId": "users_profile_user_option_retrieve", "description": "API endpoint that allows users to be created, viewed, deleted or edited.", "tags": [ "Users" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Users" } } }, "description": "" } } } }, "/api/users/role/": { "get": { "operationId": "users_role_list", "description": "This endpoint is used to fetch all roles in the current organization", "summary": "All Roles", "parameters": [ { "in": "query", "name": "items_per_page", "schema": { "type": "integer" }, "description": "Items Per Page", "required": true }, { "in": "query", "name": "page", "schema": { "type": "integer" }, "description": "Page Number", "required": true }, { "in": "query", "name": "reverse", "schema": { "type": "boolean" }, "description": "Sorting Order" }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "description": "Sorting Key" } ], "tags": [ "User Roles" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleOpt" } } } }, "description": "" } } } }, "/api/users/role/{id}/": { "get": { "operationId": "users_role_retrieve", "description": "Adaptation of DRF ModelViewSet", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "User Roles" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleOpt" } } }, "description": "" } } }, "put": { "operationId": "users_role_update", "description": "This endpoint is used to edit a role for the current organization", "summary": "Edits the role with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "User Roles" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "EditsAnExistingRole": { "value": { "name": "Org Admin", "permission": {} }, "summary": "Edits an existing Role" } } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "patch": { "operationId": "users_role_partial_update", "description": "Adaptation of DRF ModelViewSet", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "User Roles" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedRoleOpt" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedRoleOpt" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedRoleOpt" } } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleOpt" } } }, "description": "" } } }, "delete": { "operationId": "users_role_destroy", "description": "This endpoint is used to delete a role for the current organization", "summary": "Deletes the role with the given id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "User Roles" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/api/users/role/option/": { "get": { "operationId": "users_role_option_retrieve", "description": "Adaptation of DRF ModelViewSet", "tags": [ "User Roles" ], "security": [ { "bearerAuth": [] }, { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleOpt" } } }, "description": "" } } } }, "/api/widget-config": { "get": { "operationId": "widget_config_retrieve", "description": "Public endpoint: GET /api/widget-config?key=API_KEY\nReturns display config for the embeddable feedback widget.", "tags": [ "Feedback Widget" ], "security": [ { "bearerAuth": [] }, {} ], "responses": { "200": { "description": "No response body" } } } }, "/api/widget-submit": { "post": { "operationId": "widget_submit_create", "description": "Public endpoint: POST /api/widget-submit\nAuthenticated by X-Api-Key header. Accepts multipart/form-data and creates a task.", "tags": [ "Feedback Widget" ], "security": [ { "bearerAuth": [] }, {} ], "responses": { "200": { "description": "No response body" } } } } }, "components": { "schemas": { "AccessTypeEnum": { "enum": [ "user", "role", "team" ], "type": "string", "description": "* `user` - user\n* `role` - role\n* `team` - team" }, "AccountInfo": { "type": "object", "description": "Serializer for Documents.\n\nRecognized primitve fields:\n\n * ``StringField``\n * ``URLField``\n * ``EmailField``\n * ``IntField``\n * ``LongField``\n * ``FloatField``\n * ``DecimalField``\n * ``BooleanField``\n * ``DateTimeField``\n * ``ComplexDateTimeField``\n * ``ObjectIdField``\n * ``SequenceField`` (assumes it has integer counter)\n * ``UUIDField``\n * ``GeoPointField``\n * ``GeoJsonBaseField`` (all those fields)\n * ``DateField``\n\nCompound fields: ``ListField`` and ``DictField`` are mapped to corresponding DRF fields, with respect to nested field specification.\n\nThe ``ReferenceField`` is handled like ``ForeignKey`` in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as ``str(id)``).\n\nFor ``EmbeddedDocumentField`` also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.\n\nGeneric fields ``GenericReferenceField`` and ``GenericEmbeddedDocumentField`` are handled by their own with corresponding serializer fields.\n\nNot well supported or untested:\n\n ``FileField``\n ``ImageField``\n ``BinaryField``\n\nAll other fields are mapped to ``DocumentField`` and probably will work wrong.", "properties": { "account_id": { "type": "string", "maxLength": 25 }, "account_name": { "type": "string" }, "description": { "type": "string" }, "account_owner": { "type": "string", "readOnly": true }, "linked_projects": { "type": "string", "readOnly": true }, "health_score": { "type": "string", "readOnly": true }, "total_revenue": { "type": "string", "readOnly": true }, "total_projects": { "type": "string", "readOnly": true }, "completed_projects": { "type": "string", "readOnly": true }, "total_deals": { "type": "string", "readOnly": true }, "completed_deals": { "type": "string", "readOnly": true }, "vertical": { "type": "string" }, "segment": { "type": "string" }, "website_url": { "type": "string" }, "region": { "type": "string" }, "customer": { "type": "string", "readOnly": true }, "is_favourite": { "type": "boolean" }, "currency_unit": { "type": "string", "readOnly": true }, "logo_path": { "type": "string", "readOnly": true }, "logo": { "type": "string", "readOnly": true }, "insight": { "type": "object", "additionalProperties": {} }, "total_formatted_revenue": { "type": "string", "readOnly": true }, "is_internal_account": { "type": "boolean" }, "company_id": { "type": "string", "nullable": true } }, "required": [ "account_id", "account_owner", "completed_deals", "completed_projects", "currency_unit", "customer", "health_score", "linked_projects", "logo", "logo_path", "total_deals", "total_formatted_revenue", "total_projects", "total_revenue" ] }, "ActivityLog": { "type": "object", "description": "Serializer for Documents.\n\nRecognized primitve fields:\n\n * ``StringField``\n * ``URLField``\n * ``EmailField``\n * ``IntField``\n * ``LongField``\n * ``FloatField``\n * ``DecimalField``\n * ``BooleanField``\n * ``DateTimeField``\n * ``ComplexDateTimeField``\n * ``ObjectIdField``\n * ``SequenceField`` (assumes it has integer counter)\n * ``UUIDField``\n * ``GeoPointField``\n * ``GeoJsonBaseField`` (all those fields)\n * ``DateField``\n\nCompound fields: ``ListField`` and ``DictField`` are mapped to corresponding DRF fields, with respect to nested field specification.\n\nThe ``ReferenceField`` is handled like ``ForeignKey`` in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as ``str(id)``).\n\nFor ``EmbeddedDocumentField`` also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.\n\nGeneric fields ``GenericReferenceField`` and ``GenericEmbeddedDocumentField`` are handled by their own with corresponding serializer fields.\n\nNot well supported or untested:\n\n ``FileField``\n ``ImageField``\n ``BinaryField``\n\nAll other fields are mapped to ``DocumentField`` and probably will work wrong.", "properties": { "log_id": { "type": "string", "maxLength": 25 }, "title": { "type": "string" }, "raw_description": { "type": "object", "additionalProperties": {} }, "description": { "type": "string" }, "html_description": { "type": "string" }, "created_by": { "type": "string", "readOnly": true }, "icon": { "type": "string", "readOnly": true }, "time_ago": { "type": "string", "readOnly": true }, "avatar": { "type": "string", "readOnly": true } }, "required": [ "avatar", "created_by", "icon", "log_id", "time_ago" ] }, "Attachment": { "type": "object", "description": "Serializer for Documents.\n\nRecognized primitve fields:\n\n * ``StringField``\n * ``URLField``\n * ``EmailField``\n * ``IntField``\n * ``LongField``\n * ``FloatField``\n * ``DecimalField``\n * ``BooleanField``\n * ``DateTimeField``\n * ``ComplexDateTimeField``\n * ``ObjectIdField``\n * ``SequenceField`` (assumes it has integer counter)\n * ``UUIDField``\n * ``GeoPointField``\n * ``GeoJsonBaseField`` (all those fields)\n * ``DateField``\n\nCompound fields: ``ListField`` and ``DictField`` are mapped to corresponding DRF fields, with respect to nested field specification.\n\nThe ``ReferenceField`` is handled like ``ForeignKey`` in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as ``str(id)``).\n\nFor ``EmbeddedDocumentField`` also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.\n\nGeneric fields ``GenericReferenceField`` and ``GenericEmbeddedDocumentField`` are handled by their own with corresponding serializer fields.\n\nNot well supported or untested:\n\n ``FileField``\n ``ImageField``\n ``BinaryField``\n\nAll other fields are mapped to ``DocumentField`` and probably will work wrong.", "properties": { "id": { "type": "string", "readOnly": true }, "attach_id": { "type": "string" }, "organization": { "type": "string" }, "module_id": { "type": "integer" }, "module_name": { "type": "string" }, "sub_module": { "type": "string" }, "storage_type": { "type": "string" }, "reference_id": { "type": "string", "nullable": true }, "account_id": { "type": "string", "nullable": true }, "file_name": { "type": "string" }, "zip_file_name": { "type": "string" }, "file_type": { "type": "string", "maxLength": 225 }, "file_size": { "type": "integer" }, "file_path": { "type": "string" }, "file_icon": { "type": "string" }, "version": { "type": "integer", "nullable": true }, "description": { "type": "string" }, "creation_time": { "type": "string", "format": "date-time" }, "last_update_time": { "type": "string", "format": "date-time" }, "is_deleted": { "type": "boolean" }, "created_by": { "type": "string" }, "is_private": { "type": "boolean" }, "show_download_icon": { "type": "boolean", "default": true }, "tags": { "type": "array", "items": {} }, "private_users": { "type": "array", "items": {} }, "parent_attach_id": { "type": "string", "nullable": true }, "show_in_document": { "type": "boolean" }, "document_name": { "type": "string" }, "latest_version": { "type": "boolean", "default": true }, "view_count": { "type": "integer" }, "download_count": { "type": "integer" }, "share_count": { "type": "integer" }, "in_line_type": { "type": "integer" }, "file_hash": { "type": "string", "nullable": true }, "public_config": { "type": "object", "additionalProperties": {}, "nullable": true }, "external_file_url": { "type": "string", "nullable": true }, "menu_type": { "type": "string", "nullable": true }, "editorjs_content": { "type": "object", "additionalProperties": {}, "nullable": true }, "editor_html_content": { "type": "string", "nullable": true }, "is_editorjs_document": { "type": "boolean" }, "document_status": { "allOf": [ { "$ref": "#/components/schemas/DocumentStatusEnum" } ], "default": "published" }, "published_at": { "type": "string", "format": "date-time", "nullable": true }, "signature_status": { "nullable": true, "default": "none", "oneOf": [ { "$ref": "#/components/schemas/SignatureStatusEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "signatures_required": { "type": "integer", "nullable": true }, "signatures_completed": { "type": "integer", "nullable": true }, "signature_enabled": { "type": "boolean" }, "external_template_id": { "type": "integer", "nullable": true }, "external_template_slug": { "type": "string", "nullable": true }, "external_frozen_template_id": { "type": "integer", "nullable": true }, "external_frozen_template_slug": { "type": "string", "nullable": true }, "external_submission_id": { "type": "integer", "nullable": true }, "signature_recipients": { "type": "array", "items": {}, "nullable": true }, "external_signed_document_url": { "type": "string", "nullable": true }, "external_audit_log_url": { "type": "string", "nullable": true }, "signed_at": { "type": "string", "format": "date-time", "nullable": true }, "is_signed_version": { "type": "boolean" }, "original_attach_id": { "type": "string", "nullable": true }, "version_type": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VersionTypeEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] } }, "required": [ "attach_id", "document_name", "id", "organization" ] }, "BlankEnum": { "enum": [ "" ] }, "CompanyList": { "type": "object", "description": "Serializer for Documents.\n\nRecognized primitve fields:\n\n * ``StringField``\n * ``URLField``\n * ``EmailField``\n * ``IntField``\n * ``LongField``\n * ``FloatField``\n * ``DecimalField``\n * ``BooleanField``\n * ``DateTimeField``\n * ``ComplexDateTimeField``\n * ``ObjectIdField``\n * ``SequenceField`` (assumes it has integer counter)\n * ``UUIDField``\n * ``GeoPointField``\n * ``GeoJsonBaseField`` (all those fields)\n * ``DateField``\n\nCompound fields: ``ListField`` and ``DictField`` are mapped to corresponding DRF fields, with respect to nested field specification.\n\nThe ``ReferenceField`` is handled like ``ForeignKey`` in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as ``str(id)``).\n\nFor ``EmbeddedDocumentField`` also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.\n\nGeneric fields ``GenericReferenceField`` and ``GenericEmbeddedDocumentField`` are handled by their own with corresponding serializer fields.\n\nNot well supported or untested:\n\n ``FileField``\n ``ImageField``\n ``BinaryField``\n\nAll other fields are mapped to ``DocumentField`` and probably will work wrong.", "properties": { "id": { "type": "string", "readOnly": true }, "company_id": { "type": "string" }, "display_id": { "type": "string", "nullable": true, "maxLength": 100 }, "company_name": { "type": "string", "maxLength": 255 }, "domain": { "type": "string", "nullable": true }, "linkedin_url": { "type": "string", "readOnly": true }, "twitter_url": { "type": "string", "readOnly": true }, "hq_location": { "type": "string", "readOnly": true }, "hq_country": { "type": "string", "readOnly": true }, "industry": { "type": "string", "readOnly": true }, "employee_range": { "type": "string", "nullable": true }, "estimated_arr": { "type": "string", "readOnly": true }, "description": { "type": "string", "nullable": true }, "logo_url": { "type": "string", "readOnly": true }, "company_owner": { "type": "string", "readOnly": true }, "company_type": { "type": "string", "nullable": true }, "lead_status": { "type": "string", "readOnly": true }, "icp_fit": { "type": "string", "nullable": true }, "customer_segment": { "type": "string", "readOnly": true }, "connection_strength": { "type": "string", "nullable": true }, "connection_source": { "type": "string", "nullable": true }, "operating_regions": { "type": "string", "readOnly": true }, "category": { "type": "string", "nullable": true }, "vendor_being_replaced": { "type": "string", "nullable": true }, "replacement_urgency": { "type": "string", "nullable": true }, "partner_type": { "type": "string", "readOnly": true }, "parent_company": { "type": "string", "nullable": true }, "investors": { "type": "string", "readOnly": true }, "partners": { "type": "string", "readOnly": true }, "subsidiaries": { "type": "string", "readOnly": true }, "contacts_count": { "type": "string", "readOnly": true }, "is_draft": { "type": "boolean" }, "creation_time": { "type": "string", "format": "date-time" }, "last_update_time": { "type": "string", "format": "date-time" }, "record_source": { "type": "string", "readOnly": true }, "custom_fields": { "type": "object", "additionalProperties": {} }, "associated_deal_project": { "type": "string", "readOnly": true } }, "required": [ "associated_deal_project", "company_id", "company_name", "company_owner", "contacts_count", "customer_segment", "estimated_arr", "hq_country", "hq_location", "id", "industry", "investors", "lead_status", "linkedin_url", "logo_url", "operating_regions", "partner_type", "partners", "record_source", "subsidiaries", "twitter_url" ] }, "ContactList": { "type": "object", "description": "Serializer for Documents.\n\nRecognized primitve fields:\n\n * ``StringField``\n * ``URLField``\n * ``EmailField``\n * ``IntField``\n * ``LongField``\n * ``FloatField``\n * ``DecimalField``\n * ``BooleanField``\n * ``DateTimeField``\n * ``ComplexDateTimeField``\n * ``ObjectIdField``\n * ``SequenceField`` (assumes it has integer counter)\n * ``UUIDField``\n * ``GeoPointField``\n * ``GeoJsonBaseField`` (all those fields)\n * ``DateField``\n\nCompound fields: ``ListField`` and ``DictField`` are mapped to corresponding DRF fields, with respect to nested field specification.\n\nThe ``ReferenceField`` is handled like ``ForeignKey`` in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as ``str(id)``).\n\nFor ``EmbeddedDocumentField`` also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.\n\nGeneric fields ``GenericReferenceField`` and ``GenericEmbeddedDocumentField`` are handled by their own with corresponding serializer fields.\n\nNot well supported or untested:\n\n ``FileField``\n ``ImageField``\n ``BinaryField``\n\nAll other fields are mapped to ``DocumentField`` and probably will work wrong.", "properties": { "id": { "type": "string", "readOnly": true }, "contact_id": { "type": "string" }, "display_id": { "type": "string", "nullable": true, "maxLength": 100 }, "full_name": { "type": "string", "maxLength": 255 }, "profile_image": { "type": "string", "nullable": true }, "profile_image_url": { "type": "string", "readOnly": true }, "primary_email": { "type": "string", "readOnly": true }, "company": { "type": "string", "readOnly": true }, "lead_source": { "type": "string", "readOnly": true }, "contact_owner": { "type": "string", "readOnly": true }, "associated_deals": { "type": "array", "items": {} }, "lead_status": { "type": "string", "nullable": true }, "person_category": { "type": "string", "readOnly": true }, "custom_fields": { "type": "object", "additionalProperties": {} }, "contact_stage": { "type": "string", "nullable": true }, "is_draft": { "type": "boolean" }, "job_title": { "type": "string", "nullable": true }, "department": { "type": "string", "nullable": true }, "location": { "type": "object", "additionalProperties": {}, "nullable": true }, "language": { "type": "string", "nullable": true }, "seniority_level": { "type": "string", "readOnly": true }, "buying_role": { "type": "string", "readOnly": true }, "influence_level": { "type": "integer", "nullable": true }, "interest_level": { "type": "integer", "nullable": true }, "preferred_communication_channel": { "type": "string", "nullable": true }, "do_not_contact": { "type": "string", "nullable": true, "maxLength": 10 }, "phone": { "type": "string", "readOnly": true }, "whatsapp_number": { "type": "string", "readOnly": true }, "campaign": { "type": "string", "nullable": true }, "timezone": { "type": "string", "nullable": true }, "signoff_authority": { "type": "string", "nullable": true }, "lead_score": { "type": "number", "format": "double", "nullable": true }, "last_activity_date": { "type": "string", "format": "date-time", "nullable": true }, "linkedin_url": { "type": "string", "readOnly": true }, "twitter_url": { "type": "string", "readOnly": true }, "linked_user": { "type": "string", "readOnly": true }, "creation_time": { "type": "string", "format": "date-time" }, "last_update_time": { "type": "string", "format": "date-time" }, "reports_to": { "type": "object", "additionalProperties": {}, "nullable": true }, "reporting_hierarchy_level": { "type": "integer", "nullable": true }, "reporting_confidence": { "type": "number", "format": "double", "nullable": true }, "reporting_source": { "type": "string", "nullable": true }, "associated_deal_project": { "type": "string", "readOnly": true }, "login_info": { "type": "string", "readOnly": true } }, "required": [ "associated_deal_project", "buying_role", "company", "contact_id", "contact_owner", "full_name", "id", "lead_source", "linked_user", "linkedin_url", "login_info", "person_category", "phone", "primary_email", "profile_image_url", "seniority_level", "twitter_url", "whatsapp_number" ] }, "Dashboard": { "type": "object", "description": "Main dashboard serializer", "properties": { "dashboard_id": { "type": "string", "maxLength": 25 }, "dashboard_name": { "type": "string", "maxLength": 100 }, "description": { "type": "string" }, "dashboard_type": { "allOf": [ { "$ref": "#/components/schemas/DashboardTypeEnum" } ], "default": "overview" }, "is_system_defined": { "type": "boolean", "default": true }, "is_default": { "type": "boolean" }, "visibility": { "allOf": [ { "$ref": "#/components/schemas/VisibilityEnum" } ], "default": "public" }, "widgets": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardWidget" } }, "access_list": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardAccess" } }, "access_count": { "type": "integer" }, "cache_ttl": { "type": "integer", "default": 300 }, "layout_config": { "type": "object", "additionalProperties": {} }, "theme_config": { "type": "object", "additionalProperties": {} }, "time_range_default": { "type": "string", "default": "30_days", "maxLength": 20 } }, "required": [ "dashboard_id", "dashboard_name" ] }, "DashboardAccess": { "type": "object", "description": "Serializer for dashboard access control", "properties": { "access_type": { "$ref": "#/components/schemas/AccessTypeEnum" }, "access_id": { "type": "string", "maxLength": 25 }, "permission_level": { "allOf": [ { "$ref": "#/components/schemas/PermissionLevelEnum" } ], "default": "view" }, "granted_by": { "type": "string", "maxLength": 25 }, "granted_at": { "type": "string", "format": "date-time", "default": "2026-07-01T11:44:45.305634Z" } }, "required": [ "access_id", "access_type" ] }, "DashboardTypeEnum": { "enum": [ "overview", "deals", "projects", "revenue", "activities", "custom" ], "type": "string", "description": "* `overview` - overview\n* `deals` - deals\n* `projects` - projects\n* `revenue` - revenue\n* `activities` - activities\n* `custom` - custom" }, "DashboardWidget": { "type": "object", "description": "Serializer for dashboard widget configuration", "properties": { "widget_id": { "type": "string", "maxLength": 25 }, "widget_type": { "type": "string", "maxLength": 50 }, "position": { "type": "object", "additionalProperties": {} }, "config": { "type": "object", "additionalProperties": {} }, "is_visible": { "type": "boolean", "default": true }, "refresh_interval": { "type": "integer", "default": 300 }, "last_refreshed": { "type": "string", "format": "date-time" } }, "required": [ "widget_id", "widget_type" ] }, "DocumentStatusEnum": { "enum": [ "draft", "published" ], "type": "string", "description": "* `draft` - draft\n* `published` - published" }, "Embedded": { "type": "object", "description": "Serializer for EmbeddedDocuments.\n\nSkips id field and uniqueness validation.\nWhen saving, skips calling instance.save", "properties": { "name": { "type": "string" }, "date": { "type": "string", "format": "date" }, "is_repeat_annually": { "type": "boolean" } }, "required": [ "date", "name" ] }, "Holi": { "type": "object", "description": "Serializer for Documents.\n\nRecognized primitve fields:\n\n * ``StringField``\n * ``URLField``\n * ``EmailField``\n * ``IntField``\n * ``LongField``\n * ``FloatField``\n * ``DecimalField``\n * ``BooleanField``\n * ``DateTimeField``\n * ``ComplexDateTimeField``\n * ``ObjectIdField``\n * ``SequenceField`` (assumes it has integer counter)\n * ``UUIDField``\n * ``GeoPointField``\n * ``GeoJsonBaseField`` (all those fields)\n * ``DateField``\n\nCompound fields: ``ListField`` and ``DictField`` are mapped to corresponding DRF fields, with respect to nested field specification.\n\nThe ``ReferenceField`` is handled like ``ForeignKey`` in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as ``str(id)``).\n\nFor ``EmbeddedDocumentField`` also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.\n\nGeneric fields ``GenericReferenceField`` and ``GenericEmbeddedDocumentField`` are handled by their own with corresponding serializer fields.\n\nNot well supported or untested:\n\n ``FileField``\n ``ImageField``\n ``BinaryField``\n\nAll other fields are mapped to ``DocumentField`` and probably will work wrong.", "properties": { "holidays_id": { "type": "string", "maxLength": 25 }, "country": { "type": "string" }, "state": { "type": "string" }, "holidays": { "type": "array", "items": { "$ref": "#/components/schemas/Embedded" } } }, "required": [ "holidays_id" ] }, "InteractionsList": { "type": "object", "description": "Serializer for listing interactions with pagination", "properties": { "interaction_id": { "type": "string", "maxLength": 25 }, "content": { "type": "string" }, "interaction_type": { "type": "string", "default": "interaction" }, "is_pinned": { "type": "boolean" }, "is_resolved": { "type": "boolean" }, "is_private": { "type": "boolean" }, "visible_to_users": { "type": "array", "items": { "type": "string" } }, "reply_count": { "type": "integer" }, "mentions": { "type": "array", "items": { "$ref": "#/components/schemas/Embedded" } }, "reactions": { "type": "array", "items": { "$ref": "#/components/schemas/Embedded" } }, "formatted_creation_time": { "type": "string", "readOnly": true }, "user_details": { "type": "string", "readOnly": true }, "is_read": { "type": "string", "readOnly": true }, "attachment_files": { "type": "string", "readOnly": true }, "reply_interactions": { "type": "string", "readOnly": true }, "thread_level": { "type": "integer" }, "parent_interaction_id": { "type": "string", "nullable": true, "maxLength": 25 }, "reactions_summary": { "type": "string", "readOnly": true }, "is_system_generated": { "type": "boolean" } }, "required": [ "attachment_files", "content", "formatted_creation_time", "interaction_id", "is_read", "reactions_summary", "reply_interactions", "user_details" ] }, "ItemTypeEnum": { "enum": [ "survey", "survey_template", "form" ], "type": "string", "description": "* `survey` - survey\n* `survey_template` - survey_template\n* `form` - form" }, "Items": { "type": "object", "description": "Serializer for Documents.\n\nRecognized primitve fields:\n\n * ``StringField``\n * ``URLField``\n * ``EmailField``\n * ``IntField``\n * ``LongField``\n * ``FloatField``\n * ``DecimalField``\n * ``BooleanField``\n * ``DateTimeField``\n * ``ComplexDateTimeField``\n * ``ObjectIdField``\n * ``SequenceField`` (assumes it has integer counter)\n * ``UUIDField``\n * ``GeoPointField``\n * ``GeoJsonBaseField`` (all those fields)\n * ``DateField``\n\nCompound fields: ``ListField`` and ``DictField`` are mapped to corresponding DRF fields, with respect to nested field specification.\n\nThe ``ReferenceField`` is handled like ``ForeignKey`` in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as ``str(id)``).\n\nFor ``EmbeddedDocumentField`` also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.\n\nGeneric fields ``GenericReferenceField`` and ``GenericEmbeddedDocumentField`` are handled by their own with corresponding serializer fields.\n\nNot well supported or untested:\n\n ``FileField``\n ``ImageField``\n ``BinaryField``\n\nAll other fields are mapped to ``DocumentField`` and probably will work wrong.", "properties": { "item_id": { "type": "string", "maxLength": 25 }, "display_id": { "type": "string", "maxLength": 10 }, "title": { "type": "string" }, "item_type": { "type": "integer", "default": 1 }, "due_date": { "type": "string", "format": "date" }, "tags": { "type": "array", "items": {} }, "is_completed": { "type": "boolean" }, "priority": { "type": "object", "additionalProperties": {} }, "status": { "type": "object", "additionalProperties": {} }, "owner": { "type": "object", "additionalProperties": {} }, "project_id": { "type": "string", "maxLength": 25 }, "milestone_id": { "type": "string", "maxLength": 25 }, "is_private": { "type": "boolean" }, "visibility": { "type": "string", "default": "shared" }, "is_starred": { "type": "boolean" }, "is_predefined": { "type": "boolean" }, "users": { "type": "string", "readOnly": true }, "is_risk": { "type": "boolean" }, "is_blocked": { "type": "boolean" }, "attachments": { "type": "string", "readOnly": true }, "time_track_id": { "type": "string" }, "creation_time": { "type": "string", "format": "date-time" }, "last_update_time": { "type": "string", "format": "date-time" }, "sub_items": { "type": "string", "readOnly": true }, "parent_id": { "type": "string", "nullable": true, "maxLength": 25 }, "is_timer_running": { "type": "boolean" }, "total_elapsed_time": { "type": "string", "readOnly": true }, "position": { "type": "integer" }, "is_recurring": { "type": "boolean" }, "parent_recurring_id": { "type": "string", "nullable": true, "maxLength": 25 }, "recurrence_pattern": { "type": "string", "readOnly": true }, "recurrence_status": { "type": "string", "default": "active" }, "is_recurring_child": { "type": "string", "readOnly": true }, "custom_fields": { "type": "string", "readOnly": true }, "form_id": { "type": "string", "nullable": true, "maxLength": 25 }, "form_structure": { "type": "object", "additionalProperties": {}, "nullable": true }, "form_responses": { "type": "object", "additionalProperties": {}, "nullable": true }, "meeting_summary_id": { "type": "string", "nullable": true, "maxLength": 25 }, "calendar_id": { "type": "string", "nullable": true, "maxLength": 25 }, "external_map": { "type": "object", "additionalProperties": {}, "nullable": true } }, "required": [ "attachments", "custom_fields", "is_recurring_child", "item_id", "recurrence_pattern", "sub_items", "title", "total_elapsed_time", "users" ] }, "MeetingInsights": { "type": "object", "description": "Serializer for Documents.\n\nRecognized primitve fields:\n\n * ``StringField``\n * ``URLField``\n * ``EmailField``\n * ``IntField``\n * ``LongField``\n * ``FloatField``\n * ``DecimalField``\n * ``BooleanField``\n * ``DateTimeField``\n * ``ComplexDateTimeField``\n * ``ObjectIdField``\n * ``SequenceField`` (assumes it has integer counter)\n * ``UUIDField``\n * ``GeoPointField``\n * ``GeoJsonBaseField`` (all those fields)\n * ``DateField``\n\nCompound fields: ``ListField`` and ``DictField`` are mapped to corresponding DRF fields, with respect to nested field specification.\n\nThe ``ReferenceField`` is handled like ``ForeignKey`` in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as ``str(id)``).\n\nFor ``EmbeddedDocumentField`` also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.\n\nGeneric fields ``GenericReferenceField`` and ``GenericEmbeddedDocumentField`` are handled by their own with corresponding serializer fields.\n\nNot well supported or untested:\n\n ``FileField``\n ``ImageField``\n ``BinaryField``\n\nAll other fields are mapped to ``DocumentField`` and probably will work wrong.", "properties": { "meeting_insight_id": { "type": "string" }, "calendar_id": { "type": "string" }, "title": { "type": "string", "readOnly": true }, "start_time": { "type": "string", "readOnly": true }, "duration": { "type": "string", "readOnly": true }, "users": { "type": "string", "readOnly": true }, "status": { "type": "string", "readOnly": true }, "is_favorite": { "type": "string", "readOnly": true } }, "required": [ "calendar_id", "duration", "is_favorite", "meeting_insight_id", "start_time", "status", "title", "users" ] }, "NotifyHub": { "type": "object", "description": "Serializer for Documents.\n\nRecognized primitve fields:\n\n * ``StringField``\n * ``URLField``\n * ``EmailField``\n * ``IntField``\n * ``LongField``\n * ``FloatField``\n * ``DecimalField``\n * ``BooleanField``\n * ``DateTimeField``\n * ``ComplexDateTimeField``\n * ``ObjectIdField``\n * ``SequenceField`` (assumes it has integer counter)\n * ``UUIDField``\n * ``GeoPointField``\n * ``GeoJsonBaseField`` (all those fields)\n * ``DateField``\n\nCompound fields: ``ListField`` and ``DictField`` are mapped to corresponding DRF fields, with respect to nested field specification.\n\nThe ``ReferenceField`` is handled like ``ForeignKey`` in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as ``str(id)``).\n\nFor ``EmbeddedDocumentField`` also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.\n\nGeneric fields ``GenericReferenceField`` and ``GenericEmbeddedDocumentField`` are handled by their own with corresponding serializer fields.\n\nNot well supported or untested:\n\n ``FileField``\n ``ImageField``\n ``BinaryField``\n\nAll other fields are mapped to ``DocumentField`` and probably will work wrong.", "properties": { "notification_id": { "type": "string", "maxLength": 25 }, "user_id": { "type": "string" }, "notification_type": { "type": "integer" }, "title": { "type": "string" }, "description": { "type": "string" }, "notification_obj": { "type": "object", "additionalProperties": {} }, "notify_time": { "type": "string", "format": "date-time" }, "read": { "type": "boolean" }, "category": { "type": "string" }, "is_system": { "type": "boolean" } }, "required": [ "notification_id", "user_id" ] }, "NullEnum": { "enum": [ null ] }, "PatchedDashboard": { "type": "object", "description": "Main dashboard serializer", "properties": { "dashboard_id": { "type": "string", "maxLength": 25 }, "dashboard_name": { "type": "string", "maxLength": 100 }, "description": { "type": "string" }, "dashboard_type": { "allOf": [ { "$ref": "#/components/schemas/DashboardTypeEnum" } ], "default": "overview" }, "is_system_defined": { "type": "boolean", "default": true }, "is_default": { "type": "boolean" }, "visibility": { "allOf": [ { "$ref": "#/components/schemas/VisibilityEnum" } ], "default": "public" }, "widgets": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardWidget" } }, "access_list": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardAccess" } }, "access_count": { "type": "integer" }, "cache_ttl": { "type": "integer", "default": 300 }, "layout_config": { "type": "object", "additionalProperties": {} }, "theme_config": { "type": "object", "additionalProperties": {} }, "time_range_default": { "type": "string", "default": "30_days", "maxLength": 20 } } }, "PatchedRoleOpt": { "type": "object", "description": "Serializer for Documents.\n\nRecognized primitve fields:\n\n * ``StringField``\n * ``URLField``\n * ``EmailField``\n * ``IntField``\n * ``LongField``\n * ``FloatField``\n * ``DecimalField``\n * ``BooleanField``\n * ``DateTimeField``\n * ``ComplexDateTimeField``\n * ``ObjectIdField``\n * ``SequenceField`` (assumes it has integer counter)\n * ``UUIDField``\n * ``GeoPointField``\n * ``GeoJsonBaseField`` (all those fields)\n * ``DateField``\n\nCompound fields: ``ListField`` and ``DictField`` are mapped to corresponding DRF fields, with respect to nested field specification.\n\nThe ``ReferenceField`` is handled like ``ForeignKey`` in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as ``str(id)``).\n\nFor ``EmbeddedDocumentField`` also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.\n\nGeneric fields ``GenericReferenceField`` and ``GenericEmbeddedDocumentField`` are handled by their own with corresponding serializer fields.\n\nNot well supported or untested:\n\n ``FileField``\n ``ImageField``\n ``BinaryField``\n\nAll other fields are mapped to ``DocumentField`` and probably will work wrong.", "properties": { "role_id": { "type": "string" }, "role_name": { "type": "string", "maxLength": 100 }, "is_customer_role": { "type": "boolean" }, "is_admin_role": { "type": "boolean" }, "is_manager_role": { "type": "boolean" }, "is_observer_role": { "type": "boolean" }, "is_user_role": { "type": "boolean" }, "is_partner_role": { "type": "boolean" }, "is_organization_admin_role": { "type": "boolean" }, "is_pre_sales_consultant": { "type": "boolean" }, "is_system_role": { "type": "boolean" } } }, "PatchedTags": { "type": "object", "description": "Serializer for Documents.\n\nRecognized primitve fields:\n\n * ``StringField``\n * ``URLField``\n * ``EmailField``\n * ``IntField``\n * ``LongField``\n * ``FloatField``\n * ``DecimalField``\n * ``BooleanField``\n * ``DateTimeField``\n * ``ComplexDateTimeField``\n * ``ObjectIdField``\n * ``SequenceField`` (assumes it has integer counter)\n * ``UUIDField``\n * ``GeoPointField``\n * ``GeoJsonBaseField`` (all those fields)\n * ``DateField``\n\nCompound fields: ``ListField`` and ``DictField`` are mapped to corresponding DRF fields, with respect to nested field specification.\n\nThe ``ReferenceField`` is handled like ``ForeignKey`` in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as ``str(id)``).\n\nFor ``EmbeddedDocumentField`` also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.\n\nGeneric fields ``GenericReferenceField`` and ``GenericEmbeddedDocumentField`` are handled by their own with corresponding serializer fields.\n\nNot well supported or untested:\n\n ``FileField``\n ``ImageField``\n ``BinaryField``\n\nAll other fields are mapped to ``DocumentField`` and probably will work wrong.", "properties": { "tag_id": { "type": "string", "maxLength": 25 }, "tag_name": { "type": "string" }, "description": { "type": "string" }, "tag_type": { "type": "integer" }, "is_predefined": { "type": "boolean" } } }, "PermissionLevelEnum": { "enum": [ "view", "edit", "admin" ], "type": "string", "description": "* `view` - view\n* `edit` - edit\n* `admin` - admin" }, "Projects": { "type": "object", "description": "Serializer for Documents.\n\nRecognized primitve fields:\n\n * ``StringField``\n * ``URLField``\n * ``EmailField``\n * ``IntField``\n * ``LongField``\n * ``FloatField``\n * ``DecimalField``\n * ``BooleanField``\n * ``DateTimeField``\n * ``ComplexDateTimeField``\n * ``ObjectIdField``\n * ``SequenceField`` (assumes it has integer counter)\n * ``UUIDField``\n * ``GeoPointField``\n * ``GeoJsonBaseField`` (all those fields)\n * ``DateField``\n\nCompound fields: ``ListField`` and ``DictField`` are mapped to corresponding DRF fields, with respect to nested field specification.\n\nThe ``ReferenceField`` is handled like ``ForeignKey`` in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as ``str(id)``).\n\nFor ``EmbeddedDocumentField`` also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.\n\nGeneric fields ``GenericReferenceField`` and ``GenericEmbeddedDocumentField`` are handled by their own with corresponding serializer fields.\n\nNot well supported or untested:\n\n ``FileField``\n ``ImageField``\n ``BinaryField``\n\nAll other fields are mapped to ``DocumentField`` and probably will work wrong.", "properties": { "project_id": { "type": "string", "maxLength": 25 }, "project_name": { "type": "string" }, "description": { "type": "string" }, "start_date": { "type": "string", "format": "date-time" }, "due_date": { "type": "string", "format": "date-time" }, "project_score": { "type": "string", "readOnly": true }, "tasks_count": { "type": "integer" }, "milestones_count": { "type": "integer" }, "phase": { "type": "object", "additionalProperties": {} }, "tags": { "type": "array", "items": {} }, "project_manager": { "type": "object", "additionalProperties": {} }, "is_arr": { "type": "boolean" }, "revenue": { "type": "integer" }, "show_forecasted_date": { "type": "boolean" }, "forecasted_date": { "type": "string", "format": "date-time" }, "project_fee": { "type": "integer" }, "project_owner": { "type": "string", "readOnly": true }, "status": { "type": "object", "additionalProperties": {} }, "template_id": { "type": "string" }, "currency_unit": { "type": "string", "readOnly": true }, "stages": { "type": "string", "readOnly": true }, "project_team": { "type": "string", "readOnly": true }, "visible_to_all": { "type": "boolean", "default": true }, "account_id": { "type": "string", "maxLength": 25 }, "insights": { "type": "string", "readOnly": true }, "current_stage": { "type": "string", "readOnly": true }, "milestone_status": { "type": "string", "readOnly": true }, "recent_activities": { "type": "string", "readOnly": true }, "time_left": { "type": "string", "readOnly": true }, "time_spent": { "type": "string", "readOnly": true }, "customer_project_owner": { "type": "string", "readOnly": true }, "partner_orgs": { "type": "string", "readOnly": true }, "project_type_str": { "type": "string", "readOnly": true }, "project_type": { "type": "string" }, "billing_model": { "type": "string" }, "billing_frequency": { "type": "string" }, "hourly_rate": { "type": "integer" }, "monthly_rate": { "type": "integer" }, "expected_onboarding_fee": { "type": "integer" }, "project_duration": { "type": "integer" }, "external_map": { "type": "object", "additionalProperties": {}, "nullable": true }, "template_name": { "type": "string", "readOnly": true }, "template_desc": { "type": "string", "readOnly": true }, "pipeline_id": { "type": "string", "nullable": true }, "calculated_revenue": { "type": "string", "readOnly": true }, "object_source": { "type": "string", "readOnly": true }, "current_milestone_id": { "type": "string", "nullable": true }, "position": { "type": "integer" }, "expected_deal_value": { "type": "integer" }, "deal_resources": { "type": "integer" }, "contract_duration": { "type": "integer" }, "pipeline_stages": { "type": "string", "readOnly": true }, "current_pipe_stage": { "type": "string", "readOnly": true }, "formatted_deal_value": { "type": "string", "readOnly": true }, "formatted_revenue": { "type": "string", "readOnly": true }, "formatted_other_revenue": { "type": "string", "readOnly": true }, "other_revenue": { "type": "string", "readOnly": true }, "custom_fields": { "type": "array", "items": {} }, "created_by": { "type": "string", "nullable": true }, "invite_type": { "type": "string", "nullable": true } }, "required": [ "calculated_revenue", "currency_unit", "current_pipe_stage", "current_stage", "customer_project_owner", "formatted_deal_value", "formatted_other_revenue", "formatted_revenue", "insights", "milestone_status", "object_source", "other_revenue", "partner_orgs", "pipeline_stages", "project_id", "project_owner", "project_score", "project_team", "project_type_str", "recent_activities", "stages", "template_desc", "template_name", "time_left", "time_spent" ] }, "ProjetlyCalendar": { "type": "object", "description": "Serializer for Documents.\n\nRecognized primitve fields:\n\n * ``StringField``\n * ``URLField``\n * ``EmailField``\n * ``IntField``\n * ``LongField``\n * ``FloatField``\n * ``DecimalField``\n * ``BooleanField``\n * ``DateTimeField``\n * ``ComplexDateTimeField``\n * ``ObjectIdField``\n * ``SequenceField`` (assumes it has integer counter)\n * ``UUIDField``\n * ``GeoPointField``\n * ``GeoJsonBaseField`` (all those fields)\n * ``DateField``\n\nCompound fields: ``ListField`` and ``DictField`` are mapped to corresponding DRF fields, with respect to nested field specification.\n\nThe ``ReferenceField`` is handled like ``ForeignKey`` in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as ``str(id)``).\n\nFor ``EmbeddedDocumentField`` also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.\n\nGeneric fields ``GenericReferenceField`` and ``GenericEmbeddedDocumentField`` are handled by their own with corresponding serializer fields.\n\nNot well supported or untested:\n\n ``FileField``\n ``ImageField``\n ``BinaryField``\n\nAll other fields are mapped to ``DocumentField`` and probably will work wrong.", "properties": { "calendar_id": { "type": "string", "maxLength": 25 }, "title": { "type": "string" }, "class_name": { "type": "string" }, "location": { "type": "string" }, "description": { "type": "string" }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "users": { "type": "string", "readOnly": true }, "optional_users": { "type": "string", "readOnly": true }, "all_day": { "type": "boolean" }, "extended_props": { "type": "object", "additionalProperties": {} }, "link": { "type": "string" }, "repeat": { "type": "object", "additionalProperties": {} }, "project": { "type": "string" }, "milestone_id": { "type": "string", "nullable": true, "maxLength": 25 }, "is_video_conference": { "type": "boolean" }, "video_conference_type": { "type": "string" }, "timezone": { "type": "object", "additionalProperties": {} }, "is_meeting_cancelled": { "type": "boolean" }, "cancel_note": { "type": "string" }, "attendees": { "type": "string", "readOnly": true }, "push_to_google": { "type": "boolean" }, "push_to_microsoft": { "type": "boolean" } }, "required": [ "attendees", "calendar_id", "optional_users", "title", "users" ] }, "RoleOpt": { "type": "object", "description": "Serializer for Documents.\n\nRecognized primitve fields:\n\n * ``StringField``\n * ``URLField``\n * ``EmailField``\n * ``IntField``\n * ``LongField``\n * ``FloatField``\n * ``DecimalField``\n * ``BooleanField``\n * ``DateTimeField``\n * ``ComplexDateTimeField``\n * ``ObjectIdField``\n * ``SequenceField`` (assumes it has integer counter)\n * ``UUIDField``\n * ``GeoPointField``\n * ``GeoJsonBaseField`` (all those fields)\n * ``DateField``\n\nCompound fields: ``ListField`` and ``DictField`` are mapped to corresponding DRF fields, with respect to nested field specification.\n\nThe ``ReferenceField`` is handled like ``ForeignKey`` in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as ``str(id)``).\n\nFor ``EmbeddedDocumentField`` also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.\n\nGeneric fields ``GenericReferenceField`` and ``GenericEmbeddedDocumentField`` are handled by their own with corresponding serializer fields.\n\nNot well supported or untested:\n\n ``FileField``\n ``ImageField``\n ``BinaryField``\n\nAll other fields are mapped to ``DocumentField`` and probably will work wrong.", "properties": { "role_id": { "type": "string" }, "role_name": { "type": "string", "maxLength": 100 }, "is_customer_role": { "type": "boolean" }, "is_admin_role": { "type": "boolean" }, "is_manager_role": { "type": "boolean" }, "is_observer_role": { "type": "boolean" }, "is_user_role": { "type": "boolean" }, "is_partner_role": { "type": "boolean" }, "is_organization_admin_role": { "type": "boolean" }, "is_pre_sales_consultant": { "type": "boolean" }, "is_system_role": { "type": "boolean" } }, "required": [ "role_id", "role_name" ] }, "SignatureStatusEnum": { "enum": [ "none", "pending", "partial", "signed", "declined" ], "type": "string", "description": "* `none` - none\n* `pending` - pending\n* `partial` - partial\n* `signed` - signed\n* `declined` - declined" }, "SurveyDetail": { "type": "object", "description": "Serializer for survey detail view - all fields", "properties": { "survey_id": { "type": "string", "maxLength": 25 }, "organization": { "type": "string", "maxLength": 25 }, "account_id": { "type": "string", "nullable": true, "maxLength": 25 }, "item_type": { "allOf": [ { "$ref": "#/components/schemas/ItemTypeEnum" } ], "default": "survey" }, "name": { "type": "string" }, "description": { "type": "string" }, "form_structure": { "type": "object", "additionalProperties": {} }, "form_style": { "type": "string", "default": "IN_APP" }, "form_container_style": { "type": "string", "default": "POPUP" }, "background_color": { "type": "string", "default": "#F6F7F7" }, "background_url": { "type": "string" }, "field_border": { "type": "string", "default": "Rounded" }, "action_color": { "type": "string", "default": "#0468BF" }, "status": { "type": "string", "default": "draft" }, "is_active": { "type": "boolean", "default": true }, "end_date": { "type": "string", "format": "date-time", "nullable": true }, "view_count": { "type": "integer" }, "response_count": { "type": "integer" }, "field_count": { "type": "string", "readOnly": true }, "creation_time": { "type": "string", "readOnly": true }, "tags": { "type": "array", "items": {} } }, "required": [ "creation_time", "field_count", "name", "organization", "survey_id" ] }, "Tags": { "type": "object", "description": "Serializer for Documents.\n\nRecognized primitve fields:\n\n * ``StringField``\n * ``URLField``\n * ``EmailField``\n * ``IntField``\n * ``LongField``\n * ``FloatField``\n * ``DecimalField``\n * ``BooleanField``\n * ``DateTimeField``\n * ``ComplexDateTimeField``\n * ``ObjectIdField``\n * ``SequenceField`` (assumes it has integer counter)\n * ``UUIDField``\n * ``GeoPointField``\n * ``GeoJsonBaseField`` (all those fields)\n * ``DateField``\n\nCompound fields: ``ListField`` and ``DictField`` are mapped to corresponding DRF fields, with respect to nested field specification.\n\nThe ``ReferenceField`` is handled like ``ForeignKey`` in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as ``str(id)``).\n\nFor ``EmbeddedDocumentField`` also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.\n\nGeneric fields ``GenericReferenceField`` and ``GenericEmbeddedDocumentField`` are handled by their own with corresponding serializer fields.\n\nNot well supported or untested:\n\n ``FileField``\n ``ImageField``\n ``BinaryField``\n\nAll other fields are mapped to ``DocumentField`` and probably will work wrong.", "properties": { "tag_id": { "type": "string", "maxLength": 25 }, "tag_name": { "type": "string" }, "description": { "type": "string" }, "tag_type": { "type": "integer" }, "is_predefined": { "type": "boolean" } }, "required": [ "tag_id" ] }, "Template": { "type": "object", "description": "Serializer for Documents.\n\nRecognized primitve fields:\n\n * ``StringField``\n * ``URLField``\n * ``EmailField``\n * ``IntField``\n * ``LongField``\n * ``FloatField``\n * ``DecimalField``\n * ``BooleanField``\n * ``DateTimeField``\n * ``ComplexDateTimeField``\n * ``ObjectIdField``\n * ``SequenceField`` (assumes it has integer counter)\n * ``UUIDField``\n * ``GeoPointField``\n * ``GeoJsonBaseField`` (all those fields)\n * ``DateField``\n\nCompound fields: ``ListField`` and ``DictField`` are mapped to corresponding DRF fields, with respect to nested field specification.\n\nThe ``ReferenceField`` is handled like ``ForeignKey`` in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as ``str(id)``).\n\nFor ``EmbeddedDocumentField`` also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.\n\nGeneric fields ``GenericReferenceField`` and ``GenericEmbeddedDocumentField`` are handled by their own with corresponding serializer fields.\n\nNot well supported or untested:\n\n ``FileField``\n ``ImageField``\n ``BinaryField``\n\nAll other fields are mapped to ``DocumentField`` and probably will work wrong.", "properties": { "template_id": { "type": "string", "maxLength": 25 }, "template_name": { "type": "string" }, "description": { "type": "string" }, "template_config": { "type": "object", "additionalProperties": {} }, "is_predefined": { "type": "boolean" }, "options": { "type": "object", "additionalProperties": {} } }, "required": [ "template_id" ] }, "Users": { "type": "object", "description": "Serializer for Documents.\n\nRecognized primitve fields:\n\n * ``StringField``\n * ``URLField``\n * ``EmailField``\n * ``IntField``\n * ``LongField``\n * ``FloatField``\n * ``DecimalField``\n * ``BooleanField``\n * ``DateTimeField``\n * ``ComplexDateTimeField``\n * ``ObjectIdField``\n * ``SequenceField`` (assumes it has integer counter)\n * ``UUIDField``\n * ``GeoPointField``\n * ``GeoJsonBaseField`` (all those fields)\n * ``DateField``\n\nCompound fields: ``ListField`` and ``DictField`` are mapped to corresponding DRF fields, with respect to nested field specification.\n\nThe ``ReferenceField`` is handled like ``ForeignKey`` in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as ``str(id)``).\n\nFor ``EmbeddedDocumentField`` also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.\n\nGeneric fields ``GenericReferenceField`` and ``GenericEmbeddedDocumentField`` are handled by their own with corresponding serializer fields.\n\nNot well supported or untested:\n\n ``FileField``\n ``ImageField``\n ``BinaryField``\n\nAll other fields are mapped to ``DocumentField`` and probably will work wrong.", "properties": { "profile_id": { "type": "string", "maxLength": 25 }, "user_id": { "type": "string" }, "phone_no": { "type": "string", "readOnly": true }, "designation": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": {}, "nullable": true }, "email": { "type": "string", "readOnly": true }, "role_id": { "type": "string", "readOnly": true }, "is_demo_data": { "type": "boolean" }, "invite_token": { "type": "string", "nullable": true }, "organization": { "type": "string", "maxLength": 25 }, "background_image": { "type": "string", "readOnly": true }, "profile_image": { "type": "string", "readOnly": true }, "projects": { "type": "string", "readOnly": true }, "tasks": { "type": "string", "readOnly": true }, "full_name": { "type": "string", "readOnly": true }, "role": { "type": "string", "readOnly": true }, "cover_image": { "type": "string", "readOnly": true }, "joining_date": { "type": "string", "format": "date", "nullable": true }, "is_active": { "type": "string", "readOnly": true }, "is_fir_login": { "type": "string", "readOnly": true }, "deals": { "type": "string", "readOnly": true }, "department": { "type": "string", "nullable": true }, "reports_to": { "type": "object", "additionalProperties": {}, "nullable": true }, "is_team_head": { "type": "boolean" } }, "required": [ "background_image", "cover_image", "deals", "email", "full_name", "is_active", "is_fir_login", "organization", "phone_no", "profile_id", "profile_image", "projects", "role", "role_id", "tasks" ] }, "VersionTypeEnum": { "enum": [ "edit", "signature" ], "type": "string", "description": "* `edit` - edit\n* `signature` - signature" }, "VisibilityEnum": { "enum": [ "public", "private", "restricted" ], "type": "string", "description": "* `public` - public\n* `private` - private\n* `restricted` - restricted" } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "JWT token obtained from /api/login/. Pass as: Authorization: Bearer " } } } }