Skip to main content

People.ai

People.ai is an AI-powered revenue intelligence platform that automatically captures and analyzes sales activity from emails, meetings, and calls, then maps it to CRM accounts, contacts, and opportunities. By eliminating manual data entry and surfacing engagement insights, it helps revenue teams gauge deal health, forecast confidently, and identify next best actions. It integrates with Salesforce and Microsoft Dynamics 365 Sales.

People.ai icon

Power end-to-end data operations for your People.ai API with Nexla. Our bi-directional People.ai connector is purpose-built for People.ai, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to People.ai or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your People.ai workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

To connect Nexla to People.ai, you need a People.ai API key. API keys are generated from within the People.ai platform by an administrator and are sent via the X-API-Key request header on every call to the People.ai API.

Obtain a People.ai API Key

People.ai API keys are managed in the platform settings. Contact your People.ai administrator or reach out to People.ai Support to request an API key if you do not have one. People.ai may also provide API keys as part of onboarding or integration setup.

  1. Sign in to your People.ai platform account at https://app.people.ai.

  2. Navigate to Settings in the left navigation panel.

  3. Locate the API Keys or Integrations section within Settings.

  4. Generate a new API key and copy it immediately for safekeeping. Store the key securely, as it grants access to your People.ai data.

Important

Treat your People.ai API key as a password. Do not share it in publicly accessible locations such as source control repositories, chat messages, or emails.

Determine Your API Environment

People.ai provides three API environments. Use the environment that matches your deployment:

  • Production (https://api.people.ai/v0/public) — For live, production data. This is the default and most commonly used environment.
  • Staging (https://api-staging.people.ai/v0/public) — For testing integrations against a staging instance before deploying to production.
  • Mock (https://api-mock.people.ai/v0/public) — For development and testing without affecting real data.

The Production environment is selected by default in Nexla. Only change the Base URL if you specifically need to connect to the People.ai Staging or Mock environment.

Authenticate

Credentials required

Authenticate using a People.ai API key from Settings > API Keys.

FieldRequiredSecretDescription
API KeyYesYesYour People.ai API key for authentication.
Base URLYesNoAPI environment (mock, staging, or production). Allowed values: Production; Staging; Mock

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter your People.ai API key in the API Key field. This key authenticates Nexla with the People.ai API and is sent as the X-API-Key header on every request. Keep this value secure and do not share it with unauthorized users.

  4. Select the Base URL for the People.ai API environment you want to connect to from the dropdown menu. The available options are:

    • Production — Connects to https://api.people.ai/v0/public, the live People.ai environment. Select this option for all standard data integration workflows.

    • Staging — Connects to https://api-staging.people.ai/v0/public, a non-production environment used for testing integrations before promoting them to production.

    • Mock — Connects to https://api-mock.people.ai/v0/public, a mock API environment suitable for development and automated testing without affecting real data.

    The Base URL defaults to the Production environment. Select Staging or Mock only if your People.ai account and the data you need reside in one of those environments.

  5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the People.ai connector tile, 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.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common People.ai endpoints. 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.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

People.ai data sources can also be manually configured to ingest data from any valid People.ai API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

People.ai's public API primarily uses GET for retrieving data (accounts, contacts, activities, opportunities, teams) and PUT for creating or updating activity records. Endpoints are appended to the base URL selected in your credential (see Prerequisites)—for example, /accounts, /contacts, or /activities.

Date/time macros are commonly used with People.ai's date filter query parameters, such as from, to, modified_from, modified_to, ingested_from, and ingested_to.

People.ai responses wrap records in a named array; common paths to data include $.accounts[*], $.activities[*], $.contacts[*], $.participants[*], $.engagementScores[*], and $.data[*], depending on the endpoint. You do not need to include the X-API-Key header—Nexla attaches it automatically from your credential.

Once all of the relevant settings have been configured, 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.

Use as a destination

Click the + icon on the Nexset that will be sent to the People.ai destination, and select the Send to Destination option from the menu. Select the People.ai connector from the list of available destination connectors, then select the credential that will be used to connect to the People.ai organization, and click Next; or, create a new People.ai credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common People.ai endpoints. Each template is designed specifically for the corresponding People.ai write endpoint, making destination setup easy and efficient. The available endpoint templates cover pushing activity data—such as chat messages, calls, emails, meetings, and conferences—into the People.ai platform, both individually and in bulk. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Push Chat Activity

Sends a single chat activity record to the People.ai platform. Use this endpoint to push individual chat messages or conversations into People.ai so they can be associated with accounts, contacts, and opportunities and included in engagement analytics.

  • This endpoint sends a single JSON-formatted activity record to the People.ai chat activities API using a PUT request. Ensure the Nexset record structure matches the People.ai chat activity schema before sending.
  • No additional endpoint parameters are required beyond selecting this template. The activity payload is automatically derived from each Nexset record.

For sending multiple chat activity records at once, use the Push Batch Chat Activities endpoint template instead to reduce the number of API calls and improve throughput.

Push Batch Chat Activities

Sends a batch of chat activity records to the People.ai platform in a single API call. Use this endpoint when you need to push multiple chat activities at once, reducing API call overhead and improving data loading efficiency.

  • This endpoint sends multiple JSON-formatted activity records to the People.ai bulk chat activities API using a PUT request. The records are grouped and sent together in a single payload.
  • No additional endpoint parameters are required beyond selecting this template. The batch of activity records is automatically derived from the Nexset data.

Push Single Call Activity

Sends a single call activity record to the People.ai platform. Use this endpoint to push individual call records into People.ai so they can be matched to accounts, contacts, and opportunities and factored into engagement scores.

  • This endpoint sends a single JSON-formatted call activity record to the People.ai call activities API using a PUT request. Ensure the record includes required call activity fields such as participants, duration, and timestamps as defined in the People.ai API schema.
  • No additional endpoint parameters are required beyond selecting this template.

For pushing multiple call activity records at once, use the Push Batch Call Activities endpoint template to improve efficiency.

Push Batch Call Activities

Sends a batch of call activity records to the People.ai platform in a single API call. Use this endpoint when you need to push multiple call records at once.

  • This endpoint sends multiple JSON-formatted call activity records to the People.ai bulk call activities API using a PUT request.
  • No additional endpoint parameters are required beyond selecting this template. The batch of activity records is automatically derived from the Nexset data.

Push Single Email Activity

Sends a single email activity record to the People.ai platform. Use this endpoint to push individual email records into People.ai for association with CRM records and inclusion in engagement analytics.

  • This endpoint sends a single JSON-formatted email activity record to the People.ai email activities API using a PUT request. Ensure the record includes required email fields such as sender, recipients, subject, and timestamps as defined in the People.ai API schema.
  • No additional endpoint parameters are required beyond selecting this template.

For pushing multiple email activity records at once, use the Push Batch Email Activities endpoint template to reduce API call volume.

Push Batch Email Activities

Sends a batch of email activity records to the People.ai platform in a single API call. Use this endpoint when you need to push multiple email records at once to improve data loading efficiency.

  • This endpoint sends multiple JSON-formatted email activity records to the People.ai bulk email activities API using a PUT request.
  • No additional endpoint parameters are required beyond selecting this template. The batch is automatically derived from the Nexset data.

Push Single Meeting Activity

Sends a single meeting activity record to the People.ai platform. Use this endpoint to push individual calendar meetings or appointment records into People.ai for CRM association and engagement tracking.

  • This endpoint sends a single JSON-formatted meeting activity record to the People.ai meeting activities API using a PUT request. Ensure the record includes required meeting fields such as attendees, start/end times, and subject as defined in the People.ai API schema.
  • No additional endpoint parameters are required beyond selecting this template.

For pushing multiple meeting activity records at once, use the Push Batch Meeting Activities endpoint template.

Push Batch Meeting Activities

Sends a batch of meeting activity records to the People.ai platform in a single API call. Use this endpoint when loading multiple meeting records at once.

  • This endpoint sends multiple JSON-formatted meeting activity records to the People.ai bulk meeting activities API using a PUT request.
  • No additional endpoint parameters are required beyond selecting this template. The batch is automatically derived from the Nexset data.

Push Single Conference Activity

Sends a single conference activity record to the People.ai platform. Use this endpoint to push individual conference or video call records into People.ai for CRM matching and engagement analytics.

  • This endpoint sends a single JSON-formatted conference activity record to the People.ai conference activities API using a PUT request. Ensure the record includes the required fields for conference activities as defined in the People.ai API schema.
  • No additional endpoint parameters are required beyond selecting this template.

For pushing multiple conference activity records at once, use the Push Batch Conference Activities endpoint template.

Push Batch Conference Activities

Sends a batch of conference activity records to the People.ai platform in a single API call. Use this endpoint when loading multiple conference records at once to maximize throughput.

  • This endpoint sends multiple JSON-formatted conference activity records to the People.ai bulk conference activities API using a PUT request.
  • No additional endpoint parameters are required beyond selecting this template. The batch is automatically derived from the Nexset data.

Manual configuration

People.ai destinations can also be manually configured to send data to any valid People.ai API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

People.ai activity write endpoints use the PUT method (other write operations use POST), and accept JSON only. Endpoints are appended to the base URL selected in your credential (see Prerequisites) followed by the activity type path—for example, /activities/email, /activities/call, or /activities/meeting. For bulk write operations, append /_bulk to the activity endpoint path (e.g., /activities/email/_bulk).

Record batching is recommended when sending large volumes of activity records to People.ai; the default Batch Size is 100. You do not need to include the X-API-Key header—Nexla attaches it automatically from your credential.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured People.ai endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the People.ai endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.