BookedIn icon

BookedIn

Interact with BookedIn AI agents, leads, campaigns, strategies, lists, and human messaging

Overview

This node interacts with the BookedIn platform to manage leads, among other resources. Specifically, the Lead - Get Many operation retrieves multiple lead records from BookedIn with support for pagination and filtering.

Typical use cases include:

  • Fetching a list of leads for processing or analysis.
  • Searching leads by name, email, or phone number.
  • Filtering leads by their source or exact contact details.
  • Paginating through large sets of leads in batches.

For example, you might use this node to retrieve all leads imported via an API source, or to find leads matching a specific email address for follow-up campaigns.

Properties

Name Meaning
Skip Number of leads to skip for pagination (offset).
Limit Maximum number of leads to return in one request (pagination size).
Search Term Text to search within lead's name, email, or phone number.
Source Filter Filter leads by their source, e.g., "API", "Import".
Email Filter Filter leads by exact email address match.
Phone Filter Filter leads by phone number; must be in international format starting with "+" and country code (e.g., +12345678910).

Output

The output is a JSON array where each item represents a lead object as returned by the BookedIn API. Each lead object typically contains fields such as contact information (name, email, phone), source, metadata, timezone, and other lead-specific data.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the BookedIn API.
  • The node uses HTTP requests to communicate with https://api.bookedin.ai/api/v1/leads/.
  • Proper configuration of the API authentication credential in n8n is necessary.

Troubleshooting

  • Invalid phone number format: Phone filters or lead phone numbers must start with "+" followed by country code and digits only. Ensure no spaces or invalid characters are included.
  • Invalid email format: Email filters must be valid email addresses.
  • Pagination issues: If too many leads are requested at once, the API may limit results. Use the "Skip" and "Limit" properties to paginate properly.
  • Empty results: If filters are too restrictive or incorrect, no leads may be returned.
  • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • JSON parsing errors: When using JSON input fields (not applicable here but relevant for other operations), ensure valid JSON syntax.

Links and References


If you need summaries for other Resources or Operations, feel free to ask!

Discussion