{ "schemes": ["https"], "swagger": "2.0", "info": { "description": "Leadsforge API", "title": "Leadsforge API", "termsOfService": "https://www.salesforge.ai/terms", "contact": {}, "version": "1.0" }, "host": "api.leadsforge.ai", "basePath": "/", "paths": { "/account-users": { "get": { "security": [ { "Bearer": [] } ], "description": "Get all users in the account", "produces": [ "application/json" ], "tags": [ "users" ], "summary": "Get account users", "responses": { "200": { "description": "Account Users", "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountUserResponse" } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "security": [ { "Bearer": [] } ], "description": "Create a new user in the account", "tags": [ "users" ], "summary": "Create account user", "parameters": [ { "description": "Create User Request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CreateUserRequest" } } ], "responses": { "200": { "description": "Created user", "schema": { "$ref": "#/definitions/AccountUserResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/account-users/complete-invitation": { "post": { "description": "Complete a user invitation", "tags": [ "users" ], "summary": "Complete user invitation", "parameters": [ { "description": "Complete User Invitation Request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CreateUserRequest" } } ], "responses": { "200": { "description": "Created user", "schema": { "$ref": "#/definitions/AccountUserResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "410": { "description": "Gone", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/account-users/invite": { "post": { "security": [ { "Bearer": [] } ], "description": "Invite a new user to the account", "tags": [ "users" ], "summary": "Invite account user", "parameters": [ { "description": "Invite User Request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InviteUserRequest" } } ], "responses": { "200": { "description": "User invitation", "schema": { "$ref": "#/definitions/UserInvitationResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/account-users/validate-invitation": { "post": { "description": "Validate a user invitation", "tags": [ "users" ], "summary": "Validate user invitation", "parameters": [ { "description": "Validate User Invitation Request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ValidateUserInvitationRequest" } } ], "responses": { "200": { "description": "User invitation", "schema": { "$ref": "#/definitions/UserInvitationResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/account-users/{userID}": { "delete": { "security": [ { "Bearer": [] } ], "description": "Remove a user from the account (only for account owner)", "tags": [ "users" ], "summary": "Remove account user", "parameters": [ { "type": "string", "description": "User ID", "name": "userID", "in": "path", "required": true } ], "responses": { "200": { "description": "User removed" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "patch": { "security": [ { "Bearer": [] } ], "description": "Update a user in the account", "tags": [ "users" ], "summary": "Update account user", "parameters": [ { "type": "string", "description": "User ID", "name": "userID", "in": "path", "required": true }, { "description": "Update User Request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateUserRequest" } } ], "responses": { "200": { "description": "User updated" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/balance": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get credit balance", "produces": [ "application/json" ], "tags": [ "balance" ], "summary": "Get credit balance", "responses": { "200": { "description": "Credit balance", "schema": { "$ref": "#/definitions/CreditBalanceResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/billing/portal-link": { "get": { "security": [ { "Bearer": [] } ], "description": "Get subscription portal link", "produces": [ "application/json" ], "tags": [ "billing" ], "summary": "Get subscription portal link", "responses": { "200": { "description": "Redirect URL", "schema": { "$ref": "#/definitions/ChargebeeRedirectResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/billing/subscription": { "get": { "security": [ { "Bearer": [] } ], "description": "Get subscription", "produces": [ "application/json" ], "tags": [ "billing" ], "summary": "Get subscription", "responses": { "200": { "description": "Subscription", "schema": { "$ref": "#/definitions/Subscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "security": [ { "Bearer": [] } ], "description": "Update subscription", "produces": [ "application/json" ], "tags": [ "billing" ], "summary": "Update subscription", "parameters": [ { "description": "Subscription", "name": "subscription", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateSubscriptionRequest" } } ], "responses": { "200": { "description": "Redirect URL", "schema": { "$ref": "#/definitions/ChargebeeRedirectResponse" } }, "202": { "description": "Accepted" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden - code purchase_requires_approval: the purchase needs a human review before it can go through and the customer should contact support. Nothing was charged", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/billing/tiers": { "get": { "security": [ { "Bearer": [] } ], "description": "Get export credits tiers", "produces": [ "application/json" ], "tags": [ "billing" ], "summary": "Get export credits tiers", "parameters": [ { "type": "string", "description": "Billing period", "name": "billing_period", "in": "query", "required": true } ], "responses": { "200": { "description": "Export credits tiers", "schema": { "type": "array", "items": { "$ref": "#/definitions/ExportCreditsTier" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/browser-extension/enrichment-jobs": { "post": { "security": [ { "Bearer": [] } ], "description": "Create an async enrichment job for scraped contacts and return its list id.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "browser-extension" ], "summary": "Create enrichment job", "parameters": [ { "type": "string", "description": "Repeated key returns the same list id", "name": "Idempotency-Key", "in": "header" }, { "description": "Contacts to enrich", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CreateEnrichmentJobRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ExtensionEnrichmentResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "402": { "description": "Payment Required", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/browser-extension/enrichment-jobs/{listID}": { "get": { "security": [ { "Bearer": [] } ], "description": "Get the status and per-contact rows of an enrichment job for the authenticated account.", "produces": [ "application/json" ], "tags": [ "browser-extension" ], "summary": "Get enrichment job status", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ExtensionEnrichmentStatusResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/company-followers/filters/countries": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get list of supported country values", "produces": [ "application/json" ], "tags": [ "company-followers" ], "summary": "Get available countries for company followers filtering", "responses": { "200": { "description": "Countries list", "schema": { "$ref": "#/definitions/CompanyFollowersCountriesResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } } } } }, "/company-followers/filters/departments": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get list of supported department values", "produces": [ "application/json" ], "tags": [ "company-followers" ], "summary": "Get available departments for company followers filtering", "responses": { "200": { "description": "Departments list", "schema": { "$ref": "#/definitions/CompanyFollowersDepartmentsResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } } } } }, "/company-followers/filters/job-titles": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get paginated list of supported job title values with optional search", "produces": [ "application/json" ], "tags": [ "company-followers" ], "summary": "Get available job titles for company followers filtering", "parameters": [ { "type": "string", "description": "Search query", "name": "search", "in": "query" }, { "minimum": 1, "type": "integer", "description": "Page number", "name": "page", "in": "query" }, { "maximum": 20, "minimum": 1, "type": "integer", "description": "Page size", "name": "page_size", "in": "query" } ], "responses": { "200": { "description": "Job titles list", "schema": { "$ref": "#/definitions/CompanyFollowersJobTitlesResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } } } } }, "/company-followers/filters/levels": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get list of supported seniority level values", "produces": [ "application/json" ], "tags": [ "company-followers" ], "summary": "Get available levels for company followers filtering", "responses": { "200": { "description": "Levels list", "schema": { "$ref": "#/definitions/CompanyFollowersLevelsResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } } } } }, "/company-followers/filters/metros": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get list of supported metro area values. A metro replaces its country in the search.", "produces": [ "application/json" ], "tags": [ "company-followers" ], "summary": "Get available metro areas for company followers filtering", "responses": { "200": { "description": "Metros list", "schema": { "$ref": "#/definitions/CompanyFollowersMetrosResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } } } } }, "/company-followers/filters/states": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get list of supported state/region values", "produces": [ "application/json" ], "tags": [ "company-followers" ], "summary": "Get available states for company followers filtering", "responses": { "200": { "description": "States list", "schema": { "$ref": "#/definitions/CompanyFollowersStatesResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } } } } }, "/company-followers/jobs": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "List the caller's company-followers jobs, most recent first. Use the filters (status, clientRequestID, from/to) to recover a job when the job ID is unknown.", "produces": [ "application/json" ], "tags": [ "company-followers" ], "summary": "List company followers jobs", "parameters": [ { "type": "integer", "description": "Offset", "name": "offset", "in": "query" }, { "type": "integer", "description": "Page size (max 100)", "name": "limit", "in": "query", "required": true }, { "enum": [ "in_progress", "completed", "failed", "no_results" ], "type": "string", "description": "Filter by status", "name": "status", "in": "query" }, { "type": "string", "description": "Filter by your clientRequestID", "name": "clientRequestID", "in": "query" }, { "type": "string", "description": "Created-at lower bound (RFC3339)", "name": "from", "in": "query" }, { "type": "string", "description": "Created-at upper bound (RFC3339)", "name": "to", "in": "query" } ], "responses": { "200": { "description": "Jobs", "schema": { "$ref": "#/definitions/CompanyFollowersJobsListResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/company-followers/jobs/{jobID}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Fetch company followers job status.", "produces": [ "application/json" ], "tags": [ "company-followers" ], "summary": "Get company followers job status.", "parameters": [ { "type": "string", "description": "Job ID", "name": "jobID", "in": "path", "required": true } ], "responses": { "200": { "description": "Job status", "schema": { "$ref": "#/definitions/CompanyFollowersJobResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/company-followers/jobs/{jobID}/results": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Fetch company followers job results with pagination.", "produces": [ "application/json" ], "tags": [ "company-followers" ], "summary": "List company followers results.", "parameters": [ { "type": "string", "description": "Job ID", "name": "jobID", "in": "path", "required": true }, { "type": "integer", "description": "Offset", "name": "offset", "in": "query" }, { "type": "integer", "description": "Page size", "name": "limit", "in": "query" } ], "responses": { "200": { "description": "Job results", "schema": { "$ref": "#/definitions/CompanyFollowersResultsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/company-followers/search": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Starts an async company followers search for a LinkedIn company page, limit is required and capped at 50000, supports idempotency via Idempotency-Key header (if a job with the same key already exists for this account the existing job is returned), supports webhook notifications via webhookURL field (POST with JSON body on completion/failure, 2xx = success; a failed delivery is retried immediately and then redelivered in the background for up to 24h, every attempt carrying the same X-Webhook-Delivery-Id header so repeated deliveries can be deduplicated), webhook payload: jobID (string), status (completed|failed), linkedinUrl (string), companyName (string), followerCount (int), total (int), processed (int), error (string, failure only). The webhook omits companyLogoUrl to avoid sending a raw upstream image URL; fetch it from GET /company-followers/jobs/{jobID}.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "company-followers" ], "summary": "Search company followers", "parameters": [ { "type": "string", "description": "Idempotency key - if a job with this key already exists for this account, the existing job is returned as-is, use a new key to start a new search", "name": "Idempotency-Key", "in": "header" }, { "description": "Search request", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/StartCompanyFollowersSearchRequest" } } ], "responses": { "202": { "description": "Job created", "schema": { "$ref": "#/definitions/CompanyFollowersJobResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "402": { "description": "Insufficient credits", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/Error" } } } } }, "/csv-enrichments": { "get": { "security": [ { "Bearer": [] } ], "description": "Returns a paginated list of CSV enrichment jobs", "produces": [ "application/json" ], "tags": [ "csv-enrichments" ], "summary": "List CSV enrichment jobs", "parameters": [ { "type": "integer", "description": "Page number", "name": "page", "in": "query" }, { "type": "integer", "description": "Page size", "name": "size", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CSVEnrichmentListResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/csv-enrichments/sse": { "get": { "security": [ { "Bearer": [] } ], "description": "Streams CSV enrichment job updates for the authenticated user", "produces": [ "text/event-stream" ], "tags": [ "csv-enrichments" ], "summary": "CSV enrichment updates SSE", "responses": { "200": { "description": "SSE CSV Enrichment Updates", "schema": { "type": "array", "items": { "type": "object" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/csv-enrichments/template": { "get": { "security": [ { "Bearer": [] } ], "description": "Returns a CSV template with expected column headers", "produces": [ "text/csv" ], "tags": [ "csv-enrichments" ], "summary": "Download CSV enrichment template", "responses": { "200": { "description": "CSV template", "schema": { "type": "file" } } } } }, "/csv-enrichments/upload": { "post": { "security": [ { "Bearer": [] } ], "description": "Accepts a CSV file and creates a draft enrichment job", "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "tags": [ "csv-enrichments" ], "summary": "Upload CSV for enrichment", "parameters": [ { "type": "file", "description": "CSV file", "name": "file", "in": "formData", "required": true } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/CSVEnrichmentUploadResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/csv-enrichments/{jobID}": { "get": { "security": [ { "Bearer": [] } ], "description": "Returns the current state of a CSV enrichment job", "produces": [ "application/json" ], "tags": [ "csv-enrichments" ], "summary": "Get CSV enrichment job status", "parameters": [ { "type": "string", "description": "Job ID", "name": "jobID", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CSVEnrichmentJobResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/csv-enrichments/{jobID}/configure": { "post": { "security": [ { "Bearer": [] } ], "description": "Stores column mapping and enrichment options for a draft job", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "csv-enrichments" ], "summary": "Configure CSV enrichment job", "parameters": [ { "type": "string", "description": "Job ID", "name": "jobID", "in": "path", "required": true }, { "description": "Configuration payload", "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigureCSVEnrichmentRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CSVEnrichmentJobResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/csv-enrichments/{jobID}/download": { "get": { "security": [ { "Bearer": [] } ], "description": "Downloads the enriched CSV file for a completed job", "produces": [ "text/csv" ], "tags": [ "csv-enrichments" ], "summary": "Download CSV enrichment result", "parameters": [ { "type": "string", "description": "Job ID", "name": "jobID", "in": "path", "required": true } ], "responses": { "200": { "description": "CSV file", "schema": { "type": "file" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/csv-enrichments/{jobID}/start": { "post": { "security": [ { "Bearer": [] } ], "description": "Schedules processing of the configured job. Returns 400 with the mapping report in the error data when a mapped column does not look like the field it was mapped to; resend with acknowledgeMappingWarnings to proceed anyway.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "csv-enrichments" ], "summary": "Start CSV enrichment job", "parameters": [ { "type": "string", "description": "Job ID", "name": "jobID", "in": "path", "required": true }, { "description": "Start options", "name": "payload", "in": "body", "schema": { "$ref": "#/definitions/StartCSVEnrichmentRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CSVEnrichmentJobResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichment/email": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Enrich a single person's work email and return the result in the same response, no polling. Provide personID (from POST /search), linkedinURL, or firstName + lastName + a company signal (companyDomain preferred over company name). Costs 1 credit on a hit; a miss is free. Optional externalID (max 128 chars) is echoed back.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "enrichment" ], "summary": "Find email (synchronous)", "parameters": [ { "description": "Person to enrich", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SyncEnrichmentRequest" } } ], "responses": { "200": { "description": "Enrichment result", "schema": { "$ref": "#/definitions/SyncEnrichmentResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "402": { "description": "Insufficient credits", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } }, "503": { "description": "Sync enrichment not enabled for channel", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichment/emails": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Request email finding. Two input modes (mutually exclusive): (1) personIDs - array of IDs obtained from POST /search, (2) people - array of objects, each with either linkedinURL (e.g. \"https://www.linkedin.com/in/john-doe\") or firstName + lastName + company name (e.g. \"Salesforge\", not a URL). Max 500 items. Original input fields are echoed back on each result for correlation. People array entries are deduplicated by normalized linkedinURL or by case-insensitive firstName+lastName+company; only one result is returned per unique person, so duplicate entries (e.g. two CRM records pointing at the same person with different externalIDs) will lose the externalIDs of the duplicates - send unique people if you need each externalID echoed back. Each person in the people array may include an optional externalID (max 128 chars), a pure passthrough value persisted with the result and echoed back in the webhook payload and GET /results response for client-side correlation; externalID is not supported in personIDs mode. Example with people: {\"people\": [{\"linkedinURL\": \"https://www.linkedin.com/in/john-doe\", \"externalID\": \"crm-42\"}, {\"firstName\": \"Jane\", \"lastName\": \"Smith\", \"company\": \"Salesforge\"}], \"webhookURL\": \"https://example.com/webhook\"}. Example with personIDs: {\"personIDs\": [\"p_abc123\", \"p_def456\"]}. Webhook delivery: 2xx = success; a failed delivery is retried immediately and then redelivered in the background for up to 24h, every attempt carrying the same X-Webhook-Delivery-Id header so repeated deliveries can be deduplicated.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "enrichment" ], "summary": "Find emails", "parameters": [ { "type": "string", "description": "Idempotency key", "name": "Idempotency-Key", "in": "header" }, { "description": "Find request", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/StartEnrichmentRequest" } } ], "responses": { "202": { "description": "Job created", "schema": { "$ref": "#/definitions/EnrichmentJobResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "402": { "description": "Insufficient credits", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichment/jobs": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "List the caller's enrichment jobs, most recent first. Use the filters (status, channel, clientRequestID, from/to) to recover a job when the job ID is unknown.", "produces": [ "application/json" ], "tags": [ "enrichment" ], "summary": "List enrichment jobs", "parameters": [ { "type": "integer", "description": "Offset", "name": "offset", "in": "query" }, { "type": "integer", "description": "Page size (max 100)", "name": "limit", "in": "query", "required": true }, { "enum": [ "in_progress", "completed", "failed" ], "type": "string", "description": "Filter by status", "name": "status", "in": "query" }, { "enum": [ "email", "phone", "linkedin" ], "type": "string", "description": "Filter by channel", "name": "channel", "in": "query" }, { "type": "string", "description": "Filter by your clientRequestID", "name": "clientRequestID", "in": "query" }, { "type": "string", "description": "Created-at lower bound (RFC3339)", "name": "from", "in": "query" }, { "type": "string", "description": "Created-at upper bound (RFC3339)", "name": "to", "in": "query" } ], "responses": { "200": { "description": "Jobs", "schema": { "$ref": "#/definitions/EnrichmentJobsListResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichment/jobs/{jobID}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Fetch enrichment job status", "produces": [ "application/json" ], "tags": [ "enrichment" ], "summary": "Get enrichment job", "parameters": [ { "type": "string", "description": "Job ID", "name": "jobID", "in": "path", "required": true } ], "responses": { "200": { "description": "Job status", "schema": { "$ref": "#/definitions/EnrichmentJobResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichment/jobs/{jobID}/results": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Fetch enrichment job results", "produces": [ "application/json" ], "tags": [ "enrichment" ], "summary": "List enrichment results", "parameters": [ { "type": "string", "description": "Job ID", "name": "jobID", "in": "path", "required": true }, { "type": "integer", "description": "Offset", "name": "offset", "in": "query" }, { "type": "integer", "description": "Page size", "name": "limit", "in": "query", "required": true } ], "responses": { "200": { "description": "Job results", "schema": { "$ref": "#/definitions/EnrichmentJobResultsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichment/linkedin": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Request linkedin profile finding. Two input modes (mutually exclusive): (1) personIDs - array of IDs obtained from POST /search, (2) people - array of objects, each with either linkedinURL (e.g. \"https://www.linkedin.com/in/john-doe\") or firstName + lastName + company name (e.g. \"Salesforge\", not a URL). Max 500 items. Original input fields are echoed back on each result for correlation. People array entries are deduplicated by normalized linkedinURL or by case-insensitive firstName+lastName+company; only one result is returned per unique person, so duplicate entries (e.g. two CRM records pointing at the same person with different externalIDs) will lose the externalIDs of the duplicates - send unique people if you need each externalID echoed back. Each person in the people array may include an optional externalID (max 128 chars), a pure passthrough value persisted with the result and echoed back in the webhook payload and GET /results response for client-side correlation; externalID is not supported in personIDs mode. Example with people: {\"people\": [{\"linkedinURL\": \"https://www.linkedin.com/in/john-doe\", \"externalID\": \"crm-42\"}, {\"firstName\": \"Jane\", \"lastName\": \"Smith\", \"company\": \"Salesforge\"}], \"webhookURL\": \"https://example.com/webhook\"}. Example with personIDs: {\"personIDs\": [\"p_abc123\", \"p_def456\"]}. Webhook delivery: 2xx = success; a failed delivery is retried immediately and then redelivered in the background for up to 24h, every attempt carrying the same X-Webhook-Delivery-Id header so repeated deliveries can be deduplicated.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "enrichment" ], "summary": "Find linkedin profiles", "parameters": [ { "type": "string", "description": "Idempotency key", "name": "Idempotency-Key", "in": "header" }, { "description": "Find request", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/StartEnrichmentRequest" } } ], "responses": { "202": { "description": "Job created", "schema": { "$ref": "#/definitions/EnrichmentJobResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "402": { "description": "Insufficient credits", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichment/phone": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Enrich a single person's phone number and return the result in the same response, no polling. Provide personID (from POST /search), linkedinURL, or firstName + lastName + a company signal (companyDomain preferred over company name). Costs 10 credits on a hit; a miss is free. Optional externalID (max 128 chars) is echoed back.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "enrichment" ], "summary": "Find phone number (synchronous)", "parameters": [ { "description": "Person to enrich", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SyncEnrichmentRequest" } } ], "responses": { "200": { "description": "Enrichment result", "schema": { "$ref": "#/definitions/SyncEnrichmentResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "402": { "description": "Insufficient credits", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } }, "503": { "description": "Sync enrichment not enabled for channel", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichment/phones": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Request phone number finding. Two input modes (mutually exclusive): (1) personIDs - array of IDs obtained from POST /search, (2) people - array of objects, each with either linkedinURL (e.g. \"https://www.linkedin.com/in/john-doe\") or firstName + lastName + company name (e.g. \"Salesforge\", not a URL). Max 500 items. Original input fields are echoed back on each result for correlation. People array entries are deduplicated by normalized linkedinURL or by case-insensitive firstName+lastName+company; only one result is returned per unique person, so duplicate entries (e.g. two CRM records pointing at the same person with different externalIDs) will lose the externalIDs of the duplicates - send unique people if you need each externalID echoed back. Each person in the people array may include an optional externalID (max 128 chars), a pure passthrough value persisted with the result and echoed back in the webhook payload and GET /results response for client-side correlation; externalID is not supported in personIDs mode. Example with people: {\"people\": [{\"linkedinURL\": \"https://www.linkedin.com/in/john-doe\", \"externalID\": \"crm-42\"}, {\"firstName\": \"Jane\", \"lastName\": \"Smith\", \"company\": \"Salesforge\"}], \"webhookURL\": \"https://example.com/webhook\"}. Example with personIDs: {\"personIDs\": [\"p_abc123\", \"p_def456\"]}. Webhook delivery: 2xx = success; a failed delivery is retried immediately and then redelivered in the background for up to 24h, every attempt carrying the same X-Webhook-Delivery-Id header so repeated deliveries can be deduplicated.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "enrichment" ], "summary": "Find phone numbers", "parameters": [ { "type": "string", "description": "Idempotency key", "name": "Idempotency-Key", "in": "header" }, { "description": "Find request", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/StartEnrichmentRequest" } } ], "responses": { "202": { "description": "Job created", "schema": { "$ref": "#/definitions/EnrichmentJobResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "402": { "description": "Insufficient credits", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichments": { "get": { "security": [ { "Bearer": [] } ], "description": "Get enrichments", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "enrichment" ], "summary": "Get enrichments", "parameters": [ { "type": "integer", "description": "Page", "name": "page", "in": "query", "required": true }, { "type": "integer", "description": "Size", "name": "size", "in": "query", "required": true }, { "type": "string", "description": "Filter by list name", "name": "search", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EnrichmentsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichments/progress": { "get": { "security": [ { "Bearer": [] } ], "description": "Returns the current enrichment progress for every active list of the user.\nUsed by FE to reconcile the progress banner when an SSE event is missed.", "produces": [ "application/json" ], "tags": [ "enrichment" ], "summary": "Get enrichment progress snapshot", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EnrichmentProgressSnapshotResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichments/sse": { "get": { "security": [ { "Bearer": [] } ], "description": "SSE Global Enrichment Updates", "produces": [ "text/event-stream" ], "tags": [ "enrichment" ], "summary": "SSE Global Enrichment Updates", "responses": { "200": { "description": "SSE Global Enrichment Updates", "schema": { "type": "array", "items": { "type": "object" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichments/{listID}": { "get": { "security": [ { "Bearer": [] } ], "description": "Get enrichment rows", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "enrichment" ], "summary": "Get enrichment rows", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "type": "integer", "description": "Offset", "name": "offset", "in": "query", "required": true }, { "type": "integer", "description": "Limit", "name": "limit", "in": "query", "required": true }, { "type": "string", "description": "Sort column: work_email_status, linkedin_url_status, phone_number_status, or extra column UUID. Unrecognized values fall back to default sort order.", "name": "sortColumn", "in": "query" }, { "type": "string", "description": "Sort direction: positive_to_negative or negative_to_positive", "name": "sortDirection", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EnrichmentTableRowsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichments/{listID}/bulk-delete": { "post": { "security": [ { "Bearer": [] } ], "description": "Bulk delete enrichment rows", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "enrichment" ], "summary": "Bulk delete enrichment rows", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "description": "Bulk delete enrichment rows request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BulkDeleteEnrichmentRowsRequest" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichments/{listID}/cancel": { "post": { "security": [ { "Bearer": [] } ], "description": "Abort an in-progress enrichment. Not-yet-started contacts return to search/preview; in-flight contacts finish and are charged for what providers return.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "enrichment" ], "summary": "Cancel enrichment", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CancelEnrichmentResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichments/{listID}/enrich": { "post": { "security": [ { "Bearer": [] } ], "description": "Re-enrich rows", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "enrichment" ], "summary": "Re-enrich rows", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "description": "Re-enrich list request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ReEnrichListRequest" } } ], "responses": { "200": { "description": "Re-enrichment queued" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichments/{listID}/enriched-email-count": { "post": { "security": [ { "Bearer": [] } ], "description": "Get number of rows that have an enriched email", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "enrichment" ], "summary": "Get enriched email count", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "description": "Get enriched email count request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetEnrichedEmailCountRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetEnrichedEmailCountResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichments/{listID}/exports/csv": { "post": { "security": [ { "Bearer": [] } ], "description": "Export list to CSV", "produces": [ "text/plain" ], "tags": [ "exports" ], "summary": "Export list to CSV", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "description": "Export CSV request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ExportCSVRequest" } } ], "responses": { "200": { "description": "CSV file", "schema": { "type": "string" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichments/{listID}/exports/hubspot": { "post": { "security": [ { "Bearer": [] } ], "description": "Export list to Hubspot via Husbpot Integration", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "exports" ], "summary": "Export list to Hubspot", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "description": "Export to Hubspot request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ExportToHubspotRequest" } } ], "responses": { "202": { "description": "Accepted" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichments/{listID}/exports/salesforce": { "post": { "security": [ { "Bearer": [] } ], "description": "Export list to Salesforce via Salesforce Integration", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "exports" ], "summary": "Export list to Salesforce", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "description": "Export to Salesforce request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ExportToSalesforceRequest" } } ], "responses": { "202": { "description": "Accepted" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichments/{listID}/exports/salesforge": { "post": { "security": [ { "Bearer": [] } ], "description": "Export list to Salesforge", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "exports" ], "summary": "Export list to Salesforge", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "description": "Export to Salesforge request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ExportToSalesforgeRequest" } } ], "responses": { "202": { "description": "Accepted" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichments/{listID}/exports/salesforge/workspaces": { "get": { "security": [ { "Bearer": [] } ], "description": "Get Salesforge workspaces for export", "produces": [ "application/json" ], "tags": [ "exports" ], "summary": "Get Salesforge workspaces", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true } ], "responses": { "200": { "description": "Salesforge workspaces", "schema": { "type": "array", "items": { "$ref": "#/definitions/SalesforgeWorkspaceResponse" } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichments/{listID}/extra-column": { "get": { "security": [ { "Bearer": [] } ], "description": "Get lead qualification intents (extra columns filtered by lead_qualification type)", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "enrichment" ], "summary": "Get lead qualification intents", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/ExtraColumnResponse" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "security": [ { "Bearer": [] } ], "description": "Create new extra columns in the enrichment table. Columns are matched by description (whitespace trimmed). If a column with the same description exists, it will be updated. If not, a new column with a new UUID will be created. All existing columns not in the request will be marked as inactive.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "enrichment" ], "summary": "Create extra columns", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "description": "Create extra columns request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CreateExtraColumnRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "type": "array", "items": { "$ref": "#/definitions/CreateExtraColumnResponse" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichments/{listID}/extra-column/{extraColumnID}": { "delete": { "security": [ { "Bearer": [] } ], "description": "Deactivate an extra column by setting IsInactive to true", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "enrichment" ], "summary": "Deactivate extra column", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "type": "string", "description": "Extra Column ID", "name": "extraColumnID", "in": "path", "required": true } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichments/{listID}/out-of-credits-count": { "get": { "security": [ { "Bearer": [] } ], "description": "Get number of rows that were paused due to user being out of credits", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "enrichment" ], "summary": "Get out of credits count", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetOutOfCreditsCountResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichments/{listID}/rows/{personID}": { "delete": { "security": [ { "Bearer": [] } ], "description": "Delete enrichment row", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "enrichment" ], "summary": "Delete enrichment row", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "type": "string", "description": "Person ID", "name": "personID", "in": "path", "required": true } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichments/{listID}/runs": { "get": { "security": [ { "Bearer": [] } ], "description": "Returns a list's enrichment run history (newest first), keyset-paginated.", "produces": [ "application/json" ], "tags": [ "enrichment" ], "summary": "Get enrichment runs", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "type": "integer", "description": "Page size (default 5, max 200)", "name": "limit", "in": "query" }, { "type": "string", "description": "Opaque pagination cursor returned by a previous response", "name": "cursor", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EnrichmentRunsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/enrichments/{listID}/sse": { "get": { "security": [ { "Bearer": [] } ], "description": "SSE Enrichment Updates", "produces": [ "text/event-stream" ], "tags": [ "enrichment" ], "summary": "SSE Enrichment Updates", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true } ], "responses": { "200": { "description": "SSE List Enrichment Updates", "schema": { "type": "array", "items": { "type": "object" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/exports/sse": { "get": { "security": [ { "Bearer": [] } ], "description": "SSE Export Updates", "produces": [ "text/event-stream" ], "tags": [ "exports" ], "summary": "SSE Export Updates", "responses": { "200": { "description": "SSE Export Updates", "schema": { "type": "array", "items": { "type": "object" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/feature-flags": { "get": { "security": [ { "Bearer": [] } ], "description": "Get server-side feature flags and configuration values", "produces": [ "application/json" ], "tags": [ "feature-flags" ], "summary": "Get feature flags", "responses": { "200": { "description": "Feature flags", "schema": { "$ref": "#/definitions/FeatureFlagsResponse" } } } } }, "/filters/companies": { "get": { "security": [ { "Bearer": [] } ], "description": "Get companies from Elasticsearch index for autocomplete", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Autocomplete companies", "parameters": [ { "type": "string", "description": "Search query", "name": "search", "in": "query" }, { "type": "integer", "default": 10, "description": "Limit", "name": "limit", "in": "query" } ], "responses": { "200": { "description": "Companies", "schema": { "type": "array", "items": { "$ref": "#/definitions/CompanyAutocompleteResponse" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/company-domains": { "get": { "security": [ { "Bearer": [] } ], "description": "Get company domains", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get company domains", "parameters": [ { "type": "string", "description": "Search query", "name": "search", "in": "query" } ], "responses": { "200": { "description": "Company domains", "schema": { "type": "array", "items": { "$ref": "#/definitions/AutocompleteCompanyResponse" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/company-followers/countries": { "get": { "description": "Get company followers countries", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get company followers countries", "responses": { "200": { "description": "Company followers countries", "schema": { "$ref": "#/definitions/CompanyFollowersCountriesResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/company-followers/departments": { "get": { "security": [ { "Bearer": [] } ], "description": "Get available department filter values for company followers", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get company followers departments", "responses": { "200": { "description": "Departments", "schema": { "$ref": "#/definitions/CompanyFollowersDepartmentsResponse" } } } } }, "/filters/company-followers/job-titles": { "get": { "description": "Get company followers job titles", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get company followers job titles", "responses": { "200": { "description": "Company followers job titles", "schema": { "$ref": "#/definitions/CompanyFollowersJobTitlesResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/company-followers/levels": { "get": { "security": [ { "Bearer": [] } ], "description": "Get available seniority level filter values for company followers", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get company followers levels", "responses": { "200": { "description": "Levels", "schema": { "$ref": "#/definitions/CompanyFollowersLevelsResponse" } } } } }, "/filters/company-followers/metros": { "get": { "security": [ { "Bearer": [] } ], "description": "Get available metro area filter values for company followers", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get company followers metros", "responses": { "200": { "description": "Company followers metros", "schema": { "$ref": "#/definitions/CompanyFollowersMetrosResponse" } } } } }, "/filters/company-followers/states": { "get": { "security": [ { "Bearer": [] } ], "description": "Get available state/region filter values for company followers", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get company followers states", "responses": { "200": { "description": "Company followers states", "schema": { "$ref": "#/definitions/CompanyFollowersStatesResponse" } } } } }, "/filters/company-funding-types": { "get": { "security": [ { "Bearer": [] } ], "description": "Get company funding types", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get company funding types", "responses": { "200": { "description": "Company funding types", "schema": { "type": "array", "items": { "$ref": "#/definitions/CompanyFundingTypeResponse" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/company-lookalikes/locations": { "get": { "security": [ { "Bearer": [] } ], "description": "Get company lookalikes locations", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get company lookalikes locations", "responses": { "200": { "description": "Company lookalikes locations", "schema": { "type": "array", "items": { "$ref": "#/definitions/CompanyLookalikesLocation" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/company-types": { "get": { "security": [ { "Bearer": [] } ], "description": "Get company types", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get company types", "responses": { "200": { "description": "Company types", "schema": { "type": "array", "items": { "$ref": "#/definitions/CompanyTypeResponse" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/departments": { "get": { "security": [ { "Bearer": [] } ], "description": "Get the department values accepted by the leadDepartments filter, with display labels", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get lead department values", "responses": { "200": { "description": "Lead departments", "schema": { "type": "array", "items": { "$ref": "#/definitions/LabelValueItem" } } } } } }, "/filters/industries": { "get": { "security": [ { "Bearer": [] } ], "description": "Get industries", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get industries", "parameters": [ { "type": "string", "description": "Search query", "name": "search", "in": "query" }, { "type": "integer", "description": "Offset", "name": "offset", "in": "query", "required": true }, { "type": "integer", "description": "Limit", "name": "limit", "in": "query", "required": true } ], "responses": { "200": { "description": "Industries", "schema": { "type": "array", "items": { "$ref": "#/definitions/IndustryResponse" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/industries/suggestions": { "get": { "security": [ { "Bearer": [] } ], "description": "Get related industry suggestions based on currently selected industries", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get industry suggestions", "parameters": [ { "type": "string", "description": "Comma-separated current industries", "name": "current", "in": "query", "required": true }, { "type": "string", "description": "Comma-separated excluded industries", "name": "excluded", "in": "query" }, { "type": "integer", "default": 5, "description": "Max suggestions", "name": "limit", "in": "query" } ], "responses": { "200": { "description": "Suggestions", "schema": { "$ref": "#/definitions/SuggestionsResponse" } } } } }, "/filters/job-titles": { "get": { "security": [ { "Bearer": [] } ], "description": "Get job titles", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get job titles", "parameters": [ { "type": "string", "description": "Search query", "name": "search", "in": "query" }, { "type": "integer", "description": "Offset", "name": "offset", "in": "query", "required": true }, { "type": "integer", "description": "Limit", "name": "limit", "in": "query", "required": true } ], "responses": { "200": { "description": "Job Titles", "schema": { "type": "array", "items": { "$ref": "#/definitions/JobTitleResponse" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/job-titles/suggestions": { "get": { "security": [ { "Bearer": [] } ], "description": "Get related job title suggestions based on currently selected titles", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get job title suggestions", "parameters": [ { "type": "string", "description": "Comma-separated current job titles", "name": "current", "in": "query", "required": true }, { "type": "string", "description": "Comma-separated excluded job titles", "name": "excluded", "in": "query" }, { "type": "integer", "default": 5, "description": "Max suggestions", "name": "limit", "in": "query" } ], "responses": { "200": { "description": "Suggestions", "schema": { "$ref": "#/definitions/SuggestionsResponse" } } } } }, "/filters/keywords": { "get": { "security": [ { "Bearer": [] } ], "description": "Get keywords", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get keywords", "parameters": [ { "type": "string", "description": "Search query", "name": "search", "in": "query" }, { "type": "integer", "description": "Offset", "name": "offset", "in": "query", "required": true }, { "type": "integer", "description": "Limit", "name": "limit", "in": "query", "required": true } ], "responses": { "200": { "description": "Keywords", "schema": { "type": "array", "items": { "$ref": "#/definitions/KeywordResponse" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/languages": { "get": { "security": [ { "Bearer": [] } ], "description": "Get languages for filter dropdown", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get languages", "parameters": [ { "type": "string", "description": "Search query", "name": "search", "in": "query" }, { "type": "integer", "description": "Offset", "name": "offset", "in": "query", "required": true }, { "type": "integer", "description": "Limit", "name": "limit", "in": "query", "required": true } ], "responses": { "200": { "description": "Languages", "schema": { "type": "array", "items": { "$ref": "#/definitions/LanguageResponse" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/locations": { "get": { "security": [ { "Bearer": [] } ], "description": "Get locations", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get locations", "parameters": [ { "type": "string", "description": "Search query", "name": "search", "in": "query" }, { "type": "integer", "description": "Offset", "name": "offset", "in": "query", "required": true }, { "type": "integer", "description": "Limit", "name": "limit", "in": "query", "required": true } ], "responses": { "200": { "description": "Locations", "schema": { "type": "array", "items": { "$ref": "#/definitions/LocationResponse" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/locations/suggestions": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Resolve a location string (e.g. a foreign or misspelled region name) to canonical location tokens that work in the leadLocations filter. Returns region-level suggestions ranked by relevance; only tokens that actually match people are returned. Use this to normalize location values before POST /search or POST /search/count instead of guessing a token that silently matches nothing.", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Suggest locations", "parameters": [ { "type": "string", "description": "Location string to resolve (e.g. \\", "name": "search", "in": "query", "required": true }, { "type": "integer", "default": 5, "description": "Max suggestions", "name": "limit", "in": "query" } ], "responses": { "200": { "description": "Location suggestions", "schema": { "$ref": "#/definitions/LocationSuggestionsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/niches": { "get": { "security": [ { "Bearer": [] } ], "description": "Get niches - the finer segmentation layer below industries", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get niches", "parameters": [ { "type": "string", "description": "Search query", "name": "search", "in": "query" }, { "type": "integer", "description": "Offset", "name": "offset", "in": "query", "required": true }, { "type": "integer", "description": "Limit", "name": "limit", "in": "query", "required": true } ], "responses": { "200": { "description": "Niches", "schema": { "type": "array", "items": { "$ref": "#/definitions/NicheResponse" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/niches/suggestions": { "get": { "security": [ { "Bearer": [] } ], "description": "Get related niche suggestions based on currently selected niches", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get niche suggestions", "parameters": [ { "type": "string", "description": "Comma-separated current niches", "name": "current", "in": "query", "required": true }, { "type": "string", "description": "Comma-separated excluded niches", "name": "excluded", "in": "query" }, { "type": "integer", "default": 5, "description": "Max suggestions", "name": "limit", "in": "query" } ], "responses": { "200": { "description": "Suggestions", "schema": { "$ref": "#/definitions/SuggestionsResponse" } } } } }, "/filters/revenue-ranges": { "get": { "security": [ { "Bearer": [] } ], "description": "Get revenue ranges", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get revenue ranges", "responses": { "200": { "description": "Revenue Ranges", "schema": { "type": "array", "items": { "$ref": "#/definitions/RevenueRangeResponse" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/seniorities": { "get": { "security": [ { "Bearer": [] } ], "description": "Get the seniority values accepted by the leadSeniorities filter, with display labels", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get lead seniority values", "responses": { "200": { "description": "Lead seniorities", "schema": { "type": "array", "items": { "$ref": "#/definitions/LabelValueItem" } } } } } }, "/filters/signals/acquisitions/verification-statuses": { "get": { "security": [ { "Bearer": [] } ], "description": "Get the list of verification statuses for acquisition signal filters", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get acquisition verification statuses", "responses": { "200": { "description": "Acquisition verification statuses", "schema": { "type": "array", "items": { "$ref": "#/definitions/SignalFilterValueResponse" } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/signals/categories": { "get": { "security": [ { "Bearer": [] } ], "description": "Get the list of valid company category values for signal filters", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get funding signal categories", "responses": { "200": { "description": "Company categories", "schema": { "type": "array", "items": { "$ref": "#/definitions/SignalFilterValueResponse" } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/signals/hiring/applicants": { "get": { "security": [ { "Bearer": [] } ], "description": "Get the list of applicant-count buckets for hiring signal filters", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get hiring signal applicant ranges", "responses": { "200": { "description": "Hiring applicant ranges", "schema": { "type": "array", "items": { "$ref": "#/definitions/SignalFilterValueResponse" } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/signals/industries": { "get": { "security": [ { "Bearer": [] } ], "description": "Get the list of valid company industry values for signal filters", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get funding signal industries", "responses": { "200": { "description": "Company industries", "schema": { "type": "array", "items": { "$ref": "#/definitions/SignalFilterValueResponse" } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/signals/investors/types": { "get": { "security": [ { "Bearer": [] } ], "description": "Get the list of investor types for signal filters", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get investor signal types", "responses": { "200": { "description": "Investor types", "schema": { "type": "array", "items": { "$ref": "#/definitions/SignalFilterValueResponse" } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/signals/job-changes/departments": { "get": { "security": [ { "Bearer": [] } ], "description": "Get the list of curated departments for job change signal filters", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get job change departments", "responses": { "200": { "description": "Job change departments", "schema": { "type": "array", "items": { "$ref": "#/definitions/SignalFilterValueResponse" } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/signals/job-changes/positions": { "get": { "security": [ { "Bearer": [] } ], "description": "Get the list of curated positions for job change signal filters", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get job change positions", "responses": { "200": { "description": "Job change positions", "schema": { "type": "array", "items": { "$ref": "#/definitions/SignalFilterValueResponse" } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/signals/job-changes/seniorities": { "get": { "security": [ { "Bearer": [] } ], "description": "Get the list of seniority levels for job change signal filters", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get job change seniorities", "responses": { "200": { "description": "Job change seniorities", "schema": { "type": "array", "items": { "$ref": "#/definitions/SignalFilterValueResponse" } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/signals/locations": { "get": { "security": [ { "Bearer": [] } ], "description": "Get the static list of ISO countries (code + name) for signal filters", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get signal locations", "responses": { "200": { "description": "Locations", "schema": { "type": "array", "items": { "$ref": "#/definitions/LocationResponse" } } } } } }, "/filters/signals/round-flavors": { "get": { "security": [ { "Bearer": [] } ], "description": "Get the list of valid funding round flavor values for signal filters", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get funding signal round flavors", "responses": { "200": { "description": "Funding round flavors", "schema": { "type": "array", "items": { "$ref": "#/definitions/SignalFilterValueResponse" } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/signals/rounds": { "get": { "security": [ { "Bearer": [] } ], "description": "Get the list of valid funding round values for signal filters", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get funding signal rounds", "responses": { "200": { "description": "Funding rounds", "schema": { "type": "array", "items": { "$ref": "#/definitions/SignalFilterValueResponse" } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/signals/subcategories": { "get": { "security": [ { "Bearer": [] } ], "description": "Get the list of valid company subcategory values for signal filters", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get funding signal subcategories", "responses": { "200": { "description": "Company subcategories", "schema": { "type": "array", "items": { "$ref": "#/definitions/SignalFilterValueResponse" } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/technologies": { "get": { "security": [ { "Bearer": [] } ], "description": "Get technologies", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get technologies", "parameters": [ { "type": "string", "description": "Search query", "name": "search", "in": "query" }, { "type": "integer", "description": "Offset", "name": "offset", "in": "query", "required": true }, { "type": "integer", "description": "Limit", "name": "limit", "in": "query", "required": true } ], "responses": { "200": { "description": "Technologies", "schema": { "type": "array", "items": { "$ref": "#/definitions/TechnologyResponse" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters/technologies/suggestions": { "get": { "security": [ { "Bearer": [] } ], "description": "Get related technology suggestions based on currently selected technologies", "produces": [ "application/json" ], "tags": [ "filters" ], "summary": "Get technology suggestions", "parameters": [ { "type": "string", "description": "Comma-separated current technologies", "name": "current", "in": "query", "required": true }, { "type": "string", "description": "Comma-separated excluded technologies", "name": "excluded", "in": "query" }, { "type": "integer", "default": 5, "description": "Max suggestions", "name": "limit", "in": "query" } ], "responses": { "200": { "description": "Suggestions", "schema": { "$ref": "#/definitions/SuggestionsResponse" } } } } }, "/images/{token}": { "get": { "description": "Decrypts the capability token and streams the upstream image. Raster types only (jpeg, png, webp, gif).", "produces": [ "image/jpeg", "image/png", "image/webp", "image/gif" ], "tags": [ "images" ], "summary": "Proxy an external image", "parameters": [ { "type": "string", "description": "Encrypted image token", "name": "token", "in": "path", "required": true } ], "responses": { "200": { "description": "Image bytes", "schema": { "type": "file" } }, "404": { "description": "Token invalid or image unservable" }, "502": { "description": "Upstream image host unavailable" } } } }, "/internal/accounts/{accountID}/approve-purchasing": { "post": { "description": "Clear an account refused by the new-account purchase gate, so it can complete the purchase it was refused, and lift the freeze that came with the refusal. This is the only way out of a denial - nothing expires automatically - and it also records that a human has looked, so the gate will not refuse the account again. The Slack alert carries a button that does the same thing; this endpoint is the fallback where Slack interactivity is not configured. Approving an account that was never refused is safe: it clears the account in advance.", "produces": [ "application/json" ], "tags": [ "accounts" ], "summary": "Approve purchasing for an account", "parameters": [ { "type": "string", "description": "Account ID", "name": "accountID", "in": "path", "required": true } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/internal/accounts/{accountID}/freeze": { "post": { "description": "Stop an account spending credits on a human's decision rather than a fraud signal. The account keeps working otherwise - it can log in, browse and export what it already produced. Use this rather than a raw database update: it also sets the cached flag the enrichment row tasks read, so a run already holding an upfront credit reservation stops too. It applies regardless of FRAUD_GUARD_ENFORCEMENT_ENABLED, overrides an earlier unfreeze, and is a no-op on an already-frozen account.", "produces": [ "application/json" ], "tags": [ "accounts" ], "summary": "Freeze an account", "parameters": [ { "type": "string", "description": "Account ID", "name": "accountID", "in": "path", "required": true } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/internal/accounts/{accountID}/revoke-purchasing-approval": { "post": { "description": "Take back an approval granted in error, so the account meets the new-account purchase gate again on its next purchase. It does not refuse anything by itself: an account that is past its first hour, or buying below the gated tier, is unaffected. Revoking an approval the account never had is safe.", "produces": [ "application/json" ], "tags": [ "accounts" ], "summary": "Revoke purchasing approval for an account", "parameters": [ { "type": "string", "description": "Account ID", "name": "accountID", "in": "path", "required": true } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/internal/accounts/{accountID}/unfreeze": { "post": { "description": "Lift a credit-spending freeze. This is the only way out of a freeze - nothing automatic unfreezes - and it also records that a human has reviewed the account, so a replayed fraud signal cannot freeze it again. Unfreezing an account that is not frozen is a no-op.", "produces": [ "application/json" ], "tags": [ "accounts" ], "summary": "Unfreeze an account", "parameters": [ { "type": "string", "description": "Account ID", "name": "accountID", "in": "path", "required": true } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/internal/company-followers/{listID}/resume": { "post": { "description": "Admin-only endpoint to resume/downloading followers from an existing Enrich request", "produces": [ "application/json" ], "tags": [ "internal" ], "summary": "(internal) Resume company followers search", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "description": "Request payload", "name": "request", "in": "body", "schema": { "$ref": "#/definitions/resumeCompanyFollowersRequest" } } ], "responses": { "202": { "description": "Resume started" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/internal/enrichment-lookup": { "post": { "description": "Return per-account email/phone status (found/not_found) for the given LinkedIn URLs.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "enrichment" ], "summary": "Look up enriched contacts by URL", "parameters": [ { "description": "Account and LinkedIn URLs", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/EnrichmentLookupRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EnrichmentLookupResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/internal/enrichments/{externalID}/seed-rows": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Create or update the list by externalID and seed enrichment rows directly from uploaded contacts. No search is performed.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "enrichment" ], "summary": "Seed enrichment rows (external)", "parameters": [ { "type": "string", "description": "External ID", "name": "externalID", "in": "path", "required": true }, { "description": "Seed enrichment rows request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SeedEnrichmentRowsExternalRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/SeedEnrichmentRowsExternalResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/internal/enrichments/{externalID}/sse": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "SSE stream with enrichment progress updates for internal clients", "produces": [ "text/event-stream" ], "tags": [ "enrichment" ], "summary": "SSE Internal Enrichment Updates", "parameters": [ { "type": "string", "description": "External ID", "name": "externalID", "in": "path", "required": true } ], "responses": { "200": { "description": "SSE Internal Enrichment Updates", "schema": { "type": "array", "items": { "type": "object" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/internal/lookalikes/{listID}/restart": { "post": { "security": [ { "ApiSecret": [] } ], "description": "Resets company lookalikes search state so it can be started again", "produces": [ "application/json" ], "tags": [ "lists" ], "summary": "Restart company lookalikes search (internal)", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true } ], "responses": { "200": { "description": "Restarted" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lists": { "get": { "security": [ { "Bearer": [] } ], "description": "Get previews of lists created by the user (for sidebar)", "produces": [ "application/json" ], "tags": [ "lists" ], "summary": "Get list previews", "parameters": [ { "type": "string", "description": "Search query", "name": "search", "in": "query" }, { "type": "integer", "description": "Offset", "name": "offset", "in": "query", "required": true }, { "type": "integer", "description": "Limit", "name": "limit", "in": "query", "required": true } ], "responses": { "200": { "description": "List previews", "schema": { "type": "array", "items": { "$ref": "#/definitions/GetListsResponse" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "security": [ { "Bearer": [] } ], "description": "Creates a new list", "produces": [ "application/json" ], "tags": [ "lists" ], "summary": "Create a new list", "responses": { "200": { "description": "Created List", "schema": { "$ref": "#/definitions/ListResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lists/{listID}": { "get": { "security": [ { "Bearer": [] } ], "description": "Get a list by ID", "produces": [ "application/json" ], "tags": [ "lists" ], "summary": "Get list", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true } ], "responses": { "200": { "description": "List", "schema": { "$ref": "#/definitions/ListResponse" } }, "404": { "description": "List Not Found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "security": [ { "Bearer": [] } ], "description": "Delete a list by ID", "tags": [ "lists" ], "summary": "Delete a list", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "patch": { "security": [ { "Bearer": [] } ], "description": "Update an existing list", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lists" ], "summary": "Update a list", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "description": "Updated Fields", "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateListRequest" } } ], "responses": { "200": { "description": "Updated List", "schema": { "$ref": "#/definitions/ListResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lists/{listID}/company-file/job": { "get": { "security": [ { "Bearer": [] } ], "description": "Returns the most recent matching job for the list, including the full set of\nidentifiers that matched no company. This is the reload path: progress is pushed over\nSSE, but a user who refreshes the page reads the same state back here.\nA list nobody uploaded a file for has no job yet and the body is null.", "produces": [ "application/json" ], "tags": [ "lists" ], "summary": "Get the latest company CSV matching job", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true } ], "responses": { "200": { "description": "The latest job, or null when the list has none", "schema": { "$ref": "#/definitions/CompanyFileJobResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lists/{listID}/company-file/process": { "post": { "security": [ { "Bearer": [] } ], "description": "Extracts company identifiers (domain and/or LinkedIn URL) from the mapped columns and\nqueues a background job that resolves them to company IDs against the search index and\nappends those IDs to the list's CompanyIDs filter (Include or Exclude). The job is\nreturned immediately; follow its progress over SSE or by polling the job endpoint.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lists" ], "summary": "Process uploaded company CSV file", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "description": "File processing options", "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProcessCompanyFileRequest" } } ], "responses": { "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/CompanyFileJobResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "A matching job is already running for this account", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lists/{listID}/company-file/sse": { "get": { "security": [ { "Bearer": [] } ], "description": "Streams company file matching progress for the authenticated user.", "produces": [ "text/event-stream" ], "tags": [ "lists" ], "summary": "Company file matching job updates (SSE)", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true } ], "responses": { "200": { "description": "SSE company file job updates", "schema": { "type": "array", "items": { "type": "object" } } } } } }, "/lists/{listID}/company-file/template": { "get": { "security": [ { "Bearer": [] } ], "description": "Returns a CSV template with expected column headers for company upload", "produces": [ "text/csv" ], "tags": [ "lists" ], "summary": "Download company CSV template", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true } ], "responses": { "200": { "description": "CSV template", "schema": { "type": "file" } } } } }, "/lists/{listID}/company-file/upload": { "post": { "security": [ { "Bearer": [] } ], "description": "Accepts a CSV file and returns parsed column headers for mapping", "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "tags": [ "lists" ], "summary": "Upload company CSV file", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "type": "file", "description": "CSV file with company identifiers", "name": "file", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CompanyFileUploadResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lists/{listID}/company-followers/count-estimate": { "get": { "security": [ { "Bearer": [] } ], "description": "Get the current status of a company followers count estimation", "produces": [ "application/json" ], "tags": [ "lists" ], "summary": "Get count estimation status", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true } ], "responses": { "200": { "description": "Count estimation status", "schema": { "$ref": "#/definitions/CountEstimationResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "security": [ { "Bearer": [] } ], "description": "Start an async count estimation for company followers with filters", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lists" ], "summary": "Start count estimation for company followers", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "description": "Filter parameters", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CountEstimationRequest" } } ], "responses": { "202": { "description": "Count estimation started", "schema": { "$ref": "#/definitions/CountEstimationResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lists/{listID}/company-followers/search": { "post": { "security": [ { "Bearer": [] } ], "description": "Search company followers for the list", "produces": [ "application/json" ], "tags": [ "lists" ], "summary": "Search company followers", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true } ], "responses": { "200": { "description": "Searched" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lists/{listID}/company-followers/status": { "get": { "security": [ { "Bearer": [] } ], "description": "Get the status of the company followers search", "produces": [ "application/json" ], "tags": [ "lists" ], "summary": "Get company followers search status", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true } ], "responses": { "200": { "description": "Company followers search status", "schema": { "$ref": "#/definitions/CompanyFollowersStatus" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lists/{listID}/company-lookalikes/preview": { "get": { "security": [ { "Bearer": [] } ], "description": "Get the preview of the company lookalikes", "produces": [ "application/json" ], "tags": [ "lists" ], "summary": "Get company lookalikes preview", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true } ], "responses": { "200": { "description": "Company lookalikes preview", "schema": { "$ref": "#/definitions/CompanyLookalikesPreviews" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lists/{listID}/company-lookalikes/search": { "post": { "security": [ { "Bearer": [] } ], "description": "Search company lookalikes for the list", "produces": [ "application/json" ], "tags": [ "lists" ], "summary": "Search company lookalikes", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true } ], "responses": { "200": { "description": "Searched" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lists/{listID}/company-lookalikes/status": { "get": { "security": [ { "Bearer": [] } ], "description": "Get the status of the company lookalikes search", "produces": [ "application/json" ], "tags": [ "lists" ], "summary": "Get company lookalikes search status", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true } ], "responses": { "200": { "description": "Company lookalikes search status", "schema": { "$ref": "#/definitions/CompanyLookalikesStatus" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Search failed", "schema": { "$ref": "#/definitions/CompanyLookalikesStatus" } } } } }, "/lists/{listID}/contacts": { "get": { "security": [ { "Bearer": [] } ], "description": "List contacts found for list filters", "produces": [ "application/json" ], "tags": [ "lists" ], "summary": "List page contacts", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "type": "string", "description": "Pagination cursor", "name": "cursor", "in": "query" }, { "type": "integer", "description": "Contacts per page (1-100, default 20)", "name": "size", "in": "query" } ], "responses": { "200": { "description": "Contacts", "schema": { "$ref": "#/definitions/ListContactsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "410": { "description": "Cursor expired or invalid", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lists/{listID}/contacts/count": { "get": { "security": [ { "Bearer": [] } ], "description": "Get count of contacts available for list filters", "produces": [ "application/json" ], "tags": [ "lists" ], "summary": "Get list contact count", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true } ], "responses": { "200": { "description": "Contact Count", "schema": { "$ref": "#/definitions/GetListContactCountResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lists/{listID}/contacts/csv": { "post": { "security": [ { "Bearer": [] } ], "description": "Export preview to CSV", "produces": [ "text/plain" ], "tags": [ "exports" ], "summary": "Export preview to CSV", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "description": "Export CSV request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ExportContactsCSVRequest" } } ], "responses": { "200": { "description": "CSV file", "schema": { "type": "string" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lists/{listID}/enrich": { "post": { "security": [ { "Bearer": [] } ], "description": "Initiate enrichment from list", "produces": [ "application/json" ], "tags": [ "enrichment" ], "summary": "Initiate enrichment from list", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "description": "Enrich list request", "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/EnrichListRequest" } } ], "responses": { "200": { "description": "Queued", "schema": { "$ref": "#/definitions/InternalEnrichmentResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lists/{listID}/expand-filters": { "post": { "security": [ { "Bearer": [] } ], "description": "Expand filter categories with AI-generated suggestions", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lists" ], "summary": "Expand filters", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "description": "Categories to expand", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ExpandFiltersRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ListResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lists/{listID}/messages/{messageID}": { "get": { "security": [ { "Bearer": [] } ], "description": "Get a system message by ID", "produces": [ "application/json" ], "tags": [ "messages" ], "summary": "Get system message", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "type": "string", "description": "Message ID", "name": "messageID", "in": "path", "required": true } ], "responses": { "200": { "description": "Message", "schema": { "$ref": "#/definitions/GetSystemMessageResponse" } }, "404": { "description": "Message Not Found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lists/{listID}/messages/{messageID}/actions/{actionID}": { "put": { "security": [ { "Bearer": [] } ], "description": "Handles user action selection", "produces": [ "application/json" ], "tags": [ "messages" ], "summary": "Handle action selection", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "type": "string", "description": "Message ID", "name": "messageID", "in": "path", "required": true }, { "type": "string", "description": "Action ID", "name": "actionID", "in": "path", "required": true } ], "responses": { "200": { "description": "System response", "schema": { "$ref": "#/definitions/HandleUserReplyResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lists/{listID}/path/{path}/select": { "post": { "security": [ { "Bearer": [] } ], "description": "Select a path for the list", "produces": [ "application/json" ], "tags": [ "lists" ], "summary": "Select a path", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "type": "string", "description": "Path", "name": "path", "in": "path", "required": true } ], "responses": { "200": { "description": "Selected" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lists/{listID}/reply": { "post": { "security": [ { "Bearer": [] } ], "description": "Creates a new user message and handles the input", "produces": [ "application/json" ], "tags": [ "lists" ], "summary": "Handle user response", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "description": "User Response", "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserReplyRequest" } } ], "responses": { "200": { "description": "System response", "schema": { "$ref": "#/definitions/HandleUserReplyResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lists/{listID}/signals/companies": { "get": { "security": [ { "Bearer": [] } ], "description": "Paginated matched companies from the latest completed extraction, with include/total counts and a hasMore flag.", "produces": [ "application/json" ], "tags": [ "signals" ], "summary": "List matched signal companies", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "type": "integer", "description": "Pagination offset", "name": "offset", "in": "query" }, { "type": "integer", "description": "Page size (1-100)", "name": "limit", "in": "query", "required": true } ], "responses": { "200": { "description": "Matched companies page", "schema": { "$ref": "#/definitions/ListSignalCompaniesResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "patch": { "security": [ { "Bearer": [] } ], "description": "Toggle includeInFilter on a single matched company (every signal row matched to it).", "consumes": [ "application/json" ], "tags": [ "signals" ], "summary": "Update a matched signal company", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "description": "Company ID and fields to update", "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateSignalCompanyRequest" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lists/{listID}/signals/companies/bulk": { "patch": { "security": [ { "Bearer": [] } ], "description": "Apply includeInFilter to every matched company on the latest completed extraction job.", "consumes": [ "application/json" ], "tags": [ "signals" ], "summary": "Bulk update matched signal companies", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true }, { "description": "Fields to apply to all matched companies", "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BulkUpdateSignalCompaniesRequest" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lists/{listID}/signals/count": { "get": { "security": [ { "Bearer": [] } ], "description": "Count mode query — returns total matching signals without consuming provider credits", "produces": [ "application/json" ], "tags": [ "signals" ], "summary": "Get signal count", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true } ], "responses": { "200": { "description": "Total count", "schema": { "$ref": "#/definitions/SignalCountResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lists/{listID}/signals/search": { "post": { "security": [ { "Bearer": [] } ], "description": "Start async signal extraction using the list's configured signal filters", "produces": [ "application/json" ], "tags": [ "signals" ], "summary": "Trigger signal extraction", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true } ], "responses": { "202": { "description": "Extraction started" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "402": { "description": "Payment Required", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lists/{listID}/signals/status": { "get": { "security": [ { "Bearer": [] } ], "description": "Poll extraction progress — returns job status and counter fields", "produces": [ "application/json" ], "tags": [ "signals" ], "summary": "Get signal extraction status", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true } ], "responses": { "200": { "description": "Extraction status", "schema": { "$ref": "#/definitions/ExtractionStatusResponse" } }, "404": { "description": "No extraction job for list", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lists/{listID}/skip-to-filters": { "post": { "security": [ { "Bearer": [] } ], "description": "Skip the conversation flow and go directly to filters for manual editing", "produces": [ "application/json" ], "tags": [ "lists" ], "summary": "Skip to filters", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ListResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lookalikes/filters/departments": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get list of available department values for filtering", "produces": [ "application/json" ], "tags": [ "lookalikes" ], "summary": "Get available departments", "responses": { "200": { "description": "Departments list", "schema": { "$ref": "#/definitions/DepartmentsResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lookalikes/filters/employee-ranges": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get list of available employee range values for filtering", "produces": [ "application/json" ], "tags": [ "lookalikes" ], "summary": "Get available employee ranges", "responses": { "200": { "description": "Employee ranges list", "schema": { "$ref": "#/definitions/EmployeeRangesResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lookalikes/filters/locations": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get list of country ISO 3166-1 alpha-2 codes and region IDs accepted by the locations filter on /lookalikes/search.", "produces": [ "application/json" ], "tags": [ "lookalikes" ], "summary": "Get available lookalikes locations", "responses": { "200": { "description": "Locations list", "schema": { "$ref": "#/definitions/LookalikesLocationsResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lookalikes/filters/seniorities": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get list of available seniority values for filtering", "produces": [ "application/json" ], "tags": [ "lookalikes" ], "summary": "Get available seniorities", "responses": { "200": { "description": "Seniorities list", "schema": { "$ref": "#/definitions/SenioritiesResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lookalikes/preview": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Free, uncharged preview of companies similar to the provided domains. Returns company metadata only (no credits, no people). To turn these into enrichable people, pass a returned company domain into POST /search companyDomains.include to get personIDs, then send those to /enrichment/*.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lookalikes" ], "summary": "Preview lookalike companies (free)", "parameters": [ { "description": "Preview request", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/LookalikesPreviewRequest" } } ], "responses": { "200": { "description": "Preview results", "schema": { "$ref": "#/definitions/LookalikesPreviewResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lookalikes/search": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Search for companies similar to the provided domains. Costs 1 credit per company returned. Credits are reserved before the search and charged based on actual results. Page max: 100, pageSize max: 100. To find and enrich people at these companies, pass a returned company domain into POST /search companyDomains.include to get personIDs, then send those to /enrichment/*. Use POST /lookalikes/preview for a free (uncharged) look first.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lookalikes" ], "summary": "Search lookalike companies", "parameters": [ { "description": "Search request", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/LookalikesSearchRequest" } }, { "type": "string", "description": "Idempotency key - a retried request with the same key returns the original result without charging credits again", "name": "Idempotency-Key", "in": "header" } ], "responses": { "200": { "description": "Search results", "schema": { "$ref": "#/definitions/LookalikesSearchResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "402": { "description": "Insufficient credits", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Idempotency conflict", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/Error" } } } } }, "/maps-discovery/enrich-owners": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Starts an async owner search for up to 200 businesses of one search job, looking for up to maxResults owners per business and the requested contact channels (email and/or phone). Credits are reserved for the upper bound (maps owner email/phone price x maxResults per business) and settled per contact found; a business with no owner costs nothing, and businesses enriched recently are served from cache at no cost. Owner contacts the maps providers miss are backfilled by the standard email/phone waterfall at the same price; consumedCredits on the job includes that backfill. Only one owner job per search runs at a time - a second one while the first is in progress is refused with 409. Businesses not found or not owned by the account are reported as skipped in the businesses list without failing the call. Supports the Idempotency-Key header and webhookURL as the search endpoint does. Webhook payload: jobID (string), status (completed|failed|no_results), searchJobID (string), total (int), processed (int), ownersFound (int), consumedCredits (number), error (string; present on failed jobs, and on completed jobs whose email/phone backfill stopped early for insufficient credits).", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "maps-discovery" ], "summary": "Enrich owners of local businesses", "parameters": [ { "type": "string", "description": "Idempotency key - if a job with this key already exists for this account, the existing job is returned as-is", "name": "Idempotency-Key", "in": "header" }, { "description": "Owner enrichment request", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/EnrichMapsOwnersRequest" } } ], "responses": { "202": { "description": "Job created", "schema": { "$ref": "#/definitions/MapsOwnerJobResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "402": { "description": "Insufficient credits", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Search job not found", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Owner enrichment already in progress for this search", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/maps-discovery/filters/categories": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get the curated list of Google Maps business categories the app offers. Recommended values for the search categories field; free text is accepted too.", "produces": [ "application/json" ], "tags": [ "maps-discovery" ], "summary": "Get recommended business categories", "responses": { "200": { "description": "Categories list", "schema": { "$ref": "#/definitions/MapsCategoriesResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } } } } }, "/maps-discovery/jobs": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "List the caller's local business search jobs, most recent first. Use the filters (status, clientRequestID, from/to) to recover a job when the job ID is unknown.", "produces": [ "application/json" ], "tags": [ "maps-discovery" ], "summary": "List maps search jobs", "parameters": [ { "type": "integer", "description": "Offset", "name": "offset", "in": "query" }, { "type": "integer", "description": "Page size (max 100)", "name": "limit", "in": "query", "required": true }, { "enum": [ "in_progress", "completed", "failed", "no_results" ], "type": "string", "description": "Filter by status", "name": "status", "in": "query" }, { "type": "string", "description": "Filter by your clientRequestID", "name": "clientRequestID", "in": "query" }, { "type": "string", "description": "Created-at lower bound (RFC3339)", "name": "from", "in": "query" }, { "type": "string", "description": "Created-at upper bound (RFC3339)", "name": "to", "in": "query" } ], "responses": { "200": { "description": "Jobs", "schema": { "$ref": "#/definitions/MapsSearchJobsListResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/maps-discovery/jobs/{jobID}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Fetch the status of a local business search job.", "produces": [ "application/json" ], "tags": [ "maps-discovery" ], "summary": "Get maps search job status", "parameters": [ { "type": "string", "description": "Job ID", "name": "jobID", "in": "path", "required": true } ], "responses": { "200": { "description": "Job status", "schema": { "$ref": "#/definitions/MapsSearchJobResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/maps-discovery/jobs/{jobID}/results": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Page the businesses found by the search job. Businesses are stored as the search progresses, so the page is readable while the job runs and is complete once the job status is completed.", "produces": [ "application/json" ], "tags": [ "maps-discovery" ], "summary": "List maps search results", "parameters": [ { "type": "string", "description": "Job ID", "name": "jobID", "in": "path", "required": true }, { "type": "integer", "description": "Offset (max 5000)", "name": "offset", "in": "query" }, { "type": "integer", "description": "Page size (max 200, default 50)", "name": "limit", "in": "query" } ], "responses": { "200": { "description": "Businesses", "schema": { "$ref": "#/definitions/MapsSearchJobResultsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/maps-discovery/owner-jobs": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "List the caller's owner enrichment jobs, most recent first. Use the filters (status, clientRequestID, from/to) to recover a job when the job ID is unknown.", "produces": [ "application/json" ], "tags": [ "maps-discovery" ], "summary": "List maps owner jobs", "parameters": [ { "type": "integer", "description": "Offset", "name": "offset", "in": "query" }, { "type": "integer", "description": "Page size (max 100)", "name": "limit", "in": "query", "required": true }, { "enum": [ "in_progress", "completed", "failed", "no_results" ], "type": "string", "description": "Filter by status", "name": "status", "in": "query" }, { "type": "string", "description": "Filter by your clientRequestID", "name": "clientRequestID", "in": "query" }, { "type": "string", "description": "Created-at lower bound (RFC3339)", "name": "from", "in": "query" }, { "type": "string", "description": "Created-at upper bound (RFC3339)", "name": "to", "in": "query" } ], "responses": { "200": { "description": "Jobs", "schema": { "$ref": "#/definitions/MapsOwnerJobsListResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/maps-discovery/owner-jobs/{jobID}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Fetch the status of an owner enrichment job. While in progress, processed counts the businesses whose owner search has finished.", "produces": [ "application/json" ], "tags": [ "maps-discovery" ], "summary": "Get maps owner job status", "parameters": [ { "type": "string", "description": "Job ID", "name": "jobID", "in": "path", "required": true } ], "responses": { "200": { "description": "Job status", "schema": { "$ref": "#/definitions/MapsOwnerJobResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/maps-discovery/owner-jobs/{jobID}/results": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Page the owners found for the job's businesses, each carrying the businessID it belongs to. Owners are added as each business's search finishes, so the page is readable while the job runs; email/phone statuses settle once the job status is completed.", "produces": [ "application/json" ], "tags": [ "maps-discovery" ], "summary": "List maps owner results", "parameters": [ { "type": "string", "description": "Job ID", "name": "jobID", "in": "path", "required": true }, { "type": "integer", "description": "Offset", "name": "offset", "in": "query" }, { "type": "integer", "description": "Page size (max 200, default 50)", "name": "limit", "in": "query" } ], "responses": { "200": { "description": "Owner leads", "schema": { "$ref": "#/definitions/MapsOwnerJobResultsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/maps-discovery/search": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Starts an async Google Maps search for businesses of the given categories within radiusKm of the coordinates. Credits are reserved for the limit (maps discovery price per business) and settled for the businesses actually found. Supports idempotency via the Idempotency-Key header (a repeat with the same key returns the existing job) and webhook notifications via webhookURL (POST with JSON body on completion or failure, retried up to 10 times with exponential backoff, 2xx = success). Webhook payload: jobID (string), status (completed|failed|no_results), foundCount (int), limit (int), consumedCredits (number), error (string, failure only). The search creates a list named \"Public API: Local Businesses\" in the app.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "maps-discovery" ], "summary": "Search local businesses on Google Maps", "parameters": [ { "type": "string", "description": "Idempotency key - if a job with this key already exists for this account, the existing job is returned as-is, use a new key to start a new search", "name": "Idempotency-Key", "in": "header" }, { "description": "Search request", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/StartMapsDiscoverySearchRequest" } } ], "responses": { "202": { "description": "Job created", "schema": { "$ref": "#/definitions/MapsSearchJobResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "402": { "description": "Insufficient credits", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/me": { "get": { "security": [ { "Bearer": [] } ], "description": "Get logged in user and account information", "produces": [ "application/json" ], "tags": [ "users" ], "summary": "Get me", "responses": { "200": { "description": "User and account information", "schema": { "$ref": "#/definitions/GetMeResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/me/salesforge/account-is-active": { "get": { "description": "Get if the salesforge account is active", "produces": [ "application/json" ], "tags": [ "users" ], "summary": "Get salesforge account is active", "responses": { "200": { "description": "Salesforge account is active", "schema": { "$ref": "#/definitions/GetSalesforgeAccountIsActiveResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/search": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Search leads. Accepts the full person filter set. Beyond the documented fields the body also accepts exclusion filters to skip contacts you already own: excludeEmails ([]string), excludeDomains ([]string), excludeLinkedInURLs ([]string). Use companyDomains.include to target specific companies (e.g. domains returned by /lookalikes/preview or /lookalikes/search). Free-text fields (jobTitles, leadLocations, companyLocations, technologies, keywords, companyNames) accept any value (casing and partial terms are matched), so there is no value list to fetch. Controlled fields must use exact values from their discovery endpoints under /search/filters (industries, seniorities, departments, companyTypes, fundingTypes, revenueRanges).", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "search" ], "summary": "Search", "parameters": [ { "type": "string", "description": "Cursor", "name": "cursor", "in": "query" }, { "description": "Search request", "name": "search", "in": "body", "schema": { "$ref": "#/definitions/PersonSearchRequest" } } ], "responses": { "200": { "description": "Search response", "schema": { "$ref": "#/definitions/SearchResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "410": { "description": "Cursor expired or invalid, or the search has returned the maximum number of results - start a new search with narrower filters", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/search/count": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Count leads matching a filter set. Accepts the same filter payload as POST /search except the limit field, and returns the total number of matches without paginating results. Useful for sizing the audience before launching a search.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "search" ], "summary": "Count search results", "parameters": [ { "description": "Search filters", "name": "search", "in": "body", "schema": { "$ref": "#/definitions/PersonSearchFilters" } } ], "responses": { "200": { "description": "Count response", "schema": { "$ref": "#/definitions/SearchCountResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/search/filters/company-types": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get the company type values accepted by companyTypes on /search.", "produces": [ "application/json" ], "tags": [ "search" ], "summary": "Get search company types", "responses": { "200": { "description": "Company types", "schema": { "type": "array", "items": { "$ref": "#/definitions/CompanyTypeResponse" } } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } } } } }, "/search/filters/departments": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get the department values accepted by leadDepartments on /search.", "produces": [ "application/json" ], "tags": [ "search" ], "summary": "Get search departments", "responses": { "200": { "description": "Departments list", "schema": { "$ref": "#/definitions/DepartmentsResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } } } } }, "/search/filters/funding-types": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get the funding type values accepted by companyFundingRounds on /search.", "produces": [ "application/json" ], "tags": [ "search" ], "summary": "Get search funding types", "responses": { "200": { "description": "Funding types", "schema": { "type": "array", "items": { "$ref": "#/definitions/FundingTypeResponse" } } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } } } } }, "/search/filters/industries": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Search the industry filter values accepted by companyIndustries on /search. These are exact, case-sensitive values, send them verbatim.", "produces": [ "application/json" ], "tags": [ "search" ], "summary": "Get search industries", "parameters": [ { "type": "string", "description": "Search query", "name": "search", "in": "query" }, { "type": "integer", "description": "Offset", "name": "offset", "in": "query" }, { "type": "integer", "description": "Limit (1-100)", "name": "limit", "in": "query", "required": true } ], "responses": { "200": { "description": "Industries", "schema": { "type": "array", "items": { "$ref": "#/definitions/IndustryResponse" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/search/filters/revenue-ranges": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get the revenue range values accepted by companyRevenueRanges on /search.", "produces": [ "application/json" ], "tags": [ "search" ], "summary": "Get search revenue ranges", "responses": { "200": { "description": "Revenue ranges", "schema": { "$ref": "#/definitions/RevenueRangesResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } } } } }, "/search/filters/seniorities": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get the seniority values accepted by leadSeniorities on /search.", "produces": [ "application/json" ], "tags": [ "search" ], "summary": "Get search seniorities", "responses": { "200": { "description": "Seniorities list", "schema": { "$ref": "#/definitions/SenioritiesResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too Many Requests", "schema": { "$ref": "#/definitions/Error" } } } } }, "/v1/maps-discovery/businesses/enrich-owners": { "post": { "security": [ { "Bearer": [] } ], "description": "Reserves credits and submits an async owner enrichment job per business. Per-business failures are reported in the result list without failing the whole batch.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "maps-discovery" ], "summary": "Enrich owners for selected Maps businesses", "parameters": [ { "description": "Enrichment request", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/EnrichBusinessOwnersRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EnrichBusinessOwnersResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "402": { "description": "Insufficient credits", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Enrichment already in progress for this list", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/v1/maps-discovery/enrichment-jobs/sse": { "get": { "security": [ { "Bearer": [] } ], "description": "Streams owner enrichment job lifecycle updates for the authenticated user.", "produces": [ "text/event-stream" ], "tags": [ "maps-discovery" ], "summary": "Owner Enrichment job updates (SSE)", "responses": { "200": { "description": "SSE Owner Enrichment Updates", "schema": { "type": "array", "items": { "type": "object" } } } } } }, "/v1/maps-discovery/enrichment-jobs/{requestID}/cancel": { "post": { "security": [ { "Bearer": [] } ], "produces": [ "application/json" ], "tags": [ "maps-discovery" ], "summary": "Cancel an owner enrichment job", "parameters": [ { "type": "string", "description": "Enrichment job request id", "name": "requestID", "in": "path", "required": true } ], "responses": { "204": { "description": "Cancelled" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } } } } }, "/v1/maps-discovery/lists/{listID}/export/csv": { "get": { "security": [ { "Bearer": [] } ], "description": "Streams the businesses discovered for the list (name, phone, website, address, category, rating, reviews) as CSV, so the user can export right after extraction without running owner enrichment. Free - the discovery charge already applied, no enrichment cost.", "produces": [ "text/csv" ], "tags": [ "maps-discovery" ], "summary": "Export a maps list's businesses to CSV", "parameters": [ { "type": "string", "description": "List ID", "name": "listID", "in": "path", "required": true } ], "responses": { "200": { "description": "CSV file", "schema": { "type": "string" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/v1/maps-discovery/lists/{listID}/search": { "get": { "security": [ { "Bearer": [] } ], "description": "Returns the list's latest search parameters (location, radius, category) and status so the map can be re-rendered on reopen. Businesses are paged via the results endpoint using the returned request_id.\nA list with no search of its own - never searched on, or belonging to another account - gets a null body.", "produces": [ "application/json" ], "tags": [ "maps-discovery" ], "summary": "Get the current search for a Maps Discovery list", "parameters": [ { "type": "string", "description": "Maps discovery list id", "name": "listID", "in": "path", "required": true } ], "responses": { "200": { "description": "The latest search, or null when the list has none", "schema": { "$ref": "#/definitions/MapsListSearchResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } } } } }, "/v1/maps-discovery/search": { "post": { "security": [ { "Bearer": [] } ], "description": "Reserves credits and submits an async Google Maps search for the configured radius and categories (OR-combined).", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "maps-discovery" ], "summary": "Start a Maps Discovery search", "parameters": [ { "description": "Search parameters", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/StartMapsSearchRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/StartMapsSearchResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "402": { "description": "Insufficient credits", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/v1/maps-discovery/search/sse": { "get": { "security": [ { "Bearer": [] } ], "description": "Streams maps discovery job lifecycle updates for the authenticated user.", "produces": [ "text/event-stream" ], "tags": [ "maps-discovery" ], "summary": "Maps Discovery job updates (SSE)", "responses": { "200": { "description": "SSE Maps Discovery Updates", "schema": { "type": "array", "items": { "type": "object" } } } } } }, "/v1/maps-discovery/search/{requestID}/cancel": { "post": { "security": [ { "Bearer": [] } ], "produces": [ "application/json" ], "tags": [ "maps-discovery" ], "summary": "Cancel a Maps Discovery search", "parameters": [ { "type": "string", "description": "Search request id", "name": "requestID", "in": "path", "required": true } ], "responses": { "204": { "description": "Cancelled" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } } } } }, "/v1/maps-discovery/search/{requestID}/results": { "get": { "security": [ { "Bearer": [] } ], "produces": [ "application/json" ], "tags": [ "maps-discovery" ], "summary": "List Maps Discovery search results", "parameters": [ { "type": "string", "description": "Search request id", "name": "requestID", "in": "path", "required": true }, { "type": "integer", "default": 0, "description": "Pagination offset", "name": "offset", "in": "query" }, { "type": "integer", "default": 50, "description": "Page size", "name": "limit", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MapsSearchResultsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } } } } } }, "definitions": { "AccountRole": { "type": "string", "enum": [ "admin", "member" ], "x-enum-varnames": [ "AccountRoleAdmin", "AccountRoleMember" ] }, "AccountUserResponse": { "type": "object", "properties": { "createdAt": { "type": "string" }, "email": { "type": "string" }, "exportCreditsLimit": { "type": "number" }, "exportCreditsUsed": { "type": "number" }, "firstName": { "type": "string" }, "id": { "type": "string" }, "lastName": { "type": "string" }, "role": { "$ref": "#/definitions/AccountRole" } } }, "ActionSelectionMode": { "type": "string", "enum": [ "single", "suggestion", "custom" ], "x-enum-varnames": [ "ActionSelectionModeSingle", "ActionSelectionModeSuggestion", "ActionSelectionModeCustom" ] }, "AgentPayload": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" }, "workspaceUrl": { "type": "string" } } }, "AnyAllFilter": { "type": "object", "properties": { "all": { "type": "array", "items": { "type": "string" } }, "any": { "type": "array", "items": { "type": "string" } } } }, "AutocompleteCompanyResponse": { "type": "object", "properties": { "domain": { "type": "string" }, "logo": { "type": "string" }, "name": { "type": "string" } } }, "BillingPeriod": { "type": "string", "enum": [ "monthly", "yearly" ], "x-enum-varnames": [ "BillingPeriodMonthly", "BillingPeriodYearly" ] }, "BulkDeleteEnrichmentRowsRequest": { "type": "object", "properties": { "excludeIDs": { "type": "array", "items": { "type": "string" } }, "includeIDs": { "type": "array", "items": { "type": "string" } }, "qualification": { "type": "string" } } }, "BulkUpdateSignalCompaniesRequest": { "type": "object", "required": [ "includeInFilter" ], "properties": { "includeInFilter": { "type": "boolean" } } }, "CSVEnrichmentColumnReport": { "type": "object", "properties": { "blocking": { "type": "boolean" }, "column": { "type": "string" }, "field": { "type": "string" }, "reason": { "$ref": "#/definitions/CSVEnrichmentMappingReason" }, "tier": { "$ref": "#/definitions/CSVEnrichmentMappingCheckTier" }, "valuesInvalid": { "type": "integer" }, "valuesPresent": { "type": "integer" } } }, "CSVEnrichmentJobResponse": { "type": "object", "properties": { "billedCredits": { "type": "number" }, "billedEmailCredits": { "type": "number" }, "billedLinkedinCredits": { "type": "number" }, "billedPhoneCredits": { "type": "number" }, "completedAt": { "type": "string" }, "createdAt": { "type": "string" }, "emailUnitPrice": { "type": "number" }, "failedRows": { "type": "integer" }, "failureReason": { "type": "string" }, "fileSizeBytes": { "type": "integer" }, "headers": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "linkedinUnitPrice": { "type": "number" }, "listID": { "type": "string" }, "mapping": { "$ref": "#/definitions/CSVEnrichmentMappingResponse" }, "mappingReport": { "$ref": "#/definitions/CSVEnrichmentMappingReport" }, "options": { "$ref": "#/definitions/CSVEnrichmentOptionsResponse" }, "originalFilename": { "type": "string" }, "phoneUnitPrice": { "type": "number" }, "processedRows": { "type": "integer" }, "reservedCredits": { "type": "number" }, "skippedRows": { "type": "integer" }, "startedAt": { "type": "string" }, "status": { "$ref": "#/definitions/CSVEnrichmentJobStatus" }, "succeededRows": { "type": "integer" }, "totalRows": { "type": "integer" }, "unitPrice": { "type": "number" }, "updatedAt": { "type": "string" } } }, "CSVEnrichmentJobStatus": { "type": "string", "enum": [ "draft", "configured", "started", "in_progress", "failed", "completed" ], "x-enum-varnames": [ "CSVEnrichmentJobStatusDraft", "CSVEnrichmentJobStatusConfigured", "CSVEnrichmentJobStatusStarted", "CSVEnrichmentJobStatusInProgress", "CSVEnrichmentJobStatusFailed", "CSVEnrichmentJobStatusCompleted" ] }, "CSVEnrichmentListResponse": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "$ref": "#/definitions/CSVEnrichmentJobResponse" } }, "page": { "type": "integer" }, "size": { "type": "integer" }, "total": { "type": "integer" } } }, "CSVEnrichmentMappingCheckTier": { "type": "string", "enum": [ "strict", "weak" ], "x-enum-varnames": [ "CSVEnrichmentMappingCheckTierStrict", "CSVEnrichmentMappingCheckTierWeak" ] }, "CSVEnrichmentMappingReason": { "type": "string", "enum": [ "not_an_email", "not_a_phone_number", "not_a_linkedin_profile_url", "not_a_url", "not_a_name" ], "x-enum-varnames": [ "CSVEnrichmentMappingReasonNotAnEmail", "CSVEnrichmentMappingReasonNotAPhoneNumber", "CSVEnrichmentMappingReasonNotALinkedInProfileURL", "CSVEnrichmentMappingReasonNotAURL", "CSVEnrichmentMappingReasonNotAName" ] }, "CSVEnrichmentMappingReport": { "type": "object", "properties": { "blocking": { "type": "boolean" }, "columns": { "type": "array", "items": { "$ref": "#/definitions/CSVEnrichmentColumnReport" } } } }, "CSVEnrichmentMappingResponse": { "type": "object", "properties": { "companyNameColumn": { "type": "string" }, "companyUrlColumn": { "type": "string" }, "emailColumn": { "type": "string" }, "firstNameColumn": { "type": "string" }, "lastNameColumn": { "type": "string" }, "linkedinUrlColumn": { "type": "string" }, "phoneColumn": { "type": "string" } } }, "CSVEnrichmentOptions": { "type": "object", "properties": { "enrichEmail": { "type": "boolean" }, "enrichLinkedin": { "type": "boolean" }, "enrichPhone": { "type": "boolean" } } }, "CSVEnrichmentOptionsResponse": { "type": "object", "properties": { "enrichEmail": { "type": "boolean" }, "enrichLinkedin": { "type": "boolean" }, "enrichPhone": { "type": "boolean" } } }, "CSVEnrichmentUploadResponse": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "string" } }, "job": { "$ref": "#/definitions/CSVEnrichmentJobResponse" } } }, "CancelEnrichmentResponse": { "type": "object", "properties": { "alreadyEnriched": { "type": "integer" }, "softDeleted": { "type": "integer" }, "stillProcessing": { "type": "integer" } } }, "ChannelBreakdown": { "type": "object", "properties": { "email": { "$ref": "#/definitions/ChannelCount" }, "linkedin": { "$ref": "#/definitions/ChannelCount" }, "phone": { "$ref": "#/definitions/ChannelCount" }, "qualification": { "$ref": "#/definitions/ChannelCount" } } }, "ChannelCount": { "type": "object", "properties": { "charged": { "type": "integer" }, "delivered": { "type": "integer" } } }, "ChargebeeRedirectResponse": { "type": "object", "properties": { "url": { "type": "string" } } }, "Company": { "type": "object", "properties": { "domain": { "type": "string" }, "employeeCount": { "type": "integer" }, "id": { "type": "string" }, "industry": { "type": "string" }, "keywords": { "type": "array", "items": { "type": "string" } }, "location": { "$ref": "#/definitions/Location" }, "revenueRange": { "$ref": "#/definitions/RevenueRange" }, "website": { "type": "string" }, "yearsInBusiness": { "type": "integer" } } }, "CompanyAutocompleteResponse": { "type": "object", "properties": { "domain": { "type": "string" }, "id": { "type": "string" }, "logo": { "type": "string" }, "name": { "type": "string" } } }, "CompanyCategory": { "type": "string", "enum": [ "b2b", "b2c", "b2g", "ecommerce", "media", "service-provider", "mobile", "saas" ], "x-enum-varnames": [ "CompanyCategoryB2B", "CompanyCategoryB2C", "CompanyCategoryB2G", "CompanyCategoryEcommerce", "CompanyCategoryMedia", "CompanyCategoryServiceProvider", "CompanyCategoryMobile", "CompanyCategorySaaS" ] }, "CompanyFileJobResponse": { "type": "object", "properties": { "completedAt": { "type": "string" }, "createdAt": { "type": "string" }, "jobID": { "type": "string" }, "lastError": { "type": "string" }, "listID": { "type": "string" }, "matchedCompanies": { "type": "integer" }, "notMatchedDomains": { "type": "array", "items": { "type": "string" } }, "notMatchedLinkedInURLs": { "type": "array", "items": { "type": "string" } }, "processedIdentifiers": { "type": "integer" }, "status": { "type": "string" }, "totalIdentifiers": { "type": "integer" }, "updatedAt": { "type": "string" } } }, "CompanyFileUploadResponse": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "string" } }, "fileID": { "type": "string" }, "totalRows": { "type": "integer" } } }, "CompanyFollowerResultItem": { "type": "object", "properties": { "companyLocation": { "type": "string", "example": "San Francisco, CA" }, "companyLogoUrl": { "type": "string", "example": "https://media.licdn.com/dms/image/company-logo.jpg" }, "companyName": { "type": "string", "example": "Acme Corp" }, "companyProfileUrl": { "type": "string", "example": "https://www.linkedin.com/company/acme-corp" }, "firstName": { "type": "string", "example": "Jane" }, "industry": { "type": "string", "example": "Computer Software" }, "isPremium": { "type": "boolean", "example": false }, "lastName": { "type": "string", "example": "Smith" }, "location": { "type": "string", "example": "San Francisco Bay Area" }, "name": { "type": "string", "example": "Jane Smith" }, "objectUrn": { "type": "string", "example": "urn:li:member:11550089" }, "personID": { "type": "string", "example": "ps_xK9mQ2" }, "profilePictureUrl": { "type": "string", "example": "https://media.licdn.com/dms/image/example.jpg" }, "profileUrl": { "type": "string", "example": "https://www.linkedin.com/in/janesmith" }, "summary": { "type": "string", "example": "Experienced engineer focused on distributed systems" }, "title": { "type": "string", "example": "Senior Software Engineer" } } }, "CompanyFollowersCountriesResponse": { "type": "object", "properties": { "countries": { "type": "array", "items": { "type": "string" } } } }, "CompanyFollowersDepartmentsResponse": { "type": "object", "properties": { "departments": { "type": "array", "items": { "type": "string" } } } }, "CompanyFollowersFilters": { "type": "object", "properties": { "countries": { "type": "array", "items": { "type": "string" } }, "departments": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "followerCount": { "type": "integer" }, "jobTitles": { "type": "array", "items": { "type": "string" } }, "levels": { "type": "array", "items": { "type": "string" } }, "limit": { "type": "integer" }, "linkedinURL": { "type": "string" }, "logo": { "type": "string" }, "maxContactsPerCompany": { "type": "integer", "maximum": 100, "minimum": 0 }, "metros": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "states": { "type": "array", "items": { "type": "string" } }, "website": { "type": "string" } } }, "CompanyFollowersJobResponse": { "type": "object", "properties": { "clientRequestID": { "type": "string", "example": "req_12345" }, "companyLogoUrl": { "type": "string", "example": "https://media.licdn.com/dms/image/company-logo.jpg" }, "companyName": { "type": "string", "example": "Salesforge" }, "completedAt": { "type": "string", "example": "2026-03-18T12:05:00Z" }, "consumedCredits": { "type": "number", "example": 0 }, "createdAt": { "type": "string", "example": "2026-03-18T12:00:00Z" }, "error": { "type": "string" }, "followerCount": { "type": "integer", "example": 12345 }, "jobID": { "type": "string", "example": "pcfj_abc123" }, "linkedinUrl": { "type": "string", "example": "https://www.linkedin.com/company/salesforgeai" }, "processed": { "type": "integer", "example": 120 }, "reservedCredits": { "type": "number", "example": 50 }, "resultsURL": { "type": "string", "example": "/public/v1/company-followers/jobs/pcfj_abc123/results" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "failed", "no_results" ], "example": "in_progress" }, "statusURL": { "type": "string", "example": "/public/v1/company-followers/jobs/pcfj_abc123" }, "total": { "type": "integer", "example": 500 }, "updatedAt": { "type": "string", "example": "2026-03-18T12:01:00Z" }, "webhookURL": { "type": "string", "example": "https://example.com/webhooks/followers" } } }, "CompanyFollowersJobTitlesResponse": { "type": "object", "properties": { "jobTitles": { "type": "array", "items": { "type": "string" } }, "totalPages": { "type": "integer" } } }, "CompanyFollowersJobsListResponse": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "$ref": "#/definitions/CompanyFollowersJobResponse" } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer" } } }, "CompanyFollowersLevelsResponse": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "string" } } } }, "CompanyFollowersMetrosResponse": { "type": "object", "properties": { "metros": { "type": "array", "items": { "type": "string" } } } }, "CompanyFollowersResultsResponse": { "type": "object", "properties": { "jobID": { "type": "string", "example": "pcfj_abc123" }, "limit": { "type": "integer", "example": 50 }, "offset": { "type": "integer", "example": 0 }, "results": { "type": "array", "items": { "$ref": "#/definitions/CompanyFollowerResultItem" } }, "total": { "type": "integer", "example": 487 } } }, "CompanyFollowersStatesResponse": { "type": "object", "properties": { "states": { "type": "array", "items": { "type": "string" } } } }, "CompanyFollowersStatus": { "type": "object", "properties": { "collected": { "type": "integer" }, "limit": { "type": "integer" }, "listID": { "type": "string" }, "message": { "type": "string" }, "processed": { "type": "integer" }, "status": { "$ref": "#/definitions/CompanyFollowersStatusType" }, "total": { "type": "integer" }, "updatedAt": { "type": "integer" } } }, "CompanyFollowersStatusType": { "type": "string", "enum": [ "none", "in_progress", "success", "failure" ], "x-enum-varnames": [ "CompanyFollowersStatusTypeNone", "CompanyFollowersStatusTypeInProgress", "CompanyFollowersStatusTypeSuccess", "CompanyFollowersStatusTypeFailure" ] }, "CompanyFundingRound": { "type": "string", "enum": [ "seed", "debt_financing", "angel", "venture", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "other" ], "x-enum-varnames": [ "CompanyFundingRoundSeed", "CompanyFundingRoundDebtFinancing", "CompanyFundingRoundAngel", "CompanyFundingRoundVenture", "CompanyFundingRoundSeriesA", "CompanyFundingRoundSeriesB", "CompanyFundingRoundSeriesC", "CompanyFundingRoundSeriesD", "CompanyFundingRoundSeriesE", "CompanyFundingRoundSeriesF", "CompanyFundingRoundSeriesG", "CompanyFundingRoundSeriesH", "CompanyFundingRoundOther" ] }, "CompanyFundingTypeResponse": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "CompanyLookalikeFilters": { "type": "object", "properties": { "categories": { "type": "array", "items": { "type": "string" } }, "companyEmployeeRanges": { "type": "array", "items": { "type": "string" } }, "excludeCategories": { "type": "array", "items": { "type": "string" } }, "excludeCompanyEmployeeRanges": { "type": "array", "items": { "type": "string" } }, "excludeDomains": { "type": "array", "items": { "type": "string" } }, "excludeFundingStages": { "type": "array", "items": { "type": "string" } }, "excludeLocations": { "type": "array", "items": { "$ref": "#/definitions/CompanyLookalikesLocation" } }, "fundingStages": { "type": "array", "items": { "type": "string" } }, "limit": { "type": "integer" }, "locations": { "type": "array", "items": { "$ref": "#/definitions/CompanyLookalikesLocation" } }, "lookalikeDomains": { "type": "array", "maxItems": 10, "items": { "type": "string" } } } }, "CompanyLookalikePreview": { "type": "object", "properties": { "description": { "type": "string" }, "domain": { "type": "string" }, "industry": { "type": "string" }, "keywords": { "type": "array", "items": { "type": "string" } }, "logo": { "type": "string" }, "name": { "type": "string" }, "score": { "type": "number" }, "website": { "type": "string" } } }, "CompanyLookalikesLocation": { "type": "object", "required": [ "id", "type" ], "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/CompanyLookalikesLocationType" } } }, "CompanyLookalikesLocationType": { "type": "string", "enum": [ "region", "country" ], "x-enum-varnames": [ "CompanyLookalikesLocationTypeRegion", "CompanyLookalikesLocationTypeCountry" ] }, "CompanyLookalikesPreviews": { "type": "object", "properties": { "lookalikes": { "type": "array", "items": { "$ref": "#/definitions/CompanyLookalikePreview" } }, "totalCount": { "type": "integer" } } }, "CompanyLookalikesStatus": { "type": "object", "properties": { "code": { "$ref": "#/definitions/CompanyLookalikesStatusCode" }, "message": { "type": "string" }, "processed": { "type": "integer" }, "status": { "$ref": "#/definitions/CompanyLookalikesStatusType" }, "total": { "type": "integer" } } }, "CompanyLookalikesStatusCode": { "type": "string", "enum": [ "none", "success", "partial" ], "x-enum-varnames": [ "CompanyLookalikesStatusCodeNone", "CompanyLookalikesStatusCodeSuccess", "CompanyLookalikesStatusCodePartial" ] }, "CompanyLookalikesStatusType": { "type": "string", "enum": [ "none", "in_progress", "success", "failure" ], "x-enum-varnames": [ "CompanyLookalikesStatusTypeNone", "CompanyLookalikesStatusTypeInProgress", "CompanyLookalikesStatusTypeSuccess", "CompanyLookalikesStatusTypeFailure" ] }, "CompanyType": { "type": "string", "enum": [ "EDUCATIONAL", "GOVERNMENT_AGENCY", "NON_PROFIT", "PARTNERSHIP", "PRIVATELY_HELD", "PUBLIC_COMPANY", "SELF_EMPLOYED", "SELF_OWNED", "UNKNOWN" ], "x-enum-varnames": [ "CompanyTypeEducational", "CompanyTypeGovernmentAgency", "CompanyTypeNonProfit", "CompanyTypePartnership", "CompanyTypePrivatelyHeld", "CompanyTypePublicCompany", "CompanyTypeSelfEmployed", "CompanyTypeSelfOwned", "CompanyTypeUnknown" ] }, "CompanyTypeResponse": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "ConfigureCSVEnrichmentMapping": { "type": "object", "properties": { "companyEmployeeCountColumn": { "type": "string" }, "companyHqColumn": { "type": "string" }, "companyIndustryColumn": { "type": "string" }, "companyKeywordsColumn": { "type": "string" }, "companyNameColumn": { "type": "string" }, "companyUrlColumn": { "type": "string" }, "companyYearsInBusinessColumn": { "type": "string" }, "emailColumn": { "type": "string" }, "firstNameColumn": { "type": "string" }, "jobTitleColumn": { "type": "string" }, "lastNameColumn": { "type": "string" }, "linkedinUrlColumn": { "type": "string" }, "locationColumn": { "type": "string" }, "phoneColumn": { "type": "string" } } }, "ConfigureCSVEnrichmentRequest": { "type": "object", "required": [ "mapping", "options" ], "properties": { "mapping": { "$ref": "#/definitions/ConfigureCSVEnrichmentMapping" }, "options": { "$ref": "#/definitions/CSVEnrichmentOptions" } } }, "CountEstimationFilters": { "type": "object", "properties": { "countries": { "type": "array", "items": { "type": "string" } }, "departments": { "type": "array", "items": { "type": "string" } }, "jobTitles": { "type": "array", "items": { "type": "string" } }, "levels": { "type": "array", "items": { "type": "string" } }, "states": { "type": "array", "items": { "type": "string" } } } }, "CountEstimationRequest": { "type": "object", "required": [ "companyUrl" ], "properties": { "companyUrl": { "type": "string" }, "countries": { "type": "array", "items": { "type": "string" } }, "departments": { "type": "array", "items": { "type": "string" } }, "jobTitles": { "type": "array", "items": { "type": "string" } }, "levels": { "type": "array", "items": { "type": "string" } }, "metros": { "type": "array", "items": { "type": "string" } }, "states": { "type": "array", "items": { "type": "string" } } } }, "CountEstimationResponse": { "type": "object", "properties": { "error": { "type": "string" }, "filtersApplied": { "$ref": "#/definitions/CountEstimationFilters" }, "functionBreakdown": { "type": "array", "items": { "$ref": "#/definitions/FunctionBreakdownItem" } }, "seniorityBreakdown": { "type": "array", "items": { "$ref": "#/definitions/SeniorityBreakdownItem" } }, "status": { "type": "string" }, "totalCount": { "type": "integer" } } }, "CreateEnrichmentJobRequest": { "type": "object", "required": [ "contacts" ], "properties": { "channels": { "$ref": "#/definitions/EnrichmentChannelsDTO" }, "contacts": { "type": "array", "minItems": 1, "items": { "$ref": "#/definitions/EnrichmentJobContactDTO" } } } }, "CreateExtraColumnItem": { "type": "object", "required": [ "description" ], "properties": { "description": { "type": "string", "maxLength": 500, "minLength": 1 }, "name": { "type": "string" }, "type": { "enum": [ "lead_qualification" ], "allOf": [ { "$ref": "#/definitions/ExtraColumnType" } ] } } }, "CreateExtraColumnRequest": { "type": "object", "required": [ "columns" ], "properties": { "columns": { "type": "array", "maxItems": 5, "minItems": 1, "items": { "$ref": "#/definitions/CreateExtraColumnItem" } } } }, "CreateExtraColumnResponse": { "type": "object", "properties": { "description": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } } }, "CreateUserRequest": { "type": "object", "required": [ "email", "firstName", "lastName", "password" ], "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "invitationToken": { "type": "string" }, "lastName": { "type": "string" }, "password": { "type": "string", "minLength": 6 }, "phone": { "type": "string" }, "role": { "type": "string", "enum": [ "admin", "member" ] } } }, "CreditBalanceResponse": { "type": "object", "properties": { "availableCredits": { "type": "number" }, "companyFollowersPrice": { "type": "number" }, "companyLookalikePrice": { "type": "number" }, "emailEnrichmentPrice": { "type": "number" }, "linkedinEnrichmentPrice": { "type": "number" }, "phoneNumberEnrichmentPrice": { "type": "number" }, "reservedCredits": { "type": "number" } } }, "DepartmentsResponse": { "type": "object", "properties": { "departments": { "type": "array", "items": { "type": "string" } } } }, "DisplayOptions": { "type": "object", "properties": { "canReply": { "type": "boolean" }, "leadsDisplayMode": { "$ref": "#/definitions/LeadsDisplayMode" }, "progressState": { "$ref": "#/definitions/ProgressState" }, "selectedPath": { "$ref": "#/definitions/ListPath" } } }, "EmployeeRangesResponse": { "type": "object", "properties": { "employeeRanges": { "type": "array", "items": { "type": "string" } } } }, "EmptyStateType": { "type": "string", "enum": [ "none", "all_enriched", "no_results" ], "x-enum-varnames": [ "EmptyStateTypeNone", "EmptyStateTypeAllEnriched", "EmptyStateTypeNoResults" ] }, "EnrichBusinessOwnersRequest": { "type": "object", "required": [ "businessIDs", "listID" ], "properties": { "businessIDs": { "type": "array", "maxItems": 200, "minItems": 1, "items": { "type": "string" } }, "country": { "type": "string", "maxLength": 2 }, "listID": { "description": "ListID is the maps discovery list (created by the search step) the found\nowners are materialized into as leads.", "type": "string" }, "maxResults": { "type": "integer", "maximum": 8, "minimum": 1 }, "title": { "type": "string", "maxLength": 100 }, "wantEmail": { "type": "boolean" }, "wantPhone": { "type": "boolean" } } }, "EnrichBusinessOwnersResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/definitions/EnrichBusinessOwnersResultItem" } } } }, "EnrichBusinessOwnersResultItem": { "type": "object", "properties": { "businessID": { "type": "string" }, "reason": { "type": "string" }, "requestID": { "type": "string" }, "status": { "type": "string" } } }, "EnrichListRequest": { "type": "object", "properties": { "amount": { "type": "integer", "minimum": 0 }, "enrichEmail": { "type": "boolean" }, "enrichLinkedin": { "type": "boolean" }, "enrichPhoneNumber": { "type": "boolean" }, "excludeIDs": { "type": "array", "items": { "type": "string" } }, "includeIDs": { "type": "array", "items": { "type": "string" } }, "leadQualification": { "type": "boolean" }, "linkedinEnrichmentCondition": { "$ref": "#/definitions/LinkedinEnrichmentCondition" }, "replaceContactCondition": { "$ref": "#/definitions/ReplaceLeadCondition" } } }, "EnrichMapsOwnersRequest": { "type": "object", "required": [ "businessIDs", "maxResults", "searchJobID" ], "properties": { "businessIDs": { "type": "array", "maxItems": 200, "minItems": 1, "items": { "type": "string" }, "example": [ "3c1a2b4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d" ] }, "clientRequestID": { "type": "string", "maxLength": 128, "example": "req_12345" }, "maxResults": { "description": "MaxResults is the number of owners to look for per business.", "type": "integer", "maximum": 8, "minimum": 1, "example": 3 }, "searchJobID": { "type": "string", "example": "5f1c2e3a-0b1d-4c2e-9f3a-1b2c3d4e5f60" }, "wantEmail": { "type": "boolean", "example": true }, "wantPhone": { "type": "boolean", "example": true }, "webhookURL": { "type": "string", "example": "https://example.com/webhooks/maps-owners" } } }, "EnrichmentChannelsDTO": { "type": "object", "properties": { "email": { "type": "boolean" }, "linkedin": { "type": "boolean" }, "phone": { "type": "boolean" } } }, "EnrichmentColumnStatus": { "type": "string", "enum": [ "not_enriched", "queued", "in_progress", "out_of_credits", "enriched", "skipped", "not_found", "enqueue_failed", "failed" ], "x-enum-varnames": [ "EnrichmentColumnStatusNotEnriched", "EnrichmentColumnStatusQueued", "EnrichmentColumnStatusInProgress", "EnrichmentColumnStatusOutOfCredits", "EnrichmentColumnStatusEnriched", "EnrichmentColumnStatusSkipped", "EnrichmentColumnStatusNotFound", "EnrichmentColumnStatusEnqueueFailed", "EnrichmentColumnStatusFailed" ] }, "EnrichmentCompanyRevenueRange": { "type": "object", "properties": { "end": { "type": "integer" }, "start": { "type": "integer" } } }, "EnrichmentCountsResponse": { "type": "object", "properties": { "leadQualification": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64" } }, "linkedin": { "type": "integer" }, "phoneNumber": { "type": "integer" }, "workEmail": { "type": "integer" } } }, "EnrichmentJobContactDTO": { "type": "object", "required": [ "linkedinUrl" ], "properties": { "company": { "type": "string" }, "firstName": { "type": "string" }, "headline": { "type": "string" }, "lastName": { "type": "string" }, "linkedinUrl": { "type": "string" } } }, "EnrichmentJobResponse": { "type": "object", "properties": { "channel": { "type": "string" }, "clientRequestID": { "type": "string" }, "completedAt": { "type": "string" }, "consumedCredits": { "type": "number" }, "createdAt": { "type": "string" }, "failed": { "type": "integer" }, "jobID": { "type": "string" }, "processed": { "type": "integer" }, "reservedCredits": { "type": "number" }, "resultsURL": { "type": "string" }, "status": { "type": "string" }, "statusURL": { "type": "string" }, "succeeded": { "type": "integer" }, "total": { "type": "integer" }, "updatedAt": { "type": "string" }, "webhookURL": { "type": "string" } } }, "EnrichmentJobResult": { "type": "object", "properties": { "channel": { "$ref": "#/definitions/PublicEnrichmentChannel" }, "completedAt": { "type": "string" }, "error": { "type": "string" }, "externalID": { "type": "string" }, "inputCompany": { "type": "string" }, "inputFirstName": { "type": "string" }, "inputLastName": { "type": "string" }, "inputLinkedinURL": { "type": "string" }, "jobID": { "type": "string" }, "payload": { "type": "object", "additionalProperties": {} }, "person": { "$ref": "#/definitions/PersonIdentity" }, "personID": { "type": "string" }, "status": { "$ref": "#/definitions/PublicEnrichmentResultStatus" }, "webhookAttempt": { "$ref": "#/definitions/ResultWebhookAttempt" } } }, "EnrichmentJobResultsResponse": { "type": "object", "properties": { "jobID": { "type": "string" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "results": { "type": "array", "items": { "$ref": "#/definitions/EnrichmentJobResult" } }, "total": { "type": "integer" } } }, "EnrichmentJobsListResponse": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "$ref": "#/definitions/EnrichmentJobResponse" } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer" } } }, "EnrichmentLookupRequest": { "type": "object", "required": [ "accountID", "linkedinUrls" ], "properties": { "accountID": { "type": "string" }, "linkedinUrls": { "type": "array", "maxItems": 200, "minItems": 1, "items": { "type": "string" } } } }, "EnrichmentLookupResponse": { "type": "object", "properties": { "results": { "type": "object", "additionalProperties": { "$ref": "#/definitions/EnrichmentLookupValue" } } } }, "EnrichmentLookupValue": { "type": "object", "properties": { "email": { "type": "string" }, "emailStatus": { "type": "string" }, "phone": { "type": "string" }, "phoneStatus": { "type": "string" } } }, "EnrichmentProgressResponse": { "type": "object", "properties": { "completedAt": { "type": "string" }, "error": { "type": "string" }, "listID": { "type": "string" }, "listName": { "type": "string" }, "processed": { "type": "integer" }, "startedAt": { "type": "string" }, "status": { "type": "string" }, "total": { "type": "integer" }, "updatedAt": { "type": "string" } } }, "EnrichmentProgressSnapshotResponse": { "type": "object", "properties": { "enrichments": { "type": "array", "items": { "$ref": "#/definitions/EnrichmentProgressResponse" } } } }, "EnrichmentResponse": { "type": "object", "properties": { "contactCount": { "type": "integer" }, "creditsSpent": { "type": "number" }, "emailCount": { "type": "integer" }, "enrichedContactCount": { "type": "integer" }, "lastRunAt": { "type": "string" }, "lastRunBy": { "type": "string" }, "linkedinCount": { "type": "integer" }, "listID": { "type": "string" }, "listName": { "type": "string" }, "phoneNumberCount": { "type": "integer" }, "qualificationCount": { "type": "integer" }, "runCount": { "type": "integer" }, "selectedPath": { "$ref": "#/definitions/ListPath" }, "status": { "$ref": "#/definitions/EnrichmentTableStatus" } } }, "EnrichmentRunResponse": { "type": "object", "properties": { "channels": { "$ref": "#/definitions/ChannelBreakdown" }, "completedAt": { "type": "string" }, "consumedCredits": { "type": "number" }, "contactsProcessed": { "type": "integer" }, "id": { "type": "string" }, "ranBy": { "type": "string" }, "refundedCredits": { "type": "number" }, "reservedCredits": { "type": "number" }, "runNumber": { "type": "integer" }, "startedAt": { "type": "string" }, "status": { "$ref": "#/definitions/EnrichmentRunStatus" } } }, "EnrichmentRunStatus": { "type": "string", "enum": [ "completed", "cancelled", "in_progress" ], "x-enum-varnames": [ "EnrichmentRunStatusCompleted", "EnrichmentRunStatusCancelled", "EnrichmentRunStatusInProgress" ] }, "EnrichmentRunsResponse": { "type": "object", "properties": { "nextCursor": { "type": "string" }, "runs": { "type": "array", "items": { "$ref": "#/definitions/EnrichmentRunResponse" } } } }, "EnrichmentTableRowResponse": { "type": "object", "properties": { "companyFoundedYear": { "type": "integer" }, "companyFundingRound": { "$ref": "#/definitions/FundingType" }, "companyIndustries": { "type": "array", "items": { "type": "string" } }, "companyKeywords": { "type": "array", "items": { "type": "string" } }, "companyLogo": { "type": "string" }, "companyName": { "type": "string" }, "companyRevenueRange": { "$ref": "#/definitions/EnrichmentCompanyRevenueRange" }, "companySize": { "type": "integer" }, "companyTechnologies": { "type": "array", "items": { "type": "string" } }, "companyTotalFunding": { "type": "integer" }, "companyType": { "$ref": "#/definitions/CompanyType" }, "companyWebsite": { "type": "string" }, "companyYearsInBusiness": { "type": "integer" }, "departments": { "type": "array", "items": { "type": "string" } }, "extraColumns": { "type": "array", "items": { "$ref": "#/definitions/ExtraColumnValueResponse" } }, "firstName": { "type": "string" }, "fullName": { "type": "string" }, "functions": { "type": "array", "items": { "type": "string" } }, "headquartersLocation": { "type": "string" }, "industry": { "type": "string" }, "isCreator": { "type": "boolean" }, "isOpenToWork": { "type": "boolean" }, "isPremium": { "type": "boolean" }, "jobTitle": { "type": "string" }, "lastName": { "type": "string" }, "linkedinURL": { "type": "string" }, "linkedinURLStatus": { "$ref": "#/definitions/EnrichmentColumnStatus" }, "listID": { "type": "string" }, "personCity": { "type": "string" }, "personContinent": { "type": "string" }, "personCountry": { "type": "string" }, "personID": { "type": "string" }, "personProfilePicture": { "type": "string" }, "personState": { "type": "string" }, "phoneNumber": { "type": "string" }, "phoneNumberStatus": { "$ref": "#/definitions/EnrichmentColumnStatus" }, "seniority": { "type": "string" }, "skills": { "type": "array", "items": { "type": "string" } }, "workEmail": { "type": "string" }, "workEmailStatus": { "$ref": "#/definitions/EnrichmentColumnStatus" } } }, "EnrichmentTableRowsResponse": { "type": "object", "properties": { "enrichedContactCount": { "type": "integer" }, "enrichmentCounts": { "$ref": "#/definitions/EnrichmentCountsResponse" }, "extraColumns": { "type": "array", "items": { "$ref": "#/definitions/ExtraColumnResponse" } }, "lastEnrichEmail": { "type": "boolean" }, "lastEnrichLinkedin": { "type": "boolean" }, "lastEnrichPhone": { "type": "boolean" }, "lastLinkedinEnrichmentCondition": { "$ref": "#/definitions/LinkedinEnrichmentCondition" }, "linkedinURLEnrichmentInProgress": { "type": "boolean" }, "listID": { "type": "string" }, "listName": { "type": "string" }, "phoneNumberEnrichmentInProgress": { "type": "boolean" }, "rows": { "type": "array", "items": { "$ref": "#/definitions/EnrichmentTableRowResponse" } }, "status": { "$ref": "#/definitions/EnrichmentTableStatus" }, "totalCount": { "type": "integer" }, "workEmailEnrichmentInProgress": { "type": "boolean" } } }, "EnrichmentTableStatus": { "type": "string", "enum": [ "not_started", "in_progress", "out_of_credits", "enriched", "failed", "cancelled" ], "x-enum-varnames": [ "EnrichmentTableStatusNotStarted", "EnrichmentTableStatusInProgress", "EnrichmentTableStatusOutOfCredits", "EnrichmentTableStatusEnriched", "EnrichmentTableStatusFailed", "EnrichmentTableStatusCancelled" ] }, "EnrichmentsResponse": { "type": "object", "properties": { "enrichments": { "type": "array", "items": { "$ref": "#/definitions/EnrichmentResponse" } }, "totalCount": { "type": "integer" } } }, "Error": { "type": "object", "properties": { "code": { "$ref": "#/definitions/ErrorCode" }, "data": {}, "message": { "type": "string" } } }, "ErrorCode": { "type": "string", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "conflict", "insufficient_credits", "timeout", "gone", "rate_limited", "idempotency_conflict", "missing_api_key", "invalid_api_key", "bad_gateway", "service_unavailable", "account_frozen", "purchase_requires_approval", "unpaid_subscription_balance", "internal" ], "x-enum-varnames": [ "ErrorCodeBadRequest", "ErrorCodeUnauthorized", "ErrorCodeForbidden", "ErrorCodeNotFound", "ErrorCodeConflict", "ErrorCodeInsufficientCredits", "ErrorCodeTimeout", "ErrorCodeGone", "ErrorCodeRateLimited", "ErrorCodeIdempotencyConflict", "ErrorCodeMissingAPIKey", "ErrorCodeInvalidAPIKey", "ErrorCodeBadGateway", "ErrorCodeServiceUnavailable", "ErrorCodeAccountFrozen", "ErrorCodePurchaseRequiresApproval", "ErrorCodeUnpaidSubscriptionBalance", "ErrorCodeInternal" ] }, "ExpandFiltersRequest": { "type": "object", "required": [ "categories" ], "properties": { "categories": { "type": "array", "minItems": 1, "items": { "type": "string" } } } }, "ExportCSVRequest": { "type": "object", "properties": { "excludeIDs": { "type": "array", "items": { "type": "string" } }, "includeIDs": { "type": "array", "items": { "type": "string" } }, "qualification": { "type": "string" } } }, "ExportContactsCSVRequest": { "type": "object", "properties": { "excludeIDs": { "type": "array", "items": { "type": "string" } }, "includeIDs": { "type": "array", "items": { "type": "string" } } } }, "ExportCreditsTier": { "type": "object", "properties": { "credits": { "type": "number" }, "monthlyPrice": { "type": "number" }, "tier": { "type": "integer" } } }, "ExportToHubspotRequest": { "type": "object", "properties": { "excludeIDs": { "type": "array", "items": { "type": "string" } }, "includeIDs": { "type": "array", "items": { "type": "string" } }, "qualification": { "type": "string" } } }, "ExportToSalesforceRequest": { "type": "object", "properties": { "excludeIDs": { "type": "array", "items": { "type": "string" } }, "includeIDs": { "type": "array", "items": { "type": "string" } }, "qualification": { "type": "string" } } }, "ExportToSalesforgeRequest": { "type": "object", "required": [ "tagName", "targetWorkspaceId" ], "properties": { "excludeIDs": { "type": "array", "items": { "type": "string" } }, "includeIDs": { "type": "array", "items": { "type": "string" } }, "qualification": { "type": "string" }, "tagName": { "type": "string" }, "targetWorkspaceId": { "type": "string" } } }, "ExtensionEnrichmentResponse": { "type": "object", "properties": { "listId": { "type": "string" } } }, "ExtensionEnrichmentRowResponse": { "type": "object", "properties": { "linkedinUrl": { "type": "string" }, "phoneNumber": { "type": "string" }, "phoneNumberStatus": { "$ref": "#/definitions/EnrichmentColumnStatus" }, "workEmail": { "type": "string" }, "workEmailStatus": { "$ref": "#/definitions/EnrichmentColumnStatus" } } }, "ExtensionEnrichmentStatusResponse": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/definitions/ExtensionEnrichmentRowResponse" } }, "status": { "$ref": "#/definitions/EnrichmentTableStatus" } } }, "ExtraColumnResponse": { "type": "object", "properties": { "description": { "type": "string" }, "hasBeenEnriched": { "type": "boolean" }, "id": { "type": "string" }, "isPending": { "type": "boolean" }, "title": { "type": "string" }, "type": { "type": "string" } } }, "ExtraColumnType": { "type": "string", "enum": [ "lead_qualification" ], "x-enum-varnames": [ "ExtraColumnTypeLeadQualification" ] }, "ExtraColumnValueResponse": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "value": { "type": "array", "items": { "type": "integer" } } } }, "ExtractionStatusResponse": { "type": "object", "properties": { "status": { "$ref": "#/definitions/SignalExtractionJobStatus" }, "totalExpected": { "type": "integer" }, "totalFetched": { "type": "integer" }, "totalMatched": { "type": "integer" }, "totalUnmatched": { "type": "integer" } } }, "FeatureFlagsResponse": { "type": "object", "properties": { "companyFileMaxUploadRows": { "type": "integer" }, "companyFileMaxUploadSizeBytes": { "type": "integer" }, "companyNichesEnabled": { "type": "boolean" }, "csvMaxUploadRows": { "type": "integer" }, "csvMaxUploadSizeBytes": { "type": "integer" }, "maxEnrichmentAmount": { "type": "integer" }, "maxSignalExtractionAmount": { "type": "integer" }, "signalsEnabled": { "type": "boolean" } } }, "FilterCountsResponse": { "type": "object", "properties": { "companyBusinessModels": { "type": "integer" }, "companyDomains": { "type": "integer" }, "companyEmployeeNumberRange": { "type": "integer" }, "companyFoundedYearRange": { "type": "integer" }, "companyFundingRounds": { "type": "integer" }, "companyIndustries": { "type": "integer" }, "companyKeywords": { "type": "integer" }, "companyLocations": { "type": "integer" }, "companyNames": { "type": "integer" }, "companyNiches": { "type": "integer" }, "companyRevenueRanges": { "type": "integer" }, "companyTechnologies": { "type": "integer" }, "companyTypes": { "type": "integer" }, "companyYearsInBusinessRange": { "type": "integer" }, "leadDepartments": { "type": "integer" }, "leadIDs": { "type": "integer" }, "leadJobTitles": { "type": "integer" }, "leadLanguages": { "type": "integer" }, "leadLocations": { "type": "integer" }, "leadSeniorities": { "type": "integer" }, "leadTenure": { "type": "integer" } } }, "FilterWarning": { "type": "object", "properties": { "filter": { "type": "string" }, "value": { "type": "string" } } }, "FunctionBreakdownItem": { "type": "object", "properties": { "count": { "type": "integer" }, "functionId": { "type": "string" }, "functionName": { "type": "string" }, "percentage": { "type": "number" }, "seniorityBreakdown": { "type": "array", "items": { "$ref": "#/definitions/SeniorityBreakdownItem" } } } }, "FundingType": { "type": "string", "enum": [ "ANGEL", "PRE_SEED", "SEED", "VENTURE_SERIES_UNKNOWN", "SERIES_A", "SERIES_B", "SERIES_C", "SERIES_D", "SERIES_E", "SERIES_F", "SERIES_G", "SERIES_H", "SERIES_I", "SERIES_J", "EQUITY_CROWDFUNDING", "PRODUCT_CROWDFUNDING", "PRIVATE_EQUITY", "CONVERTIBLE_NOTE", "DEBT_FINANCING", "SECONDARY_MARKET", "GRANT", "CORPORATE_ROUND", "INITIAL_COIN_OFFERING", "POST_IPO_EQUITY", "POST_IPO_DEBT", "POST_IPO_SECONDARY", "NON_EQUITY_ASSISTANCE", "FUNDING_ROUND", "UNDISCLOSED", "UNKNOWN" ], "x-enum-varnames": [ "FundingTypeAngel", "FundingTypePreSeed", "FundingTypeSeed", "FundingTypeVentureSeriesUnknown", "FundingTypeSeriesA", "FundingTypeSeriesB", "FundingTypeSeriesC", "FundingTypeSeriesD", "FundingTypeSeriesE", "FundingTypeSeriesF", "FundingTypeSeriesG", "FundingTypeSeriesH", "FundingTypeSeriesI", "FundingTypeSeriesJ", "FundingTypeEquityCrowdfunding", "FundingTypeProductCrowdfunding", "FundingTypePrivateEquity", "FundingTypeConvertibleNote", "FundingTypeDebtFinancing", "FundingTypeSecondaryMarket", "FundingTypeGrant", "FundingTypeCorporateRound", "FundingTypeInitialCoinOffering", "FundingTypePostIpoEquity", "FundingTypePostIpoDebt", "FundingTypePostIpoSecondary", "FundingTypeNonEquityAssistance", "FundingTypeFundingRound", "FundingTypeUndisclosed", "FundingTypeUnknown" ] }, "FundingTypeResponse": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "GetEnrichedEmailCountRequest": { "type": "object", "properties": { "excludeIDs": { "type": "array", "items": { "type": "string" } }, "includeIDs": { "type": "array", "items": { "type": "string" } } } }, "GetEnrichedEmailCountResponse": { "type": "object", "properties": { "count": { "type": "integer" } } }, "GetListContactCountResponse": { "type": "object", "properties": { "count": { "type": "integer" } } }, "GetListsResponse": { "type": "object", "properties": { "createdAt": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } } }, "GetMeAccountResponse": { "type": "object", "properties": { "companyFollowersPrice": { "type": "number" }, "companyLookalikePrice": { "type": "number" }, "createdAt": { "type": "string" }, "emailEnrichmentPrice": { "type": "number" }, "exportCreditsBalance": { "type": "number" }, "exportCreditsReserved": { "type": "number" }, "exportCreditsTier": { "type": "integer" }, "exportCreditsUsed": { "type": "number" }, "frozen": { "description": "Frozen means credit spending is paused while the account is under review. The account keeps\nworking otherwise, so the UI shows a banner rather than a lock screen. The reason behind the\nfreeze is deliberately not exposed - it would explain our fraud detection to a fraudster.", "type": "boolean" }, "frozenAt": { "type": "string" }, "globalOnboardingComplete": { "type": "boolean" }, "id": { "type": "string" }, "linkedinEnrichmentPrice": { "type": "number" }, "mapsDiscoveryPrice": { "type": "number" }, "mapsOwnerEmailPrice": { "type": "number" }, "mapsOwnerPhonePrice": { "type": "number" }, "name": { "type": "string" }, "paymentProcessingStartedAt": { "type": "string" }, "phoneNumberEnrichmentPrice": { "type": "number" }, "planBillingPeriod": { "$ref": "#/definitions/BillingPeriod" }, "planType": { "$ref": "#/definitions/PlanType" }, "qualificationEnrichmentPrice": { "type": "number" }, "signalsPrice": { "type": "integer" }, "subscriptionStatus": { "$ref": "#/definitions/SubscriptionStatus" } } }, "GetMeResponse": { "type": "object", "properties": { "account": { "$ref": "#/definitions/GetMeAccountResponse" }, "isSuperAdminSession": { "type": "boolean" }, "user": { "$ref": "#/definitions/GetMeUserResponse" } } }, "GetMeUserResponse": { "type": "object", "properties": { "accountOwner": { "type": "boolean" }, "accountRole": { "$ref": "#/definitions/AccountRole" }, "createdAt": { "type": "string" }, "email": { "type": "string" }, "exportCreditsBalance": { "type": "number" }, "exportCreditsLimit": { "type": "number" }, "exportCreditsUsed": { "type": "number" }, "firstName": { "type": "string" }, "id": { "type": "string" }, "intercomId": { "type": "string" }, "lastName": { "type": "string" }, "phone": { "type": "string" } } }, "GetOutOfCreditsCountResponse": { "type": "object", "properties": { "count": { "type": "integer" } } }, "GetSalesforgeAccountIsActiveResponse": { "type": "object", "properties": { "isActive": { "type": "boolean" } } }, "GetSystemMessageResponse": { "type": "object", "properties": { "displayOptions": { "$ref": "#/definitions/DisplayOptions" }, "message": { "$ref": "#/definitions/MessageResponse" } } }, "HandleUserReplyResponse": { "type": "object", "properties": { "displayOptions": { "$ref": "#/definitions/DisplayOptions" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/MessageResponse" } }, "refreshContacts": { "type": "boolean" } } }, "IncludeExcludeAllFilter": { "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" } }, "include": { "type": "array", "items": { "type": "string" } }, "matchAll": { "type": "boolean" } } }, "IncludeExcludeFilter": { "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" } }, "include": { "type": "array", "items": { "type": "string" } } } }, "IndustryResponse": { "type": "object", "properties": { "name": { "type": "string" } } }, "InternalEnrichmentResponse": { "type": "object", "properties": { "jobRunID": { "type": "string" }, "jobTimestamp": { "type": "integer" } } }, "InviteUserRequest": { "type": "object", "required": [ "email", "role" ], "properties": { "email": { "type": "string" }, "role": { "type": "string" } } }, "JobTitleFilter": { "type": "object", "properties": { "exactMatch": { "type": "boolean" }, "exclude": { "type": "array", "items": { "type": "string" } }, "include": { "type": "array", "items": { "type": "string" } } } }, "JobTitleResponse": { "type": "object", "properties": { "name": { "type": "string" } } }, "KeywordResponse": { "type": "object", "properties": { "name": { "type": "string" } } }, "LabelValueItem": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" } } }, "LanguageFilter": { "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" } }, "include": { "type": "array", "items": { "type": "string" } }, "primaryOnly": { "type": "boolean" } } }, "LanguageResponse": { "type": "object", "properties": { "localeCode": { "type": "string" }, "name": { "type": "string" } } }, "Lead": { "type": "object", "properties": { "company": { "$ref": "#/definitions/Company" }, "firstName": { "type": "string" }, "id": { "type": "string" }, "jobTitle": { "type": "string" }, "lastName": { "type": "string" }, "linkedinUrl": { "type": "string" }, "location": { "$ref": "#/definitions/Location" } } }, "LeadsDisplayMode": { "type": "string", "enum": [ "none", "preview" ], "x-enum-varnames": [ "LeadsDisplayModeNone", "LeadsDisplayModePreview" ] }, "LinkedinEnrichmentCondition": { "type": "string", "enum": [ "none", "always", "email_found", "phone_found", "email_or_phone_found", "email_and_phone_found" ], "x-enum-varnames": [ "LinkedinEnrichmentConditionNone", "LinkedinEnrichmentConditionAlways", "LinkedinEnrichmentConditionEmailFound", "LinkedinEnrichmentConditionPhoneFound", "LinkedinEnrichmentConditionEmailOrPhoneFound", "LinkedinEnrichmentConditionEmailAndPhoneFound" ] }, "ListContactResponse": { "type": "object", "properties": { "company": { "type": "string" }, "companyFundingRound": { "$ref": "#/definitions/FundingType" }, "companyLocation": { "type": "string" }, "companyLogo": { "type": "string" }, "companyRevenueRange": { "$ref": "#/definitions/ListContactRevenueRange" }, "companySize": { "type": "integer" }, "companyType": { "$ref": "#/definitions/CompanyType" }, "companyWebsite": { "type": "string" }, "companyYearsInBusiness": { "type": "integer" }, "firstName": { "type": "string" }, "id": { "type": "string" }, "industries": { "type": "array", "items": { "type": "string" } }, "industry": { "type": "string" }, "jobTitle": { "type": "string" }, "keywords": { "type": "array", "items": { "type": "string" } }, "lastName": { "type": "string" }, "linkedinUrl": { "type": "string" }, "location": { "type": "string" }, "lookalikeCompanyCategories": { "type": "array", "items": { "$ref": "#/definitions/CompanyCategory" } }, "lookalikeCompanyFundingStage": { "description": "Company Lookalikes fields", "allOf": [ { "$ref": "#/definitions/CompanyFundingRound" } ] }, "lookalikeCompanyScore": { "type": "number" }, "profilePictureUrl": { "type": "string" }, "tooltip": { "$ref": "#/definitions/TooltipResponse" } } }, "ListContactRevenueRange": { "type": "object", "properties": { "end": { "type": "integer" }, "start": { "type": "integer" } } }, "ListContactsResponse": { "type": "object", "properties": { "cursor": { "type": "string" }, "emptyStateType": { "$ref": "#/definitions/EmptyStateType" }, "endReached": { "type": "boolean" }, "leads": { "type": "array", "items": { "$ref": "#/definitions/ListContactResponse" } }, "limitReached": { "type": "boolean" } } }, "ListPath": { "type": "string", "enum": [ "none", "icp", "company_lookalikes", "company_followers", "uploaded_contacts", "extension", "signals_funding", "signals_investors", "signals_job_change", "signals_acquisitions", "maps_discovery", "signals_hiring" ], "x-enum-varnames": [ "ListPathNone", "ListPathICP", "ListPathCompanyLookalikes", "ListPathCompanyFollowers", "ListPathUploadedContacts", "ListPathExtension", "ListPathSignalsFunding", "ListPathSignalsInvestors", "ListPathSignalsJobChange", "ListPathSignalsAcquisitions", "ListPathMapsDiscovery", "ListPathSignalsHiring" ] }, "ListResponse": { "type": "object", "properties": { "companyFollowersFilters": { "$ref": "#/definitions/CompanyFollowersFilters" }, "companyLookalikeFilters": { "$ref": "#/definitions/CompanyLookalikeFilters" }, "createdAt": { "type": "string" }, "displayOptions": { "$ref": "#/definitions/DisplayOptions" }, "enriched": { "description": "Enriched is true when at least one contact has an enriched email, phone, LinkedIn or qualification result.", "type": "boolean" }, "filterCounts": { "$ref": "#/definitions/FilterCountsResponse" }, "filters": { "$ref": "#/definitions/PersonSearchFilters" }, "id": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/MessageResponse" } }, "name": { "type": "string" }, "refreshContacts": { "type": "boolean" }, "resolvedFilters": { "$ref": "#/definitions/ResolvedFilterValues" }, "signalFilters": { "type": "object" }, "updatedAt": { "type": "string" } } }, "ListSignalCompaniesResponse": { "type": "object", "properties": { "companies": { "type": "array", "items": { "$ref": "#/definitions/SignalCompanyResponse" } }, "companiesSelected": { "type": "integer" }, "companiesTotal": { "type": "integer" }, "hasMore": { "type": "boolean" } } }, "Location": { "type": "object", "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" } } }, "LocationResponse": { "type": "object", "properties": { "countryCode": { "type": "string" }, "name": { "type": "string" } } }, "LocationSuggestionsResponse": { "type": "object", "properties": { "suggestions": { "type": "array", "items": { "type": "string" } } } }, "LookalikeCompany": { "type": "object", "properties": { "description": { "type": "string" }, "domain": { "type": "string" }, "industry": { "type": "string" }, "keywords": { "type": "array", "items": { "type": "string" } }, "logo": { "type": "string" }, "name": { "type": "string" }, "website": { "type": "string" } } }, "LookalikesLocation": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/CompanyLookalikesLocationType" } } }, "LookalikesLocationsResponse": { "type": "object", "properties": { "locations": { "type": "array", "items": { "$ref": "#/definitions/LookalikesLocation" } } } }, "LookalikesPreviewRequest": { "type": "object", "required": [ "domains" ], "properties": { "categories": { "type": "array", "items": { "type": "string" } }, "domains": { "type": "array", "maxItems": 10, "minItems": 1, "items": { "type": "string" } }, "employeeRanges": { "type": "array", "items": { "type": "string" } }, "fundingStages": { "type": "array", "items": { "type": "string" } }, "locations": { "type": "array", "items": { "$ref": "#/definitions/CompanyLookalikesLocation" } } } }, "LookalikesPreviewResponse": { "type": "object", "properties": { "companies": { "type": "array", "items": { "$ref": "#/definitions/LookalikeCompany" } }, "totalCount": { "type": "integer" } } }, "LookalikesSearchRequest": { "type": "object", "required": [ "domains" ], "properties": { "categories": { "type": "array", "items": { "type": "string" } }, "domains": { "type": "array", "maxItems": 10, "minItems": 1, "items": { "type": "string" } }, "employeeRanges": { "type": "array", "items": { "type": "string" } }, "fundingStages": { "type": "array", "items": { "type": "string" } }, "locations": { "type": "array", "items": { "$ref": "#/definitions/CompanyLookalikesLocation" } }, "page": { "type": "integer", "minimum": 1 }, "pageSize": { "type": "integer", "maximum": 100, "minimum": 1 } } }, "LookalikesSearchResponse": { "type": "object", "properties": { "companies": { "type": "array", "items": { "$ref": "#/definitions/LookalikeCompany" } }, "page": { "type": "integer" }, "totalCount": { "type": "integer" }, "totalPages": { "type": "integer" } } }, "MapsBusinessItem": { "type": "object", "properties": { "address": { "type": "string", "example": "1560 Broadway, New York, NY 10036" }, "businessID": { "type": "string", "example": "3c1a2b4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d" }, "category": { "type": "string", "example": "Dentist" }, "domain": { "type": "string", "example": "www.salesforge.ai" }, "lat": { "type": "number", "example": 40.759 }, "lng": { "type": "number", "example": -73.9845 }, "name": { "type": "string", "example": "Salesforge Dental" }, "permanentlyClosed": { "type": "boolean", "example": false }, "phone": { "type": "string", "example": "+1 212 555 0100" }, "placeID": { "type": "string", "example": "ChIJN1t_tDeuEmsRUsoyG83frY4" }, "rating": { "type": "number", "example": 4.7 }, "reviewsCount": { "type": "integer", "example": 128 }, "temporarilyClosed": { "type": "boolean", "example": false } } }, "MapsBusinessResponse": { "type": "object", "properties": { "address": { "type": "string" }, "category": { "type": "string" }, "domain": { "type": "string" }, "id": { "type": "string" }, "lat": { "type": "number" }, "lng": { "type": "number" }, "name": { "type": "string" }, "permanentlyClosed": { "type": "boolean" }, "phone": { "type": "string" }, "placeID": { "type": "string" }, "rating": { "type": "number" }, "reviewsCount": { "type": "integer" }, "temporarilyClosed": { "type": "boolean" } } }, "MapsCategoriesResponse": { "type": "object", "properties": { "categories": { "type": "array", "items": { "type": "string" }, "example": [ "Accounting", "Bakery", "Dentist" ] } } }, "MapsListSearchResponse": { "type": "object", "properties": { "completedAt": { "type": "string" }, "createdAt": { "type": "string" }, "foundCount": { "type": "integer" }, "lastError": { "type": "string" }, "limitRequested": { "type": "integer" }, "params": { "$ref": "#/definitions/MapsSearchParamsResponse" }, "requestID": { "type": "string" }, "status": { "type": "string" } } }, "MapsOwnerBusinessItem": { "type": "object", "properties": { "businessID": { "type": "string", "example": "3c1a2b4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d" }, "reason": { "type": "string", "example": "business not found or not owned by account" }, "status": { "type": "string", "enum": [ "queued", "cached", "skipped", "already_enriching" ], "example": "queued" } } }, "MapsOwnerJobResponse": { "type": "object", "properties": { "accepted": { "type": "integer", "example": 48 }, "businesses": { "type": "array", "items": { "$ref": "#/definitions/MapsOwnerBusinessItem" } }, "clientRequestID": { "type": "string", "example": "req_12345" }, "completedAt": { "type": "string", "example": "2026-09-13T12:25:00Z" }, "consumedCredits": { "type": "number", "example": 0 }, "createdAt": { "type": "string", "example": "2026-09-13T12:10:00Z" }, "error": { "description": "set on failed jobs, and on completed jobs whose email/phone backfill stopped early for insufficient credits", "type": "string" }, "jobID": { "type": "string", "example": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d" }, "maxResults": { "type": "integer", "example": 3 }, "ownersFound": { "type": "integer", "example": 0 }, "processed": { "type": "integer", "example": 12 }, "reservedCredits": { "type": "number", "example": 2880 }, "resultsURL": { "type": "string", "example": "/public/v1/maps-discovery/owner-jobs/9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d/results" }, "searchJobID": { "type": "string", "example": "5f1c2e3a-0b1d-4c2e-9f3a-1b2c3d4e5f60" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "failed", "no_results" ], "example": "in_progress" }, "statusURL": { "type": "string", "example": "/public/v1/maps-discovery/owner-jobs/9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d" }, "total": { "type": "integer", "example": 50 }, "updatedAt": { "type": "string", "example": "2026-09-13T12:11:00Z" }, "wantEmail": { "type": "boolean", "example": true }, "wantPhone": { "type": "boolean", "example": true }, "webhookURL": { "type": "string", "example": "https://example.com/webhooks/maps-owners" } } }, "MapsOwnerJobResultsResponse": { "type": "object", "properties": { "jobID": { "type": "string", "example": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d" }, "limit": { "type": "integer", "example": 50 }, "offset": { "type": "integer", "example": 0 }, "results": { "type": "array", "items": { "$ref": "#/definitions/MapsOwnerLeadItem" } }, "total": { "type": "integer", "example": 37 } } }, "MapsOwnerJobsListResponse": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "$ref": "#/definitions/MapsOwnerJobResponse" } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer" } } }, "MapsOwnerLeadItem": { "type": "object", "properties": { "businessID": { "type": "string", "example": "3c1a2b4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d" }, "companyName": { "type": "string", "example": "Salesforge Dental" }, "domain": { "type": "string", "example": "salesforge.ai" }, "email": { "type": "string", "example": "jane@salesforge.ai" }, "emailStatus": { "type": "string", "enum": [ "not_enriched", "queued", "in_progress", "enriched", "not_found", "failed", "skipped", "out_of_credits", "enqueue_failed" ], "example": "enriched" }, "firstName": { "type": "string", "example": "Jane" }, "fullName": { "type": "string", "example": "Jane Smith" }, "lastName": { "type": "string", "example": "Smith" }, "personID": { "type": "string", "example": "7d3f2a1b-9c8e-5f4a-8b7c-6d5e4f3a2b1c" }, "phone": { "type": "string", "example": "+1 212 555 0100" }, "phoneStatus": { "type": "string", "enum": [ "not_enriched", "queued", "in_progress", "enriched", "not_found", "failed", "skipped", "out_of_credits", "enqueue_failed" ], "example": "enriched" }, "title": { "type": "string", "example": "Owner" } } }, "MapsSearchJobResponse": { "type": "object", "properties": { "categories": { "type": "array", "items": { "type": "string" }, "example": [ "Dentist", "Dental Clinic" ] }, "clientRequestID": { "type": "string", "example": "req_12345" }, "completedAt": { "type": "string", "example": "2026-09-13T12:05:00Z" }, "consumedCredits": { "type": "number", "example": 143 }, "createdAt": { "type": "string", "example": "2026-09-13T12:00:00Z" }, "error": { "type": "string" }, "foundCount": { "type": "integer", "example": 143 }, "jobID": { "type": "string", "example": "5f1c2e3a-0b1d-4c2e-9f3a-1b2c3d4e5f60" }, "language": { "type": "string", "example": "en" }, "lat": { "type": "number", "example": 40.758 }, "limit": { "type": "integer", "example": 200 }, "lng": { "type": "number", "example": -73.9855 }, "radiusKm": { "type": "number", "example": 5 }, "reservedCredits": { "type": "number", "example": 200 }, "resultsURL": { "type": "string", "example": "/public/v1/maps-discovery/jobs/5f1c2e3a-0b1d-4c2e-9f3a-1b2c3d4e5f60/results" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "failed", "no_results" ], "example": "in_progress" }, "statusURL": { "type": "string", "example": "/public/v1/maps-discovery/jobs/5f1c2e3a-0b1d-4c2e-9f3a-1b2c3d4e5f60" }, "updatedAt": { "type": "string", "example": "2026-09-13T12:01:00Z" }, "webhookURL": { "type": "string", "example": "https://example.com/webhooks/maps-search" } } }, "MapsSearchJobResultsResponse": { "type": "object", "properties": { "jobID": { "type": "string", "example": "5f1c2e3a-0b1d-4c2e-9f3a-1b2c3d4e5f60" }, "limit": { "type": "integer", "example": 50 }, "offset": { "type": "integer", "example": 0 }, "results": { "type": "array", "items": { "$ref": "#/definitions/MapsBusinessItem" } }, "total": { "type": "integer", "example": 143 } } }, "MapsSearchJobsListResponse": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "$ref": "#/definitions/MapsSearchJobResponse" } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer" } } }, "MapsSearchParamsResponse": { "type": "object", "properties": { "categories": { "type": "array", "items": { "type": "string" } }, "language": { "type": "string" }, "lat": { "type": "number" }, "limit": { "type": "integer" }, "lng": { "type": "number" }, "radiusKm": { "type": "number" } } }, "MapsSearchResultsResponse": { "type": "object", "properties": { "businesses": { "type": "array", "items": { "$ref": "#/definitions/MapsBusinessResponse" } }, "limit": { "type": "integer" }, "offset": { "type": "integer" } } }, "MessageAction": { "type": "object", "properties": { "id": { "type": "string" }, "text": { "type": "string" }, "value": { "type": "string" } } }, "MessageActions": { "type": "object", "properties": { "options": { "type": "array", "items": { "$ref": "#/definitions/MessageAction" } }, "selectionMode": { "$ref": "#/definitions/ActionSelectionMode" } } }, "MessageResponse": { "type": "object", "properties": { "actions": { "$ref": "#/definitions/MessageActions" }, "created_at": { "type": "string" }, "extraData": {}, "id": { "type": "string" }, "role": { "$ref": "#/definitions/MessageRole" }, "status": { "$ref": "#/definitions/SystemMessageStatus" }, "text": { "type": "string" } } }, "MessageRole": { "type": "string", "enum": [ "system", "user" ], "x-enum-varnames": [ "MessageRoleSystem", "MessageRoleUser" ] }, "MinMaxFilter": { "type": "object", "properties": { "max": { "type": "integer" }, "min": { "type": "integer" } } }, "NicheResponse": { "type": "object", "properties": { "name": { "type": "string" } } }, "PersonIdentity": { "type": "object", "properties": { "company": { "type": "string" }, "firstName": { "type": "string" }, "jobTitle": { "type": "string" }, "lastName": { "type": "string" }, "location": { "type": "string" } } }, "PersonInput": { "type": "object", "properties": { "company": { "type": "string", "example": "Salesforge" }, "companyDomain": { "type": "string", "example": "salesforge.ai" }, "externalID": { "type": "string", "maxLength": 128, "example": "crm-contact-42" }, "firstName": { "type": "string", "example": "John" }, "lastName": { "type": "string", "example": "Doe" }, "linkedinURL": { "type": "string", "example": "https://www.linkedin.com/in/john-doe" } } }, "PersonSearchFilters": { "type": "object", "properties": { "companyBusinessModels": { "$ref": "#/definitions/IncludeExcludeFilter" }, "companyDomains": { "$ref": "#/definitions/IncludeExcludeFilter" }, "companyEmployeeNumberRange": { "$ref": "#/definitions/MinMaxFilter" }, "companyFoundedYearRange": { "$ref": "#/definitions/MinMaxFilter" }, "companyFundingRounds": { "$ref": "#/definitions/IncludeExcludeFilter" }, "companyIDs": { "$ref": "#/definitions/IncludeExcludeFilter" }, "companyIndustries": { "$ref": "#/definitions/IncludeExcludeFilter" }, "companyKeywords": { "$ref": "#/definitions/IncludeExcludeAllFilter" }, "companyLocations": { "$ref": "#/definitions/IncludeExcludeFilter" }, "companyNames": { "$ref": "#/definitions/IncludeExcludeFilter" }, "companyNiches": { "$ref": "#/definitions/IncludeExcludeFilter" }, "companyRequired": { "type": "boolean" }, "companyRevenueRanges": { "type": "array", "items": { "$ref": "#/definitions/RevenueCategory" } }, "companyTechnologies": { "$ref": "#/definitions/AnyAllFilter" }, "companyTypes": { "$ref": "#/definitions/IncludeExcludeFilter" }, "companyYearsInBusinessRange": { "$ref": "#/definitions/MinMaxFilter" }, "leadDepartments": { "$ref": "#/definitions/IncludeExcludeFilter" }, "leadIDs": { "$ref": "#/definitions/IncludeExcludeFilter" }, "leadJobTitles": { "$ref": "#/definitions/JobTitleFilter" }, "leadLanguages": { "$ref": "#/definitions/LanguageFilter" }, "leadLocations": { "$ref": "#/definitions/IncludeExcludeFilter" }, "leadSeniorities": { "$ref": "#/definitions/IncludeExcludeFilter" }, "leadTenure": { "$ref": "#/definitions/MinMaxFilter" }, "maxContactsPerCompany": { "type": "integer", "maximum": 100, "minimum": 0 } } }, "PersonSearchRequest": { "type": "object", "properties": { "companyBusinessModels": { "$ref": "#/definitions/IncludeExcludeFilter" }, "companyDomains": { "$ref": "#/definitions/IncludeExcludeFilter" }, "companyEmployeeNumberRange": { "$ref": "#/definitions/MinMaxFilter" }, "companyFoundedYearRange": { "$ref": "#/definitions/MinMaxFilter" }, "companyFundingRounds": { "$ref": "#/definitions/IncludeExcludeFilter" }, "companyIDs": { "$ref": "#/definitions/IncludeExcludeFilter" }, "companyIndustries": { "$ref": "#/definitions/IncludeExcludeFilter" }, "companyKeywords": { "$ref": "#/definitions/IncludeExcludeAllFilter" }, "companyLocations": { "$ref": "#/definitions/IncludeExcludeFilter" }, "companyNames": { "$ref": "#/definitions/IncludeExcludeFilter" }, "companyNiches": { "$ref": "#/definitions/IncludeExcludeFilter" }, "companyRequired": { "type": "boolean" }, "companyRevenueRanges": { "type": "array", "items": { "$ref": "#/definitions/RevenueCategory" } }, "companyTechnologies": { "$ref": "#/definitions/AnyAllFilter" }, "companyTypes": { "$ref": "#/definitions/IncludeExcludeFilter" }, "companyYearsInBusinessRange": { "$ref": "#/definitions/MinMaxFilter" }, "leadDepartments": { "$ref": "#/definitions/IncludeExcludeFilter" }, "leadIDs": { "$ref": "#/definitions/IncludeExcludeFilter" }, "leadJobTitles": { "$ref": "#/definitions/JobTitleFilter" }, "leadLanguages": { "$ref": "#/definitions/LanguageFilter" }, "leadLocations": { "$ref": "#/definitions/IncludeExcludeFilter" }, "leadSeniorities": { "$ref": "#/definitions/IncludeExcludeFilter" }, "leadTenure": { "$ref": "#/definitions/MinMaxFilter" }, "limit": { "type": "integer", "maximum": 2000, "minimum": 1 }, "maxContactsPerCompany": { "type": "integer", "maximum": 100, "minimum": 0 } } }, "PlanType": { "type": "string", "enum": [ "free", "growth", "internal" ], "x-enum-varnames": [ "PlanTypeFree", "PlanTypeGrowth", "PlanTypeInternal" ] }, "ProcessCompanyFileRequest": { "type": "object", "required": [ "fileID" ], "properties": { "exclude": { "type": "boolean" }, "fileID": { "type": "string" }, "linkedinColumn": { "type": "string" }, "websiteColumn": { "type": "string" } } }, "ProgressState": { "type": "string", "enum": [ "none", "filtering", "searching", "completed", "failed" ], "x-enum-varnames": [ "ProgressStateNone", "ProgressStateFiltering", "ProgressStateSearching", "ProgressStateCompleted", "ProgressStateFailed" ] }, "PublicEnrichmentChannel": { "type": "string", "enum": [ "email", "phone", "linkedin" ], "x-enum-varnames": [ "PublicEnrichmentChannelEmail", "PublicEnrichmentChannelPhone", "PublicEnrichmentChannelLinkedIn" ] }, "PublicEnrichmentResultStatus": { "type": "string", "enum": [ "succeeded", "failed", "not_found" ], "x-enum-varnames": [ "PublicEnrichmentResultStatusSucceeded", "PublicEnrichmentResultStatusFailed", "PublicEnrichmentResultStatusNotFound" ] }, "ReEnrichListRequest": { "type": "object", "properties": { "amount": { "type": "integer", "minimum": 0 }, "enrichEmail": { "type": "boolean" }, "enrichLinkedin": { "type": "boolean" }, "enrichPhoneNumber": { "type": "boolean" }, "excludeIDs": { "type": "array", "items": { "type": "string" } }, "includeIDs": { "type": "array", "items": { "type": "string" } }, "leadQualification": { "type": "boolean" }, "linkedinEnrichmentCondition": { "$ref": "#/definitions/LinkedinEnrichmentCondition" }, "outOfCredits": { "type": "boolean" }, "qualification": { "type": "string" }, "replaceContactCondition": { "$ref": "#/definitions/ReplaceLeadCondition" } } }, "ReplaceLeadCondition": { "type": "string", "enum": [ "none", "until_email_found", "until_phone_found", "until_email_or_phone_found" ], "x-enum-varnames": [ "ReplaceLeadConditionNone", "ReplaceLeadConditionUntilEmailFound", "ReplaceLeadConditionUntilPhoneFound", "ReplaceLeadConditionUntilEmailOrPhoneFound" ] }, "ResolvedFilterValues": { "type": "object", "properties": { "companyFundingRounds": { "type": "object", "additionalProperties": { "type": "string" } }, "companyIDs": { "type": "object", "additionalProperties": { "type": "string" } }, "companyTypes": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ResultWebhookAttempt": { "type": "object", "properties": { "delivered": { "type": "boolean" }, "error": { "type": "string" }, "statusCode": { "type": "integer" } } }, "RevenueCategory": { "type": "string", "enum": [ "very_small", "small_lower", "small_upper", "lower_mid_sized", "mid_sized_lower", "mid_sized_upper", "large_lower", "large_upper", "enterprise_lower", "enterprise_upper", "global_giants_lower", "global_giants_upper", "super_enterprises" ], "x-enum-varnames": [ "RevenueVerySmall", "RevenueSmallLower", "RevenueSmallUpper", "RevenueLowerMidSized", "RevenueMidSizedLower", "RevenueMidSizedUpper", "RevenueLargeLower", "RevenueLargeUpper", "RevenueEnterpriseLower", "RevenueEnterpriseUpper", "RevenueGlobalGiantsLower", "RevenueGlobalGiantsUpper", "RevenueSuperEnterprises" ] }, "RevenueRange": { "type": "object", "properties": { "end": { "type": "integer" }, "start": { "type": "integer" } } }, "RevenueRangeResponse": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "$ref": "#/definitions/RevenueCategory" } } }, "RevenueRangesResponse": { "type": "object", "properties": { "revenueRanges": { "type": "array", "items": { "$ref": "#/definitions/RevenueRangeResponse" } } } }, "SalesforgeWorkspaceResponse": { "type": "object", "properties": { "accountId": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "userCanImport": { "type": "boolean" } } }, "SearchCountResponse": { "type": "object", "properties": { "totalCount": { "type": "integer" }, "warnings": { "type": "array", "items": { "$ref": "#/definitions/FilterWarning" } } } }, "SearchResponse": { "type": "object", "properties": { "cursor": { "type": "string" }, "leads": { "type": "array", "items": { "$ref": "#/definitions/Lead" } }, "warnings": { "type": "array", "items": { "$ref": "#/definitions/FilterWarning" } } } }, "SeedEnrichmentContactDTO": { "type": "object", "required": [ "email", "firstName", "linkedinUrl" ], "properties": { "company": { "type": "string" }, "email": { "type": "string" }, "externalRef": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "linkedinUrl": { "type": "string" }, "location": { "type": "string" }, "title": { "type": "string" } } }, "SeedEnrichmentPersonIDMapping": { "type": "object", "properties": { "externalRef": { "type": "string" }, "personID": { "type": "string" } } }, "SeedEnrichmentRowsExternalRequest": { "type": "object", "required": [ "contacts" ], "properties": { "agent": { "$ref": "#/definitions/AgentPayload" }, "contacts": { "type": "array", "minItems": 1, "items": { "$ref": "#/definitions/SeedEnrichmentContactDTO" } }, "criteria": { "type": "array", "maxItems": 5, "items": { "$ref": "#/definitions/CreateExtraColumnItem" } }, "name": { "type": "string" }, "triggerQualification": { "type": "boolean" } } }, "SeedEnrichmentRowsExternalResponse": { "type": "object", "properties": { "listID": { "type": "string" }, "mappings": { "type": "array", "items": { "$ref": "#/definitions/SeedEnrichmentPersonIDMapping" } } } }, "SenioritiesResponse": { "type": "object", "properties": { "seniorities": { "type": "array", "items": { "type": "string" } } } }, "SeniorityBreakdownItem": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" }, "seniorityId": { "type": "string" }, "seniorityLevel": { "type": "string" } } }, "SignalCompanyResponse": { "type": "object", "properties": { "companyId": { "type": "string" }, "country": { "type": "string" }, "includeInFilter": { "type": "boolean" }, "logo": { "type": "string" }, "name": { "type": "string" }, "signals": { "type": "array", "items": { "type": "object" } }, "website": { "type": "string" } } }, "SignalCountResponse": { "type": "object", "properties": { "total": { "type": "integer" } } }, "SignalExtractionJobStatus": { "type": "string", "enum": [ "pending", "in_progress", "post_fetch_processing", "completed", "failed" ], "x-enum-varnames": [ "SignalExtractionJobStatusPending", "SignalExtractionJobStatusInProgress", "SignalExtractionJobStatusPostFetchProcessing", "SignalExtractionJobStatusCompleted", "SignalExtractionJobStatusFailed" ] }, "SignalFilterValueResponse": { "type": "object", "properties": { "name": { "type": "string" } } }, "StartCSVEnrichmentRequest": { "type": "object", "properties": { "acknowledgeMappingWarnings": { "type": "boolean" } } }, "StartCompanyFollowersSearchRequest": { "type": "object", "required": [ "limit", "linkedinUrl" ], "properties": { "clientRequestID": { "type": "string", "maxLength": 128, "example": "req_12345" }, "countries": { "type": "array", "items": { "type": "string" }, "example": [ "United States", "Germany" ] }, "departments": { "type": "array", "items": { "type": "string" }, "example": [ "Engineering", "Marketing" ] }, "jobTitles": { "type": "array", "items": { "type": "string" }, "example": [ "Software Engineer", "Product Manager" ] }, "levels": { "type": "array", "items": { "type": "string" }, "example": [ "Senior", "Director" ] }, "limit": { "type": "integer", "maximum": 50000, "minimum": 1, "example": 500 }, "linkedinUrl": { "type": "string", "example": "https://www.linkedin.com/company/salesforgeai" }, "metros": { "type": "array", "items": { "type": "string" }, "example": [ "San Francisco Bay Area", "London Area", " United Kingdom" ] }, "states": { "type": "array", "items": { "type": "string" }, "example": [ "California", "Bavaria" ] }, "webhookURL": { "type": "string", "example": "https://example.com/webhooks/followers" } } }, "StartEnrichmentRequest": { "type": "object", "properties": { "clientRequestID": { "type": "string", "maxLength": 128, "example": "my-request-123" }, "people": { "type": "array", "maxItems": 500, "minItems": 1, "items": { "$ref": "#/definitions/PersonInput" } }, "personIDs": { "type": "array", "maxItems": 500, "minItems": 1, "items": { "type": "string" }, "example": [ "p_abc123", "p_def456" ] }, "saveToList": { "type": "boolean", "example": false }, "webhookURL": { "type": "string", "example": "https://example.com/webhook" } } }, "StartMapsDiscoverySearchRequest": { "type": "object", "required": [ "categories", "limit", "radiusKm" ], "properties": { "categories": { "description": "Categories are OR-combined. Recommended values: GET /maps-discovery/filters/categories; free text is accepted too.", "type": "array", "maxItems": 100, "minItems": 1, "items": { "type": "string" }, "example": [ "Dentist", "Dental Clinic" ] }, "clientRequestID": { "type": "string", "maxLength": 128, "example": "req_12345" }, "language": { "type": "string", "maxLength": 10, "example": "en" }, "lat": { "type": "number", "maximum": 90, "minimum": -90, "example": 40.758 }, "limit": { "type": "integer", "maximum": 5000, "minimum": 1, "example": 200 }, "lng": { "type": "number", "maximum": 180, "minimum": -180, "example": -73.9855 }, "radiusKm": { "type": "number", "maximum": 500, "example": 5 }, "webhookURL": { "type": "string", "example": "https://example.com/webhooks/maps-search" } } }, "StartMapsSearchRequest": { "type": "object", "required": [ "categories", "limit", "radiusKm" ], "properties": { "categories": { "description": "Categories are OR-combined: a business matching any of them is returned.\n`min=1` on the slice rejects an empty array: go-playground's `required`\nonly checks for a non-nil slice, so a present-but-empty `\"categories\": []`\nwould otherwise slip through to the domain validation and surface as a 500\ninstead of a 400. `max=100` bounds the count so an unbounded OR list cannot\nballoon the async job / provider query - generous enough that a real\ncustomer never hits it.", "type": "array", "maxItems": 100, "minItems": 1, "items": { "type": "string" } }, "language": { "type": "string", "maxLength": 10 }, "lat": { "description": "Lat / Lng omit the `required` validator on purpose: go-playground's\n`required` treats zero as missing, which would 400 valid searches on\nthe equator (lat=0) or the Greenwich meridian (lng=0, e.g. London).\nThe min/max bounds still reject out-of-range values.", "type": "number", "maximum": 90, "minimum": -90 }, "limit": { "type": "integer", "maximum": 5000, "minimum": 1 }, "listID": { "description": "ListID re-searches into an existing maps discovery list (new search job,\nsame list). Empty creates a fresh list, returned as listID so the search\nappears in the sidebar.", "type": "string" }, "lng": { "type": "number", "maximum": 180, "minimum": -180 }, "radiusKm": { "type": "number", "maximum": 500 } } }, "StartMapsSearchResponse": { "type": "object", "properties": { "limitRequested": { "type": "integer" }, "listID": { "type": "string" }, "maxCostCredits": { "type": "number" }, "requestID": { "type": "string" }, "unitPriceCredits": { "type": "number" } } }, "Subscription": { "type": "object", "properties": { "breakdown": { "type": "array", "items": { "$ref": "#/definitions/SubscriptionBreakdownItem" } }, "id": { "type": "string" }, "price": { "type": "number" }, "renewsAt": { "type": "string" } } }, "SubscriptionBreakdownItem": { "type": "object", "properties": { "name": { "type": "string" }, "price": { "type": "number" }, "quantity": { "type": "number" } } }, "SubscriptionStatus": { "type": "string", "enum": [ "none", "active", "paused", "cancelled" ], "x-enum-varnames": [ "SubscriptionStatusNone", "SubscriptionStatusActive", "SubscriptionStatusPaused", "SubscriptionStatusCancelled" ] }, "SuggestionsResponse": { "type": "object", "properties": { "suggestions": { "type": "array", "items": { "type": "string" } } } }, "SyncEnrichmentRequest": { "type": "object", "properties": { "company": { "type": "string", "example": "Salesforge" }, "companyDomain": { "type": "string", "example": "salesforge.ai" }, "externalID": { "type": "string", "maxLength": 128, "example": "crm-contact-42" }, "firstName": { "type": "string", "example": "John" }, "lastName": { "type": "string", "example": "Doe" }, "linkedinURL": { "type": "string", "example": "https://www.linkedin.com/in/john-doe" }, "personID": { "type": "string", "example": "p_abc123" } } }, "SyncEnrichmentResponse": { "type": "object", "properties": { "channel": { "type": "string" }, "email": { "type": "string" }, "externalID": { "type": "string" }, "personID": { "type": "string" }, "phoneNumber": { "type": "string" }, "status": { "type": "string" } } }, "SystemMessageStatus": { "type": "string", "enum": [ "pending", "ready" ], "x-enum-varnames": [ "SystemMessageStatusPending", "SystemMessageStatusReady" ] }, "TechnologyResponse": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "TooltipResponse": { "type": "object", "properties": { "evidence": { "type": "object" }, "success": { "type": "boolean" } } }, "UpdateListRequest": { "type": "object", "properties": { "companyFollowersFilters": { "$ref": "#/definitions/CompanyFollowersFilters" }, "companyLookalikeFilters": { "$ref": "#/definitions/CompanyLookalikeFilters" }, "filters": { "$ref": "#/definitions/PersonSearchFilters" }, "name": { "type": "string", "maxLength": 100 }, "signalFilters": { "type": "object" } } }, "UpdateSignalCompanyRequest": { "type": "object", "required": [ "companyId", "includeInFilter" ], "properties": { "companyId": { "type": "string" }, "includeInFilter": { "type": "boolean" } } }, "UpdateSubscriptionRequest": { "type": "object", "required": [ "billingPeriod", "exportCreditsTier" ], "properties": { "billingPeriod": { "enum": [ "monthly", "yearly" ], "allOf": [ { "$ref": "#/definitions/BillingPeriod" } ] }, "exportCreditsTier": { "type": "integer", "minimum": 1 } } }, "UpdateUserRequest": { "type": "object", "properties": { "exportCreditsLimit": { "type": "integer" }, "role": { "type": "string", "enum": [ "admin", "member" ] } } }, "UserInvitationResponse": { "type": "object", "properties": { "accountID": { "type": "string" }, "companyName": { "type": "string" }, "createdAt": { "type": "string" }, "email": { "type": "string" }, "expiresAt": { "type": "string" }, "id": { "type": "string" }, "invitedBy": { "type": "string" }, "role": { "type": "string" }, "token": { "type": "string" }, "usedAt": { "type": "string" } } }, "UserReplyRequest": { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string" } } }, "ValidateUserInvitationRequest": { "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string" } } }, "resumeCompanyFollowersRequest": { "type": "object", "properties": { "requestID": { "type": "string" } } } }, "securityDefinitions": { "Bearer": { "type": "apiKey", "name": "Authorization", "in": "header" } } }