Skip to main content

People.ai Data Source

People.ai is an AI-powered revenue intelligence platform that automatically captures and analyzes sales activities—including emails, calls, meetings, and CRM interactions—across accounts, contacts, opportunities, and leads. Follow the instructions below to create a new data flow that ingests data from a People.ai source in Nexla.
people_ai_api.png

People.ai

Create a New Data Flow

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the People.ai connector tile from the list of available connectors. Then, select the credential that will be used to connect to the People.ai instance, and click Next; or, create a new People.ai credential for use in this flow.

  3. In Nexla, People.ai data sources can be created using pre-built endpoint templates, which expedite source setup for common People.ai endpoints. Each template is designed specifically for the corresponding People.ai endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    People.ai sources can also be configured manually, allowing you to ingest data from People.ai endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common People.ai endpoints. Each template is designed specifically for the corresponding People.ai endpoint, making data source setup easy and efficient.

Endpoint Settings

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

List Accounts

Retrieves all organization accounts from People.ai, with optional filtering by account type and support for paginated results. Use this endpoint to pull a broad list of accounts for reporting, analysis, or syncing account records into a downstream system.

  • This endpoint automatically handles pagination, fetching up to 100 accounts per page and continuing until all matching records have been retrieved.
  • Optionally, enter a value in the Account Type field to filter accounts by type. Leave this field blank to retrieve all accounts regardless of type.

Additional details about the People.ai Accounts API are available in the People.ai API documentation.

Get Account by ID

Retrieves a single People.ai account record using its unique People.ai account ID. Use this endpoint when you need to fetch detailed information about a specific account.

  • Enter the unique People.ai account identifier in the Account ID field. This field is required. The account ID can be obtained from the List Accounts endpoint or from your People.ai platform.

Get Account by CRM ID

Retrieves a single People.ai account record using the corresponding CRM ID (such as a Salesforce Account ID). Use this endpoint when you know the account's CRM identifier but not its People.ai internal ID.

  • Enter the CRM system identifier for the account in the CRM ID field. This field is required. The CRM ID is typically the account's ID in your connected CRM, such as Salesforce.

List Account Engagement Scores

Retrieves engagement scores for accounts within your organization. Engagement scores reflect the level and quality of sales activity associated with each account over a given time period. Use this endpoint for account health monitoring, pipeline analytics, or prioritization workflows.

  • Optionally, enter a People.ai account ID in the Account ID field to limit results to a specific account. Leave blank to retrieve engagement scores for all accounts.
  • Use the date range fields to limit the time period for which engagement scores are returned:

    • From Date — The start of the date range in ISO 8601 format (e.g., 2024-01-01).
    • To Date — The end of the date range in ISO 8601 format (e.g., 2024-03-31).
    • Last N Days — Alternatively, enter a number to retrieve engagement scores from the last N days (e.g., 30 for the past 30 days). This parameter takes precedence over the From/To date range when both are provided.
  • Optionally, enter a time zone identifier in the Time Zone field to apply time zone–aware date filtering (e.g., America/New_York). This ensures date boundaries are interpreted correctly for your organization's location.

List Activities

Retrieves all company activities captured by People.ai across all activity types (emails, calls, meetings, etc.), with extensive filtering options. Use this endpoint for broad activity analysis, compliance reporting, or syncing all activity data to a data warehouse.

  • Optionally, enter a People.ai account ID in the Account ID field or an opportunity ID in the Opportunity ID field to filter activities to a specific account or opportunity.
  • Use the following optional date filter fields to control the time range of activities returned:

    • Modified From / Modified To — Filter activities that were last modified within this date range (ISO 8601 format).
    • Ingested From / Ingested To — Filter activities by the date they were ingested into People.ai (ISO 8601 format).
    • From Date / To Date — Filter activities by their activity date (ISO 8601 format).
    • Last N Days — Retrieve activities from the last N days. This overrides the From/To date range when both are provided.
  • Optionally, enter a value in the Internal/External field to filter activities by direction. Use internal for activities between team members, or external for activities involving contacts outside the organization.
  • Optionally, set Include Deleted to true to include activities that have been deleted from People.ai in the results.
  • Optionally, enter a value in the UID field to filter activities by their unique identifier.
  • Enter a time zone identifier in the Time Zone field if date-based filters should be interpreted in a specific time zone (e.g., America/Chicago).

List Activity Participants

Retrieves all participants associated with company activities, with support for the same filtering options as the List Activities endpoint. Use this endpoint to analyze who is involved in sales activities, measure team coverage, or build contact engagement reports.

  • Optionally, filter participants by providing an Account ID or Opportunity ID to scope results to a specific account or opportunity.
  • Use the following optional date filter fields to control which activity participants are returned:

    • Ingested From / Ingested To — Filter by the date the associated activity was ingested into People.ai (ISO 8601 format).
    • From Date / To Date — Filter by the activity date (ISO 8601 format).
    • Last N Days — Retrieve participants from activities in the last N days.
  • Optionally, enter internal or external in the Internal/External field to filter participants by activity direction.
  • Optionally, set Include Deleted to true to include participants from deleted activities.
  • Optionally, filter by UID (participant unique identifier) or Activity UID (the unique identifier of the associated activity) to retrieve participants for specific records.
  • Enter a time zone identifier in the Time Zone field if date-based filters should be interpreted in a specific time zone (e.g., America/Los_Angeles).

List Activities by Type

Retrieves company activities filtered to a specific activity type. Use this endpoint when you need activity data for a single channel, such as building an email activity report or analyzing call volume trends.

  • Enter the activity type in the Activity Type field. This field is required. Common values include email, call, meeting, chat, and conference.
  • Optionally, filter results by providing an Account ID or Opportunity ID.
  • Use the following optional date filter fields to control the time range of activities returned:

    • Ingested From / Ingested To — Filter by activity ingestion date (ISO 8601 format).
    • Modified From / Modified To — Filter by activity modification date (ISO 8601 format).
    • From Date / To Date — Filter by activity date (ISO 8601 format).
    • Last N Days — Retrieve activities from the last N days.
  • Optionally, filter by Internal/External direction, include deleted records with Include Deleted, or filter by UID.
  • Enter a time zone identifier in the Time Zone field if date-based filters should be interpreted in a specific time zone.

Get Activity by CRM ID

Retrieves a single People.ai activity record using the corresponding CRM ID. Use this endpoint when you need to look up a specific activity by its CRM system identifier.

  • Enter the CRM system identifier for the activity in the CRM ID field. This field is required.

Get Activity Participants by CRM ID

Retrieves all participants for a specific People.ai activity identified by its CRM ID. Use this endpoint to see who participated in a known CRM activity.

  • Enter the CRM system identifier for the activity in the CRM ID field. This field is required. All participants associated with the matching activity will be returned.

List Contacts

Retrieves all company contacts tracked in People.ai, with optional filtering by job title. Use this endpoint to build contact lists, enrich CRM records, or analyze your organization's external contact network.

  • Optionally, enter a job title in the Job Title field to filter contacts by their role (e.g., VP of Sales). Leave this field blank to retrieve all contacts.
  • This endpoint uses pagination and will automatically retrieve all matching contacts across multiple pages.

Get Contact by CRM ID

Retrieves a single People.ai contact record using the corresponding CRM ID. Use this endpoint to look up detailed contact information for a specific CRM contact.

  • Enter the CRM system identifier for the contact in the CRM ID field. This field is required.

List Contact Engagement Scores

Retrieves engagement scores for contacts in your organization. Contact engagement scores reflect the depth and recency of sales interactions with individual contacts. Use this endpoint for contact prioritization, relationship health monitoring, or building engagement analytics dashboards.

  • Optionally, enter a People.ai contact ID in the Contact ID field to retrieve engagement scores for a specific contact only. Leave blank to retrieve scores for all contacts.
  • Use the following optional fields to define the date range for engagement score calculation:

    • Start Date — The beginning of the date range (ISO 8601 format).
    • End Date — The end of the date range (ISO 8601 format).
    • Last N Days — Retrieve scores for the last N days instead of specifying a fixed date range.
  • Optionally, enter a time zone identifier in the Time Zone field to apply time zone–aware date filtering (e.g., America/New_York).

List Company Leads

Retrieves all company leads tracked in People.ai, with optional filtering by job title. Use this endpoint to analyze lead data, build lead lists, or sync lead records to a downstream system for scoring or enrichment.

  • Optionally, enter a job title in the Job Title field to filter leads by role (e.g., Director of Marketing). Leave blank to retrieve all leads.
  • This endpoint uses pagination to return all matching leads across multiple pages automatically.

List Lead Engagement Scores

Retrieves engagement scores for leads in your organization. Lead engagement scores indicate the level of sales activity and interaction associated with each lead. Use this endpoint to prioritize lead follow-up or track engagement trends over time.

  • Optionally, enter a People.ai lead ID in the Lead ID field to retrieve the engagement score for a specific lead. Leave blank to retrieve scores for all leads.
  • Use the following optional fields to define the date range for engagement score calculation:

    • Start Date — The beginning of the date range (ISO 8601 format).
    • End Date — The end of the date range (ISO 8601 format).
    • Last N Days — Retrieve scores for the last N days instead of a fixed date range.
  • Optionally, enter a time zone identifier in the Time Zone field to apply time zone–aware date filtering.

List Company Opportunities

Retrieves all company opportunities tracked in People.ai. Use this endpoint to pull your full opportunity pipeline for analysis, forecasting, or syncing opportunity records to a data warehouse or BI tool.

  • This endpoint retrieves all opportunities without requiring any additional configuration. Pagination is handled automatically, ensuring all opportunity records are returned.

People.ai enriches opportunity records with AI-driven insights, including engagement scores and activity coverage metrics. The data returned from this endpoint reflects the enriched opportunity view as configured in your People.ai organization.

List Opportunity Engagement Scores

Retrieves engagement scores for opportunities in your organization. Opportunity engagement scores reflect the depth and recency of sales activity associated with each deal. Use this endpoint for pipeline health analysis, deal risk scoring, or opportunity prioritization.

  • Optionally, enter a People.ai opportunity ID in the Opportunity ID field to retrieve the engagement score for a specific opportunity. Leave blank to retrieve scores for all opportunities.
  • Use the following optional fields to define the date range for engagement score calculation:

    • Start Date — The beginning of the date range (ISO 8601 format).
    • End Date — The end of the date range (ISO 8601 format).
    • Last N Days — Retrieve scores for the last N days instead of a fixed date range.
  • Optionally, enter a time zone identifier in the Time Zone field to apply time zone–aware date filtering.

List Company Teams

Retrieves all company teams configured in People.ai, with optional filtering by parent team. Use this endpoint to map your organization's team hierarchy or to retrieve a specific branch of the team structure.

  • Optionally, enter a People.ai team ID in the Parent Team ID field to retrieve only the teams that are direct children of that parent team. Leave blank to retrieve all teams.

List Team Members

Retrieves all registered company users (team members) in People.ai, with optional filtering by job title. Use this endpoint to build user lists, analyze team composition, or identify representatives by role.

  • Optionally, enter a job title in the Job Title field to filter team members by their role (e.g., Account Executive). Leave blank to retrieve all registered users.

List Team Members by Team ID

Retrieves all company users assigned to a specific People.ai team and any of its sub-teams. Use this endpoint when you need a full member list for a particular team branch within your organization's hierarchy.

  • Enter the People.ai team identifier in the Team ID field. This field is required. The team ID can be obtained from the List Company Teams endpoint.

List Team Members by Team CRM ID

Retrieves all company users assigned to a team identified by its CRM ID, including users in all sub-teams. Use this endpoint when you know a team's CRM identifier but not its People.ai internal team ID.

  • Enter the CRM system identifier for the team in the Team CRM ID field. This field is required. The CRM ID is typically the team's identifier in your connected CRM system, such as Salesforce.

Endpoint Testing

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually

People.ai data sources can be manually configured to ingest data from any valid People.ai API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex People.ai sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom request parameters.

API Method

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the People.ai API from the Method pulldown menu. People.ai's public API primarily uses the following methods:

    • GET: For retrieving data from the API (accounts, contacts, activities, opportunities, teams, etc.)
    • PUT: For creating or updating activity records in People.ai

API Endpoint URL

  1. Enter the URL of the People.ai API endpoint from which this source will fetch data in the Set API URL field. All People.ai API endpoints use the base URL selected in your credential (e.g., https://api.people.ai/v0/public), followed by the resource path (e.g., /accounts, /contacts, /activities).

The complete list of People.ai API endpoints and their URL structures is available in the People.ai API documentation. Ensure the endpoint URL is correct and accessible with your current API key and Base URL configuration.

Date/Time Macros (API URL)

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements. This is particularly useful for People.ai endpoints that accept date range query parameters such as from, to, modified_from, modified_to, ingested_from, or ingested_to.

Date/time macros are especially useful for People.ai activity and engagement score endpoints that support date filtering. For example, you can use macros to automatically retrieve activities modified in the last 24 hours by including a {now-1} macro in the modified_from query parameter.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime
  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are useful for People.ai endpoints that require specific IDs as path parameters—for example, using an account ID or team ID retrieved from another Nexla source to dynamically construct the endpoint URL.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data

Optional

If only a subset of the data returned by the API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. People.ai API responses typically wrap records in a named array within the JSON response body, so specifying the correct data path ensures Nexla treats each element of that array as an individual record.

For example, a request to the List Accounts endpoint returns a JSON response with an accounts array. By specifying the path to this array, Nexla will treat each account object as a separate record.

Path to Data is essential for People.ai endpoints that return paginated arrays of records. Common People.ai response data paths include $.accounts[*], $.activities[*], $.contacts[*], $.data[*], $.participants[*], and $.engagementScores[*], depending on the endpoint.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.data.items[*] to access an array of items within a data object).

    • For responses in XML format, enter the XPath that points to the object/array containing relevant data. XPath uses slash notation (e.g., /response/data/item to access item elements within a data element).

    Path to Data Example:

    If the People.ai API response includes a top-level array named accounts that contains the relevant records, the path to the response would be entered as $.accounts[*].

Autogenerate Path Suggestions

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve important contextual information that applies to all records but isn't part of the main data array.

For example, a People.ai response may include pagination context such as a total record count alongside the main records array. If you have specified the path to the records array but also want to capture this context, you can specify a separate path to include that metadata with each record.

Metadata paths are particularly useful for preserving People.ai response context like request timestamps or summary statistics that apply to all records in the response.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata, and for responses in XML format, enter the XPath.

Request Headers

Optional
  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers may be required for API versioning or custom request parameters.

    You do not need to include the X-API-Key authentication header—this is automatically included in every request based on your People.ai credential configuration.

Endpoint Testing

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new People.ai data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.