{ "openapi": "3.0.0", "info": { "title": "PropertyBase GO API", "version": "2.0", "description": "PropertyBase GO Real Estate Platform REST API\n\nComplete API documentation for PropertyBase GO system integration. All requests require authentication via X-BL-API-Key header.", "contact": { "name": "PropertyBase Support", "email": "help@propertybase.com", "url": "https://www.propertybase.com" }, "license": { "name": "PropertyBase" }, "x-api-id": "propertybase-go-api", "x-api-lifecycle": "production", "x-authentication-scheme": "API Key (X-BL-API-Key header)", "x-content-type": "application/json", "x-permission-model": "Resource-based with Read, Write, Delete access levels" }, "externalDocs": { "description": "PropertyBase GO API Documentation", "url": "https://apidocs.propertybase.com" }, "servers": [ { "url": "{protocol}://{domain}/api/v2", "description": "PropertyBase GO API Endpoint", "variables": { "protocol": { "default": "https", "enum": [ "https", "http" ], "description": "API communication protocol" }, "domain": { "default": "api.propertybase.com", "description": "Your PropertyBase domain name" } } } ], "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "description": "API Key authentication. Include X-BL-API-Key header with all requests. Keep your API key private!", "name": "X-BL-API-Key", "in": "header" } }, "schemas": { "ApiResponse": { "type": "object", "title": "API Response", "description": "Standard API response wrapper for all endpoints", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "success", "failure" ], "description": "Response status indicator" }, "message": { "type": "string", "description": "Human-readable response message" }, "data": { "description": "Response data - structure varies by endpoint. Can be object or array." } } }, "PaginatedResponse": { "type": "object", "title": "Paginated Response", "description": "Response for paginated list endpoints", "properties": { "status": { "type": "string", "enum": [ "success" ] }, "message": { "type": "string" }, "data": { "type": "array", "items": { "type": "object" } } } }, "ErrorResponse": { "type": "object", "title": "Error Response", "description": "Error response returned on request failure", "required": [ "status", "message", "errors" ], "properties": { "status": { "type": "string", "enum": [ "failure", "unauthorized" ] }, "message": { "type": "string", "description": "Error message" }, "errors": { "type": "array", "items": { "type": "string" }, "description": "Array of detailed error messages" } } }, "Agent": { "type": "object", "title": "Agent", "description": "Real estate agent", "properties": { "id": { "type": "integer", "description": "Unique agent identifier" }, "created_at": { "type": "string", "format": "date-time", "description": "Creation timestamp" }, "updated_at": { "type": "string", "format": "date-time", "description": "Last update timestamp" }, "user_id": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string", "format": "email" }, "role": { "type": "string" }, "display": { "type": "boolean" } } }, "Contact": { "type": "object", "title": "Contact", "description": "Contact record", "properties": { "id": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string", "format": "email" } } }, "ContactNote": { "type": "object", "title": "Contact Note", "properties": { "id": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "contact_id": { "type": "integer" }, "note": { "type": "string" } } }, "Development": { "type": "object", "title": "Development", "properties": { "id": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "description": { "type": "string" } } }, "Office": { "type": "object", "title": "Office", "properties": { "id": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "address": { "type": "string" }, "phone": { "type": "string" } } }, "Task": { "type": "object", "title": "Task", "properties": { "id": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "title": { "type": "string" }, "status": { "type": "string" }, "due_date": { "type": "string", "format": "date" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ { "name": "agents", "description": "Agents endpoints" }, { "name": "company-contact-custom-fields", "description": "Company Contact Custom Fields endpoints" }, { "name": "company-lead-custom-fields", "description": "Company Lead Custom Fields endpoints" }, { "name": "contact-notes", "description": "Contact Notes endpoints" }, { "name": "contacts", "description": "Contacts endpoints" }, { "name": "development-categories", "description": "Development Categories endpoints" }, { "name": "developments", "description": "Developments endpoints" }, { "name": "dynamic-forms", "description": "Dynamic Forms endpoints" }, { "name": "employees", "description": "Employees endpoints" }, { "name": "events", "description": "Events endpoints" }, { "name": "lead-enumerations", "description": "Lead Enumerations endpoints" }, { "name": "leads", "description": "Leads endpoints" }, { "name": "market-reports", "description": "Market Reports endpoints" }, { "name": "marketing-lists", "description": "Marketing Lists endpoints" }, { "name": "messages", "description": "Messages endpoints" }, { "name": "offices", "description": "Offices endpoints" }, { "name": "sales-exclusives", "description": "Sales Exclusives endpoints" }, { "name": "saved-searches", "description": "Saved Searches endpoints" }, { "name": "tasks", "description": "Tasks endpoints" }, { "name": "teams", "description": "Teams endpoints" } ], "paths": { "/agents": { "get": { "summary": "GET /agents", "operationId": "get_agents", "tags": [ "agents" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Records per page (max 100)", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 100 } } ] }, "post": { "summary": "POST /agents", "operationId": "post_agents", "tags": [ "agents" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/agents/{id}": { "delete": { "summary": "DELETE /agents/{id}", "operationId": "delete_agents", "tags": [ "agents" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /agents/{id}", "operationId": "get_agents", "tags": [ "agents" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /agents/{id}", "operationId": "patch_agents", "tags": [ "agents" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/agents/{id}/deactivate": { "put": { "summary": "PUT /agents/{id}/deactivate", "operationId": "put_agents", "tags": [ "agents" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/agents/{id}/reactivate": { "put": { "summary": "PUT /agents/{id}/reactivate", "operationId": "put_agents", "tags": [ "agents" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/company_contact_custom_fields": { "get": { "summary": "GET /company_contact_custom_fields", "operationId": "get_companycontactcustomfields", "tags": [ "company-contact-custom-fields" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Records per page (max 100)", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 100 } } ] } }, "/company_lead_custom_fields": { "get": { "summary": "GET /company_lead_custom_fields", "operationId": "get_companyleadcustomfields", "tags": [ "company-lead-custom-fields" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Records per page (max 100)", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 100 } } ] } }, "/contact_notes": { "get": { "summary": "GET /contact_notes", "operationId": "get_contactnotes", "tags": [ "contact-notes" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Records per page (max 100)", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 100 } } ] }, "post": { "summary": "POST /contact_notes", "operationId": "post_contactnotes", "tags": [ "contact-notes" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/contact_notes/{id}": { "delete": { "summary": "DELETE /contact_notes/{id}", "operationId": "delete_contactnotes", "tags": [ "contact-notes" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /contact_notes/{id}", "operationId": "get_contactnotes", "tags": [ "contact-notes" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /contact_notes/{id}", "operationId": "patch_contactnotes", "tags": [ "contact-notes" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/contacts": { "get": { "summary": "GET /contacts", "operationId": "get_contacts", "tags": [ "contacts" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Records per page (max 100)", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 100 } } ] }, "post": { "summary": "POST /contacts", "operationId": "post_contacts", "tags": [ "contacts" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/contacts/{id}": { "delete": { "summary": "DELETE /contacts/{id}", "operationId": "delete_contacts", "tags": [ "contacts" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /contacts/{id}", "operationId": "get_contacts", "tags": [ "contacts" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /contacts/{id}", "operationId": "patch_contacts", "tags": [ "contacts" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/development_categories": { "get": { "summary": "GET /development_categories", "operationId": "get_developmentcategories", "tags": [ "development-categories" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Records per page (max 100)", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 100 } } ] }, "post": { "summary": "POST /development_categories", "operationId": "post_developmentcategories", "tags": [ "development-categories" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/development_categories/{development_category_id}": { "delete": { "summary": "DELETE /development_categories/{development_category_id}", "operationId": "delete_developmentcategories", "tags": [ "development-categories" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "development_category_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /development_categories/{development_category_id}", "operationId": "get_developmentcategories", "tags": [ "development-categories" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "development_category_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /development_categories/{development_category_id}", "operationId": "patch_developmentcategories", "tags": [ "development-categories" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "development_category_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/developments": { "get": { "summary": "GET /developments", "operationId": "get_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Records per page (max 100)", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 100 } } ] }, "post": { "summary": "POST /developments", "operationId": "post_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/developments/{development_id}": { "delete": { "summary": "DELETE /developments/{development_id}", "operationId": "delete_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /developments/{development_id}", "operationId": "get_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /developments/{development_id}", "operationId": "patch_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/developments/{development_id}/development_addresses": { "get": { "summary": "GET /developments/{development_id}/development_addresses", "operationId": "get_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /developments/{development_id}/development_addresses", "operationId": "post_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/developments/{development_id}/development_addresses/{development_address_id}": { "delete": { "summary": "DELETE /developments/{development_id}/development_addresses/{development_address_id}", "operationId": "delete_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "development_address_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /developments/{development_id}/development_addresses/{development_address_id}", "operationId": "get_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "development_address_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /developments/{development_id}/development_addresses/{development_address_id}", "operationId": "patch_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "development_address_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/developments/{development_id}/development_agents": { "get": { "summary": "GET /developments/{development_id}/development_agents", "operationId": "get_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/developments/{development_id}/development_agents/add_agents": { "patch": { "summary": "PATCH /developments/{development_id}/development_agents/add_agents", "operationId": "patch_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/developments/{development_id}/development_agents/remove_agents": { "patch": { "summary": "PATCH /developments/{development_id}/development_agents/remove_agents", "operationId": "patch_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/developments/{development_id}/development_area_profiles": { "get": { "summary": "GET /developments/{development_id}/development_area_profiles", "operationId": "get_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/developments/{development_id}/development_area_profiles/add_area_profiles": { "patch": { "summary": "PATCH /developments/{development_id}/development_area_profiles/add_area_profiles", "operationId": "patch_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/developments/{development_id}/development_area_profiles/remove_area_profiles": { "patch": { "summary": "PATCH /developments/{development_id}/development_area_profiles/remove_area_profiles", "operationId": "patch_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/developments/{development_id}/development_categories": { "get": { "summary": "GET /developments/{development_id}/development_categories", "operationId": "get_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/developments/{development_id}/development_categories/add_categories": { "patch": { "summary": "PATCH /developments/{development_id}/development_categories/add_categories", "operationId": "patch_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/developments/{development_id}/development_categories/remove_categories": { "patch": { "summary": "PATCH /developments/{development_id}/development_categories/remove_categories", "operationId": "patch_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/developments/{development_id}/development_floor_plans": { "get": { "summary": "GET /developments/{development_id}/development_floor_plans", "operationId": "get_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /developments/{development_id}/development_floor_plans", "operationId": "post_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/developments/{development_id}/development_floor_plans/{development_floor_plan_id}": { "delete": { "summary": "DELETE /developments/{development_id}/development_floor_plans/{development_floor_plan_id}", "operationId": "delete_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "development_floor_plan_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /developments/{development_id}/development_floor_plans/{development_floor_plan_id}", "operationId": "get_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "development_floor_plan_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /developments/{development_id}/development_floor_plans/{development_floor_plan_id}", "operationId": "patch_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "development_floor_plan_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/developments/{development_id}/development_listing_sheets": { "get": { "summary": "GET /developments/{development_id}/development_listing_sheets", "operationId": "get_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /developments/{development_id}/development_listing_sheets", "operationId": "post_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/developments/{development_id}/development_listing_sheets/{development_listing_sheet_id}": { "delete": { "summary": "DELETE /developments/{development_id}/development_listing_sheets/{development_listing_sheet_id}", "operationId": "delete_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "development_listing_sheet_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /developments/{development_id}/development_listing_sheets/{development_listing_sheet_id}", "operationId": "get_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "development_listing_sheet_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /developments/{development_id}/development_listing_sheets/{development_listing_sheet_id}", "operationId": "patch_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "development_listing_sheet_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/developments/{development_id}/development_pictures": { "get": { "summary": "GET /developments/{development_id}/development_pictures", "operationId": "get_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /developments/{development_id}/development_pictures", "operationId": "post_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/developments/{development_id}/development_pictures/{development_picture_id}": { "delete": { "summary": "DELETE /developments/{development_id}/development_pictures/{development_picture_id}", "operationId": "delete_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "development_picture_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /developments/{development_id}/development_pictures/{development_picture_id}", "operationId": "get_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "development_picture_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /developments/{development_id}/development_pictures/{development_picture_id}", "operationId": "patch_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "development_picture_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/developments/{development_id}/development_prices": { "get": { "summary": "GET /developments/{development_id}/development_prices", "operationId": "get_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /developments/{development_id}/development_prices", "operationId": "post_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/developments/{development_id}/development_prices/{development_price_id}": { "delete": { "summary": "DELETE /developments/{development_id}/development_prices/{development_price_id}", "operationId": "delete_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "development_price_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /developments/{development_id}/development_prices/{development_price_id}", "operationId": "get_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "development_price_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /developments/{development_id}/development_prices/{development_price_id}", "operationId": "patch_developments", "tags": [ "developments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "development_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "development_price_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/dynamic_forms": { "get": { "summary": "GET /dynamic_forms", "operationId": "get_dynamicforms", "tags": [ "dynamic-forms" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Records per page (max 100)", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 100 } } ] } }, "/dynamic_forms/{id}": { "get": { "summary": "GET /dynamic_forms/{id}", "operationId": "get_dynamicforms", "tags": [ "dynamic-forms" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/dynamic_forms/{id}/form_submissions": { "get": { "summary": "GET /dynamic_forms/{id}/form_submissions", "operationId": "get_dynamicforms", "tags": [ "dynamic-forms" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/employees": { "get": { "summary": "GET /employees", "operationId": "get_employees", "tags": [ "employees" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Records per page (max 100)", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 100 } } ] }, "post": { "summary": "POST /employees", "operationId": "post_employees", "tags": [ "employees" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/employees/{id}": { "delete": { "summary": "DELETE /employees/{id}", "operationId": "delete_employees", "tags": [ "employees" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /employees/{id}", "operationId": "get_employees", "tags": [ "employees" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /employees/{id}", "operationId": "patch_employees", "tags": [ "employees" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/employees/{id}/deactivate": { "put": { "summary": "PUT /employees/{id}/deactivate", "operationId": "put_employees", "tags": [ "employees" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/employees/{id}/reactivate": { "put": { "summary": "PUT /employees/{id}/reactivate", "operationId": "put_employees", "tags": [ "employees" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/events": { "get": { "summary": "GET /events", "operationId": "get_events", "tags": [ "events" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Records per page (max 100)", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 100 } } ] }, "post": { "summary": "POST /events", "operationId": "post_events", "tags": [ "events" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/events/{id}": { "delete": { "summary": "DELETE /events/{id}", "operationId": "delete_events", "tags": [ "events" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /events/{id}", "operationId": "get_events", "tags": [ "events" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /events/{id}", "operationId": "patch_events", "tags": [ "events" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/lead_enumerations": { "get": { "summary": "GET /lead_enumerations", "operationId": "get_leadenumerations", "tags": [ "lead-enumerations" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Records per page (max 100)", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 100 } } ] } }, "/leads": { "get": { "summary": "GET /leads", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Records per page (max 100)", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 100 } } ] }, "post": { "summary": "POST /leads", "operationId": "post_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/leads/{id}": { "delete": { "summary": "DELETE /leads/{id}", "operationId": "delete_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /leads/{id}", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /leads/{id}", "operationId": "patch_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/leads/{id}/contact_forms": { "get": { "summary": "GET /leads/{id}/contact_forms", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/leads/{id}/email_friends": { "get": { "summary": "GET /leads/{id}/email_friends", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /leads/{id}/email_friends", "operationId": "post_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/leads/{id}/favorite_properties": { "get": { "summary": "GET /leads/{id}/favorite_properties", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /leads/{id}/favorite_properties", "operationId": "post_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/leads/{id}/favorite_properties/{favorite_id}": { "delete": { "summary": "DELETE /leads/{id}/favorite_properties/{favorite_id}", "operationId": "delete_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "favorite_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /leads/{id}/favorite_properties/{favorite_id}", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "favorite_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /leads/{id}/favorite_properties/{favorite_id}", "operationId": "patch_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "favorite_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/leads/{id}/favorite_rental_properties": { "get": { "summary": "GET /leads/{id}/favorite_rental_properties", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/leads/{id}/inquiries": { "get": { "summary": "GET /leads/{id}/inquiries", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /leads/{id}/inquiries", "operationId": "post_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/leads/{id}/inquiries/{inquiry_id}": { "get": { "summary": "GET /leads/{id}/inquiries/{inquiry_id}", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "inquiry_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/leads/{id}/lead_notes": { "get": { "summary": "GET /leads/{id}/lead_notes", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /leads/{id}/lead_notes", "operationId": "post_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/leads/{id}/lead_notes/{note_id}": { "delete": { "summary": "DELETE /leads/{id}/lead_notes/{note_id}", "operationId": "delete_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /leads/{id}/lead_notes/{note_id}", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /leads/{id}/lead_notes/{note_id}", "operationId": "patch_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/leads/{id}/lead_properties": { "get": { "summary": "GET /leads/{id}/lead_properties", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/leads/{id}/lead_relationships": { "get": { "summary": "GET /leads/{id}/lead_relationships", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /leads/{id}/lead_relationships", "operationId": "post_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/leads/{id}/lead_relationships/{relationship_id}": { "delete": { "summary": "DELETE /leads/{id}/lead_relationships/{relationship_id}", "operationId": "delete_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "relationship_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /leads/{id}/lead_relationships/{relationship_id}", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "relationship_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /leads/{id}/lead_relationships/{relationship_id}", "operationId": "patch_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "relationship_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/leads/{id}/market_report_updates": { "get": { "summary": "GET /leads/{id}/market_report_updates", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /leads/{id}/market_report_updates", "operationId": "post_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/leads/{id}/market_report_updates/{update_id}": { "delete": { "summary": "DELETE /leads/{id}/market_report_updates/{update_id}", "operationId": "delete_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "update_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /leads/{id}/market_report_updates/{update_id}", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "update_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /leads/{id}/market_report_updates/{update_id}", "operationId": "patch_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "update_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/leads/{id}/property_notes": { "get": { "summary": "GET /leads/{id}/property_notes", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/leads/{id}/property_views": { "get": { "summary": "GET /leads/{id}/property_views", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /leads/{id}/property_views", "operationId": "post_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/leads/{id}/property_views/{view_id}": { "get": { "summary": "GET /leads/{id}/property_views/{view_id}", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "view_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/leads/{id}/public_activity": { "get": { "summary": "GET /leads/{id}/public_activity", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/leads/{id}/rental_property_notes": { "get": { "summary": "GET /leads/{id}/rental_property_notes", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/leads/{id}/rental_property_views": { "get": { "summary": "GET /leads/{id}/rental_property_views", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/leads/{id}/rental_saved_searches": { "get": { "summary": "GET /leads/{id}/rental_saved_searches", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/leads/{id}/rental_searches": { "get": { "summary": "GET /leads/{id}/rental_searches", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/leads/{id}/searches": { "get": { "summary": "GET /leads/{id}/searches", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /leads/{id}/searches", "operationId": "post_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/leads/{id}/showings": { "get": { "summary": "GET /leads/{id}/showings", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /leads/{id}/showings", "operationId": "post_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/leads/{id}/showings/{showing_id}": { "get": { "summary": "GET /leads/{id}/showings/{showing_id}", "operationId": "get_leads", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "showing_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/market_reports": { "get": { "summary": "GET /market_reports", "operationId": "get_marketreports", "tags": [ "market-reports" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Records per page (max 100)", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 100 } } ] }, "post": { "summary": "POST /market_reports", "operationId": "post_marketreports", "tags": [ "market-reports" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/market_reports/{id}": { "delete": { "summary": "DELETE /market_reports/{id}", "operationId": "delete_marketreports", "tags": [ "market-reports" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /market_reports/{id}", "operationId": "get_marketreports", "tags": [ "market-reports" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /market_reports/{id}", "operationId": "patch_marketreports", "tags": [ "market-reports" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/market_reports/{id}/market_report_updates": { "get": { "summary": "GET /market_reports/{id}/market_report_updates", "operationId": "get_marketreports", "tags": [ "market-reports" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /market_reports/{id}/market_report_updates", "operationId": "post_marketreports", "tags": [ "market-reports" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/market_reports/{id}/market_report_updates/{update_id}": { "delete": { "summary": "DELETE /market_reports/{id}/market_report_updates/{update_id}", "operationId": "delete_marketreports", "tags": [ "market-reports" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "update_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /market_reports/{id}/market_report_updates/{update_id}", "operationId": "get_marketreports", "tags": [ "market-reports" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "update_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /market_reports/{id}/market_report_updates/{update_id}", "operationId": "patch_marketreports", "tags": [ "market-reports" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "update_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/marketing_lists": { "get": { "summary": "GET /marketing_lists", "operationId": "get_marketinglists", "tags": [ "marketing-lists" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Records per page (max 100)", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 100 } } ] }, "post": { "summary": "POST /marketing_lists", "operationId": "post_marketinglists", "tags": [ "marketing-lists" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/marketing_lists/{id}": { "delete": { "summary": "DELETE /marketing_lists/{id}", "operationId": "delete_marketinglists", "tags": [ "marketing-lists" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /marketing_lists/{id}", "operationId": "get_marketinglists", "tags": [ "marketing-lists" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /marketing_lists/{id}", "operationId": "patch_marketinglists", "tags": [ "marketing-lists" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/marketing_lists/{id}/add_member": { "post": { "summary": "POST /marketing_lists/{id}/add_member", "operationId": "post_marketinglists", "tags": [ "marketing-lists" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/marketing_lists/{id}/agents": { "get": { "summary": "GET /marketing_lists/{id}/agents", "operationId": "get_marketinglists", "tags": [ "marketing-lists" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /marketing_lists/{id}/agents", "operationId": "post_marketinglists", "tags": [ "marketing-lists" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/marketing_lists/{id}/agents/{agent_id}": { "delete": { "summary": "DELETE /marketing_lists/{id}/agents/{agent_id}", "operationId": "delete_marketinglists", "tags": [ "marketing-lists" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /marketing_lists/{id}/agents/{agent_id}", "operationId": "get_marketinglists", "tags": [ "marketing-lists" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /marketing_lists/{id}/agents/{agent_id}", "operationId": "patch_marketinglists", "tags": [ "marketing-lists" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/marketing_lists/{id}/contacts": { "get": { "summary": "GET /marketing_lists/{id}/contacts", "operationId": "get_marketinglists", "tags": [ "marketing-lists" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /marketing_lists/{id}/contacts", "operationId": "post_marketinglists", "tags": [ "marketing-lists" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/marketing_lists/{id}/contacts/{contact_id}": { "delete": { "summary": "DELETE /marketing_lists/{id}/contacts/{contact_id}", "operationId": "delete_marketinglists", "tags": [ "marketing-lists" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /marketing_lists/{id}/contacts/{contact_id}", "operationId": "get_marketinglists", "tags": [ "marketing-lists" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /marketing_lists/{id}/contacts/{contact_id}", "operationId": "patch_marketinglists", "tags": [ "marketing-lists" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/marketing_lists/{id}/employees": { "get": { "summary": "GET /marketing_lists/{id}/employees", "operationId": "get_marketinglists", "tags": [ "marketing-lists" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /marketing_lists/{id}/employees", "operationId": "post_marketinglists", "tags": [ "marketing-lists" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/marketing_lists/{id}/employees/{employee_id}": { "delete": { "summary": "DELETE /marketing_lists/{id}/employees/{employee_id}", "operationId": "delete_marketinglists", "tags": [ "marketing-lists" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /marketing_lists/{id}/employees/{employee_id}", "operationId": "get_marketinglists", "tags": [ "marketing-lists" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /marketing_lists/{id}/employees/{employee_id}", "operationId": "patch_marketinglists", "tags": [ "marketing-lists" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/marketing_lists/{id}/leads": { "get": { "summary": "GET /marketing_lists/{id}/leads", "operationId": "get_marketinglists", "tags": [ "marketing-lists" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /marketing_lists/{id}/leads", "operationId": "post_marketinglists", "tags": [ "marketing-lists" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/marketing_lists/{id}/leads/{lead_id}": { "delete": { "summary": "DELETE /marketing_lists/{id}/leads/{lead_id}", "operationId": "delete_marketinglists", "tags": [ "marketing-lists" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "lead_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /marketing_lists/{id}/leads/{lead_id}", "operationId": "get_marketinglists", "tags": [ "marketing-lists" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "lead_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /marketing_lists/{id}/leads/{lead_id}", "operationId": "patch_marketinglists", "tags": [ "marketing-lists" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "lead_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/messages": { "get": { "summary": "GET /messages", "operationId": "get_messages", "tags": [ "messages" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Records per page (max 100)", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 100 } } ] }, "post": { "summary": "POST /messages", "operationId": "post_messages", "tags": [ "messages" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/messages/{id}": { "delete": { "summary": "DELETE /messages/{id}", "operationId": "delete_messages", "tags": [ "messages" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /messages/{id}", "operationId": "get_messages", "tags": [ "messages" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /messages/{id}", "operationId": "patch_messages", "tags": [ "messages" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/offices": { "get": { "summary": "GET /offices", "operationId": "get_offices", "tags": [ "offices" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Records per page (max 100)", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 100 } } ] }, "post": { "summary": "POST /offices", "operationId": "post_offices", "tags": [ "offices" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/offices/{id}": { "delete": { "summary": "DELETE /offices/{id}", "operationId": "delete_offices", "tags": [ "offices" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /offices/{id}", "operationId": "get_offices", "tags": [ "offices" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /offices/{id}", "operationId": "patch_offices", "tags": [ "offices" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/offices/{id}/deactivate": { "put": { "summary": "PUT /offices/{id}/deactivate", "operationId": "put_offices", "tags": [ "offices" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/offices/{id}/reactivate": { "put": { "summary": "PUT /offices/{id}/reactivate", "operationId": "put_offices", "tags": [ "offices" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/sales_exclusives": { "get": { "summary": "GET /sales_exclusives", "operationId": "get_salesexclusives", "tags": [ "sales-exclusives" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Records per page (max 100)", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 100 } } ] } }, "/sales_exclusives/{sales_exclusive_id}": { "patch": { "summary": "PATCH /sales_exclusives/{sales_exclusive_id}", "operationId": "patch_salesexclusives", "tags": [ "sales-exclusives" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "sales_exclusive_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/saved_searches": { "get": { "summary": "GET /saved_searches", "operationId": "get_savedsearches", "tags": [ "saved-searches" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Records per page (max 100)", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 100 } } ] }, "post": { "summary": "POST /saved_searches", "operationId": "post_savedsearches", "tags": [ "saved-searches" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/saved_searches/{id}": { "delete": { "summary": "DELETE /saved_searches/{id}", "operationId": "delete_savedsearches", "tags": [ "saved-searches" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /saved_searches/{id}", "operationId": "get_savedsearches", "tags": [ "saved-searches" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /saved_searches/{id}", "operationId": "patch_savedsearches", "tags": [ "saved-searches" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/saved_searches/data": { "get": { "summary": "GET /saved_searches/data", "operationId": "get_savedsearches", "tags": [ "saved-searches" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Records per page (max 100)", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 100 } } ] } }, "/tasks": { "get": { "summary": "GET /tasks", "operationId": "get_tasks", "tags": [ "tasks" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Records per page (max 100)", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 100 } } ] }, "post": { "summary": "POST /tasks", "operationId": "post_tasks", "tags": [ "tasks" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/tasks/{id}": { "delete": { "summary": "DELETE /tasks/{id}", "operationId": "delete_tasks", "tags": [ "tasks" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /tasks/{id}", "operationId": "get_tasks", "tags": [ "tasks" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /tasks/{id}", "operationId": "patch_tasks", "tags": [ "tasks" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/teams": { "get": { "summary": "GET /teams", "operationId": "get_teams", "tags": [ "teams" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Records per page (max 100)", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 100 } } ] }, "post": { "summary": "POST /teams", "operationId": "post_teams", "tags": [ "teams" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/teams/{id}": { "delete": { "summary": "DELETE /teams/{id}", "operationId": "delete_teams", "tags": [ "teams" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /teams/{id}", "operationId": "get_teams", "tags": [ "teams" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /teams/{id}", "operationId": "patch_teams", "tags": [ "teams" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/teams/{id}/deactivate": { "put": { "summary": "PUT /teams/{id}/deactivate", "operationId": "put_teams", "tags": [ "teams" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/teams/{id}/reactivate": { "put": { "summary": "PUT /teams/{id}/reactivate", "operationId": "put_teams", "tags": [ "teams" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized - Invalid or missing API key" }, "403": { "description": "Forbidden - Insufficient permissions" } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } } }, "x-supporting-documents": { "description": "Additional documentation and reference materials", "readme": { "title": "Quick Start Guide", "description": "Integration guide with examples for Postman, Swagger UI, and code generators", "content": "# PropertyBase GO API - OpenAPI 3.0 Specification\n\n## Overview\n\nThis package contains a complete OpenAPI 3.0 specification for the PropertyBase GO API, extracted from the official documentation at https://apidocs.propertybase.com.\n\n## Files Included\n\n1. **propertybase-api-openapi-3.0.json** (245 KB)\n - Complete OpenAPI 3.0 specification\n - All 194 API endpoints\n - 102 unique paths across 20 resource types\n - Ready for use with OpenAPI tools\n\n2. **EXTRACTION_SUMMARY.txt**\n - Detailed extraction report\n - Resource descriptions\n - Usage guidelines\n - Known limitations\n\n3. **README.md** (this file)\n - Quick reference guide\n\n## API Statistics\n\n| Metric | Value |\n|--------|-------|\n| Total Endpoints | 194 |\n| Unique Paths | 102 |\n| Resource Types | 20 |\n| GET Operations | 86 |\n| POST Operations | 35 |\n| PATCH Operations | 36 |\n| DELETE Operations | 29 |\n| PUT Operations | 8 |\n| API Version | 2.0 |\n| OpenAPI Version | 3.0.0 |\n\n## Quick Start\n\n### Using with Swagger UI\n```bash\ndocker run -p 8080:8080 -e SWAGGER_JSON=/spec.json -v $(pwd)/propertybase-api-openapi-3.0.json:/spec.json swaggerapi/swagger-ui\n```\n\n### Using with ReDoc\n```bash\ndocker run -p 8080:8080 -e SPEC_URL=/spec.json -v $(pwd)/propertybase-api-openapi-3.0.json:/spec.json redocly/redoc\n```\n\n### Importing into Postman\n1. Open Postman\n2. Click \"Import\"\n3. Select \"Upload Files\"\n4. Choose `propertybase-api-openapi-3.0.json`\n\n### Using with Code Generation\n```bash\n# Generate Python client\nopenapi-generator-cli generate -i propertybase-api-openapi-3.0.json -g python -o ./python-client\n\n# Generate TypeScript client\nopenapi-generator-cli generate -i propertybase-api-openapi-3.0.json -g typescript-fetch -o ./ts-client\n\n# Generate Go client\nopenapi-generator-cli generate -i propertybase-api-openapi-3.0.json -g go -o ./go-client\n```\n\n## Resource Types\n\nThe specification covers 20 resource types:\n\n1. **agents** (7 endpoints)\n - Real estate agent management\n - CRUD operations + activation/deactivation\n\n2. **contacts** (5 endpoints)\n - Contact record management\n - Customer and prospect data\n\n3. **leads** (47 endpoints)\n - Comprehensive lead lifecycle management\n - Sub-resources: contact forms, properties, inquiries, notes, etc.\n\n4. **developments** (39 endpoints)\n - Real estate development project management\n - Sub-resources: addresses, agents, floor plans, prices, etc.\n\n5. **marketing_lists** (26 endpoints)\n - Marketing campaign management\n - Member management for agents, contacts, employees, leads\n\n6. **market_reports** (10 endpoints)\n - Market analysis and reporting\n - Market report updates tracking\n\n7. **employees** (7 endpoints)\n - Employee management\n - Activation/deactivation\n\n8. **offices** (7 endpoints)\n - Office management\n - Activation/deactivation\n\n9. **teams** (7 endpoints)\n - Team management\n - Activation/deactivation\n\n10-20. Additional resources:\n - contact_notes (5)\n - development_categories (5)\n - events (5)\n - messages (5)\n - tasks (5)\n - saved_searches (6)\n - dynamic_forms (3)\n - sales_exclusives (2)\n - company_contact_custom_fields (1)\n - company_lead_custom_fields (1)\n - lead_enumerations (1)\n\n## Authentication\n\nAll API requests require the `X-BL-API-Key` header:\n\n```bash\ncurl -H \"X-BL-API-Key: your_api_key_here\" \\\n -H \"Content-Type: application/json\" \\\n https://domain.propertybase.com/api/v2/agents\n```\n\n## Base URL\n\n```\n{protocol}://{domain}/api/v2\n```\n\nWhere:\n- `protocol`: https (default) or http\n- `domain`: Your PropertyBase domain name\n\nExample: `https://mycompany.propertybase.com/api/v2`\n\n## Standard Response Format\n\n### Success Response\n```json\n{\n \"status\": \"success\",\n \"message\": \"Operation completed successfully\",\n \"data\": {\n \"id\": 123,\n \"name\": \"Example\",\n ...\n }\n}\n```\n\n### Error Response\n```json\n{\n \"status\": \"failure\",\n \"message\": \"Operation failed\",\n \"errors\": [\n \"Error message 1\",\n \"Error message 2\"\n ]\n}\n```\n\n## HTTP Status Codes\n\n| Code | Meaning |\n|------|---------|\n| 200 | Success |\n| 400 | Bad Request |\n| 401 | Unauthorized (invalid API key) |\n| 403 | Forbidden (insufficient permissions) |\n| 404 | Not Found |\n| 500 | Server Error |\n\n## Pagination\n\nList endpoints support pagination:\n\n```\nGET /api/v2/agents?page=2&per_page=50\n```\n\nParameters:\n- `page`: Page number (1-indexed, default: 1)\n- `per_page`: Records per page (default: 50, max: 100)\n\n## Specification Validation\n\nThe OpenAPI specification has been validated and confirmed to:\n- \u2713 Valid JSON format\n- \u2713 Compliant with OpenAPI 3.0.0 specification\n- \u2713 All paths have operations\n- \u2713 All operations have response definitions\n- \u2713 Security schemes properly defined\n- \u2713 All operations include security requirements\n\n## Usage Examples\n\n### Example 1: Get Agents\n```bash\ncurl -X GET \"https://domain.propertybase.com/api/v2/agents?page=1&per_page=20\" \\\n -H \"X-BL-API-Key: your_api_key\" \\\n -H \"Content-Type: application/json\"\n```\n\n### Example 2: Create a Contact\n```bash\ncurl -X POST \"https://domain.propertybase.com/api/v2/contacts\" \\\n -H \"X-BL-API-Key: your_api_key\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john@example.com\"\n }'\n```\n\n### Example 3: Update an Agent\n```bash\ncurl -X PATCH \"https://domain.propertybase.com/api/v2/agents/123\" \\\n -H \"X-BL-API-Key: your_api_key\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"first_name\": \"Jane\"\n }'\n```\n\n## Tools & Integrations\n\nThis specification can be used with:\n\n### API Documentation\n- Swagger UI\n- ReDoc\n- Stoplight\n\n### Code Generation\n- OpenAPI Generator\n- AutoRest\n- Swagger Codegen\n\n### API Testing\n- Postman\n- Insomnia\n- Thunder Client\n\n### Development\n- SDK generation\n- Mock server creation\n- Contract testing\n\n## Limitations\n\n1. **Detailed Field Types**: The specification includes standard field types. Verify custom field types with actual API responses.\n\n2. **Rate Limiting**: Not documented in the original API documentation. Check with PropertyBase support.\n\n3. **Webhooks**: Not included in this specification. Check PropertyBase documentation for event-based APIs.\n\n4. **Field Validation**: Some field validations and constraints may need verification through actual API testing.\n\n## Support & Resources\n\n- **PropertyBase Support**: help@propertybase.com\n- **API Documentation**: https://apidocs.propertybase.com\n- **Website**: https://www.propertybase.com\n\n## Version Information\n\n- **Extracted**: 2026-09-11\n- **API Version**: 2.0\n- **OpenAPI Version**: 3.0.0\n- **Specification Size**: 245 KB\n- **Format**: JSON\n\n## License\n\nThis specification is derived from PropertyBase GO API documentation.\n\n---\n\n**Generated from**: https://apidocs.propertybase.com\n" }, "extraction-summary": { "title": "Resource Descriptions & Usage", "description": "Detailed descriptions of each resource type and usage recommendations", "content": "================================================================================\nPropertyBase GO API - OpenAPI 3.0 Extraction Summary\n================================================================================\nGenerated: 2026-09-11\nSource: https://apidocs.propertybase.com\nOpenAPI Version: 3.0.0\nAPI Version: 2.0\n\n================================================================================\nEXTRACTION RESULTS\n================================================================================\n\nTotal API Endpoints Extracted: 194\nTotal Unique Paths: 102\nTotal Resource Types: 20\n\nFile Generated: propertybase-api-openapi-3.0.json\nFile Size: 246 KB\nLines: 10,206\n\n================================================================================\nOPERATIONS BY HTTP METHOD\n================================================================================\n\nGET (List/Retrieve): 86 operations\nPOST (Create): 35 operations\nPATCH (Update): 36 operations\nDELETE (Delete): 29 operations\nPUT (Action): 8 operations\n\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\nTOTAL: 194 operations\n\n================================================================================\nRESOURCES INCLUDED (20 total)\n================================================================================\n\n1. agents 7 endpoints\n2. company_contact_custom_fields 1 endpoint\n3. company_lead_custom_fields 1 endpoint\n4. contact_notes 5 endpoints\n5. contacts 5 endpoints\n6. development_categories 5 endpoints\n7. developments 39 endpoints\n8. dynamic_forms 3 endpoints\n9. employees 7 endpoints\n10. events 5 endpoints\n11. lead_enumerations 1 endpoint\n12. leads 47 endpoints\n13. market_reports 10 endpoints\n14. marketing_lists 26 endpoints\n15. messages 5 endpoints\n16. offices 7 endpoints\n17. sales_exclusives 2 endpoints\n18. saved_searches 6 endpoints\n19. tasks 5 endpoints\n20. teams 7 endpoints\n\n================================================================================\nKEY RESOURCES EXPLAINED\n================================================================================\n\nAGENTS (7 endpoints)\n - Manage real estate agents\n - Endpoints: List, Create, Retrieve, Update, Delete, Deactivate, Reactivate\n - Used for: Agent management and team administration\n\nCONTACTS (5 endpoints)\n - Manage contact records\n - Endpoints: List, Create, Retrieve, Update, Delete\n - Used for: Customer and prospect management\n\nLEADS (47 endpoints)\n - Comprehensive lead management with nested sub-resources\n - Endpoints: CRUD operations + sub-resources for:\n * Contact forms, email friends, favorite properties\n * Inquiries, lead notes, relationships\n * Market report updates, property views and notes\n * Searches, showings, and more\n - Used for: Complete lead lifecycle management\n\nDEVELOPMENTS (39 endpoints)\n - Development/project management with extensive nesting\n - Sub-resources:\n * Development addresses, agents, area profiles\n * Categories, floor plans, listing sheets\n * Pictures, prices\n - Used for: Real estate development tracking\n\nMARKETING_LISTS (26 endpoints)\n - Campaign and marketing list management\n - Sub-resources for adding members:\n * Agents, Contacts, Employees, Leads\n - Used for: Marketing campaigns and bulk communications\n\nMARKET_REPORTS (10 endpoints)\n - Market analysis and reporting\n - Includes market report updates sub-resource\n - Used for: Market analysis and lead nurturing\n\n================================================================================\nAUTHENTICATION\n================================================================================\n\nHeader: X-BL-API-Key\nLocation: HTTP Header (required with all requests)\nType: API Key Authentication\nDescription: PropertyBase API key for authentication\n\nExample Request:\n GET /api/v2/agents HTTP/1.1\n Host: domain.propertybase.com\n Content-Type: application/json\n X-BL-API-Key: your_api_key_here\n\n================================================================================\nAPI STRUCTURE\n================================================================================\n\nBase URL Pattern: {protocol}://{domain}/api/v2\n - protocol: https or http\n - domain: Your PropertyBase domain name\n\nExample: https://mycompany.propertybase.com/api/v2\n\nStandard Response Format:\n{\n \"status\": \"success\" | \"failure\",\n \"message\": \"description\",\n \"data\": { /* response data */ }\n}\n\nError Response Format:\n{\n \"status\": \"failure\",\n \"message\": \"description\",\n \"errors\": [\"error1\", \"error2\"]\n}\n\nHTTP Status Codes:\n 200: Success\n 400: Bad Request\n 401: Unauthorized (invalid API key)\n 403: Forbidden (insufficient permissions)\n 404: Not Found\n 500: Server Error\n\n================================================================================\nPAGINATION\n================================================================================\n\nList endpoints support pagination via query parameters:\n - page: Page number (1-indexed, default: 1)\n - per_page: Records per page (default: 50, maximum: 100)\n\nExample:\n GET /api/v2/agents?page=2&per_page=25\n\n================================================================================\nCONTENT TYPE\n================================================================================\n\nAll requests and responses use: application/json\n\nRequest headers required:\n - Content-Type: application/json\n - X-BL-API-Key: [your_api_key]\n\n================================================================================\nOPENAPI SPECIFICATION FEATURES\n================================================================================\n\nThe generated OpenAPI 3.0 specification includes:\n\n1. Complete API Information\n - Title, version, description\n - Contact information\n - External documentation links\n\n2. Server Configuration\n - Server URL patterns with variables\n - Support for https and http protocols\n - Domain name substitution\n\n3. Components\n - Security schemes (API Key authentication)\n - Response schemas (ApiResponse, ErrorResponse)\n - Resource schemas (Agent, Contact, etc.)\n\n4. Complete Paths Documentation\n - All 102 unique paths\n - All 194 operations\n - Operation tags for organization\n - Parameter definitions\n - Response definitions\n - Security requirements\n\n5. Tags\n - Organized by resource type\n - Descriptive tags for all 20 resources\n\n================================================================================\nUSAGE RECOMMENDATIONS\n================================================================================\n\n1. Integration Tools:\n - Import into Postman, Insomnia, or other API clients\n - Use for code generation (OpenAPI generators)\n - Create mock servers for testing\n\n2. API Documentation:\n - Generate interactive API documentation\n - Share with development teams\n - Version control the specification\n\n3. Development:\n - Generate client SDKs in various languages\n - Create server stubs\n - Validate API requests/responses\n\n4. Testing:\n - Create automated integration tests\n - Validate API contracts\n - Monitor API compliance\n\n================================================================================\nKNOWN LIMITATIONS\n================================================================================\n\n1. Detailed Request/Response Bodies:\n - Schema details extracted from documentation\n - May need manual refinement based on actual API behavior\n - Query parameter types need verification\n\n2. Deprecated Endpoints:\n - All active endpoints included\n - Check PropertyBase documentation for deprecation notices\n\n3. Rate Limiting:\n - Not specified in original documentation\n - May need to be added based on API provider guidelines\n\n4. Webhooks/Events:\n - Not included in this extraction\n - Check PropertyBase documentation for event-based APIs\n\n================================================================================\nNEXT STEPS\n================================================================================\n\n1. Validation:\n - Test endpoints against live API\n - Verify all parameter types and required fields\n - Validate response schemas with actual responses\n\n2. Enhancement:\n - Add detailed field descriptions\n - Include example requests and responses\n - Add error code documentation\n - Document custom field details\n\n3. Integration:\n - Generate client libraries\n - Create API wrapper classes\n - Implement rate limiting and retry logic\n\n4. Documentation:\n - Host on ReadTheDocs or similar\n - Create getting started guides\n - Document authentication setup\n\n================================================================================\nFILE INFORMATION\n================================================================================\n\nOutput File: propertybase-api-openapi-3.0.json\nLocation: /sessions/serene-busy-euler/mnt/outputs/\nSize: 246 KB\nFormat: JSON (OpenAPI 3.0.0 compliant)\nValid JSON: Yes\nMinified: No (formatted for readability)\n\n================================================================================\nCONTACT & SUPPORT\n================================================================================\n\nPropertyBase Support: help@propertybase.com\nAPI Documentation: https://apidocs.propertybase.com\nWebsite: https://www.propertybase.com\n\n================================================================================\nEND OF EXTRACTION SUMMARY\n================================================================================\n" }, "api-statistics": { "title": "API Coverage & Metrics", "description": "Complete extraction statistics and API coverage breakdown", "content": "PropertyBase GO API - OpenAPI 3.0 Extraction Statistics\n=====================================================\n\nEXTRACTION COMPLETED: 2026-09-11\n\nSUMMARY STATISTICS\n------------------\nTotal Paths: 102\nTotal Operations: 194\nAPI Version: 2.0\nOpenAPI Version: 3.0.0\nStatus: \u2713 Valid and Complete\n\nOPERATIONS BY HTTP METHOD\n--------------------------\nDELETE: 29\nGET: 86\nPATCH: 36\nPOST: 35\nPUT: 8\n\nRESOURCES DOCUMENTED\n---------------------\n 27 leads\n 21 developments\n 11 marketing_lists\n 4 teams\n 4 offices\n 4 market_reports\n 4 employees\n 4 agents\n 3 saved_searches\n 3 dynamic_forms\n 2 tasks\n 2 sales_exclusives\n 2 messages\n 2 events\n 2 development_categories\n 2 contacts\n 2 contact_notes\n 1 lead_enumerations\n 1 company_lead_custom_fields\n 1 company_contact_custom_fields\n\nSECURITY SCHEME\n---------------\nType: API Key (Header)\nHeader Name: X-BL-API-Key\nRequired: Yes (on all requests)\nLocation: HTTP Request Header\n\nSERVERS CONFIGURED\n------------------\nDefault: https://{domain}/api/v2\nVariables:\n - protocol: https (default) or http\n - domain: Your PropertyBase domain name\n\nAUTHENTICATION\n--------------\nAll API requests require:\n1. Content-Type: application/json header\n2. X-BL-API-Key: header\n\nRESPONSE FORMAT\n---------------\nSuccess Response (status: 200):\n{\n \"status\": \"success\",\n \"message\": \"description\",\n \"data\": { /* response object or array */ }\n}\n\nError Response (status: 400/401/403/etc):\n{\n \"status\": \"failure\",\n \"message\": \"error description\",\n \"errors\": [ /* array of error messages */ ]\n}\n\nSCHEMAS DEFINED\n---------------\n- Agent: Agent profile and details\n- Contact: Contact record information\n- ContactNote: Notes associated with contacts\n- Development: Real estate development projects\n- Task: Task management records\n- Office: Office location information\n- ApiResponse: Standard response wrapper\n- ErrorResponse: Error response format\n- PaginatedResponse: Paginated list responses\n\nFILES GENERATED\n---------------\n1. propertybase-api-openapi-3.0.json (246 KB)\n \u2192 Complete OpenAPI 3.0 specification\n \u2192 Ready for Swagger UI, ReDoc, Postman\n \n2. README.md\n \u2192 Quick start guide\n \u2192 Tool integration examples\n \n3. EXTRACTION_SUMMARY.txt\n \u2192 Detailed resource descriptions\n \n4. API_STATISTICS.txt (this file)\n \u2192 Extraction statistics and metrics\n\nUSE CASES\n---------\n\u2713 Interactive API documentation (Swagger UI, ReDoc)\n\u2713 Code generation (OpenAPI Generator, Swagger Codegen)\n\u2713 API testing (Postman, Insomnia)\n\u2713 Mock server generation\n\u2713 Contract testing and validation\n\u2713 CI/CD integration\n\nNOTES\n-----\n- All endpoints documented with parameters and responses\n- Security requirements clearly defined\n- Standard HTTP error codes included\n- Pagination supported on list endpoints\n- Base URL customizable via server variables\n" } }, "x-documentation": { "authentication-and-security": { "title": "Authentication & Security", "overview": "PropertyBase support staff will provide you with the domain name and an API Key that you will use in combination to authenticate for API calls.", "api-key-header": "X-BL-API-Key", "security-warnings": [ "The API Key should be kept private for security purposes", "Any person with your API Key can make changes to your system including creating, updating and deleting records", "If you feel your API Key has been compromised, contact help@propertybase.com and they will remove your old key from our system and issue you a new key", "The combination of the API Key and the domain the HTTP API request was received for will be used to authenticate the request" ] }, "requests-and-responses": { "title": "Requests and Responses", "content-type": "application/json", "required-headers": [ "Content-Type: application/json", "X-BL-API-Key: xxxxxxxxxx" ], "http-methods": { "GET": "Used to fetch the list of records or an individual record by id", "POST": "Used to create a new record. Request body should be in JSON format", "PATCH": "Used to update a record. PUT is also supported but PATCH is preferred. Request body should be in JSON format", "DELETE": "Used to delete a record. Request body should be in JSON format" }, "example-request": "curl -H \"Content-Type: application/json\" -H \"X-BL-API-Key: xxxxxxxxxx\" -X GET http://www.domain.com/api/v2/offices", "response-format": { "overview": "All responses will return a JSON object in the body", "required-fields": [ "status: either \"success\" or \"failure\"", "message: human-readable response message" ], "success-response": { "contains": [ "status", "message", "data" ], "data-description": "Can be either an array of objects or a single object depending on the request" }, "failure-response": { "contains": [ "status", "message", "errors" ], "errors-description": "An array of error messages that describe why the request failed", "example": { "status": "failure", "message": "Office not created", "errors": [ "Office name must be unique" ] } }, "status-codes": "Available in response headers. See Appendix A: Error Codes for definitions" } }, "permissions": { "title": "Permissions", "overview": "Each API key will be predefined to a set of permissions per resource", "permission-types": [ "Read", "Write", "Delete" ], "granularity": "API Keys could have different levels of access for each type. For example, Read only access to Offices, but Read and Write for Agents and Employees", "unauthorized-response": { "status_code": 401, "example": { "status": "unauthorized", "message": "Office not created", "errors": [ "API Key does not have permissions to create offices" ] } } } } }