{ "openapi": "3.1.0", "info": { "title": "Waalaxy AI public API (beta)", "version": "1.0.0-beta" }, "paths": { "/v1/me": { "get": { "operationId": "getMe", "summary": "Get the key owner", "description": "Get the user who owns the API key", "tags": [ "Workspace" ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "name": { "type": [ "string", "null" ] }, "image": { "type": [ "string", "null" ] }, "workspaceId": { "type": "string" }, "workspaceRole": { "type": "string", "enum": [ "OWNER", "ADMIN", "MEMBER", "VIEWER" ] }, "country": { "type": "string", "minLength": 2, "maxLength": 2 }, "interfaceLanguage": { "type": [ "string", "null" ], "enum": [ "en", "fr" ] }, "emailVerified": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "email", "name", "image", "workspaceId", "workspaceRole", "country", "interfaceLanguage", "emailVerified", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "status", "data" ], "additionalProperties": false } } } }, "400": { "description": "Error, see Errors and rate limits", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } }, "required": [ "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/workspace": { "get": { "operationId": "getWorkspace", "summary": "Get the workspace", "description": "Get the workspace name, timezone and contact email", "tags": [ "Workspace" ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "data": { "type": "object", "properties": { "name": { "type": "string" }, "timezone": { "type": "string" }, "contactEmail": { "type": [ "string", "null" ], "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } }, "required": [ "name", "timezone", "contactEmail" ], "additionalProperties": false } }, "required": [ "status", "data" ], "additionalProperties": false } } } }, "400": { "description": "Error, see Errors and rate limits", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } }, "required": [ "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/team": { "get": { "operationId": "getTeam", "summary": "Get the team", "description": "List the workspace members with their role, and the pending invitations", "tags": [ "Team" ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "data": { "type": "object", "properties": { "members": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "name": { "type": [ "string", "null" ] }, "image": { "type": [ "string", "null" ] }, "workspaceRole": { "type": "string", "enum": [ "OWNER", "ADMIN", "MEMBER", "VIEWER" ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "email", "name", "image", "workspaceRole", "createdAt" ], "additionalProperties": false } }, "invitations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "invitedByName": { "type": "string", "minLength": 1 }, "workspaceRole": { "type": "string", "enum": [ "ADMIN", "MEMBER", "VIEWER" ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "email", "invitedByName", "workspaceRole", "createdAt" ], "additionalProperties": false } } }, "required": [ "members", "invitations" ], "additionalProperties": false } }, "required": [ "status", "data" ], "additionalProperties": false } } } }, "400": { "description": "Error, see Errors and rate limits", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } }, "required": [ "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/linkedin-accounts": { "get": { "operationId": "listLinkedinAccounts", "summary": "List LinkedIn accounts", "description": "List the LinkedIn accounts with their connection state, daily capacity, working hours and generation languages", "tags": [ "LinkedIn accounts" ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "data": { "type": "object", "properties": { "linkedinAccounts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "userId": { "type": "string" }, "status": { "type": "string", "enum": [ "ACTIVE", "DISABLED" ] }, "disabledAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "firstName": { "type": [ "string", "null" ] }, "lastName": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "profilePicture": { "type": [ "string", "null" ] }, "memberId": { "type": [ "string", "null" ] }, "linkedinId": { "type": [ "string", "null" ] }, "publicIdentifier": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ], "minLength": 2, "maxLength": 2 }, "connectionPhase": { "type": "string", "enum": [ "connected", "connecting", "reconnecting", "disconnected" ] }, "premiumType": { "type": "string", "enum": [ "unknown", "salesnav", "recruiter" ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "capacity": { "type": "object", "properties": { "timezone": { "type": "string" }, "workingHoursSummary": { "oneOf": [ { "type": "object", "properties": { "key": { "type": "string", "const": "noSlots" }, "timezone": { "type": "string" } }, "required": [ "key", "timezone" ], "additionalProperties": false }, { "type": "object", "properties": { "key": { "type": "string", "const": "weekdays" }, "from": { "type": "string" }, "timezone": { "type": "string" }, "to": { "type": "string" } }, "required": [ "key", "from", "timezone", "to" ], "additionalProperties": false }, { "type": "object", "properties": { "key": { "type": "string", "const": "everyDay" }, "from": { "type": "string" }, "timezone": { "type": "string" }, "to": { "type": "string" } }, "required": [ "key", "from", "timezone", "to" ], "additionalProperties": false }, { "type": "object", "properties": { "dayCount": { "type": "number", "const": 1 }, "key": { "type": "string", "const": "sharedOneDay" }, "from": { "type": "string" }, "timezone": { "type": "string" }, "to": { "type": "string" } }, "required": [ "dayCount", "key", "from", "timezone", "to" ], "additionalProperties": false }, { "type": "object", "properties": { "dayCount": { "type": "integer", "minimum": 2, "maximum": 6 }, "key": { "type": "string", "const": "sharedDays" }, "from": { "type": "string" }, "timezone": { "type": "string" }, "to": { "type": "string" } }, "required": [ "dayCount", "key", "from", "timezone", "to" ], "additionalProperties": false }, { "type": "object", "properties": { "dayCount": { "type": "number", "const": 1 }, "key": { "type": "string", "const": "customOneDay" }, "timezone": { "type": "string" } }, "required": [ "dayCount", "key", "timezone" ], "additionalProperties": false }, { "type": "object", "properties": { "dayCount": { "type": "integer", "minimum": 2, "maximum": 7 }, "key": { "type": "string", "const": "customDays" }, "timezone": { "type": "string" } }, "required": [ "dayCount", "key", "timezone" ], "additionalProperties": false } ], "discriminator": { "propertyName": "key" } }, "nextAvailableAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "isInsideWindow": { "type": "boolean" }, "isOnCooldown": { "type": "boolean" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "linkedin.refreshLeadState", "linkedin.sendInvite", "linkedin.sendMessage", "linkedin.handleConversationReply" ] }, "dailyLimit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "dailyTarget": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 9007199254740991 }, "cooldownMinMs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "cooldownMaxMs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "usedToday": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remainingToday": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "action", "dailyLimit", "dailyTarget", "cooldownMinMs", "cooldownMaxMs", "usedToday", "remainingToday" ], "additionalProperties": false } }, "activeGates": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "linkedin.refreshLeadState", "linkedin.sendInvite", "linkedin.sendMessage", "linkedin.handleConversationReply" ] }, "blockedReason": { "type": "string" }, "blockedUntil": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "source": { "type": "string", "enum": [ "CAPACITY", "PROVIDER" ] } }, "required": [ "action", "blockedReason", "blockedUntil", "source" ], "additionalProperties": false } } }, "required": [ "timezone", "workingHoursSummary", "nextAvailableAt", "isInsideWindow", "isOnCooldown", "actions", "activeGates" ], "additionalProperties": false }, "workingHours": { "type": "object", "properties": { "days": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "key": { "type": "string", "const": "mon" }, "enabled": { "type": "boolean" }, "slots": { "minItems": 1, "maxItems": 2, "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$" }, "to": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$" } }, "required": [ "from", "to" ], "additionalProperties": false } } }, "required": [ "key", "enabled", "slots" ], "additionalProperties": false }, { "type": "object", "properties": { "key": { "type": "string", "const": "tue" }, "enabled": { "type": "boolean" }, "slots": { "minItems": 1, "maxItems": 2, "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$" }, "to": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$" } }, "required": [ "from", "to" ], "additionalProperties": false } } }, "required": [ "key", "enabled", "slots" ], "additionalProperties": false }, { "type": "object", "properties": { "key": { "type": "string", "const": "wed" }, "enabled": { "type": "boolean" }, "slots": { "minItems": 1, "maxItems": 2, "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$" }, "to": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$" } }, "required": [ "from", "to" ], "additionalProperties": false } } }, "required": [ "key", "enabled", "slots" ], "additionalProperties": false }, { "type": "object", "properties": { "key": { "type": "string", "const": "thu" }, "enabled": { "type": "boolean" }, "slots": { "minItems": 1, "maxItems": 2, "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$" }, "to": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$" } }, "required": [ "from", "to" ], "additionalProperties": false } } }, "required": [ "key", "enabled", "slots" ], "additionalProperties": false }, { "type": "object", "properties": { "key": { "type": "string", "const": "fri" }, "enabled": { "type": "boolean" }, "slots": { "minItems": 1, "maxItems": 2, "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$" }, "to": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$" } }, "required": [ "from", "to" ], "additionalProperties": false } } }, "required": [ "key", "enabled", "slots" ], "additionalProperties": false }, { "type": "object", "properties": { "key": { "type": "string", "const": "sat" }, "enabled": { "type": "boolean" }, "slots": { "minItems": 1, "maxItems": 2, "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$" }, "to": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$" } }, "required": [ "from", "to" ], "additionalProperties": false } } }, "required": [ "key", "enabled", "slots" ], "additionalProperties": false }, { "type": "object", "properties": { "key": { "type": "string", "const": "sun" }, "enabled": { "type": "boolean" }, "slots": { "minItems": 1, "maxItems": 2, "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$" }, "to": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$" } }, "required": [ "from", "to" ], "additionalProperties": false } } }, "required": [ "key", "enabled", "slots" ], "additionalProperties": false } ], "items": { "not": {} } }, "timezone": { "type": "string", "minLength": 1 } }, "required": [ "days", "timezone" ], "additionalProperties": false }, "messageGenerationLanguages": { "type": "object", "properties": { "allowedGenerationLanguages": {}, "effectiveAllowedGenerationLanguages": {}, "workspaceAllowedGenerationLanguages": {} }, "required": [ "allowedGenerationLanguages", "effectiveAllowedGenerationLanguages", "workspaceAllowedGenerationLanguages" ], "additionalProperties": false } }, "required": [ "id", "workspaceId", "userId", "status", "disabledAt", "firstName", "lastName", "email", "profilePicture", "memberId", "linkedinId", "publicIdentifier", "country", "connectionPhase", "premiumType", "createdAt", "updatedAt", "capacity", "workingHours", "messageGenerationLanguages" ], "additionalProperties": false } } }, "required": [ "linkedinAccounts" ], "additionalProperties": false } }, "required": [ "status", "data" ], "additionalProperties": false } } } }, "400": { "description": "Error, see Errors and rate limits", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } }, "required": [ "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/agents": { "get": { "operationId": "listAgents", "summary": "List agents", "description": "List the prospecting agents with their mission, configuration, LinkedIn accounts and memory", "tags": [ "Agents" ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "data": { "type": "object", "properties": { "agents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "linkedinAccountIds": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "memory": { "type": "object", "properties": { "writingRules": { "type": "array", "items": { "type": "string" } }, "companyFacts": { "type": "array", "items": { "type": "string" } }, "offerFacts": { "type": "array", "items": { "type": "string" } } }, "required": [ "writingRules", "companyFacts", "offerFacts" ], "additionalProperties": false }, "companyTargetId": { "type": "string" }, "companyTarget": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "name": { "type": "string" }, "valueProposition": { "type": "string" }, "painPoint": { "type": "string" }, "fitScore": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 100 }, "differentiators": { "type": "array", "items": { "type": "string" } }, "icpJobTitles": { "type": "array", "items": { "type": "string" } }, "icpIndustry": { "type": "array", "items": { "type": "string" } }, "icpCompanySize": { "type": "array", "items": { "type": "string" } }, "icpLocation": { "type": "string" }, "icpYearsOfExperience": { "type": "array", "items": { "type": "string" } }, "icpYearsInCurrentPosition": { "type": "array", "items": { "type": "string" } }, "icpCompanyType": { "type": "array", "items": { "type": "string" } }, "icpGender": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "workspaceId", "name", "valueProposition", "painPoint", "fitScore", "differentiators", "icpJobTitles", "icpIndustry", "icpCompanySize", "icpLocation", "icpYearsOfExperience", "icpYearsInCurrentPosition", "icpCompanyType", "icpGender", "createdAt", "updatedAt" ], "additionalProperties": false }, "conversionAction": { "type": "object", "properties": { "conversionAction": { "type": "string", "enum": [ "BOOK_A_CALL", "LINK_ACTION", "DIRECT_CONTACT", "FREE_TRIAL", "WEBINAR_SIGNUP", "EVENT_SIGNUP", "LEAD_MAGNET", "CASE_STUDY", "SALES_DEMO", "FREE_AUDIT", "WAITLIST", "SEND_COLLATERAL", "SHARE_CONTACT", "GENERIC_LINK", "CUSTOM" ] }, "payload": {}, "summary": { "type": "string", "minLength": 1 } }, "required": [ "conversionAction", "payload" ], "additionalProperties": false }, "autonomyLevel": { "type": "string", "enum": [ "ASSISTED", "SEMI_AUTONOMOUS", "AUTONOMOUS" ] }, "recommendedAutonomyLevel": { "type": "string", "enum": [ "ASSISTED", "SEMI_AUTONOMOUS", "AUTONOMOUS" ] }, "forceHandoffOnFirstDecision": { "type": "boolean" }, "disableLeadExit": { "type": "boolean" }, "linkTrackingEnabled": { "type": "boolean" }, "humanizerEnabled": { "type": "boolean" }, "status": { "type": "string", "enum": [ "ACTIVE", "PAUSED" ] }, "pausedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "workspaceId", "linkedinAccountIds", "name", "memory", "companyTargetId", "companyTarget", "conversionAction", "autonomyLevel", "recommendedAutonomyLevel", "forceHandoffOnFirstDecision", "disableLeadExit", "linkTrackingEnabled", "humanizerEnabled", "status", "pausedAt", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "required": [ "agents" ], "additionalProperties": false } }, "required": [ "status", "data" ], "additionalProperties": false } } } }, "400": { "description": "Error, see Errors and rate limits", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } }, "required": [ "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/agents/{id}": { "get": { "operationId": "getAgent", "summary": "Get an agent", "description": "Get a prospecting agent", "tags": [ "Agents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "GET /v1/agents/:id Parameter", "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "linkedinAccountIds": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "memory": { "type": "object", "properties": { "writingRules": { "type": "array", "items": { "type": "string" } }, "companyFacts": { "type": "array", "items": { "type": "string" } }, "offerFacts": { "type": "array", "items": { "type": "string" } } }, "required": [ "writingRules", "companyFacts", "offerFacts" ], "additionalProperties": false }, "companyTargetId": { "type": "string" }, "companyTarget": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "name": { "type": "string" }, "valueProposition": { "type": "string" }, "painPoint": { "type": "string" }, "fitScore": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 100 }, "differentiators": { "type": "array", "items": { "type": "string" } }, "icpJobTitles": { "type": "array", "items": { "type": "string" } }, "icpIndustry": { "type": "array", "items": { "type": "string" } }, "icpCompanySize": { "type": "array", "items": { "type": "string" } }, "icpLocation": { "type": "string" }, "icpYearsOfExperience": { "type": "array", "items": { "type": "string" } }, "icpYearsInCurrentPosition": { "type": "array", "items": { "type": "string" } }, "icpCompanyType": { "type": "array", "items": { "type": "string" } }, "icpGender": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "workspaceId", "name", "valueProposition", "painPoint", "fitScore", "differentiators", "icpJobTitles", "icpIndustry", "icpCompanySize", "icpLocation", "icpYearsOfExperience", "icpYearsInCurrentPosition", "icpCompanyType", "icpGender", "createdAt", "updatedAt" ], "additionalProperties": false }, "conversionAction": { "type": "object", "properties": { "conversionAction": { "type": "string", "enum": [ "BOOK_A_CALL", "LINK_ACTION", "DIRECT_CONTACT", "FREE_TRIAL", "WEBINAR_SIGNUP", "EVENT_SIGNUP", "LEAD_MAGNET", "CASE_STUDY", "SALES_DEMO", "FREE_AUDIT", "WAITLIST", "SEND_COLLATERAL", "SHARE_CONTACT", "GENERIC_LINK", "CUSTOM" ] }, "payload": {}, "summary": { "type": "string", "minLength": 1 } }, "required": [ "conversionAction", "payload" ], "additionalProperties": false }, "autonomyLevel": { "type": "string", "enum": [ "ASSISTED", "SEMI_AUTONOMOUS", "AUTONOMOUS" ] }, "recommendedAutonomyLevel": { "type": "string", "enum": [ "ASSISTED", "SEMI_AUTONOMOUS", "AUTONOMOUS" ] }, "forceHandoffOnFirstDecision": { "type": "boolean" }, "disableLeadExit": { "type": "boolean" }, "linkTrackingEnabled": { "type": "boolean" }, "humanizerEnabled": { "type": "boolean" }, "status": { "type": "string", "enum": [ "ACTIVE", "PAUSED" ] }, "pausedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "workspaceId", "linkedinAccountIds", "name", "memory", "companyTargetId", "companyTarget", "conversionAction", "autonomyLevel", "recommendedAutonomyLevel", "forceHandoffOnFirstDecision", "disableLeadExit", "linkTrackingEnabled", "humanizerEnabled", "status", "pausedAt", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "status", "data" ], "additionalProperties": false } } } }, "400": { "description": "Error, see Errors and rate limits", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } }, "required": [ "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/agents/{id}/activity": { "get": { "operationId": "getAgentActivity", "summary": "Get agent activity", "description": "Get the recent activity of a prospecting agent", "tags": [ "Agents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "GET /v1/agents/:id/activity Parameter", "schema": { "type": "string", "minLength": 1 } }, { "name": "limit", "in": "query", "required": false, "description": "GET /v1/agents/:id/activity Parameter", "schema": { "default": 10, "type": "integer", "exclusiveMinimum": 0, "maximum": 50 } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "data": { "type": "object", "properties": { "timeline": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "action": { "type": "string", "enum": [ "sourced", "dataRefreshed", "inviteSent", "message1Sent", "message2Sent", "message3Sent", "sequenceToValidate", "messageSent", "messageToValidate", "waitingForInfo", "statusInterested", "statusNotInterested", "statusNeverReplied" ] }, "occurredAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "lead": { "type": "object", "properties": { "id": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": [ "string", "null" ] }, "headline": { "type": "string" }, "profilePicture": { "type": [ "string", "null" ] }, "companyName": { "type": [ "string", "null" ] } }, "required": [ "id", "firstName", "lastName", "headline", "profilePicture", "companyName" ], "additionalProperties": false } }, "required": [ "id", "action", "occurredAt", "lead" ], "additionalProperties": false } }, "isSourcing": { "type": "boolean" }, "lastActivityAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "refreshedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "runningEnrollments": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sourced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "interested": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "timeline", "isSourcing", "lastActivityAt", "refreshedAt", "runningEnrollments", "sourced", "interested" ], "additionalProperties": false } }, "required": [ "status", "data" ], "additionalProperties": false } } } }, "400": { "description": "Error, see Errors and rate limits", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } }, "required": [ "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/leads/list": { "post": { "operationId": "listLeads", "summary": "List leads", "description": "Search, filter, sort and paginate the leads (read-only, POST for the filter body)", "tags": [ "Leads" ], "requestBody": { "description": "POST /v1/leads/list Request body", "content": { "application/json": { "schema": { "type": "object", "properties": { "agentIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "linkedinAccountIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "searchFilterId": { "type": "string", "minLength": 1 }, "flowId": { "type": "string", "minLength": 1 }, "currentStepId": { "type": "string", "minLength": 1 }, "q": { "type": "string" }, "assigned": { "type": "string", "enum": [ "assigned", "unassigned", "any" ] }, "relationshipStatus": { "type": "string", "enum": [ "ACTIVE_ASSIGNMENT", "PAST_ASSIGNMENT", "ACCOUNT_STATE_ONLY", "UNASSIGNED" ] }, "handlingFilters": { "type": "array", "items": { "type": "string", "enum": [ "automationActive", "automationEnded" ] } }, "outreachStatuses": { "type": "array", "items": { "type": "string", "enum": [ "sourced", "inviteSent", "inviteAccepted", "messaged", "neverReplied", "hasReplied", "interested", "notInterested" ] } }, "blacklisted": { "type": "boolean" }, "page": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 200 }, "sortBy": { "type": "string", "enum": [ "createdAt", "updatedAt", "name", "company" ] }, "sortDirection": { "type": "string", "enum": [ "asc", "desc" ] } }, "additionalProperties": false } } } }, "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "data": { "type": "object", "properties": { "leads": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "agentId": { "type": [ "string", "null" ] }, "agent": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "activeAssignment": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "agentId": { "type": "string" }, "leadId": { "type": "string" }, "linkedinAccountId": { "type": "string" }, "status": { "type": "string", "enum": [ "ACTIVE", "INACTIVE" ] }, "source": { "type": "string", "enum": [ "SEARCH", "MANUAL", "AUTO" ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "agentId", "leadId", "linkedinAccountId", "status", "source", "createdAt", "updatedAt" ], "additionalProperties": false }, "assignedLinkedinAccount": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "userId": { "type": "string" }, "firstName": { "type": [ "string", "null" ] }, "lastName": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "profilePicture": { "type": [ "string", "null" ] } }, "required": [ "id", "userId", "firstName", "lastName", "email", "profilePicture" ], "additionalProperties": false }, "relationshipStatus": { "type": "string", "enum": [ "ACTIVE_ASSIGNMENT", "PAST_ASSIGNMENT", "ACCOUNT_STATE_ONLY", "UNASSIGNED" ] }, "accountState": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "leadId": { "type": "string" }, "linkedinAccountId": { "type": "string" }, "inviteAcceptedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "canMessage": { "type": [ "boolean", "null" ] }, "conversationId": { "type": [ "string", "null" ] }, "conversationOpenedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "lastCheckedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "leadId", "linkedinAccountId", "inviteAcceptedAt", "canMessage", "conversationId", "conversationOpenedAt", "lastCheckedAt", "createdAt", "updatedAt" ], "additionalProperties": false }, "outreachStatus": { "type": "string", "enum": [ "sourced", "inviteSent", "inviteAccepted", "messaged", "neverReplied", "hasReplied", "interested", "notInterested" ] }, "memberId": { "type": [ "string", "null" ] }, "publicIdentifier": { "type": [ "string", "null" ] }, "linkedinId": { "type": [ "integer", "null" ], "minimum": -9007199254740991, "maximum": 9007199254740991 }, "firstName": { "type": "string" }, "lastName": { "type": [ "string", "null" ] }, "headline": { "type": "string" }, "profileUrl": { "type": "string" }, "profilePicture": { "type": [ "string", "null" ] }, "region": { "type": [ "string", "null" ] }, "companyName": { "type": [ "string", "null" ] }, "companyLinkedinUrl": { "type": [ "string", "null" ] }, "companyWebsite": { "type": [ "string", "null" ] }, "premium": { "type": "boolean" }, "influencer": { "type": "boolean" }, "blacklistedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "exitReason": { "type": [ "object", "null" ], "properties": { "category": { "type": "string", "enum": [ "competitor", "wrong_job_title", "wrong_company", "other", "existing_conversation" ] }, "reason": { "type": "string", "minLength": 1 } }, "required": [ "category", "reason" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "workspaceId", "agentId", "agent", "activeAssignment", "assignedLinkedinAccount", "relationshipStatus", "accountState", "outreachStatus", "memberId", "publicIdentifier", "linkedinId", "firstName", "lastName", "headline", "profileUrl", "profilePicture", "region", "companyName", "companyLinkedinUrl", "companyWebsite", "premium", "influencer", "blacklistedAt", "exitReason", "createdAt", "updatedAt" ], "additionalProperties": false } }, "totalCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "page": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "hasNextPage": { "type": "boolean" } }, "required": [ "leads", "totalCount", "page", "limit", "hasNextPage" ], "additionalProperties": false } }, "required": [ "status", "data" ], "additionalProperties": false } } } }, "400": { "description": "Error, see Errors and rate limits", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } }, "required": [ "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/leads/outreach-status-counts": { "post": { "operationId": "countLeadsByOutreachStatus", "summary": "Count leads by outreach status", "description": "Count the leads by outreach status (read-only, POST for the filter body)", "tags": [ "Leads" ], "requestBody": { "description": "POST /v1/leads/outreach-status-counts Request body", "content": { "application/json": { "schema": { "type": "object", "properties": { "agentIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "linkedinAccountIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "searchFilterId": { "type": "string", "minLength": 1 }, "flowId": { "type": "string", "minLength": 1 }, "currentStepId": { "type": "string", "minLength": 1 }, "q": { "type": "string" }, "assigned": { "type": "string", "enum": [ "assigned", "unassigned", "any" ] }, "relationshipStatus": { "type": "string", "enum": [ "ACTIVE_ASSIGNMENT", "PAST_ASSIGNMENT", "ACCOUNT_STATE_ONLY", "UNASSIGNED" ] }, "handlingFilters": { "type": "array", "items": { "type": "string", "enum": [ "automationActive", "automationEnded" ] } }, "blacklisted": { "type": "boolean" } }, "additionalProperties": false } } } }, "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "data": { "type": "object", "propertyNames": { "type": "string", "enum": [ "sourced", "inviteSent", "inviteAccepted", "messaged", "neverReplied", "hasReplied", "interested", "notInterested" ] }, "additionalProperties": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "required": [ "sourced", "inviteSent", "inviteAccepted", "messaged", "neverReplied", "hasReplied", "interested", "notInterested" ] } }, "required": [ "status", "data" ], "additionalProperties": false } } } }, "400": { "description": "Error, see Errors and rate limits", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } }, "required": [ "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/leads/{id}": { "get": { "operationId": "getLead", "summary": "Get a lead", "description": "Get a lead", "tags": [ "Leads" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "GET /v1/leads/:id Parameter", "schema": { "type": "string", "minLength": 1 } }, { "name": "linkedinAccountId", "in": "query", "required": false, "description": "GET /v1/leads/:id Parameter", "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "data": { "type": "object", "properties": { "lead": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "agentId": { "type": [ "string", "null" ] }, "agent": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "activeAssignment": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "agentId": { "type": "string" }, "leadId": { "type": "string" }, "linkedinAccountId": { "type": "string" }, "status": { "type": "string", "enum": [ "ACTIVE", "INACTIVE" ] }, "source": { "type": "string", "enum": [ "SEARCH", "MANUAL", "AUTO" ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "agentId", "leadId", "linkedinAccountId", "status", "source", "createdAt", "updatedAt" ], "additionalProperties": false }, "assignedLinkedinAccount": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "userId": { "type": "string" }, "firstName": { "type": [ "string", "null" ] }, "lastName": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "profilePicture": { "type": [ "string", "null" ] } }, "required": [ "id", "userId", "firstName", "lastName", "email", "profilePicture" ], "additionalProperties": false }, "relationshipStatus": { "type": "string", "enum": [ "ACTIVE_ASSIGNMENT", "PAST_ASSIGNMENT", "ACCOUNT_STATE_ONLY", "UNASSIGNED" ] }, "accountState": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "leadId": { "type": "string" }, "linkedinAccountId": { "type": "string" }, "inviteAcceptedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "canMessage": { "type": [ "boolean", "null" ] }, "conversationId": { "type": [ "string", "null" ] }, "conversationOpenedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "lastCheckedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "leadId", "linkedinAccountId", "inviteAcceptedAt", "canMessage", "conversationId", "conversationOpenedAt", "lastCheckedAt", "createdAt", "updatedAt" ], "additionalProperties": false }, "outreachStatus": { "type": "string", "enum": [ "sourced", "inviteSent", "inviteAccepted", "messaged", "neverReplied", "hasReplied", "interested", "notInterested" ] }, "memberId": { "type": [ "string", "null" ] }, "publicIdentifier": { "type": [ "string", "null" ] }, "linkedinId": { "type": [ "integer", "null" ], "minimum": -9007199254740991, "maximum": 9007199254740991 }, "firstName": { "type": "string" }, "lastName": { "type": [ "string", "null" ] }, "headline": { "type": "string" }, "profileUrl": { "type": "string" }, "profilePicture": { "type": [ "string", "null" ] }, "region": { "type": [ "string", "null" ] }, "companyName": { "type": [ "string", "null" ] }, "companyLinkedinUrl": { "type": [ "string", "null" ] }, "companyWebsite": { "type": [ "string", "null" ] }, "premium": { "type": "boolean" }, "influencer": { "type": "boolean" }, "blacklistedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "exitReason": { "type": [ "object", "null" ], "properties": { "category": { "type": "string", "enum": [ "competitor", "wrong_job_title", "wrong_company", "other", "existing_conversation" ] }, "reason": { "type": "string", "minLength": 1 } }, "required": [ "category", "reason" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "assignments": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "agentId": { "type": "string" }, "leadId": { "type": "string" }, "linkedinAccountId": { "type": "string" }, "status": { "type": "string", "enum": [ "ACTIVE", "INACTIVE" ] }, "source": { "type": "string", "enum": [ "SEARCH", "MANUAL", "AUTO" ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "agentId", "leadId", "linkedinAccountId", "status", "source", "createdAt", "updatedAt" ], "additionalProperties": false } }, "linkedinStates": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "leadId": { "type": "string" }, "linkedinAccountId": { "type": "string" }, "inviteAcceptedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "canMessage": { "type": [ "boolean", "null" ] }, "conversationId": { "type": [ "string", "null" ] }, "conversationOpenedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "lastCheckedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "leadId", "linkedinAccountId", "inviteAcceptedAt", "canMessage", "conversationId", "conversationOpenedAt", "lastCheckedAt", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "required": [ "id", "workspaceId", "agentId", "agent", "activeAssignment", "assignedLinkedinAccount", "relationshipStatus", "accountState", "outreachStatus", "memberId", "publicIdentifier", "linkedinId", "firstName", "lastName", "headline", "profileUrl", "profilePicture", "region", "companyName", "companyLinkedinUrl", "companyWebsite", "premium", "influencer", "blacklistedAt", "exitReason", "createdAt", "updatedAt", "assignments", "linkedinStates" ], "additionalProperties": false } }, "required": [ "lead" ], "additionalProperties": false } }, "required": [ "status", "data" ], "additionalProperties": false } } } }, "400": { "description": "Error, see Errors and rate limits", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } }, "required": [ "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/leads/{id}/activity": { "get": { "operationId": "getLeadActivity", "summary": "Get lead activity", "description": "Get the activity timeline of a lead", "tags": [ "Leads" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "GET /v1/leads/:id/activity Parameter", "schema": { "type": "string", "minLength": 1 } }, { "name": "limit", "in": "query", "required": false, "description": "GET /v1/leads/:id/activity Parameter", "schema": { "type": "integer", "exclusiveMinimum": 0, "maximum": 200 } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "data": { "type": "object", "properties": { "timeline": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "sourced", "assigned", "flowStepExecution", "flowEvent", "linkClick", "enrollmentTerminal", "blacklisted" ] }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "terminalReason": { "type": [ "string", "null" ] }, "manualOutcome": { "type": [ "string", "null" ], "enum": [ "interested", "notInterested" ] }, "occurredAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "linkedinAccount": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "firstName": { "type": [ "string", "null" ] }, "lastName": { "type": [ "string", "null" ] }, "profilePicture": { "type": [ "string", "null" ] } }, "required": [ "id", "firstName", "lastName", "profilePicture" ], "additionalProperties": false }, "agent": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "exitReason": { "type": [ "object", "null" ], "properties": { "category": { "type": "string", "enum": [ "competitor", "wrong_job_title", "wrong_company", "other", "existing_conversation" ] }, "reason": { "type": "string", "minLength": 1 } }, "required": [ "category", "reason" ], "additionalProperties": false } }, "required": [ "id", "type", "title", "description", "status", "terminalReason", "manualOutcome", "occurredAt", "linkedinAccount", "agent", "exitReason" ], "additionalProperties": false } } }, "required": [ "timeline" ], "additionalProperties": false } }, "required": [ "status", "data" ], "additionalProperties": false } } } }, "400": { "description": "Error, see Errors and rate limits", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } }, "required": [ "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/inbox/conversations": { "get": { "operationId": "listInboxConversations", "summary": "List conversations", "description": "List the inbox conversations, with filters and a cursor", "tags": [ "Inbox" ], "parameters": [ { "name": "agentId", "in": "query", "required": false, "description": "GET /v1/inbox/conversations Parameter", "schema": { "type": "string", "minLength": 1 } }, { "name": "linkedinAccountId", "in": "query", "required": false, "description": "GET /v1/inbox/conversations Parameter", "schema": { "type": "string", "minLength": 1 } }, { "name": "q", "in": "query", "required": false, "description": "GET /v1/inbox/conversations Parameter", "schema": { "type": "string", "minLength": 1 } }, { "name": "scope", "in": "query", "required": true, "description": "GET /v1/inbox/conversations Parameter", "schema": { "type": "string", "enum": [ "todo", "all" ] } }, { "name": "filter", "in": "query", "required": false, "description": "GET /v1/inbox/conversations Parameter", "schema": { "type": "string", "enum": [ "toValidate", "coldSequenceToValidate", "replyToValidate", "missingInformation", "interested", "notInterested", "noReply", "ongoing" ] } }, { "name": "cursor", "in": "query", "required": false, "description": "GET /v1/inbox/conversations Parameter", "schema": { "type": "string", "minLength": 1 } }, { "name": "limit", "in": "query", "required": false, "description": "GET /v1/inbox/conversations Parameter", "schema": { "default": 25, "type": "integer", "exclusiveMinimum": 0, "maximum": 200 } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "data": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "enrollmentId": { "type": "string" }, "conversationId": { "type": [ "string", "null" ] }, "conversationOpenedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "status": { "type": "string", "enum": [ "ACTIVE", "WAITING", "COMPLETED", "FAILED", "CANCELLED" ] }, "tag": { "type": "string", "enum": [ "coldSequenceToValidate", "coldSequenceWaitingForSlot", "replyToValidate", "missingInformation", "interested", "notInterested", "noReply", "ongoing" ] }, "selectedOutcome": { "type": [ "string", "null" ], "enum": [ "interested", "notInterested" ] }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "agentNextAction": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "preparingReply" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "waitingForReply" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "followUpPlanned" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "monitoringConnectionRequest" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "monitoringConversation" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "needsInput" } }, "required": [ "kind" ], "additionalProperties": false } ], "discriminator": { "propertyName": "kind" } }, "pendingHandoff": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "note": { "type": "string" }, "category": { "default": "", "type": "string" } }, "required": [ "id", "note", "category" ], "additionalProperties": false }, "pendingValidation": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "message", "coldSequence" ] }, "preview": { "type": "string" }, "generating": { "default": false, "type": "boolean" }, "regenerating": { "default": false, "type": "boolean" } }, "required": [ "id", "kind", "preview", "generating", "regenerating" ], "additionalProperties": false }, "coldOpenerPreview": { "type": [ "string", "null" ] }, "lastMessagePreview": { "type": [ "string", "null" ] }, "lead": { "type": "object", "properties": { "id": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": [ "string", "null" ] }, "headline": { "type": "string" }, "companyName": { "type": [ "string", "null" ] }, "profilePicture": { "type": [ "string", "null" ] } }, "required": [ "id", "firstName", "lastName", "headline", "companyName", "profilePicture" ], "additionalProperties": false }, "agent": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "linkedinAccount": { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "type": "string" }, "firstName": { "type": [ "string", "null" ] }, "lastName": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "profilePicture": { "type": [ "string", "null" ] }, "memberId": { "type": [ "string", "null" ] } }, "required": [ "id", "userId", "firstName", "lastName", "email", "profilePicture", "memberId" ], "additionalProperties": false } }, "required": [ "enrollmentId", "conversationId", "conversationOpenedAt", "status", "tag", "selectedOutcome", "updatedAt", "agentNextAction", "pendingHandoff", "pendingValidation", "coldOpenerPreview", "lastMessagePreview", "lead", "agent", "linkedinAccount" ], "additionalProperties": false } }, "nextCursor": { "type": [ "string", "null" ] } }, "required": [ "items", "nextCursor" ], "additionalProperties": false } }, "required": [ "status", "data" ], "additionalProperties": false } } } }, "400": { "description": "Error, see Errors and rate limits", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } }, "required": [ "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/inbox/conversations/counts": { "get": { "operationId": "countInboxConversations", "summary": "Count conversations", "description": "Count the inbox conversations by state", "tags": [ "Inbox" ], "parameters": [ { "name": "agentId", "in": "query", "required": false, "description": "GET /v1/inbox/conversations/counts Parameter", "schema": { "type": "string", "minLength": 1 } }, { "name": "linkedinAccountId", "in": "query", "required": false, "description": "GET /v1/inbox/conversations/counts Parameter", "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "data": { "type": "object", "properties": { "todo": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "toValidate": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "coldSequenceToValidate": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "coldSequenceBeingWritten": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "coldSequenceWaitingForSlot": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyToValidate": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyBeingWritten": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "missingInformation": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "total", "toValidate", "coldSequenceToValidate", "coldSequenceBeingWritten", "coldSequenceWaitingForSlot", "replyToValidate", "replyBeingWritten", "missingInformation" ], "additionalProperties": false }, "all": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "interested": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "notInterested": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "noReply": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "ongoing": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "total", "interested", "notInterested", "noReply", "ongoing" ], "additionalProperties": false } }, "required": [ "todo", "all" ], "additionalProperties": false } }, "required": [ "status", "data" ], "additionalProperties": false } } } }, "400": { "description": "Error, see Errors and rate limits", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } }, "required": [ "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/linkedin-accounts/{id}/inbox/leads/{leadId}/messages": { "get": { "operationId": "listConversationMessages", "summary": "List conversation messages", "description": "Read the messages of a conversation between a LinkedIn account and a lead", "tags": [ "Inbox" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "GET /v1/linkedin-accounts/:id/inbox/leads/:leadId/messages Parameter", "schema": { "type": "string", "minLength": 1 } }, { "name": "leadId", "in": "path", "required": true, "description": "GET /v1/linkedin-accounts/:id/inbox/leads/:leadId/messages Parameter", "schema": { "type": "string", "minLength": 1 } }, { "name": "before", "in": "query", "required": false, "description": "GET /v1/linkedin-accounts/:id/inbox/leads/:leadId/messages Parameter", "schema": { "type": "number" } }, { "name": "cursor", "in": "query", "required": false, "description": "GET /v1/linkedin-accounts/:id/inbox/leads/:leadId/messages Parameter", "schema": { "type": "string" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "data": { "type": "object", "properties": { "conversationId": { "type": "string" }, "messages": { "type": "array", "items": { "type": "object", "properties": { "entityUrn": { "type": "string" }, "createdAt": { "type": "number" }, "text": { "type": "string" }, "senderMemberId": { "type": "string" }, "subType": { "type": "string" }, "from": { "anyOf": [ { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": [ "string", "null" ] }, "headline": { "type": [ "string", "null" ] }, "occupation": { "type": [ "string", "null" ] }, "profilePicture": { "type": "string" }, "memberId": { "type": "string" }, "linkedinUrl": { "type": "string" } }, "required": [ "firstName", "lastName", "memberId" ], "additionalProperties": false }, { "type": "string" } ] }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "byteSize": { "type": "string" }, "mediaType": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" } }, "required": [ "id", "mediaType", "name" ], "additionalProperties": false } }, "audioAttachments": { "type": "array", "items": { "type": "object", "properties": { "audioMetadata": { "type": "object", "properties": { "duration": { "type": "number" }, "url": { "type": "string" } }, "required": [ "duration", "url" ], "additionalProperties": false } }, "required": [ "audioMetadata" ], "additionalProperties": false } }, "gif": { "type": "object", "properties": { "id": { "type": "string" }, "gif": { "type": "object", "properties": { "height": { "type": "number" }, "width": { "type": "number" }, "url": { "type": "string" } }, "required": [ "height", "width", "url" ], "additionalProperties": false }, "previewGif": { "type": "object", "properties": { "height": { "type": "number" }, "width": { "type": "number" }, "url": { "type": "string" } }, "required": [ "height", "width", "url" ], "additionalProperties": false }, "title": { "type": "string" } }, "required": [ "id", "gif" ], "additionalProperties": false }, "videos": { "type": "array", "items": { "type": "object", "properties": { "entityUrn": { "type": "string" }, "media": { "type": "string" }, "progressiveStreams": { "type": "array", "items": { "type": "object", "properties": { "streamingLocations": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ], "additionalProperties": false } } }, "required": [ "streamingLocations" ], "additionalProperties": false } } }, "required": [ "entityUrn", "media", "progressiveStreams" ], "additionalProperties": false } }, "pictureUrl": { "type": "string" }, "sharingPostUrn": { "type": "string" }, "origin": { "type": "string", "enum": [ "agent", "agentEdited", "manual" ] } }, "required": [ "entityUrn", "createdAt", "senderMemberId", "subType", "from", "attachments", "audioAttachments" ], "additionalProperties": false } }, "inviteAcceptedAt": { "type": [ "number", "null" ] }, "linkClicks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "occurredAt": { "type": "number" }, "destination": { "type": "string" } }, "required": [ "id", "occurredAt", "destination" ], "additionalProperties": false } }, "nextBefore": { "type": [ "number", "null" ] }, "nextCursor": { "type": [ "string", "null" ] } }, "required": [ "conversationId", "messages", "inviteAcceptedAt", "linkClicks", "nextBefore" ], "additionalProperties": false } }, "required": [ "status", "data" ], "additionalProperties": false } } } }, "400": { "description": "Error, see Errors and rate limits", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } }, "required": [ "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/linkedin-accounts/{id}/inbox/leads/{leadId}/messages/{messageId}/attachments/{attachmentId}": { "get": { "operationId": "getConversationMessageAttachment", "summary": "Download a message attachment", "description": "Download a message attachment, base64-encoded", "tags": [ "Inbox" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "GET /v1/linkedin-accounts/:id/inbox/leads/:leadId/messages/:messageId/attachments/:attachmentId Parameter", "schema": { "type": "string", "minLength": 1 } }, { "name": "leadId", "in": "path", "required": true, "description": "GET /v1/linkedin-accounts/:id/inbox/leads/:leadId/messages/:messageId/attachments/:attachmentId Parameter", "schema": { "type": "string", "minLength": 1 } }, { "name": "messageId", "in": "path", "required": true, "description": "GET /v1/linkedin-accounts/:id/inbox/leads/:leadId/messages/:messageId/attachments/:attachmentId Parameter", "schema": { "type": "string", "minLength": 1 } }, { "name": "attachmentId", "in": "path", "required": true, "description": "GET /v1/linkedin-accounts/:id/inbox/leads/:leadId/messages/:messageId/attachments/:attachmentId Parameter", "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "data": { "type": "object", "properties": { "dataBase64": { "type": "string", "minLength": 1 }, "mediaType": { "type": "string", "minLength": 1 } }, "required": [ "dataBase64", "mediaType" ], "additionalProperties": false } }, "required": [ "status", "data" ], "additionalProperties": false } } } }, "400": { "description": "Error, see Errors and rate limits", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } }, "required": [ "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/message-validations": { "get": { "operationId": "listValidations", "summary": "List validations", "description": "List the messages and cold sequences waiting for validation", "tags": [ "Validations" ], "parameters": [ { "name": "status", "in": "query", "required": false, "description": "GET /v1/message-validations Parameter", "schema": { "type": "string", "enum": [ "PENDING", "APPROVED", "REJECTED", "CANCELLED", "SENT" ] } }, { "name": "agentId", "in": "query", "required": false, "description": "GET /v1/message-validations Parameter", "schema": { "type": "string", "minLength": 1 } }, { "name": "linkedinAccountId", "in": "query", "required": false, "description": "GET /v1/message-validations Parameter", "schema": { "type": "string", "minLength": 1 } }, { "name": "q", "in": "query", "required": false, "description": "GET /v1/message-validations Parameter", "schema": { "type": "string", "minLength": 1 } }, { "name": "validationItemType", "in": "query", "required": false, "description": "GET /v1/message-validations Parameter", "schema": { "type": "string", "enum": [ "coldSequence", "conversationReply" ] } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "data": { "type": "object", "properties": { "items": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "message" }, "request": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "flowId": { "type": "string" }, "flowEnrollmentId": { "type": "string" }, "stepId": { "type": "string" }, "leadId": { "type": "string" }, "linkedinAccountId": { "type": "string" }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "draftMessage": { "type": "string" }, "inputSnapshot": {}, "metadata": {}, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "status": { "type": "string", "const": "PENDING" }, "approvedMessage": { "type": "null" }, "reviewedAt": { "type": "null" }, "sentAt": { "type": "null" }, "rejectionReason": { "type": "null" } }, "required": [ "id", "workspaceId", "flowId", "flowEnrollmentId", "stepId", "leadId", "linkedinAccountId", "revision", "draftMessage", "inputSnapshot", "metadata", "createdAt", "updatedAt", "status", "approvedMessage", "reviewedAt", "sentAt", "rejectionReason" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "flowId": { "type": "string" }, "flowEnrollmentId": { "type": "string" }, "stepId": { "type": "string" }, "leadId": { "type": "string" }, "linkedinAccountId": { "type": "string" }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "draftMessage": { "type": "string" }, "inputSnapshot": {}, "metadata": {}, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "status": { "type": "string", "const": "APPROVED" }, "approvedMessage": { "type": "string" }, "reviewedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "sentAt": { "type": "null" }, "rejectionReason": { "type": "null" } }, "required": [ "id", "workspaceId", "flowId", "flowEnrollmentId", "stepId", "leadId", "linkedinAccountId", "revision", "draftMessage", "inputSnapshot", "metadata", "createdAt", "updatedAt", "status", "approvedMessage", "reviewedAt", "sentAt", "rejectionReason" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "flowId": { "type": "string" }, "flowEnrollmentId": { "type": "string" }, "stepId": { "type": "string" }, "leadId": { "type": "string" }, "linkedinAccountId": { "type": "string" }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "draftMessage": { "type": "string" }, "inputSnapshot": {}, "metadata": {}, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "status": { "type": "string", "const": "SENT" }, "approvedMessage": { "type": "string" }, "reviewedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "sentAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "rejectionReason": { "type": "null" } }, "required": [ "id", "workspaceId", "flowId", "flowEnrollmentId", "stepId", "leadId", "linkedinAccountId", "revision", "draftMessage", "inputSnapshot", "metadata", "createdAt", "updatedAt", "status", "approvedMessage", "reviewedAt", "sentAt", "rejectionReason" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "flowId": { "type": "string" }, "flowEnrollmentId": { "type": "string" }, "stepId": { "type": "string" }, "leadId": { "type": "string" }, "linkedinAccountId": { "type": "string" }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "draftMessage": { "type": "string" }, "inputSnapshot": {}, "metadata": {}, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "status": { "type": "string", "const": "REJECTED" }, "approvedMessage": { "type": "null" }, "reviewedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "sentAt": { "type": "null" }, "rejectionReason": { "type": [ "string", "null" ] } }, "required": [ "id", "workspaceId", "flowId", "flowEnrollmentId", "stepId", "leadId", "linkedinAccountId", "revision", "draftMessage", "inputSnapshot", "metadata", "createdAt", "updatedAt", "status", "approvedMessage", "reviewedAt", "sentAt", "rejectionReason" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "flowId": { "type": "string" }, "flowEnrollmentId": { "type": "string" }, "stepId": { "type": "string" }, "leadId": { "type": "string" }, "linkedinAccountId": { "type": "string" }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "draftMessage": { "type": "string" }, "inputSnapshot": {}, "metadata": {}, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "status": { "type": "string", "const": "CANCELLED" }, "approvedMessage": { "type": [ "string", "null" ] }, "reviewedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "sentAt": { "type": "null" }, "rejectionReason": { "type": "string" } }, "required": [ "id", "workspaceId", "flowId", "flowEnrollmentId", "stepId", "leadId", "linkedinAccountId", "revision", "draftMessage", "inputSnapshot", "metadata", "createdAt", "updatedAt", "status", "approvedMessage", "reviewedAt", "sentAt", "rejectionReason" ], "additionalProperties": false } ], "discriminator": { "propertyName": "status" } }, "agent": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "enrollmentStatus": { "type": "string", "enum": [ "ACTIVE", "WAITING", "COMPLETED", "FAILED", "CANCELLED" ] }, "selectedOutcome": { "type": [ "string", "null" ], "enum": [ "interested", "notInterested" ] } }, "required": [ "kind", "request", "agent", "enrollmentStatus", "selectedOutcome" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "coldSequence" }, "request": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "flowId": { "type": "string" }, "flowEnrollmentId": { "type": "string" }, "leadId": { "type": "string" }, "linkedinAccountId": { "type": "string" }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "coldOpener": { "type": "string" }, "coldOpenerHumanizer": { "type": [ "object", "null" ], "properties": { "variant": { "type": "string", "enum": [ "control", "greeting_split", "last_sentence_split", "full_split" ] }, "parts": { "minItems": 1, "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "lowercaseApplied": { "type": "boolean" }, "sentAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "text", "lowercaseApplied", "sentAt" ], "additionalProperties": false } } }, "required": [ "variant", "parts" ], "additionalProperties": false }, "coldFollowUp": { "type": "string" }, "coldBreakUp": { "type": "string" }, "status": { "type": "string", "enum": [ "GENERATING", "PENDING", "APPROVED", "REJECTED", "CANCELLED" ] }, "reviewedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "rejectionReason": { "type": [ "string", "null" ] }, "inputSnapshot": {}, "metadata": {}, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "workspaceId", "flowId", "flowEnrollmentId", "leadId", "linkedinAccountId", "revision", "coldOpener", "coldOpenerHumanizer", "coldFollowUp", "coldBreakUp", "status", "reviewedAt", "rejectionReason", "inputSnapshot", "metadata", "createdAt", "updatedAt" ], "additionalProperties": false }, "sentMessageKeys": { "type": "array", "items": { "type": "string", "enum": [ "coldOpener", "coldFollowUp", "coldBreakUp" ] } }, "agent": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "enrollmentStatus": { "type": "string", "enum": [ "ACTIVE", "WAITING", "COMPLETED", "FAILED", "CANCELLED" ] }, "selectedOutcome": { "type": [ "string", "null" ], "enum": [ "interested", "notInterested" ] } }, "required": [ "kind", "request", "sentMessageKeys", "agent", "enrollmentStatus", "selectedOutcome" ], "additionalProperties": false } ], "discriminator": { "propertyName": "kind" } } }, "totalPendingCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "items", "totalPendingCount" ], "additionalProperties": false } }, "required": [ "status", "data" ], "additionalProperties": false } } } }, "400": { "description": "Error, see Errors and rate limits", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } }, "required": [ "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/message-validations/{id}": { "get": { "operationId": "getValidation", "summary": "Get a validation", "description": "Get a message or cold sequence waiting for validation", "tags": [ "Validations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "GET /v1/message-validations/:id Parameter", "schema": { "type": "string", "minLength": 1 } }, { "name": "kind", "in": "query", "required": true, "description": "GET /v1/message-validations/:id Parameter", "schema": { "type": "string", "enum": [ "message", "coldSequence" ] } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "data": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "message" }, "request": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "flowId": { "type": "string" }, "flowEnrollmentId": { "type": "string" }, "stepId": { "type": "string" }, "leadId": { "type": "string" }, "linkedinAccountId": { "type": "string" }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "draftMessage": { "type": "string" }, "inputSnapshot": {}, "metadata": {}, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "status": { "type": "string", "const": "PENDING" }, "approvedMessage": { "type": "null" }, "reviewedAt": { "type": "null" }, "sentAt": { "type": "null" }, "rejectionReason": { "type": "null" } }, "required": [ "id", "workspaceId", "flowId", "flowEnrollmentId", "stepId", "leadId", "linkedinAccountId", "revision", "draftMessage", "inputSnapshot", "metadata", "createdAt", "updatedAt", "status", "approvedMessage", "reviewedAt", "sentAt", "rejectionReason" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "flowId": { "type": "string" }, "flowEnrollmentId": { "type": "string" }, "stepId": { "type": "string" }, "leadId": { "type": "string" }, "linkedinAccountId": { "type": "string" }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "draftMessage": { "type": "string" }, "inputSnapshot": {}, "metadata": {}, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "status": { "type": "string", "const": "APPROVED" }, "approvedMessage": { "type": "string" }, "reviewedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "sentAt": { "type": "null" }, "rejectionReason": { "type": "null" } }, "required": [ "id", "workspaceId", "flowId", "flowEnrollmentId", "stepId", "leadId", "linkedinAccountId", "revision", "draftMessage", "inputSnapshot", "metadata", "createdAt", "updatedAt", "status", "approvedMessage", "reviewedAt", "sentAt", "rejectionReason" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "flowId": { "type": "string" }, "flowEnrollmentId": { "type": "string" }, "stepId": { "type": "string" }, "leadId": { "type": "string" }, "linkedinAccountId": { "type": "string" }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "draftMessage": { "type": "string" }, "inputSnapshot": {}, "metadata": {}, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "status": { "type": "string", "const": "SENT" }, "approvedMessage": { "type": "string" }, "reviewedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "sentAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "rejectionReason": { "type": "null" } }, "required": [ "id", "workspaceId", "flowId", "flowEnrollmentId", "stepId", "leadId", "linkedinAccountId", "revision", "draftMessage", "inputSnapshot", "metadata", "createdAt", "updatedAt", "status", "approvedMessage", "reviewedAt", "sentAt", "rejectionReason" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "flowId": { "type": "string" }, "flowEnrollmentId": { "type": "string" }, "stepId": { "type": "string" }, "leadId": { "type": "string" }, "linkedinAccountId": { "type": "string" }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "draftMessage": { "type": "string" }, "inputSnapshot": {}, "metadata": {}, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "status": { "type": "string", "const": "REJECTED" }, "approvedMessage": { "type": "null" }, "reviewedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "sentAt": { "type": "null" }, "rejectionReason": { "type": [ "string", "null" ] } }, "required": [ "id", "workspaceId", "flowId", "flowEnrollmentId", "stepId", "leadId", "linkedinAccountId", "revision", "draftMessage", "inputSnapshot", "metadata", "createdAt", "updatedAt", "status", "approvedMessage", "reviewedAt", "sentAt", "rejectionReason" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "flowId": { "type": "string" }, "flowEnrollmentId": { "type": "string" }, "stepId": { "type": "string" }, "leadId": { "type": "string" }, "linkedinAccountId": { "type": "string" }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "draftMessage": { "type": "string" }, "inputSnapshot": {}, "metadata": {}, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "status": { "type": "string", "const": "CANCELLED" }, "approvedMessage": { "type": [ "string", "null" ] }, "reviewedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "sentAt": { "type": "null" }, "rejectionReason": { "type": "string" } }, "required": [ "id", "workspaceId", "flowId", "flowEnrollmentId", "stepId", "leadId", "linkedinAccountId", "revision", "draftMessage", "inputSnapshot", "metadata", "createdAt", "updatedAt", "status", "approvedMessage", "reviewedAt", "sentAt", "rejectionReason" ], "additionalProperties": false } ], "discriminator": { "propertyName": "status" } }, "agent": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "enrollmentStatus": { "type": "string", "enum": [ "ACTIVE", "WAITING", "COMPLETED", "FAILED", "CANCELLED" ] }, "selectedOutcome": { "type": [ "string", "null" ], "enum": [ "interested", "notInterested" ] } }, "required": [ "kind", "request", "agent", "enrollmentStatus", "selectedOutcome" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "coldSequence" }, "request": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "flowId": { "type": "string" }, "flowEnrollmentId": { "type": "string" }, "leadId": { "type": "string" }, "linkedinAccountId": { "type": "string" }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "coldOpener": { "type": "string" }, "coldOpenerHumanizer": { "type": [ "object", "null" ], "properties": { "variant": { "type": "string", "enum": [ "control", "greeting_split", "last_sentence_split", "full_split" ] }, "parts": { "minItems": 1, "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "lowercaseApplied": { "type": "boolean" }, "sentAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "text", "lowercaseApplied", "sentAt" ], "additionalProperties": false } } }, "required": [ "variant", "parts" ], "additionalProperties": false }, "coldFollowUp": { "type": "string" }, "coldBreakUp": { "type": "string" }, "status": { "type": "string", "enum": [ "GENERATING", "PENDING", "APPROVED", "REJECTED", "CANCELLED" ] }, "reviewedAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "rejectionReason": { "type": [ "string", "null" ] }, "inputSnapshot": {}, "metadata": {}, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "workspaceId", "flowId", "flowEnrollmentId", "leadId", "linkedinAccountId", "revision", "coldOpener", "coldOpenerHumanizer", "coldFollowUp", "coldBreakUp", "status", "reviewedAt", "rejectionReason", "inputSnapshot", "metadata", "createdAt", "updatedAt" ], "additionalProperties": false }, "sentMessageKeys": { "type": "array", "items": { "type": "string", "enum": [ "coldOpener", "coldFollowUp", "coldBreakUp" ] } }, "agent": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "enrollmentStatus": { "type": "string", "enum": [ "ACTIVE", "WAITING", "COMPLETED", "FAILED", "CANCELLED" ] }, "selectedOutcome": { "type": [ "string", "null" ], "enum": [ "interested", "notInterested" ] } }, "required": [ "kind", "request", "sentMessageKeys", "agent", "enrollmentStatus", "selectedOutcome" ], "additionalProperties": false } ], "discriminator": { "propertyName": "kind" } } }, "required": [ "status", "data" ], "additionalProperties": false } } } }, "400": { "description": "Error, see Errors and rate limits", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } }, "required": [ "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/message-validations/{id}/conversation": { "get": { "operationId": "getValidationConversation", "summary": "Get a validation conversation", "description": "Get the recent conversation behind a validation", "tags": [ "Validations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "GET /v1/message-validations/:id/conversation Parameter", "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "data": { "type": "object", "properties": { "conversationId": { "type": [ "string", "null" ] }, "messages": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "sender": { "type": "string", "enum": [ "lead", "linkedinAccount", "unknown" ] }, "senderLabel": { "type": "string" }, "text": { "type": "string" }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "byteSize": { "type": "string" }, "mediaType": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" } }, "required": [ "id", "mediaType", "name" ], "additionalProperties": false } }, "subType": { "type": "string" }, "origin": { "type": "string", "enum": [ "agent", "agentEdited", "manual" ] } }, "required": [ "id", "at", "sender", "senderLabel", "attachments", "subType" ], "additionalProperties": false } } }, "required": [ "conversationId", "messages" ], "additionalProperties": false } }, "required": [ "status", "data" ], "additionalProperties": false } } } }, "400": { "description": "Error, see Errors and rate limits", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } }, "required": [ "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/message-validations/{id}/regeneration": { "get": { "operationId": "getValidationRegeneration", "summary": "Get a validation regeneration", "description": "Read which drafts of a validation the agent is currently rewriting", "tags": [ "Validations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "GET /v1/message-validations/:id/regeneration Parameter", "schema": { "type": "string", "minLength": 1 } }, { "name": "kind", "in": "query", "required": true, "description": "GET /v1/message-validations/:id/regeneration Parameter", "schema": { "type": "string", "enum": [ "message", "coldSequence" ] } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "data": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "PENDING", "SETTLED" ] }, "targets": { "type": "array", "items": { "type": "string", "enum": [ "reply", "coldOpener", "coldFollowUp", "coldBreakUp" ] } } }, "required": [ "status", "targets" ], "additionalProperties": false } }, "required": [ "status", "data" ], "additionalProperties": false } } } }, "400": { "description": "Error, see Errors and rate limits", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } }, "required": [ "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/cockpit": { "get": { "operationId": "getCockpit", "summary": "Get live activity", "description": "Get the live activity of the workspace: running agents, queues and pending actions", "tags": [ "Cockpit" ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "data": { "type": "object", "properties": { "live": { "type": "object", "properties": { "runningAgents": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "linkedinAccounts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "invitationsInQueue": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "messagesInQueue": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "runningAgents", "linkedinAccounts", "invitationsInQueue", "messagesInQueue" ], "additionalProperties": false }, "actions": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "linkedin_account_disconnected", "conversation_handoff_pending", "reply_validation_pending", "sequence_validation_pending" ] }, "count": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "destination": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "route" }, "href": { "type": "string", "pattern": "^\\/.*" } }, "required": [ "kind", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "linkedin_account" }, "accountId": { "type": "string" }, "view": { "type": "string", "const": "reconnect" } }, "required": [ "kind", "accountId", "view" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "humanizer" }, "agents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "kind", "agents" ], "additionalProperties": false } ], "discriminator": { "propertyName": "kind" } }, "label": { "type": "string" }, "message": { "type": "string" }, "nature": { "type": "string", "const": "action" }, "ignore": { "type": "null" } }, "required": [ "key", "count", "destination", "label", "message", "nature", "ignore" ], "additionalProperties": false } } }, "required": [ "live", "actions" ], "additionalProperties": false } }, "required": [ "status", "data" ], "additionalProperties": false } } } }, "400": { "description": "Error, see Errors and rate limits", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } }, "required": [ "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/cockpit/analytics": { "get": { "operationId": "getCockpitAnalytics", "summary": "Get analytics", "description": "Get the performance indicators and the funnel, by period, agent or LinkedIn account", "tags": [ "Cockpit" ], "parameters": [ { "name": "range", "in": "query", "required": false, "description": "GET /v1/cockpit/analytics Parameter", "schema": { "default": "7", "type": "string", "enum": [ "7", "30", "90", "today" ] } }, { "name": "agentId", "in": "query", "required": false, "description": "GET /v1/cockpit/analytics Parameter", "schema": { "type": "string", "minLength": 1 } }, { "name": "linkedinAccountId", "in": "query", "required": false, "description": "GET /v1/cockpit/analytics Parameter", "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "data": { "type": "object", "properties": { "range": { "type": "string", "enum": [ "7", "30", "90", "today" ] }, "from": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "to": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "kpis": { "type": "object", "properties": { "messagesSent": { "type": "object", "properties": { "value": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "deltaValue": { "type": [ "integer", "null" ], "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deltaPercent": { "type": [ "integer", "null" ], "minimum": -9007199254740991, "maximum": 9007199254740991 }, "series": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } } }, "required": [ "value", "deltaValue", "deltaPercent", "series" ], "additionalProperties": false }, "replies": { "type": "object", "properties": { "value": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "deltaValue": { "type": [ "integer", "null" ], "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deltaPercent": { "type": [ "integer", "null" ], "minimum": -9007199254740991, "maximum": 9007199254740991 }, "series": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } } }, "required": [ "value", "deltaValue", "deltaPercent", "series" ], "additionalProperties": false }, "interested": { "type": "object", "properties": { "value": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "deltaValue": { "type": [ "integer", "null" ], "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deltaPercent": { "type": [ "integer", "null" ], "minimum": -9007199254740991, "maximum": 9007199254740991 }, "series": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } } }, "required": [ "value", "deltaValue", "deltaPercent", "series" ], "additionalProperties": false }, "linkClicks": { "type": "object", "properties": { "value": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "deltaValue": { "type": [ "integer", "null" ], "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deltaPercent": { "type": [ "integer", "null" ], "minimum": -9007199254740991, "maximum": 9007199254740991 }, "series": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } } }, "required": [ "value", "deltaValue", "deltaPercent", "series" ], "additionalProperties": false } }, "required": [ "messagesSent", "replies", "interested", "linkClicks" ], "additionalProperties": false }, "funnel": { "type": "object", "properties": { "entryLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sourcedInPeriod": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "notContacted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inviteSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "alreadyConnected": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "messagedViaNew": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replied": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "interested": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "notInterested": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "entryLeads", "sourcedInPeriod", "notContacted", "inviteSent", "alreadyConnected", "messagedViaNew", "replied", "interested", "notInterested" ], "additionalProperties": false } }, "required": [ "range", "from", "to", "kpis", "funnel" ], "additionalProperties": false } }, "required": [ "status", "data" ], "additionalProperties": false } } } }, "400": { "description": "Error, see Errors and rate limits", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } }, "required": [ "status", "error" ], "additionalProperties": false } } } } } } }, "/v1/billing": { "get": { "operationId": "getBilling", "summary": "Get billing", "description": "Get the subscription state and the plan catalog", "tags": [ "Billing" ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "data": { "type": "object", "properties": { "subscription": { "type": "object", "properties": { "isSubscribed": { "type": "boolean" }, "paymentFailed": { "type": "boolean" }, "trialEnded": { "type": "boolean" }, "accessKind": { "type": [ "string", "null" ], "enum": [ "alpha", "admin" ] }, "billingCurrency": { "type": "string", "enum": [ "eur", "usd" ] }, "status": { "type": [ "string", "null" ] }, "seats": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "paidSeats": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "complimentarySeats": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "usedSeats": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "billingPrice": { "type": [ "object", "null" ], "properties": { "billingPeriod": { "type": "string", "enum": [ "monthly", "yearly" ] }, "currency": { "type": "string", "enum": [ "eur", "usd" ] }, "unitAmount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "product": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 } }, "required": [ "name" ], "additionalProperties": false } }, "required": [ "billingPeriod", "currency", "unitAmount", "product" ], "additionalProperties": false }, "currentPeriodEnd": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "cancelAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "cancelAtPeriodEnd": { "type": "boolean" }, "nextPaymentAmount": { "type": [ "integer", "null" ], "minimum": -9007199254740991, "maximum": 9007199254740991 }, "nextPaymentDate": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "nextPaymentDiscount": { "type": [ "object", "null" ], "properties": { "code": { "type": "string", "minLength": 1 }, "name": { "type": [ "string", "null" ], "minLength": 1 }, "duration": { "type": "string", "enum": [ "once", "repeating", "forever" ] }, "durationInMonths": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "percentOff": { "type": [ "number", "null" ], "exclusiveMinimum": 0, "maximum": 100 }, "amountOff": { "type": [ "integer", "null" ], "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "redeemBy": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endsAt": { "type": [ "string", "null" ], "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "regularAmount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "discountAmount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "code", "name", "duration", "durationInMonths", "percentOff", "amountOff", "redeemBy", "endsAt", "regularAmount", "discountAmount" ], "additionalProperties": false } }, "required": [ "isSubscribed", "paymentFailed", "trialEnded", "accessKind", "billingCurrency", "status", "seats", "paidSeats", "complimentarySeats", "usedSeats", "billingPrice", "currentPeriodEnd", "cancelAt", "cancelAtPeriodEnd", "nextPaymentAmount", "nextPaymentDate", "nextPaymentDiscount" ], "additionalProperties": false }, "catalog": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "prices": { "type": "array", "items": { "type": "object", "properties": { "billingPeriod": { "type": "string", "enum": [ "monthly", "yearly" ] }, "currency": { "type": "string", "enum": [ "eur", "usd" ] }, "unitAmount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "billingPeriod", "currency", "unitAmount" ], "additionalProperties": false } } }, "required": [ "name", "prices" ], "additionalProperties": false } } }, "required": [ "subscription", "catalog" ], "additionalProperties": false } }, "required": [ "status", "data" ], "additionalProperties": false } } } }, "400": { "description": "Error, see Errors and rate limits", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "error" }, "error": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } }, "required": [ "status", "error" ], "additionalProperties": false } } } } } } } }, "components": { "schemas": {}, "responses": {}, "parameters": {}, "examples": {}, "requestBodies": {}, "headers": {}, "securitySchemes": { "apiKey": { "type": "http", "scheme": "bearer", "bearerFormat": "wai_…", "description": "A personal API key, created in Settings › API & MCP." } }, "links": {}, "callbacks": {} }, "tags": [ { "name": "Workspace", "description": "The workspace and the user who owns the API key." }, { "name": "Team", "description": "Workspace members and pending invitations. Needs the Owner or Admin role." }, { "name": "LinkedIn accounts", "description": "Connected LinkedIn accounts and their sending settings." }, { "name": "Agents", "description": "Prospecting agents, their configuration and activity." }, { "name": "Leads", "description": "Leads and their timeline." }, { "name": "Inbox", "description": "Conversations held by the agents, and their messages." }, { "name": "Validations", "description": "Messages and cold sequences waiting for a human validation." }, { "name": "Cockpit", "description": "Live activity and analytics of the workspace." }, { "name": "Billing", "description": "Subscription and plans. Needs the Owner role." } ], "servers": [ { "url": "https://developers.waalaxy.ai" } ] }