{ "openapi": "3.1.0", "info": { "title": "LinkyCal API", "version": "1.0.0", "description": "Project-scoped LinkyCal REST API plus anonymous visitor endpoints. Send API keys as Authorization: Bearer lc_live_.... Dashboard session cookies are not part of this public contract." }, "servers": [ { "url": "https://linkycal.com", "description": "Production" } ], "tags": [ { "name": "Activity" }, { "name": "Analytics" }, { "name": "Availability" }, { "name": "Bookings" }, { "name": "Calendars" }, { "name": "Contacts" }, { "name": "Event types" }, { "name": "Files" }, { "name": "Forms" }, { "name": "MCP" }, { "name": "Projects" }, { "name": "Public files" }, { "name": "Tags" }, { "name": "Visitor booking" }, { "name": "Visitor forms" }, { "name": "Visitor links" }, { "name": "Visitor tracking" }, { "name": "Widgets" }, { "name": "Workflows" } ], "paths": { "/api/projects/{projectId}": { "get": { "operationId": "getProjectsProjectId", "summary": "Get projects", "tags": [ "Projects" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } }, "put": { "operationId": "putProjectsProjectId", "summary": "Update projects", "tags": [ "Projects" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/entitlements": { "get": { "operationId": "getProjectsProjectIdEntitlements", "summary": "Get entitlements", "tags": [ "Projects" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/uploads": { "post": { "operationId": "postProjectsProjectIdUploads", "summary": "Create uploads", "tags": [ "Files" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "fieldId": { "type": "string" } } } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/uploads/{key}": { "delete": { "operationId": "deleteProjectsProjectIdUploadsKey", "summary": "Delete uploads", "tags": [ "Files" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/event-types": { "get": { "operationId": "getProjectsProjectIdEventTypes", "summary": "Get event types", "tags": [ "Event types" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } }, "post": { "operationId": "postProjectsProjectIdEventTypes", "summary": "Create event types", "tags": [ "Event types" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/event-types/{eventTypeId}": { "get": { "operationId": "getProjectsProjectIdEventTypesEventTypeId", "summary": "Get event types", "tags": [ "Event types" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "eventTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } }, "put": { "operationId": "putProjectsProjectIdEventTypesEventTypeId", "summary": "Update event types", "tags": [ "Event types" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "eventTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } }, "delete": { "operationId": "deleteProjectsProjectIdEventTypesEventTypeId", "summary": "Delete event types", "tags": [ "Event types" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "eventTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/schedules": { "get": { "operationId": "getProjectsProjectIdSchedules", "summary": "Get schedules", "tags": [ "Availability" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } }, "post": { "operationId": "postProjectsProjectIdSchedules", "summary": "Create schedules", "tags": [ "Availability" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/schedules/{scheduleId}": { "put": { "operationId": "putProjectsProjectIdSchedulesScheduleId", "summary": "Update schedules", "tags": [ "Availability" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scheduleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } }, "delete": { "operationId": "deleteProjectsProjectIdSchedulesScheduleId", "summary": "Delete schedules", "tags": [ "Availability" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scheduleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/schedules/{scheduleId}/rules": { "put": { "operationId": "putProjectsProjectIdSchedulesScheduleIdRules", "summary": "Update rules", "tags": [ "Availability" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scheduleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } }, "get": { "operationId": "getProjectsProjectIdSchedulesScheduleIdRules", "summary": "Get rules", "tags": [ "Availability" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scheduleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/schedules/{scheduleId}/overrides": { "get": { "operationId": "getProjectsProjectIdSchedulesScheduleIdOverrides", "summary": "Get overrides", "tags": [ "Availability" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scheduleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } }, "post": { "operationId": "postProjectsProjectIdSchedulesScheduleIdOverrides", "summary": "Create overrides", "tags": [ "Availability" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scheduleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/schedules/{scheduleId}/overrides/{overrideId}": { "delete": { "operationId": "deleteProjectsProjectIdSchedulesScheduleIdOverridesOverrideId", "summary": "Delete overrides", "tags": [ "Availability" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scheduleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "overrideId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/bookings": { "get": { "operationId": "getProjectsProjectIdBookings", "summary": "Get bookings", "tags": [ "Bookings" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/bookings/{bookingId}": { "get": { "operationId": "getProjectsProjectIdBookingsBookingId", "summary": "Get bookings", "tags": [ "Bookings" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bookingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/bookings/{bookingId}/cancel": { "patch": { "operationId": "patchProjectsProjectIdBookingsBookingIdCancel", "summary": "Update cancel", "tags": [ "Bookings" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bookingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/bookings/{bookingId}/form-response": { "get": { "operationId": "getProjectsProjectIdBookingsBookingIdFormResponse", "summary": "Get form response", "tags": [ "Bookings" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bookingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/bookings/{bookingId}/confirm": { "patch": { "operationId": "patchProjectsProjectIdBookingsBookingIdConfirm", "summary": "Update confirm", "tags": [ "Bookings" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bookingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/bookings/{bookingId}/decline": { "patch": { "operationId": "patchProjectsProjectIdBookingsBookingIdDecline", "summary": "Update decline", "tags": [ "Bookings" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bookingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/forms": { "get": { "operationId": "getProjectsProjectIdForms", "summary": "Get forms", "tags": [ "Forms" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } }, "post": { "operationId": "postProjectsProjectIdForms", "summary": "Create forms", "tags": [ "Forms" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/forms/{formId}": { "get": { "operationId": "getProjectsProjectIdFormsFormId", "summary": "Get forms", "tags": [ "Forms" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } }, "put": { "operationId": "putProjectsProjectIdFormsFormId", "summary": "Update forms", "tags": [ "Forms" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } }, "delete": { "operationId": "deleteProjectsProjectIdFormsFormId", "summary": "Delete forms", "tags": [ "Forms" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/forms/{formId}/steps": { "get": { "operationId": "getProjectsProjectIdFormsFormIdSteps", "summary": "Get steps", "tags": [ "Forms" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } }, "post": { "operationId": "postProjectsProjectIdFormsFormIdSteps", "summary": "Create steps", "tags": [ "Forms" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/forms/{formId}/steps/{stepId}": { "put": { "operationId": "putProjectsProjectIdFormsFormIdStepsStepId", "summary": "Update steps", "tags": [ "Forms" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "stepId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } }, "delete": { "operationId": "deleteProjectsProjectIdFormsFormIdStepsStepId", "summary": "Delete steps", "tags": [ "Forms" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "stepId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/forms/{formId}/steps/reorder": { "put": { "operationId": "putProjectsProjectIdFormsFormIdStepsReorder", "summary": "Update reorder", "tags": [ "Forms" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/forms/{formId}/fields": { "get": { "operationId": "getProjectsProjectIdFormsFormIdFields", "summary": "Get fields", "tags": [ "Forms" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } }, "post": { "operationId": "postProjectsProjectIdFormsFormIdFields", "summary": "Create fields", "tags": [ "Forms" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/forms/{formId}/fields/reorder": { "put": { "operationId": "putProjectsProjectIdFormsFormIdFieldsReorder", "summary": "Update reorder", "tags": [ "Forms" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/forms/{formId}/fields/{fieldId}": { "put": { "operationId": "putProjectsProjectIdFormsFormIdFieldsFieldId", "summary": "Update fields", "tags": [ "Forms" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } }, "delete": { "operationId": "deleteProjectsProjectIdFormsFormIdFieldsFieldId", "summary": "Delete fields", "tags": [ "Forms" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/forms/{formId}/responses": { "get": { "operationId": "getProjectsProjectIdFormsFormIdResponses", "summary": "Get responses", "tags": [ "Forms" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/forms/{formId}/responses/{responseId}/files/{valueId}": { "get": { "operationId": "getProjectsProjectIdFormsFormIdResponsesResponseIdFilesValueId", "summary": "Get files", "tags": [ "Forms" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "responseId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "valueId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/forms/{formId}/responses/{responseId}": { "get": { "operationId": "getProjectsProjectIdFormsFormIdResponsesResponseId", "summary": "Get responses", "tags": [ "Forms" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "responseId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/form-responses/{responseId}": { "delete": { "operationId": "deleteProjectsProjectIdFormResponsesResponseId", "summary": "Delete form responses", "tags": [ "Forms" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "responseId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/contacts": { "get": { "operationId": "getProjectsProjectIdContacts", "summary": "List and filter contacts", "tags": [ "Contacts" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "tagId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Legacy single-tag filter." }, { "name": "tagIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true, "description": "Repeat the query parameter to filter by multiple tags." }, { "name": "matchAllTags", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "stageTagId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "excludeStageTagIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "activityType", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "form_submitted", "booked", "cancelled", "tag_added", "tag_removed", "workflow_researched" ] } }, { "name": "activitySinceDays", "in": "query", "required": false, "schema": { "type": "number", "minimum": 0 } }, { "name": "noActivitySinceDays", "in": "query", "required": false, "schema": { "type": "number", "minimum": 0 } }, { "name": "bookingStatus", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "confirmed", "cancelled", "rescheduled", "pending", "declined" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "Contact page", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactListResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "postProjectsProjectIdContacts", "summary": "Create contacts", "tags": [ "Contacts" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/contact-views": { "get": { "operationId": "getProjectsProjectIdContactViews", "summary": "Get contact views", "tags": [ "Contacts" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } }, "post": { "operationId": "postProjectsProjectIdContactViews", "summary": "Create contact views", "tags": [ "Contacts" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/contact-views/{viewId}": { "put": { "operationId": "putProjectsProjectIdContactViewsViewId", "summary": "Update contact views", "tags": [ "Contacts" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "viewId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } }, "delete": { "operationId": "deleteProjectsProjectIdContactViewsViewId", "summary": "Delete contact views", "tags": [ "Contacts" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "viewId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/contacts/import": { "post": { "operationId": "postProjectsProjectIdContactsImport", "summary": "Create import", "tags": [ "Contacts" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/contacts/{contactId}": { "get": { "operationId": "getProjectsProjectIdContactsContactId", "summary": "Get contacts", "tags": [ "Contacts" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } }, "put": { "operationId": "putProjectsProjectIdContactsContactId", "summary": "Update contacts", "tags": [ "Contacts" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } }, "delete": { "operationId": "deleteProjectsProjectIdContactsContactId", "summary": "Delete contacts", "tags": [ "Contacts" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/contacts/{contactId}/activities": { "get": { "operationId": "getProjectsProjectIdContactsContactIdActivities", "summary": "List contact activity", "tags": [ "Contacts" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "category", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "bookings", "form_responses", "workflows" ], "default": "all" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Opaque nextCursor value from the previous page." } ], "responses": { "200": { "description": "Contact activity page", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactActivityPage" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/projects/{projectId}/contacts/{contactId}/next-action": { "put": { "operationId": "putProjectsProjectIdContactsContactIdNextAction", "summary": "Update next action", "tags": [ "Contacts" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/tags": { "get": { "operationId": "getProjectsProjectIdTags", "summary": "List tags", "tags": [ "Tags" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 100 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Opaque cursor from a previous response; requires limit." } ], "responses": { "200": { "description": "Tag page", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagListResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "postProjectsProjectIdTags", "summary": "Create a tag", "tags": [ "Tags" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTagRequest" } } } }, "responses": { "201": { "description": "Tag created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "A tag with this name already exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/projects/{projectId}/tags/{tagId}": { "get": { "operationId": "getProjectsProjectIdTagsTagId", "summary": "Get a tag", "tags": [ "Tags" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Tag details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "operationId": "deleteProjectsProjectIdTagsTagId", "summary": "Delete a tag", "tags": [ "Tags" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Tag deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "The tag is referenced by workflows", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagInUseError" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "operationId": "patchProjectsProjectIdTagsTagId", "summary": "Update a tag", "tags": [ "Tags" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTagRequest" } } } }, "responses": { "200": { "description": "Tag updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "A tag with this name already exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/projects/{projectId}/contacts/{contactId}/tags": { "post": { "operationId": "postProjectsProjectIdContactsContactIdTags", "summary": "Assign a tag to a contact (legacy)", "tags": [ "Tags" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignTagRequest" } } } }, "responses": { "201": { "description": "Tag assignment processed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagAssignmentResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/projects/{projectId}/contacts/{contactId}/tags/{tagId}": { "put": { "operationId": "putProjectsProjectIdContactsContactIdTagsTagId", "summary": "Assign a tag to a contact", "tags": [ "Tags" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Tag assignment processed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagAssignmentResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "operationId": "deleteProjectsProjectIdContactsContactIdTagsTagId", "summary": "Remove a tag from a contact", "tags": [ "Tags" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Tag removal processed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagRemovalResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/projects/{projectId}/contacts/{contactId}/stage": { "post": { "operationId": "postProjectsProjectIdContactsContactIdStage", "summary": "Create stage", "tags": [ "Contacts" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/contacts/{contactId}/enrich": { "post": { "operationId": "postProjectsProjectIdContactsContactIdEnrich", "summary": "Create enrich", "tags": [ "Contacts" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/pipeline/seed": { "post": { "operationId": "postProjectsProjectIdPipelineSeed", "summary": "Create seed", "tags": [ "Contacts" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/workflows": { "get": { "operationId": "getProjectsProjectIdWorkflows", "summary": "Get workflows", "tags": [ "Workflows" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } }, "post": { "operationId": "postProjectsProjectIdWorkflows", "summary": "Create workflows", "tags": [ "Workflows" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/workflows/{workflowId}": { "put": { "operationId": "putProjectsProjectIdWorkflowsWorkflowId", "summary": "Update workflows", "tags": [ "Workflows" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } }, "delete": { "operationId": "deleteProjectsProjectIdWorkflowsWorkflowId", "summary": "Delete workflows", "tags": [ "Workflows" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } }, "get": { "operationId": "getProjectsProjectIdWorkflowsWorkflowId", "summary": "Get workflows", "tags": [ "Workflows" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/workflows/{workflowId}/steps": { "get": { "operationId": "getProjectsProjectIdWorkflowsWorkflowIdSteps", "summary": "Get steps", "tags": [ "Workflows" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } }, "post": { "operationId": "postProjectsProjectIdWorkflowsWorkflowIdSteps", "summary": "Create steps", "tags": [ "Workflows" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/workflows/{workflowId}/steps/reorder": { "put": { "operationId": "putProjectsProjectIdWorkflowsWorkflowIdStepsReorder", "summary": "Update reorder", "tags": [ "Workflows" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/workflows/{workflowId}/steps/{stepId}": { "put": { "operationId": "putProjectsProjectIdWorkflowsWorkflowIdStepsStepId", "summary": "Update steps", "tags": [ "Workflows" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "stepId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } }, "delete": { "operationId": "deleteProjectsProjectIdWorkflowsWorkflowIdStepsStepId", "summary": "Delete steps", "tags": [ "Workflows" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "stepId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/workflows/{workflowId}/runs": { "get": { "operationId": "getProjectsProjectIdWorkflowsWorkflowIdRuns", "summary": "Get runs", "tags": [ "Workflows" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/workflows/{workflowId}/runs/{runId}": { "get": { "operationId": "getProjectsProjectIdWorkflowsWorkflowIdRunsRunId", "summary": "Get runs", "tags": [ "Workflows" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/workflows/{workflowId}/trigger": { "post": { "operationId": "postProjectsProjectIdWorkflowsWorkflowIdTrigger", "summary": "Create trigger", "tags": [ "Workflows" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/workflows/{workflowId}/test": { "post": { "operationId": "postProjectsProjectIdWorkflowsWorkflowIdTest", "summary": "Create test", "tags": [ "Workflows" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/calendar/calendars": { "get": { "operationId": "getProjectsProjectIdCalendarCalendars", "summary": "Get calendars", "tags": [ "Calendars" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/event-types/{eventTypeId}/calendars": { "get": { "operationId": "getProjectsProjectIdEventTypesEventTypeIdCalendars", "summary": "Get calendars", "tags": [ "Event types" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "eventTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } }, "put": { "operationId": "putProjectsProjectIdEventTypesEventTypeIdCalendars", "summary": "Update calendars", "tags": [ "Event types" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "eventTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/activity/recent": { "get": { "operationId": "getProjectsProjectIdActivityRecent", "summary": "Get recent", "tags": [ "Activity" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/projects/{projectId}/analytics/filters": { "get": { "operationId": "getProjectsProjectIdAnalyticsFilters", "summary": "List analytics filters and project resources", "description": "Pro or Business required. Returns project-owned event types/forms plus observed UTM, source, and device values.", "tags": [ "Analytics" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Analytics filter catalog", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsFiltersResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/projects/{projectId}/analytics/overview": { "get": { "operationId": "getProjectsProjectIdAnalyticsOverview", "summary": "Get analytics overview", "description": "Pro or Business required. Returns aggregate traffic and conversion totals without visitor histories.", "tags": [ "Analytics" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": false, "description": "Preset period or custom date range.", "schema": { "type": "string", "enum": [ "7d", "30d", "90d", "custom" ], "default": "30d" } }, { "name": "start", "in": "query", "required": false, "description": "Inclusive ISO date; accepted only when period=custom.", "schema": { "type": "string", "format": "date" } }, { "name": "end", "in": "query", "required": false, "description": "Inclusive ISO date; accepted only when period=custom.", "schema": { "type": "string", "format": "date" } }, { "name": "utmSource", "in": "query", "required": false, "description": "Filter by UTM source.", "schema": { "type": "string" } }, { "name": "utmMedium", "in": "query", "required": false, "description": "Filter by UTM medium.", "schema": { "type": "string" } }, { "name": "utmCampaign", "in": "query", "required": false, "description": "Filter by UTM campaign.", "schema": { "type": "string" } }, { "name": "source", "in": "query", "required": false, "description": "Filter direct pages or widget journeys.", "schema": { "type": "string", "enum": [ "direct", "widget" ] } }, { "name": "deviceType", "in": "query", "required": false, "description": "Filter by coarse device class.", "schema": { "type": "string", "enum": [ "mobile", "tablet", "desktop" ] } } ], "responses": { "200": { "description": "Analytics overview", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsOverviewResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/projects/{projectId}/analytics/bookings": { "get": { "operationId": "getProjectsProjectIdAnalyticsBookings", "summary": "Get booking funnel analytics", "description": "Pro or Business required. Select an event type for unique-journey stage continuation, drop-offs, dates, availability, offered times, selected times, and safe failures.", "tags": [ "Analytics" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": false, "description": "Preset period or custom date range.", "schema": { "type": "string", "enum": [ "7d", "30d", "90d", "custom" ], "default": "30d" } }, { "name": "start", "in": "query", "required": false, "description": "Inclusive ISO date; accepted only when period=custom.", "schema": { "type": "string", "format": "date" } }, { "name": "end", "in": "query", "required": false, "description": "Inclusive ISO date; accepted only when period=custom.", "schema": { "type": "string", "format": "date" } }, { "name": "resourceSlug", "in": "query", "required": false, "description": "Project-owned event type or form slug. Required for exact stage reports.", "schema": { "type": "string" } }, { "name": "utmSource", "in": "query", "required": false, "description": "Filter by UTM source.", "schema": { "type": "string" } }, { "name": "utmMedium", "in": "query", "required": false, "description": "Filter by UTM medium.", "schema": { "type": "string" } }, { "name": "utmCampaign", "in": "query", "required": false, "description": "Filter by UTM campaign.", "schema": { "type": "string" } }, { "name": "source", "in": "query", "required": false, "description": "Filter direct pages or widget journeys.", "schema": { "type": "string", "enum": [ "direct", "widget" ] } }, { "name": "deviceType", "in": "query", "required": false, "description": "Filter by coarse device class.", "schema": { "type": "string", "enum": [ "mobile", "tablet", "desktop" ] } } ], "responses": { "200": { "description": "Booking funnel analytics", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookingAnalyticsResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/projects/{projectId}/analytics/forms": { "get": { "operationId": "getProjectsProjectIdAnalyticsForms", "summary": "Get form funnel analytics", "description": "Pro or Business required. Select a form for unique-journey question/step continuation, skips, drop-offs, and safe validation failures.", "tags": [ "Analytics" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": false, "description": "Preset period or custom date range.", "schema": { "type": "string", "enum": [ "7d", "30d", "90d", "custom" ], "default": "30d" } }, { "name": "start", "in": "query", "required": false, "description": "Inclusive ISO date; accepted only when period=custom.", "schema": { "type": "string", "format": "date" } }, { "name": "end", "in": "query", "required": false, "description": "Inclusive ISO date; accepted only when period=custom.", "schema": { "type": "string", "format": "date" } }, { "name": "resourceSlug", "in": "query", "required": false, "description": "Project-owned event type or form slug. Required for exact stage reports.", "schema": { "type": "string" } }, { "name": "utmSource", "in": "query", "required": false, "description": "Filter by UTM source.", "schema": { "type": "string" } }, { "name": "utmMedium", "in": "query", "required": false, "description": "Filter by UTM medium.", "schema": { "type": "string" } }, { "name": "utmCampaign", "in": "query", "required": false, "description": "Filter by UTM campaign.", "schema": { "type": "string" } }, { "name": "source", "in": "query", "required": false, "description": "Filter direct pages or widget journeys.", "schema": { "type": "string", "enum": [ "direct", "widget" ] } }, { "name": "deviceType", "in": "query", "required": false, "description": "Filter by coarse device class.", "schema": { "type": "string", "enum": [ "mobile", "tablet", "desktop" ] } } ], "responses": { "200": { "description": "Form funnel analytics", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormAnalyticsResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/projects/{projectId}/analytics/integrations": { "get": { "operationId": "getProjectsProjectIdAnalyticsIntegrations", "summary": "List analytics integrations", "description": "Pro or Business required. Returns normalized public GA4, Meta Pixel, and PostHog configuration.", "tags": [ "Analytics" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Analytics integrations", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsIntegrationsResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/projects/{projectId}/analytics/integrations/{provider}": { "put": { "operationId": "putProjectsProjectIdAnalyticsIntegrationsProvider", "summary": "Configure an analytics integration", "description": "Pro or Business required. Provider is ga4, meta_pixel, or posthog. Raw scripts, script URLs, secrets, and arbitrary PostHog hosts are rejected.", "tags": [ "Analytics" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "provider", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "ga4", "meta_pixel", "posthog" ] } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigureAnalyticsIntegrationRequest" } } } }, "responses": { "200": { "description": "Analytics integration saved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsIntegrationResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/availability/{projectSlug}": { "get": { "operationId": "getV1AvailabilityProjectSlug", "summary": "List available booking times", "description": "Visitor-facing; rate limited to 60 requests per minute per IP.", "tags": [ "Visitor booking" ], "security": [], "parameters": [ { "name": "projectSlug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/v1/t": { "post": { "operationId": "postV1T", "summary": "Record a public tracking event", "description": "Visitor-facing telemetry endpoint; accepts one event or a batch of at most 20 and is rate limited to 120 requests per minute per IP.", "tags": [ "Visitor tracking" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnonymousAnalyticsEventsRequest" } } } }, "responses": { "204": { "description": "Events accepted" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/bookings": { "post": { "operationId": "postV1Bookings", "summary": "Create a booking", "description": "Visitor-facing; rate limited to 10 requests per minute per IP.", "tags": [ "Visitor booking" ], "security": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/v1/forms/{projectSlug}/{formSlug}/responses": { "post": { "operationId": "postV1FormsProjectSlugFormSlugResponses", "summary": "Start a form response", "description": "Visitor-facing; rate limited to 30 requests per minute per IP.", "tags": [ "Visitor forms" ], "security": [], "parameters": [ { "name": "projectSlug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formSlug", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/v1/forms/{projectSlug}/{formSlug}/responses/{responseId}/uploads": { "post": { "operationId": "postV1FormsProjectSlugFormSlugResponsesResponseIdUploads", "summary": "Upload a form response file", "description": "Visitor-facing multipart upload; rate limited to 30 requests per minute per IP.", "tags": [ "Visitor forms" ], "security": [], "parameters": [ { "name": "projectSlug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formSlug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "responseId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "fieldId": { "type": "string" } } } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/v1/forms/{projectSlug}/{formSlug}/responses/{responseId}/files/{valueId}": { "get": { "operationId": "getV1FormsProjectSlugFormSlugResponsesResponseIdFilesValueId", "summary": "Download a private form response file", "description": "Project-scoped API key required; the key project must own the form.", "tags": [ "Forms" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectSlug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formSlug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "responseId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "valueId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/v1/forms/{projectSlug}/{formSlug}/responses/{responseId}/steps/{stepIndex}": { "patch": { "operationId": "patchV1FormsProjectSlugFormSlugResponsesResponseIdStepsStepIndex", "summary": "Submit a form response step", "description": "Visitor-facing; rate limited to 60 requests per minute per IP.", "tags": [ "Visitor forms" ], "security": [], "parameters": [ { "name": "projectSlug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formSlug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "responseId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "stepIndex", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/v1/event-types/{projectSlug}/{eventSlug}": { "get": { "operationId": "getV1EventTypesProjectSlugEventSlug", "summary": "Get a public event type", "description": "Visitor-facing booking configuration.", "tags": [ "Visitor booking" ], "security": [], "parameters": [ { "name": "projectSlug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "eventSlug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/widget/booking/{projectSlug}/config": { "get": { "operationId": "getWidgetBookingProjectSlugConfig", "summary": "Get booking widget configuration", "description": "Visitor-facing widget bootstrap endpoint.", "tags": [ "Widgets" ], "security": [], "parameters": [ { "name": "projectSlug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/widget/form/{projectSlug}/{formSlug}/config": { "get": { "operationId": "getWidgetFormProjectSlugFormSlugConfig", "summary": "Get form widget configuration", "description": "Visitor-facing widget bootstrap endpoint.", "tags": [ "Widgets" ], "security": [], "parameters": [ { "name": "projectSlug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formSlug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/public/resolve/{projectSlug}/{slug}": { "get": { "operationId": "getPublicResolveProjectSlugSlug", "summary": "Resolve a public link", "description": "Visitor-facing resolver for form and booking links.", "tags": [ "Visitor links" ], "security": [], "parameters": [ { "name": "projectSlug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/public/forms/{projectSlug}/{formSlug}": { "get": { "operationId": "getPublicFormsProjectSlugFormSlug", "summary": "Get a public form", "description": "Visitor-facing form definition.", "tags": [ "Visitor forms" ], "security": [], "parameters": [ { "name": "projectSlug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formSlug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/public/forms/{projectSlug}/{formSlug}/responses": { "post": { "operationId": "postPublicFormsProjectSlugFormSlugResponses", "summary": "Start a public form response", "description": "Legacy visitor form endpoint retained for compatibility.", "tags": [ "Visitor forms" ], "security": [], "parameters": [ { "name": "projectSlug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formSlug", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/public/forms/{projectSlug}/{formSlug}/responses/{responseId}/steps/{stepIndex}": { "patch": { "operationId": "patchPublicFormsProjectSlugFormSlugResponsesResponseIdStepsStepIndex", "summary": "Submit a public form response step", "description": "Legacy visitor form endpoint retained for compatibility.", "tags": [ "Visitor forms" ], "security": [], "parameters": [ { "name": "projectSlug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formSlug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "responseId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "stepIndex", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/public/forms/{projectSlug}/{formSlug}/submit": { "post": { "operationId": "postPublicFormsProjectSlugFormSlugSubmit", "summary": "Submit a public form", "description": "Legacy single-request form submission endpoint.", "tags": [ "Visitor forms" ], "security": [], "parameters": [ { "name": "projectSlug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formSlug", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/uploads/{key}": { "get": { "operationId": "getUploadsKey", "summary": "Download a public upload", "description": "Public object delivery endpoint; object keys are unguessable.", "tags": [ "Public files" ], "security": [], "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } }, "/api/mcp": { "post": { "operationId": "postMcp", "summary": "Connect to the LinkyCal MCP server", "description": "Streamable HTTP MCP transport; project-scoped API key required.", "tags": [ "MCP" ], "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonObject" } } } }, "responses": { "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The credential cannot access this project or operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "2XX": { "description": "Successful response" } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "lc_live_..." } }, "schemas": { "FunnelContextValue": { "type": "object", "additionalProperties": false, "required": [ "value", "visitors" ], "properties": { "value": { "type": "string" }, "visitors": { "type": "integer", "minimum": 0 } } }, "FunnelContextBreakdowns": { "type": "object", "additionalProperties": false, "properties": { "selectedDates": { "type": "array", "items": { "$ref": "#/components/schemas/FunnelContextValue" } }, "availabilityOutcomes": { "type": "array", "items": { "$ref": "#/components/schemas/FunnelContextValue" } }, "offeredTimes": { "type": "array", "items": { "$ref": "#/components/schemas/FunnelContextValue" } }, "selectedTimes": { "type": "array", "items": { "$ref": "#/components/schemas/FunnelContextValue" } }, "validationFailures": { "type": "array", "items": { "$ref": "#/components/schemas/FunnelContextValue" } }, "submitFailures": { "type": "array", "items": { "$ref": "#/components/schemas/FunnelContextValue" } } } }, "FunnelStageReport": { "type": "object", "additionalProperties": false, "required": [ "key", "label", "kind", "order", "visitors", "continued", "continuationRate", "dropOffs", "dropOffRate" ], "properties": { "key": { "type": "string" }, "label": { "type": "string", "description": "Dashboard-only stage label. It is not sent to external analytics providers." }, "kind": { "type": "string", "enum": [ "page", "date", "availability", "time", "details", "statement", "question", "group", "step", "submit", "completion" ] }, "order": { "type": "integer", "minimum": 0 }, "visitors": { "type": "integer", "minimum": 0 }, "continued": { "type": "integer", "minimum": 0 }, "continuationRate": { "type": "number", "minimum": 0, "maximum": 100 }, "dropOffs": { "type": "integer", "minimum": 0 }, "dropOffRate": { "type": "number", "minimum": 0, "maximum": 100 }, "skipped": { "type": "integer", "minimum": 0 }, "contextBreakdowns": { "$ref": "#/components/schemas/FunnelContextBreakdowns" } } }, "DetailedFunnelReport": { "type": "object", "additionalProperties": false, "required": [ "availableSince", "stages", "bySource", "byDevice", "failures" ], "properties": { "availableSince": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "First detailed event in the selected report. Earlier high-level history may exist." }, "stages": { "type": "array", "items": { "$ref": "#/components/schemas/FunnelStageReport" } }, "bySource": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "source", "visitors" ], "properties": { "source": { "type": "string", "enum": [ "direct", "widget" ] }, "visitors": { "type": "integer", "minimum": 0 } } } }, "byDevice": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "deviceType", "visitors" ], "properties": { "deviceType": { "type": "string", "enum": [ "mobile", "tablet", "desktop" ] }, "visitors": { "type": "integer", "minimum": 0 } } } }, "failures": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "category", "count" ], "properties": { "category": { "type": "string", "enum": [ "validation", "slot_unavailable", "rate_limited", "network", "server", "unknown" ] }, "count": { "type": "integer", "minimum": 0 } } } } } }, "AnalyticsOverviewResponse": { "type": "object", "required": [ "totals", "timeSeries", "topSources", "topCountries" ], "properties": { "totals": { "type": "object", "required": [ "views", "conversions", "conversionRate", "uniqueSources" ], "properties": { "views": { "type": "integer", "minimum": 0 }, "conversions": { "type": "integer", "minimum": 0 }, "conversionRate": { "type": "number", "minimum": 0, "maximum": 100 }, "uniqueSources": { "type": "integer", "minimum": 0 } } }, "timeSeries": { "type": "array", "items": { "type": "object" } }, "topSources": { "type": "array", "items": { "type": "object" } }, "topCountries": { "type": "array", "items": { "type": "object" } } } }, "BookingAnalyticsResponse": { "allOf": [ { "$ref": "#/components/schemas/DetailedFunnelReport" }, { "type": "object", "required": [ "funnel", "byEventType", "timeSeries" ], "properties": { "funnel": { "type": "object", "required": [ "pageViews", "bookingsCreated", "conversionRate" ], "properties": { "pageViews": { "type": "integer", "minimum": 0 }, "bookingsCreated": { "type": "integer", "minimum": 0 }, "conversionRate": { "type": "number", "minimum": 0, "maximum": 100 } } }, "byEventType": { "type": "array", "items": { "type": "object" } }, "timeSeries": { "type": "array", "items": { "type": "object" } } } } ] }, "FormAnalyticsResponse": { "allOf": [ { "$ref": "#/components/schemas/DetailedFunnelReport" }, { "type": "object", "required": [ "funnel", "byForm", "timeSeries" ], "properties": { "funnel": { "type": "object", "required": [ "views", "started", "completed", "startRate", "completionRate" ], "properties": { "views": { "type": "integer", "minimum": 0 }, "started": { "type": "integer", "minimum": 0 }, "completed": { "type": "integer", "minimum": 0 }, "startRate": { "type": "number", "minimum": 0, "maximum": 100 }, "completionRate": { "type": "number", "minimum": 0, "maximum": 100 } } }, "byForm": { "type": "array", "items": { "type": "object" } }, "timeSeries": { "type": "array", "items": { "type": "object" } } } } ] }, "AnalyticsFiltersResponse": { "type": "object", "additionalProperties": false, "required": [ "utmSources", "utmMediums", "utmCampaigns", "sources", "deviceTypes", "eventTypes", "forms" ], "properties": { "utmSources": { "type": "array", "items": { "type": "string" } }, "utmMediums": { "type": "array", "items": { "type": "string" } }, "utmCampaigns": { "type": "array", "items": { "type": "string" } }, "sources": { "type": "array", "items": { "type": "string", "enum": [ "direct", "widget" ] } }, "deviceTypes": { "type": "array", "items": { "type": "string", "enum": [ "mobile", "tablet", "desktop" ] } }, "eventTypes": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyticsResource" } }, "forms": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyticsResource" } } } }, "AnalyticsResource": { "type": "object", "additionalProperties": false, "required": [ "id", "slug", "name" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } } }, "Ga4AnalyticsIntegration": { "type": "object", "additionalProperties": false, "required": [ "provider", "enabled" ], "properties": { "provider": { "type": "string", "const": "ga4" }, "enabled": { "type": "boolean" }, "measurementId": { "type": "string", "pattern": "^G-[A-Z0-9]{4,20}$" } } }, "MetaPixelAnalyticsIntegration": { "type": "object", "additionalProperties": false, "required": [ "provider", "enabled" ], "properties": { "provider": { "type": "string", "const": "meta_pixel" }, "enabled": { "type": "boolean" }, "pixelId": { "type": "string", "pattern": "^\\d{5,30}$" } } }, "PostHogAnalyticsIntegration": { "type": "object", "additionalProperties": false, "required": [ "provider", "enabled", "host" ], "properties": { "provider": { "type": "string", "const": "posthog" }, "enabled": { "type": "boolean" }, "projectKey": { "type": "string", "pattern": "^phc_[A-Za-z0-9_-]{10,200}$" }, "host": { "type": "string", "enum": [ "us", "eu" ] } } }, "AnalyticsIntegration": { "oneOf": [ { "$ref": "#/components/schemas/Ga4AnalyticsIntegration" }, { "$ref": "#/components/schemas/MetaPixelAnalyticsIntegration" }, { "$ref": "#/components/schemas/PostHogAnalyticsIntegration" } ] }, "AnalyticsIntegrationsResponse": { "type": "object", "additionalProperties": false, "required": [ "integrations" ], "properties": { "integrations": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyticsIntegration" } } } }, "ConfigureAnalyticsIntegrationRequest": { "oneOf": [ { "type": "object", "additionalProperties": false, "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean" }, "measurementId": { "type": "string", "pattern": "^G-[A-Z0-9]{4,20}$" } } }, { "type": "object", "additionalProperties": false, "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean" }, "pixelId": { "type": "string", "pattern": "^\\d{5,30}$" } } }, { "type": "object", "additionalProperties": false, "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean" }, "projectKey": { "type": "string", "pattern": "^phc_[A-Za-z0-9_-]{10,200}$" }, "host": { "type": "string", "enum": [ "us", "eu" ] } } } ] }, "AnalyticsIntegrationResponse": { "type": "object", "additionalProperties": false, "required": [ "integration" ], "properties": { "integration": { "$ref": "#/components/schemas/AnalyticsIntegration" } } }, "AnonymousAnalyticsEventContext": { "type": "object", "additionalProperties": false, "properties": { "selectedDate": { "type": "string", "format": "date" }, "weekday": { "type": "string" }, "viewerTimezone": { "type": "string" }, "offeredSlotStarts": { "type": "array", "maxItems": 48, "items": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$" } }, "earliestSlot": { "type": "string" }, "latestSlot": { "type": "string" }, "availabilityOutcome": { "type": "string", "enum": [ "available", "none", "error" ] }, "selectedTime": { "type": "string" }, "fieldType": { "type": "string" }, "required": { "type": "boolean" }, "stageOutcome": { "type": "string", "enum": [ "viewed", "completed", "skipped", "validation_failed" ] }, "failureCategory": { "type": "string", "enum": [ "validation", "slot_unavailable", "rate_limited", "network", "server", "unknown" ] } } }, "AnonymousAnalyticsEvent": { "type": "object", "additionalProperties": false, "description": "PII-free funnel event. Names, emails, answers, notes, filenames, raw errors, and IP addresses are not accepted.", "required": [ "event", "projectSlug" ], "properties": { "event": { "type": "string", "enum": [ "page_view", "booking_created", "form_view", "form_started", "form_completed", "booking_date_selected", "booking_availability_shown", "booking_time_selected", "booking_details_viewed", "booking_submit_attempted", "booking_submit_failed", "form_stage_viewed", "form_stage_completed", "form_stage_skipped", "form_stage_validation_failed", "form_submit_attempted", "form_submit_failed" ] }, "projectSlug": { "type": "string" }, "resourceSlug": { "type": "string" }, "journeyId": { "type": "string", "format": "uuid" }, "funnelType": { "type": "string", "enum": [ "booking", "form" ] }, "stageKey": { "type": "string" }, "stageLabel": { "type": "string" }, "stageKind": { "type": "string" }, "stageOrder": { "type": "integer", "minimum": 0 }, "primaryValue": { "type": "string" }, "deviceType": { "type": "string", "enum": [ "mobile", "tablet", "desktop" ] }, "source": { "type": "string", "enum": [ "direct", "widget" ] }, "slotCount": { "type": "integer", "minimum": 0 }, "daysAhead": { "type": "integer" }, "durationMinutes": { "type": "integer", "minimum": 1 }, "context": { "$ref": "#/components/schemas/AnonymousAnalyticsEventContext" }, "utmSource": { "type": "string" }, "utmMedium": { "type": "string" }, "utmCampaign": { "type": "string" }, "utmTerm": { "type": "string" }, "utmContent": { "type": "string" }, "referrer": { "type": "string" } } }, "AnonymousAnalyticsEventsRequest": { "oneOf": [ { "$ref": "#/components/schemas/AnonymousAnalyticsEvent" }, { "type": "array", "minItems": 1, "maxItems": 20, "items": { "$ref": "#/components/schemas/AnonymousAnalyticsEvent" } } ] }, "ContactTag": { "type": "object", "required": [ "id", "name", "color" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "anyOf": [ { "type": "string", "pattern": "^#[0-9a-fA-F]{6}$" }, { "type": "null" } ] } } }, "ContactNextAction": { "type": "object", "required": [ "text", "deadline" ], "properties": { "text": { "type": "string" }, "deadline": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] } } }, "Contact": { "type": "object", "required": [ "id", "projectId", "name", "tags", "lastActivityAt", "enteredAtByTagId", "nextAction", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "email": { "anyOf": [ { "type": "string", "format": "email" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "companyWebsite": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "position": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "companySize": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "estimatedRevenue": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "linkedinUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metadata": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/ContactTag" } }, "lastActivityAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "enteredAtByTagId": { "type": "object", "additionalProperties": { "type": "string", "format": "date-time" } }, "nextAction": { "anyOf": [ { "$ref": "#/components/schemas/ContactNextAction" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "ContactListResponse": { "type": "object", "required": [ "contacts", "total" ], "properties": { "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "total": { "type": "integer", "minimum": 0 } } }, "ContactActivityCounts": { "type": "object", "required": [ "all", "bookings", "formResponses", "workflows" ], "properties": { "all": { "type": "integer", "minimum": 0 }, "bookings": { "type": "integer", "minimum": 0 }, "formResponses": { "type": "integer", "minimum": 0 }, "workflows": { "type": "integer", "minimum": 0 } } }, "ContactActivityItem": { "type": "object", "additionalProperties": true, "required": [ "id", "kind", "category", "occurredAt", "title", "description", "status" ], "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "booking", "form_response", "workflow_run", "research", "generic" ] }, "category": { "type": "string", "enum": [ "all", "bookings", "form_responses", "workflows" ] }, "occurredAt": { "type": "string", "format": "date-time" }, "title": { "type": "string" }, "description": { "type": "string" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "ContactActivityPage": { "type": "object", "required": [ "activities", "counts", "nextCursor" ], "properties": { "activities": { "type": "array", "items": { "$ref": "#/components/schemas/ContactActivityItem" } }, "counts": { "$ref": "#/components/schemas/ContactActivityCounts" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "Tag": { "type": "object", "required": [ "id", "projectId", "name", "color", "createdAt" ], "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string", "minLength": 1, "maxLength": 50 }, "color": { "anyOf": [ { "type": "string", "pattern": "^#[0-9a-fA-F]{6}$" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" } } }, "TagResponse": { "type": "object", "required": [ "tag" ], "properties": { "tag": { "$ref": "#/components/schemas/Tag" } } }, "TagListResponse": { "type": "object", "required": [ "tags", "nextCursor" ], "properties": { "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "CreateTagRequest": { "type": "object", "additionalProperties": false, "required": [ "name" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 50 }, "color": { "type": "string", "pattern": "^#[0-9a-fA-F]{6}$" } } }, "UpdateTagRequest": { "type": "object", "additionalProperties": false, "minProperties": 1, "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 50 }, "color": { "type": "string", "pattern": "^#[0-9a-fA-F]{6}$" } } }, "AssignTagRequest": { "type": "object", "additionalProperties": false, "required": [ "tagId" ], "properties": { "tagId": { "type": "string", "minLength": 1 } } }, "TagAssignmentResponse": { "type": "object", "required": [ "tag", "assigned" ], "properties": { "success": { "type": "boolean" }, "tag": { "$ref": "#/components/schemas/Tag" }, "assigned": { "type": "boolean" } } }, "TagRemovalResponse": { "type": "object", "required": [ "success", "tag", "removed" ], "properties": { "success": { "type": "boolean" }, "tag": { "$ref": "#/components/schemas/Tag" }, "removed": { "type": "boolean" } } }, "TagInUseError": { "type": "object", "required": [ "error", "code", "workflows" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "const": "TAG_IN_USE" }, "workflows": { "type": "array", "items": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } } }, "SuccessResponse": { "type": "object", "required": [ "success" ], "properties": { "success": { "type": "boolean" } } }, "JsonObject": { "type": "object", "additionalProperties": true }, "Error": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" }, "code": { "type": "string" } } } } } }