Introduction

Welcome to the Signalist API! You can use our API to access Signalist API endpoints, which can get information on your lists and prospects as well as update them in our database.

We have language bindings in Shell and JavaScript! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

Authentication

To authorize, use this code:

# With shell, you can just pass the correct header with each request
curl "api_endpoint_here" \
  -H "api-key: 123456789"

const axios = require('axios');

const {data} = await axios.patch('/v1/list_person/12345', {
  values: [
    {
      columnName: "test1",
      fieldValue: "column text"
    }
  ]
}, {
  headers: {
    'Content-Type': 'application/json'
    'api-key': "123456789"
  }
});

Make sure to replace 123456789 with your API key.

Signalist uses API keys to allow access to the API. You can register a new API key at our developer portal.

Signalist expects for the API key to be included in all API requests to the server in a header that looks like the following:

api-key: 123456789

Lists

Get All Lists

curl "https://api.signalist.io/api/v1/list" \
  -H "api-key: 123456789"

const axios = require('axios');

const {data} = await axios.get('/v1/list', {
  headers: {
    'Content-Type': 'application/json'
    'api-key': "123456789"
  }
});

The above command returns JSON structured like this:

[
  {
    "id": 1,
    "name": "List1",
  },
  {
    "id": 2,
    "name": "List2",
  }
]

This endpoint retrieves all lists of your organization.

HTTP Request

GET https://api.signalist.io/api/v1/list?page=1&limit=2

Query Parameters

Companies

Get Company Lists

This endpoint retrieves all company lists available in your organization.

HTTP Request

GET https://api.signalist.io/api/v1/list/company

Code Examples

curl "https://api.signalist.io/api/v1/list/company" \
  -H "api-key: 123456789"

const axios = require('axios');

const {data} = await axios.get('/v1/list/company', {
  headers: {
    'Content-Type': 'application/json',
    'api-key': '123456789'
  }
});

The above command returns JSON structured like this:

[
  {
    "id": 1,
    "name": "Tech Companies",
    "entityType": "ORGANIZATION"
  },
  {
    "id": 2,
    "name": "Startups",
    "entityType": "ORGANIZATION"
  }
]

Add Company to List

This endpoint allows you to add a company to a specific list using various identification methods.

HTTP Request

POST https://api.signalist.io/api/v1/list/company/{listId}

URL Parameters

Request Body

The request body accepts the following parameters:

{
  "companyName": "Signalist",
  "websiteUrl": "https://www.signalist.io",
  "linkedinUrl": "https://www.linkedin.com/company/signalist",
  "jobTitle": "Software Engineer",
  "method": "linkedinUrl",
  "customColumns": {
    "customField1": "value1",
    "customField2": "value2"
  }
}

Code Examples

# Add company using LinkedIn URL with all available fields
curl -X POST "https://api.signalist.io/api/v1/list/company/123" \
  -H "Content-Type: application/json" \
  -H "api-key: 123456789" \
  -d '{
    "linkedinUrl": "https://www.linkedin.com/company/signalist",
    "method": "linkedinUrl",
    "jobTitle": "Software Engineer",
    "customColumns": {
      "customField1": "value1"
    }
  }'

# Add company using website URL
curl -X POST "https://api.signalist.io/api/v1/list/company/123" \
  -H "Content-Type: application/json" \
  -H "api-key: 123456789" \
  -d '{
    "websiteUrl": "https://www.signalist.io",
    "method": "websiteUrl"
  }'

# Add company using company name
curl -X POST "https://api.signalist.io/api/v1/list/company/123" \
  -H "Content-Type: application/json" \
  -H "api-key: 123456789" \
  -d '{
    "companyName": "Signalist",
    "method": "companyName"
  }'

const axios = require('axios');

// Add company using LinkedIn URL with all available fields
const response = await axios.post('/v1/list/company/123', {
  linkedinUrl: 'https://www.linkedin.com/company/signalist',
  method: 'linkedinUrl',
  jobTitle: 'Software Engineer',
  customColumns: {
    customField1: 'value1',
    customField2: 'value2'
  }
}, {
  headers: {
    'Content-Type': 'application/json',
    'api-key': '123456789'
  }
});

// Add company using website URL
const response2 = await axios.post('/v1/list/company/123', {
  websiteUrl: 'https://www.signalist.io',
  method: 'websiteUrl'
}, {
  headers: {
    'Content-Type': 'application/json',
    'api-key': '123456789'
  }
});

// Add company using company name
const response3 = await axios.post('/v1/list/company/123', {
  companyName: 'Signalist',
  method: 'companyName'
}, {
  headers: {
    'Content-Type': 'application/json',
    'api-key': '123456789'
  }
});

The above commands return JSON structured like this:

{
  "success": true,
  "processingId": "abc123-def456-ghi789",
  "message": "Company added successfully"
}

Response Parameters

People

Get People Lists

This endpoint retrieves all company lists available in your organization.

HTTP Request

GET https://api.signalist.io/api/v1/list/person

Code Examples

curl "https://api.signalist.io/api/v1/list/person" \
  -H "api-key: 123456789"

const axios = require('axios');

const {data} = await axios.get('/v1/list/person', {
  headers: {
    'Content-Type': 'application/json',
    'api-key': '123456789'
  }
});

The above command returns JSON structured like this:

[
  {
    "id": 1,
    "name": "Tech Companies",
    "entityType": "PERSON"
  },
  {
    "id": 2,
    "name": "Startups",
    "entityType": "PERSON"
  }
]

Add Person to List

This endpoint allows you to add a person to a specific list using various identification methods.

HTTP Request

POST https://api.signalist.io/api/v1/list/person/{listId}

URL Parameters

Request Body

The request body accepts the following optional parameters:

{
  "name": "John Doe",
  "companyName": "Signalist",
  "linkedinUrl": "https://www.linkedin.com/in/johndoe",
  "jobTitle": "Software Engineer",
  "email": "john.doe@signalist.io",
  "companyDomain": "signalist.io",
  "companyLinkedinUrl": "https://www.linkedin.com/company/signalist",
  "customColumns": {
    "customField1": "value1",
    "customField2": "value2"
  }
}

All parameters are optional. You can provide any combination of these fields to identify and add a person to the list.

Code Examples

# Add person with all available fields
curl -X POST "https://api.signalist.io/api/v1/list/person/123" \
  -H "Content-Type: application/json" \
  -H "api-key: 123456789" \
  -d '{
    "name": "John Doe",
    "companyName": "Signalist",
    "linkedinUrl": "https://www.linkedin.com/in/johndoe",
    "jobTitle": "Software Engineer",
    "email": "john.doe@signalist.io",
    "companyDomain": "signalist.io",
    "companyLinkedinUrl": "https://www.linkedin.com/company/signalist",
    "customColumns": {
      "customField1": "value1"
    }
  }'

# Add person with minimal information (only LinkedIn URL)
curl -X POST "https://api.signalist.io/api/v1/list/person/123" \
  -H "Content-Type: application/json" \
  -H "api-key: 123456789" \
  -d '{
    "linkedinUrl": "https://www.linkedin.com/in/johndoe"
  }'

const axios = require('axios');

// Add person with all available fields
const response = await axios.post('/v1/list/person/123', {
  name: 'John Doe',
  companyName: 'Signalist',
  linkedinUrl: 'https://www.linkedin.com/in/johndoe',
  jobTitle: 'Software Engineer',
  email: 'john.doe@signalist.io',
  companyDomain: 'signalist.io',
  companyLinkedinUrl: 'https://www.linkedin.com/company/signalist',
  customColumns: {
    customField1: 'value1',
    customField2: 'value2'
  }
}, {
  headers: {
    'Content-Type': 'application/json',
    'api-key': '123456789'
  }
});

// Add person with minimal information (only LinkedIn URL)
const response2 = await axios.post('/v1/list/person/123', {
  linkedinUrl: 'https://www.linkedin.com/in/johndoe'
}, {
  headers: {
    'Content-Type': 'application/json',
    'api-key': '123456789'
  }
});

The above commands return JSON structured like this:

{
  "success": true,
  "processingId": "abc123-def456-ghi789",
  "message": "Person added successfully"
}

Response Parameters

Get Processing Status

This endpoint allows you to check the processing status of a person addition operation using the processingId returned from the "Add Person to List" endpoint.

HTTP Request

GET https://api.signalist.io/api/v1/processing-status/{id}

URL Parameters

Code Examples

curl "https://api.signalist.io/api/v1/processing-status/abc123-def456-ghi789" \
  -H "api-key: 123456789"

const axios = require('axios');

const {data} = await axios.get('/v1/processing-status/abc123-def456-ghi789', {
  headers: {
    'Content-Type': 'application/json',
    'api-key': '123456789'
  }
});

The above command returns JSON structured like this:

{
  "processingStatus": "DONE",
  "signalistProspectIds": [12345, 67890],
  "message": "Processing completed successfully"
}

Response Parameters

N8N Integration

Company Sender Node

The Signalist Company Sender node for N8N allows you to easily add companies to your Signalist lists directly from your N8N workflows. You can identify companies using LinkedIn URL, website URL, or company name, and optionally include job title information.

Node Configuration

The node supports multiple ways to identify a company: - LinkedIn URL: Use a LinkedIn company URL (e.g., https://www.linkedin.com/company/signalistapp) - Website URL: Use the company's website URL (e.g., https://www.signalist.io) - Company Name: Use the company name directly (e.g., Signalist)

At least one of these fields must be provided. You can also combine them for better identification.

Additionally, you can optionally specify: - Job Title: When provided, the node will use lists that filter by job title - Custom Columns: Add custom key-value pairs to enrich the company data

Node Parameters

Credentials

The node requires Signalist API credentials: - API Key: Your Signalist API key - Base URL: Your Signalist API base URL (e.g., https://api.signalist.io)

Output

The node returns the company data along with the API response from the Signalist API:

{
  "success": true
}

Error Handling

The node includes comprehensive error handling: - Validates that at least one identifier is provided (LinkedIn URL, Website URL, or Company Name) - Validates that a list is selected from the dropdown - Handles API errors gracefully - Supports continue-on-fail mode for workflow resilience - Provides detailed error messages for debugging

Common Errors: - Please provide a LinkedIn URL or company name or domain: Occurs when none of the identification fields (LinkedIn URL, Website URL, or Company Name) are provided - Please select a list from the dropdown: Occurs when no list is selected - Failed to fetch lists: Occurs when the API request to load available lists fails

Installation

Install the Signalist N8N node package:

npm install n8n-nodes-signalist

Usage Examples

Adding a Company via LinkedIn URL

1. Add the "Send Company to Signalist" node to your workflow
2. Enter the LinkedIn company URL in the "LinkedIn URL" field (e.g., https://www.linkedin.com/company/signalistapp)
3. Select a list from the "List of Companies by Name or ID" dropdown
4. The node will automatically add the company to the selected list

Adding a Company via Website URL

1. Add the "Send Company to Signalist" node to your workflow
2. Enter the company's website URL in the "Website URL" field (e.g., https://www.signalist.io)
3. Select a list from the "List of Companies by Name or ID" dropdown
4. The node will add the company to the selected list

Adding a Company via Company Name

1. Add the "Send Company to Signalist" node to your workflow
2. Enter the company name in the "Company Name" field (e.g., Signalist)
3. Select a list from the "List of Companies by Name or ID" dropdown
4. The node will add the company to the selected list

Adding a Company with Job Title

1. Add the "Send Company to Signalist" node to your workflow
2. Enter company identification (LinkedIn URL, Website URL, or Company Name)
3. Enter a job title in the "Job Title" field (e.g., Software Engineer)
4. Select a list from the "List of Job Titles at Companies Name or ID" dropdown (this dropdown appears when Job Title is provided)
5. The node will add the company with job title information to the selected list

Adding a Company with Custom Columns

1. Add the "Send Company to Signalist" node to your workflow
2. Enter company identification (LinkedIn URL, Website URL, or Company Name)
3. Click "Add Custom Column" in the "Custom Columns" section
4. Enter a column name and value for each custom column you want to add
5. Select a list from the dropdown
6. The node will add the company with custom columns to the selected list

People Sender Node

The Signalist People Sender node for N8N allows you to easily add people to your Signalist lists directly from your N8N workflows. You can identify people using LinkedIn URL or by providing name along with company information.

Node Configuration

The node supports two main identification methods: - LinkedIn URL: Provide the person's LinkedIn profile URL - Name and Company: Provide the person's name along with at least one of the following: - Company Name - Company Domain - Company LinkedIn URL - E-Mail

You can also optionally include: - E-Mail: The person's email address - Job Title: The person's job title - Custom Columns: Add custom key-value pairs to enrich the person data

Node Parameters

Credentials

The node requires Signalist API credentials: - API Key: Your Signalist API key - Base URL: Your Signalist API base URL (e.g., https://api.signalist.io)

Output

The node returns the person data along with the API response from the Signalist API:

{
  "success": true
}

Error Handling

The node includes comprehensive error handling: - Validates that either LinkedIn URL is provided, or name is provided with at least one company identifier (Company Name, Company Domain, Company LinkedIn URL, or E-Mail) - Validates that a list is selected (either from dropdown or manual entry) - Handles API errors gracefully - Supports continue-on-fail mode for workflow resilience - Provides detailed error messages for debugging

Common Errors: - Please provide a LinkedIn URL or name and company name: Occurs when neither LinkedIn URL is provided, nor name with at least one company identifier - Please select a list from the dropdown: Occurs when "Fetch From Api" is selected but no list is chosen - List ID is required when using manual entry: Occurs when "Manual Entry" is selected but no List ID is provided - Failed to fetch lists: Occurs when the API request to load available lists fails

Usage Examples

Adding a Person via LinkedIn URL

1. Add the "Send People to Signalist" node to your workflow
2. Enter the LinkedIn profile URL in the "LinkedIn URL" field (e.g., https://www.linkedin.com/in/username)
3. Set "List Selection" to "Fetch From Api"
4. Select a list from the "List Name or ID" dropdown
5. The node will automatically add the person to the selected list

Adding a Person via Name and Company Name

1. Add the "Send People to Signalist" node to your workflow
2. Enter the person's name in the "Name" field (e.g., John Doe)
3. Enter the company name in the "Company Name" field (e.g., Signalist)
4. Set "List Selection" to "Manual Entry"
5. Enter the list ID in the "List ID" field (e.g., 123)
6. The node will add the person to the specified list

Adding a Person via Name and Company Domain

1. Add the "Send People to Signalist" node to your workflow
2. Enter the person's name in the "Name" field
3. Enter the company domain in the "Company Domain" field (e.g., signalist.io)
4. Optionally add email, job title, or other information
5. Select a list from the dropdown or enter a list ID manually
6. The node will add the person to the selected list

Adding a Person with Additional Information

1. Add the "Send People to Signalist" node to your workflow
2. Enter identification information (LinkedIn URL or Name + Company identifier)
3. Optionally add:
   • E-Mail address
   • Job Title
   • Company LinkedIn URL
4. Add custom columns if needed by clicking "Add Custom Column" and entering name-value pairs
5. Select a list from the dropdown or enter a list ID manually
6. The node will add the person with all provided information to the selected list

Processing Status Node

The Signalist Processing Status node for N8N allows you to check the processing status of a list operation in Signalist. This is useful for monitoring the progress of list processing tasks.

Node Configuration

The node retrieves the current processing status by making a GET request to the Signalist API with a processing ID.

Node Parameters

Credentials

The node requires Signalist API credentials: - API Key: Your Signalist API key - Base URL: Your Signalist API base URL (e.g., https://api.signalist.io)

Output

The node returns the processing status information from the Signalist API:

{
  "status": "completed",
  "progress": 100,
  "message": "Processing finished successfully"
}

The exact structure of the response may vary based on the current processing state and the API version.

Error Handling

The node includes comprehensive error handling: - Validates that a Processing ID is provided - Handles API errors gracefully - Supports continue-on-fail mode for workflow resilience - Provides detailed error messages for debugging

Common Errors: - API errors when the processing ID is invalid or not found - Network errors when the API is unreachable - Authentication errors when API credentials are invalid

Usage Examples

Checking Processing Status

1. Add the "Check Processing Status in Signalist" node to your workflow
2. Enter the Processing ID in the "Processing ID" field (e.g., 12345678-1234-1234-1234-123456789012)
3. The node will retrieve and return the current processing status
4. Use the response to determine if processing is complete, in progress, or has failed

Monitoring List Processing in a Workflow

1. After adding companies or people to a list, capture the processing ID from the response
2. Add the "Check Processing Status in Signalist" node
3. Pass the processing ID to the node
4. Use conditional logic based on the status to determine next steps in your workflow
5. Optionally, add a delay node and loop to periodically check the status until processing is complete

Signalist CRM Node

The Signalist CRM node for N8N allows you to update CRM data for companies or people in Signalist. This node enables you to sync CRM information such as URLs, status, custom fields, account owner details, and last updated timestamps from your CRM system to Signalist.

Node Configuration

The node supports updating CRM data for two types of entities: - Person: Update CRM data for a person/prospect in Signalist - Company: Update CRM data for a company/organization in Signalist

Different fields are available depending on the selected update type.

Node Parameters

Credentials

The node requires Signalist API credentials: - API Key: Your Signalist API key - Base URL: Your Signalist API base URL (e.g., https://api.signalist.io)

Output

The node returns the updated CRM data along with a success indicator:

{
  "success": true,
  "organizationId": "12345",
  "url": "https://app-eu1.hubspot.com/contacts/123456789/record/0-1/01234567890",
  "customField1": "1234567890",
  "customField2": "0987654321",
  "lastUpdatedAt": "2021-01-01T00:00:00Z",
  "accountOwner": "John Doe",
  "accountOwnerId": "1234567890"
}

For Person updates, the response includes prospectId and currentStatus instead of organizationId.

Error Handling

The node includes comprehensive error handling: - Validates required parameters based on the selected update type - Handles API errors gracefully - Supports continue-on-fail mode for workflow resilience - Provides detailed error messages for debugging

Common Errors: - API errors when the organization ID or person ID is invalid or not found - Network errors when the API is unreachable - Authentication errors when API credentials are invalid

API Endpoints

The node uses the following API endpoints: - Company updates: POST /api/v1/crm/organization/${organizationId} - Person updates: POST /api/v1/crm/person/${prospectId}

Usage Examples

Updating CRM Data for a Person

1. Add the "Signalist CRM" node to your workflow
2. Set "Update Type" to "Person"
3. Enter the "Signalist Person ID" (the ID of the person in Signalist)
4. Optionally fill in:
   • CRM Url (link to the person in your CRM)
   • CRM Status (current status in your CRM)
   • CRM Custom Field 1 and 2
   • Last Updated At
   • Account Owner Name and Account Owner Reference ID
5. The node will update the CRM data for the person in Signalist

Updating CRM Data for a Company

1. Add the "Signalist CRM" node to your workflow
2. Set "Update Type" to "Company"
3. Enter the "Signalist Organization ID" (the ID of the company in Signalist)
4. Optionally fill in:
   • CRM Url (link to the company in your CRM)
   • CRM Custom Field 1 and 2
   • Last Updated At
   • Account Owner Name and Account Owner Reference ID
5. The node will update the CRM data for the company in Signalist

Syncing CRM Data from HubSpot

1. In your N8N workflow, retrieve person or company data from HubSpot
2. Add the "Signalist CRM" node
3. Map the HubSpot contact/company ID to the Signalist Person ID or Organization ID
4. Map the HubSpot URL to the CRM Url field
5. Map any custom properties to CRM Custom Field 1 and 2
6. Map the last modified date to Last Updated At
7. Map the owner information to Account Owner Name and Account Owner Reference ID
8. The node will sync all the CRM data to Signalist