### List signal templates response Source: https://docs.getwhitewhale.com/api Example response from GET /v1/get_signal_templates showing the structure of Template objects with title, question, complete flag, and examples for templates with placeholders. ```json { "templates": [ { "title": "M&A", "question": "Did {account} recently acquire or merge with another company?", "complete": true }, { "title": "Hiring", "question": "Is {account} hiring for <>?", "complete": false, "examples": [ "Is {account} hiring for engineers?", "Is {account} hiring for any sales positions?" ] } ] } ``` -------------------------------- ### GET /v1/get_signal_templates Source: https://docs.getwhitewhale.com/api Returns the list of signal question formats the platform supports. Use these to validate signal text before adding via the API. ```APIDOC ## GET /v1/get_signal_templates ### Description Returns the list of signal question formats the platform supports. Use these to validate signal text before adding via the API. ### Method GET ### Endpoint /v1/get_signal_templates ### Response #### Success Response (200) - **templates** (array) - Array of Template objects with the question format, a title, whether the template is complete, and examples for templates with placeholders. #### Response Example { "templates": [ { "title": "M&A", "question": "Did {account} recently acquire or merge with another company?", "complete": true }, { "title": "Hiring", "question": "Is {account} hiring for <>?", "complete": false, "examples": [ "Is {account} hiring for engineers?", "Is {account} hiring for any sales positions?" ] } ] } ``` -------------------------------- ### GET /v1/icp/details Source: https://docs.getwhitewhale.com/api Returns details for one or all ICPs in your instance, including signals, Account Suggestions mode, and constraints. ```APIDOC ## GET /v1/icp/details ### Description Returns details for one or all ICPs in your instance, including signals, Account Suggestions mode, and constraints. ### Method GET ### Endpoint /v1/icp/details ### Parameters #### Query Parameters - **icp_ids** (array) - Optional - ICP IDs to fetch. If omitted, returns all ICPs in your instance. ``` -------------------------------- ### POST /v1/create_user_request Source: https://docs.getwhitewhale.com/api Programmatically invite a new user to your WhiteWhale instance. ```APIDOC ## POST /v1/create_user_request ### Description Programmatically invite a new user to your WhiteWhale instance. ### Method POST ### Endpoint /v1/create_user_request ### Parameters #### Request Body - **email** (string) - Required - Email address for the new user. Stored entirely lowercase. - **email_alerts** (boolean) - Optional - Default false. Set to true to enable email alerts for this user. ### Errors - **403** - Out of user seats - **409** - A user with that email already exists ``` -------------------------------- ### GET /v1/get_user_data Source: https://docs.getwhitewhale.com/api Returns signals, ICPs, remaining credits, and active account count for the authenticated user. ```APIDOC ## GET /v1/get_user_data ### Description Returns signals, ICPs, remaining credits, and active account count for the authenticated user. ### Method GET ### Endpoint /v1/get_user_data ### Response #### Success Response (200) - **icps** (list) - List of ICP names - **icp_id_dict** (map) - Map of ICP name → ICP ID - **signals** (list) - All signals across the user’s ICPs - **credits_remaining** (number) - Remaining account credits - **active_accounts** (number) - Current active account count ``` -------------------------------- ### GET /v1/utilities/industries Source: https://docs.getwhitewhale.com/api Returns all valid industry strings accepted by the API. Maps to LinkedIn’s industry taxonomy. ```APIDOC ## GET /v1/utilities/industries ### Description Returns all valid industry strings accepted by the API. Maps to LinkedIn’s industry taxonomy. ### Method GET ### Endpoint /v1/utilities/industries ### Response #### Success Response (200) - **body** (array of strings) - List of valid industry strings. #### Response Example [ "Technology", "Finance", "Healthcare" ] ``` -------------------------------- ### POST /v1/icp/farsight_state_switch Source: https://docs.getwhitewhale.com/api Activates or deactivates Account Suggestions for an ICP. ```APIDOC ## POST /v1/icp/farsight_state_switch ### Description Activates or deactivates Account Suggestions for an ICP. ### Method POST ### Endpoint /v1/icp/farsight_state_switch ### Parameters #### Request Body - **icp_id** (string) - ICP to update - **state** (string) - "false" (off), "limited" (only scans uploaded accounts), or "unlimited" (scans the full internet within your constraints) ### Notes At least one signal of rank 6 (High) is required for Account Suggestions to find new accounts. Account Suggestions runs automatically at 3:00 UTC daily. To trigger immediately, use /v1/icp/run_farsight. ``` -------------------------------- ### GET /v1/get_all_user_data Source: https://docs.getwhitewhale.com/api Returns an array of UserOverview objects for every user in your WhiteWhale instance. Requires admin authentication. ```APIDOC ## GET /v1/get_all_user_data ### Description Returns an array of UserOverview objects for every user in your WhiteWhale instance. Requires admin authentication. ### Method GET ### Endpoint /v1/get_all_user_data ### Response #### Success Response (200) - **array** (array) - Array of UserOverview objects for every user in the instance ``` -------------------------------- ### POST /v1/upload_accounts Source: https://docs.getwhitewhale.com/api Uploads one or more accounts by domain. By default, accounts are sent to Account Suggestions for pre-scoring before being activated, unless farsight is set to false. ```APIDOC ## POST /v1/upload_accounts ### Description Upload one or more accounts by domain. By default, accounts are first sent to Account Suggestions for pre-scoring before being activated. ### Method POST ### Endpoint /v1/upload_accounts ### Parameters #### Request Body - **accounts** (array of strings) - Required - List of account domains to upload - **farsight** (boolean) - Optional - Default `true` — sends to Account Suggestions first. Set to `false` to add directly as active. - **icp** (string) - Optional - ICP to upload accounts to. Default: `Master` ### Notes If `farsight: true` (default), uploaded accounts land in Account Suggestions and must be activated. If you have a webhook configured, you’ll receive a pre-score payload when they’re ready. If `farsight: false`, accounts are immediately active and will consume credits. ``` -------------------------------- ### POST /v1/set_webhook Source: https://docs.getwhitewhale.com/webhooks Registers a webhook URL for your account. One webhook URL per account, and the same endpoint receives all event types. ```APIDOC ## [POST] /v1/set_webhook ### Description Registers a webhook URL for your account. One webhook URL per account, and the same endpoint receives all event types. ### Method POST ### Endpoint https://app.getwhitewhale.com/v1/set_webhook ### Headers - **api-key** (string) - Required - Your API key - **user** (string) - Required - Your account email - **Content-Type** (string) - Required - application/json ### Request Body - **webhook_url** (string) - Required - The URL to receive webhook events ### Request Example ``` curl -X POST https://app.getwhitewhale.com/v1/set_webhook \ -H "api-key: YOUR_API_KEY" \ -H "user: you@company.com" \ -H "Content-Type: application/json" \ -d '{"webhook_url": "https://your-endpoint.com/whitewhale"}' ``` ### Response No response schema is documented in the source. ``` -------------------------------- ### GET /v1/utilities/location_codes Source: https://docs.getwhitewhale.com/api Returns a dictionary of valid country and state codes accepted by the API. Use these codes when setting Account Suggestions geography constraints. ```APIDOC ## GET /v1/utilities/location_codes ### Description Returns a dictionary of valid country and state codes accepted by the API. Use these when setting Account Suggestions geography constraints. ### Method GET ### Endpoint /v1/utilities/location_codes ### Response #### Success Response (200) - **body** (object) - A dictionary of valid country and state codes. #### Response Example { "country_codes": ["US", "CA"], "state_codes": ["AL", "AK"] } ``` -------------------------------- ### API Endpoint: GET /v1/get_account_contacts Source: https://docs.getwhitewhale.com/contacts-overview Use this endpoint to retrieve contact data. You must supply the account_id parameter. This endpoint is also exposed via the MCP, allowing natural language queries. ```http GET /v1/get_account_contacts ``` -------------------------------- ### Step 2: Find contacts in Apollo Source: https://docs.getwhitewhale.com/workflow-guides Prompt for Claude to search Apollo for specific roles (VP Sales, VP Marketing, Head of RevOps) at a company, limited to US-based contacts, and grab emails and phone numbers. ```text For [COMPANY NAME], search Apollo for the following people: - VP Sales, CRO, or Head of Revenue - VP Marketing or Head of Demand Gen - Head of RevOps or Sales Operations Only include people based in the United States. Grab their emails and phone numbers. ``` -------------------------------- ### Step 3: Draft personalized outbound sequence Source: https://docs.getwhitewhale.com/workflow-guides Prompt for Claude to write a 3-step outbound sequence using the WhiteWhale Why Now summary and contact details, including LinkedIn request, email with framework, and follow-up. ```text Using the WhiteWhale Why Now summary for [COMPANY] and the contact details you just found, write a 3-step outbound sequence for [CONTACT NAME], [TITLE]: Step 1: LinkedIn connection request (under 300 characters) Step 2: Email (use the I noticed / I bet / here's how we help / lead magnet framework) Step 3: Follow-up email 3 days later (short, reference the first email) We sell [YOUR PRODUCT] that helps companies [YOUR VALUE PROP]. Use the specific signals — don't be generic. ```