{ "openapi": "3.0.4", "info": { "title": "Bizkar CRM API", "description": "The published Bizkar CRM API. Authenticate with an organization API key, made under Settings → API keys: `Authorization: Bearer bzk_…`. Each key acts in one organization with its role's permissions. Within v1, changes only add; breaking changes come as v2, with six months' notice.", "version": "v1" }, "paths": { "/api/v1/me": { "get": { "tags": [ "Public API v1" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicMeResponse" } } } } } } }, "/api/v1/leads": { "get": { "tags": [ "Public API v1" ], "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "assignedToUserId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "converted", "in": "query", "schema": { "type": "boolean" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1LeadV1Page" } } } } } }, "post": { "tags": [ "Public API v1" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1LeadInput" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1Lead" } } } } } } }, "/api/v1/leads/{id}": { "get": { "tags": [ "Public API v1" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1Lead" } } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "Public API v1" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1LeadInput" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1Lead" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/leads/{id}/convert": { "post": { "tags": [ "Public API v1" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1LeadConversion" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1LeadConversionResult" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/contacts": { "get": { "tags": [ "Public API v1" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "customerId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ContactV1Page" } } } } } }, "post": { "tags": [ "Public API v1" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ContactInput" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1Contact" } } } } } } }, "/api/v1/contacts/{id}": { "get": { "tags": [ "Public API v1" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1Contact" } } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "Public API v1" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ContactInput" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1Contact" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/customers": { "get": { "tags": [ "Public API v1" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "isPerson", "in": "query", "schema": { "type": "boolean" } }, { "name": "isActive", "in": "query", "schema": { "type": "boolean" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1CustomerV1Page" } } } } } }, "post": { "tags": [ "Public API v1" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1CustomerInput" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1Customer" } } } } } } }, "/api/v1/customers/{id}": { "get": { "tags": [ "Public API v1" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1Customer" } } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "Public API v1" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1CustomerInput" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1Customer" } } } } } } }, "/api/v1/deals": { "get": { "tags": [ "Public API v1" ], "parameters": [ { "name": "stage", "in": "query", "schema": { "type": "string" } }, { "name": "customerId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "contactId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "assignedToUserId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "openOnly", "in": "query", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1DealV1Page" } } } } } }, "post": { "tags": [ "Public API v1" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1DealCreate" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1Deal" } } } } } } }, "/api/v1/deals/{id}": { "get": { "tags": [ "Public API v1" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1Deal" } } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "Public API v1" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1DealUpdate" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1Deal" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/deals/{id}/stage": { "put": { "tags": [ "Public API v1" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1DealStage" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1Deal" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/tickets": { "get": { "tags": [ "Public API v1" ], "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "priority", "in": "query", "schema": { "type": "string" } }, { "name": "customerId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "contactId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "contractId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "assignedToUserId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "isCompleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1TicketV1Page" } } } } } }, "post": { "tags": [ "Public API v1" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1TicketCreate" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1Ticket" } } } } } } }, "/api/v1/tickets/{id}": { "get": { "tags": [ "Public API v1" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1Ticket" } } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "Public API v1" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1TicketUpdate" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1Ticket" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/quotes": { "get": { "tags": [ "Public API v1" ], "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "customerId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "dealId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "contactId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "assignedToUserId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1QuoteV1Page" } } } } } } }, "/api/v1/quotes/{id}": { "get": { "tags": [ "Public API v1" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1Quote" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/contracts": { "get": { "tags": [ "Public API v1" ], "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "customerId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "assignedToUserId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "contractType", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ContractV1Page" } } } } } } }, "/api/v1/contracts/{id}": { "get": { "tags": [ "Public API v1" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1Contract" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/activities": { "get": { "tags": [ "Public API v1" ], "parameters": [ { "name": "relatedToType", "in": "query", "schema": { "type": "string" } }, { "name": "relatedToId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "assignedToUserId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "completed", "in": "query", "schema": { "type": "boolean" } }, { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "taskStatus", "in": "query", "schema": { "type": "string" } }, { "name": "dueFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "dueTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ActivityV1Page" } } } } } }, "post": { "tags": [ "Public API v1" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ActivityCreate" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1Activity" } } } } } } }, "/api/v1/activities/{id}": { "get": { "tags": [ "Public API v1" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1Activity" } } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "Public API v1" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ActivityUpdate" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1Activity" } } } }, "404": { "description": "Not Found" } } } }, "/api/v1/notes": { "get": { "tags": [ "Public API v1" ], "parameters": [ { "name": "relatedToType", "in": "query", "schema": { "type": "string" } }, { "name": "relatedToId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1NoteV1Page" } } } } } }, "post": { "tags": [ "Public API v1" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1NoteCreate" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1Note" } } } } } } }, "/api/v1/notes/{id}": { "get": { "tags": [ "Public API v1" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1Note" } } } }, "404": { "description": "Not Found" } } } } }, "components": { "schemas": { "ActivityType": { "enum": [ "task", "call", "meeting", "email" ], "type": "string" }, "BillingFrequency": { "enum": [ "monthly", "quarterly", "annual", "one-time" ], "type": "string" }, "ContractCoverage": { "enum": [ "business-hours", "all-hours" ], "type": "string" }, "ContractStatus": { "enum": [ "draft", "pending-approval", "active", "expired", "cancelled" ], "type": "string" }, "ContractType": { "enum": [ "maintenance", "operation" ], "type": "string" }, "PublicMeResponse": { "required": [ "organizationId", "organizationName", "permissions", "workspaceId", "workspaceName" ], "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid" }, "organizationName": { "type": "string" }, "apiKeyName": { "type": "string", "nullable": true }, "permissions": { "type": "array", "items": { "type": "string" } }, "workspaceId": { "type": "string", "format": "uuid" }, "workspaceName": { "type": "string" } }, "additionalProperties": false }, "QuoteAdjustmentType": { "enum": [ "percentage", "flat" ], "type": "string" }, "RelatedToType": { "enum": [ "lead", "contact", "customer", "deal", "quote", "contract", "ticket" ], "type": "string" }, "RenewalType": { "enum": [ "auto-renew", "manual", "non-renewing" ], "type": "string" }, "V1Activity": { "required": [ "assignedToUserId", "completed", "createdAt", "id", "relatedToId", "relatedToType", "subject", "type", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "$ref": "#/components/schemas/ActivityType" }, "relatedToType": { "$ref": "#/components/schemas/RelatedToType" }, "relatedToId": { "type": "string", "format": "uuid" }, "relatedToName": { "type": "string", "nullable": true }, "assignedToUserId": { "type": "string", "format": "uuid" }, "subject": { "type": "string" }, "description": { "type": "string", "nullable": true }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "taskStatus": { "type": "string", "nullable": true }, "completed": { "type": "boolean" }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "V1ActivityCreate": { "required": [ "relatedToId", "relatedToType", "subject", "type" ], "type": "object", "properties": { "relatedToType": { "$ref": "#/components/schemas/RelatedToType" }, "relatedToId": { "type": "string", "format": "uuid" }, "subject": { "type": "string" }, "type": { "$ref": "#/components/schemas/ActivityType" }, "description": { "type": "string", "nullable": true }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "taskStatus": { "type": "string", "nullable": true }, "assignedToUserId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "V1ActivityUpdate": { "required": [ "assignedToUserId", "subject", "type" ], "type": "object", "properties": { "subject": { "type": "string" }, "type": { "$ref": "#/components/schemas/ActivityType" }, "assignedToUserId": { "type": "string", "format": "uuid" }, "description": { "type": "string", "nullable": true }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "taskStatus": { "type": "string", "nullable": true } }, "additionalProperties": false }, "V1ActivityV1Page": { "required": [ "items", "page", "pageSize", "totalCount" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/V1Activity" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "V1Contact": { "required": [ "assignedToUserId", "createdAt", "customFields", "firstName", "id", "isPrimary", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "assignedToUserId": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid", "nullable": true }, "customerName": { "type": "string", "nullable": true }, "salutation": { "type": "string", "nullable": true }, "firstName": { "type": "string" }, "lastName": { "type": "string", "nullable": true }, "jobTitle": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "phoneSecondary": { "type": "string", "nullable": true }, "isPrimary": { "type": "boolean" }, "customFields": { "type": "object", "additionalProperties": { "nullable": true } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "V1ContactInput": { "required": [ "firstName", "isPrimary" ], "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string", "nullable": true }, "salutation": { "type": "string", "nullable": true }, "jobTitle": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "phoneSecondary": { "type": "string", "nullable": true }, "customerId": { "type": "string", "format": "uuid", "nullable": true }, "isPrimary": { "type": "boolean" }, "assignedToUserId": { "type": "string", "format": "uuid", "nullable": true }, "customFields": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "V1ContactV1Page": { "required": [ "items", "page", "pageSize", "totalCount" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/V1Contact" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "V1Contract": { "required": [ "assignedToUserId", "contractNumber", "contractType", "coverage", "createdAt", "customerId", "id", "status", "title", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "contractNumber": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "customerName": { "type": "string", "nullable": true }, "contactId": { "type": "string", "format": "uuid", "nullable": true }, "contactName": { "type": "string", "nullable": true }, "dealId": { "type": "string", "format": "uuid", "nullable": true }, "quoteId": { "type": "string", "format": "uuid", "nullable": true }, "assignedToUserId": { "type": "string", "format": "uuid" }, "renewalOfContractId": { "type": "string", "format": "uuid", "nullable": true }, "title": { "type": "string" }, "contractType": { "$ref": "#/components/schemas/ContractType" }, "status": { "$ref": "#/components/schemas/ContractStatus" }, "startDate": { "type": "string", "format": "date", "nullable": true }, "endDate": { "type": "string", "format": "date", "nullable": true }, "contractValue": { "type": "number", "format": "double", "nullable": true }, "billingFrequency": { "$ref": "#/components/schemas/BillingFrequency" }, "renewalType": { "$ref": "#/components/schemas/RenewalType" }, "slaResponseHours": { "type": "integer", "format": "int32", "nullable": true }, "coverage": { "$ref": "#/components/schemas/ContractCoverage" }, "description": { "type": "string", "nullable": true }, "terms": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "V1ContractV1Page": { "required": [ "items", "page", "pageSize", "totalCount" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/V1Contract" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "V1Customer": { "required": [ "createdAt", "customerNumber", "customFields", "id", "isActive", "isPerson", "name", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "customerNumber": { "type": "string" }, "name": { "type": "string" }, "isPerson": { "type": "boolean" }, "isActive": { "type": "boolean" }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "phoneSecondary": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "annualRevenue": { "type": "number", "format": "double", "nullable": true }, "employeeCount": { "type": "integer", "format": "int32", "nullable": true }, "industry": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "taxNumber": { "type": "string", "nullable": true }, "assignedToUserId": { "type": "string", "format": "uuid", "nullable": true }, "customFields": { "type": "object", "additionalProperties": { "nullable": true } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "V1CustomerInput": { "required": [ "isActive", "isPerson", "name" ], "type": "object", "properties": { "name": { "type": "string" }, "isPerson": { "type": "boolean" }, "isActive": { "type": "boolean" }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "phoneSecondary": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "annualRevenue": { "type": "number", "format": "double", "nullable": true }, "employeeCount": { "type": "integer", "format": "int32", "nullable": true }, "industry": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "taxNumber": { "type": "string", "nullable": true }, "assignedToUserId": { "type": "string", "format": "uuid", "nullable": true }, "customFields": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "V1CustomerV1Page": { "required": [ "items", "page", "pageSize", "totalCount" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/V1Customer" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "V1Deal": { "required": [ "assignedToUserId", "createdAt", "currency", "customerId", "customFields", "id", "name", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "customerName": { "type": "string", "nullable": true }, "primaryContactId": { "type": "string", "format": "uuid", "nullable": true }, "primaryContactName": { "type": "string", "nullable": true }, "assignedToUserId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "stage": { "type": "string", "nullable": true }, "lostReason": { "type": "string", "nullable": true }, "value": { "type": "number", "format": "double", "nullable": true }, "currency": { "type": "string" }, "valueInBase": { "type": "number", "format": "double", "nullable": true }, "probability": { "type": "integer", "format": "int32", "nullable": true }, "closeDate": { "type": "string", "format": "date", "nullable": true }, "productCategory": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "customFields": { "type": "object", "additionalProperties": { "nullable": true } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "V1DealCreate": { "required": [ "customerId", "name" ], "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "primaryContactId": { "type": "string", "format": "uuid", "nullable": true }, "stage": { "type": "string", "nullable": true }, "value": { "type": "number", "format": "double", "nullable": true }, "probability": { "type": "integer", "format": "int32", "nullable": true }, "closeDate": { "type": "string", "format": "date", "nullable": true }, "productCategory": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "assignedToUserId": { "type": "string", "format": "uuid", "nullable": true }, "customFields": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "V1DealStage": { "required": [ "stage" ], "type": "object", "properties": { "stage": { "type": "string" }, "lostReason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "V1DealUpdate": { "required": [ "assignedToUserId", "name" ], "type": "object", "properties": { "name": { "type": "string" }, "assignedToUserId": { "type": "string", "format": "uuid" }, "primaryContactId": { "type": "string", "format": "uuid", "nullable": true }, "value": { "type": "number", "format": "double", "nullable": true }, "probability": { "type": "integer", "format": "int32", "nullable": true }, "closeDate": { "type": "string", "format": "date", "nullable": true }, "productCategory": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "customFields": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "V1DealV1Page": { "required": [ "items", "page", "pageSize", "totalCount" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/V1Deal" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "V1Lead": { "required": [ "assignedToUserId", "createdAt", "customFields", "firstName", "id", "isConverted", "status", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "assignedToUserId": { "type": "string", "format": "uuid" }, "firstName": { "type": "string" }, "lastName": { "type": "string", "nullable": true }, "jobTitle": { "type": "string", "nullable": true }, "company": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "annualRevenue": { "type": "number", "format": "double", "nullable": true }, "employeeCount": { "type": "integer", "format": "int32", "nullable": true }, "industry": { "type": "string", "nullable": true }, "productCategory": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "status": { "type": "string" }, "isConverted": { "type": "boolean" }, "convertedAt": { "type": "string", "format": "date-time", "nullable": true }, "convertedCustomerId": { "type": "string", "format": "uuid", "nullable": true }, "convertedContactId": { "type": "string", "format": "uuid", "nullable": true }, "convertedDealId": { "type": "string", "format": "uuid", "nullable": true }, "tags": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "customFields": { "type": "object", "additionalProperties": { "nullable": true } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "V1LeadConversion": { "required": [ "closeDate", "dealName", "valueUnknown" ], "type": "object", "properties": { "dealName": { "type": "string" }, "closeDate": { "type": "string", "format": "date" }, "value": { "type": "number", "format": "double", "nullable": true }, "valueUnknown": { "type": "boolean" }, "assignedToUserId": { "type": "string", "format": "uuid", "nullable": true }, "existingCustomerId": { "type": "string", "format": "uuid", "nullable": true }, "existingContactId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "V1LeadConversionResult": { "required": [ "contactCreated", "contactId", "customerCreated", "customerId", "dealId", "lead" ], "type": "object", "properties": { "lead": { "$ref": "#/components/schemas/V1Lead" }, "customerId": { "type": "string", "format": "uuid" }, "contactId": { "type": "string", "format": "uuid" }, "dealId": { "type": "string", "format": "uuid" }, "customerCreated": { "type": "boolean" }, "contactCreated": { "type": "boolean" } }, "additionalProperties": false }, "V1LeadInput": { "required": [ "firstName" ], "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string", "nullable": true }, "jobTitle": { "type": "string", "nullable": true }, "company": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "annualRevenue": { "type": "number", "format": "double", "nullable": true }, "employeeCount": { "type": "integer", "format": "int32", "nullable": true }, "industry": { "type": "string", "nullable": true }, "productCategory": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "tags": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "assignedToUserId": { "type": "string", "format": "uuid", "nullable": true }, "customFields": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "V1LeadV1Page": { "required": [ "items", "page", "pageSize", "totalCount" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/V1Lead" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "V1Note": { "required": [ "body", "createdAt", "id", "relatedToId", "relatedToType" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "relatedToType": { "$ref": "#/components/schemas/RelatedToType" }, "relatedToId": { "type": "string", "format": "uuid" }, "authorUserId": { "type": "string", "format": "uuid", "nullable": true }, "body": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "V1NoteCreate": { "required": [ "body", "relatedToId", "relatedToType" ], "type": "object", "properties": { "relatedToType": { "$ref": "#/components/schemas/RelatedToType" }, "relatedToId": { "type": "string", "format": "uuid" }, "body": { "type": "string" } }, "additionalProperties": false }, "V1NoteV1Page": { "required": [ "items", "page", "pageSize", "totalCount" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/V1Note" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "V1Quote": { "required": [ "adjustments", "assignedToUserId", "createdAt", "currency", "customerId", "id", "lineItems", "quoteDate", "quoteNumber", "status", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "quoteNumber": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "customerName": { "type": "string", "nullable": true }, "dealId": { "type": "string", "format": "uuid", "nullable": true }, "dealName": { "type": "string", "nullable": true }, "contactId": { "type": "string", "format": "uuid", "nullable": true }, "contactName": { "type": "string", "nullable": true }, "assignedToUserId": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "quoteDate": { "type": "string", "format": "date" }, "dueDate": { "type": "string", "format": "date", "nullable": true }, "subject": { "type": "string", "nullable": true }, "productCategory": { "type": "string", "nullable": true }, "currency": { "type": "string" }, "subTotal": { "type": "number", "format": "double", "nullable": true }, "total": { "type": "number", "format": "double", "nullable": true }, "totalInBase": { "type": "number", "format": "double", "nullable": true }, "notes": { "type": "string", "nullable": true }, "terms": { "type": "string", "nullable": true }, "sentAt": { "type": "string", "format": "date-time", "nullable": true }, "acceptedAt": { "type": "string", "format": "date-time", "nullable": true }, "rejectedAt": { "type": "string", "format": "date-time", "nullable": true }, "rejectedReason": { "type": "string", "nullable": true }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/V1QuoteLine" } }, "adjustments": { "type": "array", "items": { "$ref": "#/components/schemas/V1QuoteAdjustment" } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "V1QuoteAdjustment": { "required": [ "id", "label", "type", "value" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "label": { "type": "string" }, "type": { "$ref": "#/components/schemas/QuoteAdjustmentType" }, "value": { "type": "number", "format": "double" }, "amount": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "V1QuoteLine": { "required": [ "id", "name", "price", "productId", "quantity" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "productId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "unit": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double", "nullable": true }, "taxCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "V1QuoteV1Page": { "required": [ "items", "page", "pageSize", "totalCount" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/V1Quote" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "V1Ticket": { "required": [ "createdAt", "customFields", "description", "id", "incidentDate", "isCompleted", "name", "status", "ticketNumber", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "ticketNumber": { "type": "string" }, "customerId": { "type": "string", "format": "uuid", "nullable": true }, "customerName": { "type": "string", "nullable": true }, "contactId": { "type": "string", "format": "uuid", "nullable": true }, "contactName": { "type": "string", "nullable": true }, "contractId": { "type": "string", "format": "uuid", "nullable": true }, "assignedToUserId": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string" }, "description": { "type": "string" }, "incidentDate": { "type": "string", "format": "date" }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string" }, "priority": { "type": "string", "nullable": true }, "productCategory": { "type": "string", "nullable": true }, "isCompleted": { "type": "boolean" }, "responseDueAt": { "type": "string", "format": "date-time", "nullable": true }, "respondedAt": { "type": "string", "format": "date-time", "nullable": true }, "customFields": { "type": "object", "additionalProperties": { "nullable": true } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "V1TicketCreate": { "required": [ "description", "incidentDate", "name" ], "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "incidentDate": { "type": "string", "format": "date" }, "customerId": { "type": "string", "format": "uuid", "nullable": true }, "contactId": { "type": "string", "format": "uuid", "nullable": true }, "contractId": { "type": "string", "format": "uuid", "nullable": true }, "priority": { "type": "string", "nullable": true }, "productCategory": { "type": "string", "nullable": true }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "assignedToUserId": { "type": "string", "format": "uuid", "nullable": true }, "customFields": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "V1TicketUpdate": { "required": [ "description", "incidentDate", "isCompleted", "name" ], "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "incidentDate": { "type": "string", "format": "date" }, "customerId": { "type": "string", "format": "uuid", "nullable": true }, "contactId": { "type": "string", "format": "uuid", "nullable": true }, "contractId": { "type": "string", "format": "uuid", "nullable": true }, "priority": { "type": "string", "nullable": true }, "productCategory": { "type": "string", "nullable": true }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "isCompleted": { "type": "boolean" }, "customFields": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "V1TicketV1Page": { "required": [ "items", "page", "pageSize", "totalCount" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/V1Ticket" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "http", "description": "An organization API key (bzk_…), or a member's own access token.", "scheme": "bearer" } } }, "security": [ { "Bearer": [] } ], "tags": [ { "name": "Public API v1" } ] }