Skip to main content

Activities APIs

The Activity API provides access to unaggregated activity data synchronously ingested from your GTM motions.

REST API for activities will return your results upon making requests without the additional wait for data extraction job completion.

How to make a request

Path

Returns all activities for the organization

Subresource

/v0/public/activities/participants

Returns all participants for activities within the organization

Path params

activity_type

Specific activity type, one of [email, call, meeting]

Result

List of all activities or list of typed activities if activity_type is specified

Method

GET

Pagination

Yes

Schema

Field

Type

Description

crm_id

string

Unique CRM identifier for the pushed activity

user_id

integer

Unique backstory identifier for the team member we ingested activity for

is_partner

boolean

Indicated whether an activity was matched to a partner account. The valid values are true, false, and null.

with_partner

boolean

Indicated whether an activity had partner involvement. The valid values are true, false, and null.

opportunity_id

integer

Unique backstory identifier for the opportunity we matched to

opportunity_ids

integer

List of backstory identifiers for all opportunities matched to the activity

opportunity_crm_id

string

Unique CRM identifier for the opportunity we matched to

opportunity_crm_ids

string

List of CRM identifiers for all opportunities matched to the activity

opportunity_stage_id

string

Stage of an opportunity at the time when the activity was processed

account_id

integer

Unique backstory identifier for the account we matched to

account_crm_id

string

Unique CRM identifier for the account we matched to

matched_to

string

One of: “account”, “opportunity”, “lead”, “none”

lead_id

integer

Unique backstory identifier for the lead we matched to

lead_crm_id

string

Unique CRM identifier for the lead we matched to

created_at

timestamp

Denotes when the activity was created

activity_type

string

backstory classifies activity type. One of: “email”, “meeting”, “call”

subtype

string

Classification of activity: "inbound email","outbound email","conference call","in-person meeting"

timestamp

timestamp

Time of the activity

external

boolean

Indicate whether the activity has any external participants

uid

string

Unique peopl.ai identifier for the activity

activity_source_id

string

Unique identifier for the activity taken from the source system. In case of calls, the ID of the activity in CRM

direction

string

Direction of the activity (“outbound”: outbound from the user’s organization, “inbound”: outbound from anyone else)

meeting_start_time (meeting only)

timestamp

Start time of the meeting activity

meeting_end_time (meeting only)

timestamp

End time of the meeting activity

meeting_status (meeting only)

string

Status of the meeting. One of: "scheduled", "rescheduled", "completed", or "canceled"

in_reply_to_source_id (emails only)

string

Unique source system identifier of the activity being replied to

outbound_phone_number (calls only)

string

Outbound phone number

duration

float

Duration of activity in seconds

number_of_participants

integer

Indicates the number of participants engaged

Participants schema

Field

Type

Description

user_id

integer

Unique backstory identifier for the team member we ingested activity for. Present only for users.

id

integer

Unique backstory identifier for participants

name

string

Participant name

email

string

Email of activity participant

job_title

string

Job title of activity participant

phone_number

string

Phone number of the activity participant

seniority

string

The backstory-classified seniority of the contact’s job title

department

string

The backstory-classified department of the contact’s job title

external

boolean

Denotes if the participant is internal or external

original

boolean

Denotes if the participant was on the original activity copy

status

string

Status of activity participant

source_id

string

Original source ID of activity from the provider

is_originator

boolean

Denotes if participant is the originator of the activity

activity_uid

string

Unique backstory identifier for the activity

activity_crm_id

string

Unique CRM identifier for the pushed activity

account_id

integer

Unique backstory identifier for the account we matched to

account_crm_id

string

Unique CRM identifier for the account we matched to

opportunity_id

integer

Unique backstory identifier for the opportunity we matched to

opportunity_crm_id

string

Unique CRM identifier for the opportunity we matched to

lead_id

integer

Unique backstory identifier for the lead we matched to

lead_crm_id

string

Unique CRM identifier for the lead we matched to

activity_timestamp

timestamp

Time of the activity

created_at

timestamp

Denotes when the activity was created

deleted

boolean

Denotes if the activity was deleted

duration

integer

Duration for participants in seconds

Did this answer your question?