AddContactToAudienceRequest
audience_idThe audience to add the contact to.
contact_idThe contact to add.
AddContactToAudienceResponse
successWhether the contact was successfully added.
Additional information about the result.
AudienceDestinationConnection
connection_idInternal connection identifier.
nameDisplay name for the connected destination.
platformstatusconfiguredsetup_completereadyAudienceDestinationPlatform
AudienceExportFieldSelection
firstNamelastNameworkEmailspersonalEmailsphonescompanyNamejobTitlecitystateRegioncountrycompanyIndustryfunctionalArealinkedinUrlcompanyLinkedinUrlcompanyDomaincompanyCountrypostalCodeAudienceModel
idUnique identifier for the audience
organization_idIdentifier for the organization
nameName of the audience
statusCurrent status of the audience (active, paused, archived)
descriptionDescription of the audience's purpose
UTM value used for tracking the audience in marketing campaigns
created_atISO 8601 timestamp when the audience was created
AudienceSyncRunResult
sync_idconnection_idplatformdispositionAudienceSyncStatusItem
sync_idplatformstatusLatest run status, or startup status before a run exists.
total_recordsrecords_processedrecords_successfulrecords_failedrecords_skippedAudienceSyncStatusRequest
audience_idsync_idsExact sync IDs. Use either sync_ids or connection_ids; omit both for all destinations.
connection_idsConnection IDs whose latest sync for this audience should be returned. Cannot be combined with nonempty sync_ids.
BatchCreateContactItem
Optional list of tag names to attach to this contact. Tag names that already exist on your organization are reused; any new names are created automatically.
BatchCreateContactRequest
audience_idThe audience ID that every contact in the batch will be added to.
List of contacts to create. Maximum 100 per request.
BatchCreateContactResponse
The contacts that were created, in input order.
created_countTotal number of contacts created in this batch.
credits_consumedTotal credits consumed (one per contact created).
CampaignItem
campaign_idnamestatuscampaign_typeCampaignMetric
Company
linkedin_company_idsnamelinkedin_urlCompanyCampaignPage
pagepage_sizetotal_countCompanyDetail
CompanyDetailMetrics
campaigns_reachedcampaigns_engagedCompanyListItem
CompanyListMetrics
campaigns_reachedcampaigns_engagedCompanyModel
idUnique identifier for the company
organization_idIdentifier for the organization
nameCompany name
domainPrimary domain of the company
LinkedIn company page URL
descriptionBrief description of the company
Industry classification
City of company headquarters
State or province of headquarters
Country of headquarters
ZIP or postal code
Approximate employee count range
Approximate annual revenue range
CompanyPeriodMetrics
CompanyTimePeriod
start_dateend_dateConfigureAudienceSyncRequest
audience_idconnection_idenabledConfigureAudienceSyncResponse
audience_idconnection_idconnection_nameplatformenabledcreatedConnectionIntegrationStatus
ContactEmailEnrichmentResponse
contact_idThe contact id that was queried.
The work email discovered for the contact's LinkedIn URL, or null if no match was found.
ContactModel
idUnique identifier for the contact
Identifier for the associated company
first_nameContact's first name
last_nameContact's last name
work_emailsList of work email addresses
personal_emailsList of personal email addresses
phonesList of phone numbers in E.164 format
linkedin_urlLinkedIn profile URL
Contact location details
Associated company details, included when fetching a single contact
CreateAudienceExportRequest
export_typeThe type of audience export to create.
formatThe file format to generate.
Optional boolean field map. Missing field keys default to false.
CreateAudienceExportResponse
export_idThe export job id.
audience_idThe audience being exported.
export_typeThe export type.
formatThe export format.
statusThe export status.
CreateAudienceRequest
nameName for the new audience.
Optional description of the audience.
CreateAudienceResponse
The created audience.
CreateContactRequestModel
audience_idThe audience ID the new contact will be added to.
Optional list of tag names to attach to the contact. Free-text input — names that already exist on your organization are reused, and any new names are created automatically.
CreateContactResponse
The newly created contact.
CreativeItem
creative_idnamecampaign_idcampaign_namestatusErrorResponse
detailThe error message.
Stable machine-readable error code when one is available.
FetchAudienceResponse
The audience details.
FetchCampaignsRequest
start_dateend_dategranularitycampaign_idsstatusesobjective_typessearchsort_directionpagepage_sizeFetchCampaignsResponse
pagepage_sizetotal_countprovisionalwarningsFetchCompaniesRequest
start_dateend_dategranularitycampaign_idscompany_idslinkedin_company_idsdomainsExact company domains; case-insensitive and ignoring a leading www. Matches the returned company domain.
searchCase-insensitive substring search across company names and domains.
sort_bysort_directionpagepage_sizeFetchCompaniesResponse
pagepage_sizetotal_countwarningsFetchCompanyRequest
start_dateend_dategranularitycampaign_idsCompany ID or LinkedIn company ID. Provide either company_id or domain.
Exact company domain, e.g. example.com. Provide either domain or company_id.
campaign_pagecampaign_page_sizeFetchCompanyResponse
The company details.
FetchContactResponse
The contact details.
FetchContactVisitsRequest
Filter visits to a specific audience.
Filter by identity resolution outcome: direct, probable, or unresolved.
pagePage number (1-indexed).
page_sizeNumber of results per page.
FetchContactVisitsResponse
Website visits associated with the contact.
totalTotal number of matching website visits.
pageCurrent page number.
page_sizeNumber of results per page.
FetchCreativesRequest
start_dateend_dategranularitycampaign_idsstatusesobjective_typessearchsort_directionpagepage_sizecreative_idsFetchCreativesResponse
pagepage_sizetotal_countprovisionalwarningsFetchLinkedInCompanyResponse
warningsFetchWebsiteVisitResponse
The website visit details. Includes resolved contacts when include_contacts=true.
GetAudienceExportResponse
export_idThe export job id.
audience_idThe audience being exported.
export_typeThe export type.
formatThe export format.
statusThe export status.
row_countThe number of rows written.
The generated file name.
A presigned download URL when the export is completed.
Expiration timestamp for the presigned download URL.
Safe error message when the export failed.
GetCreditBalanceResponse
organization_idThe organization ID.
credit_balanceCurrent credit balance available to the organization.
GetOrganizationIdResponse
organization_idThe organization ID authenticated for this connection.
organization_nameThe current display name of the authenticated organization.
permissionEndpoint access for this connection: read_only or read_write. Direct API keys have read_write access.
ListCompanyWebsiteVisitsRequest
Filter by stored visit type: ad_click (campaign-attributed) or return. Omit to include both.
Filter by company ID directly. When provided, other company filters are ignored.
Filter by company name.
Filter by company domain.
Filter by industry.
Filter by city.
Filter by state.
Filter by country.
Filter by ZIP code.
Filter by employee count range.
Filter by revenue range.
Filter by LinkedIn company URL.
pagePage number (1-indexed).
page_sizeNumber of results per page.
ListCompanyWebsiteVisitsResponse
Website visits associated with matching companies.
totalTotal number of matching website visits.
pageCurrent page number.
page_sizeNumber of results per page.
ListContactWebsiteVisitsRequest
Filter by stored visit type: ad_click (campaign-attributed) or return. Omit to include both.
Filter by contact's first name.
Filter by contact's last name.
Filter by contact's job title.
Filter by functional area.
Filter by company name.
Filter by company domain.
Filter by contact's city.
Filter by contact's state or region.
Filter by contact's country.
Filter by postal code.
Filter by LinkedIn profile URL.
pagePage number (1-indexed).
page_sizeNumber of results per page.
ListContactWebsiteVisitsResponse
Website visits associated with matching contacts.
totalTotal number of matching website visits.
pageCurrent page number.
page_sizeNumber of results per page.
PersonLocationModel
Contact's city
Contact's state or region
Contact's country
PublicApiErrorCode
Stable codes that API consumers may safely branch on.
RemoveContactFromAudienceRequest
audience_idThe audience to remove the contact from.
contact_idThe contact to remove.
RemoveContactFromAudienceResponse
successWhether the contact was successfully removed.
Additional information about the result.
RunAudienceSyncsRequest
audience_idconnection_idsDestination connection IDs. Reuses the latest audience sync configuration or creates an enabled configuration on first use. Omit or send [] to run all existing enabled audience destinations.
SearchAudienceContactModel
idUnique identifier for the contact
Identifier for the associated company
first_nameContact's first name
last_nameContact's last name
work_emailsList of work email addresses
personal_emailsList of personal email addresses
phonesList of phone numbers in E.164 format
linkedin_urlLinkedIn profile URL
Contact location details
Associated company details, included when fetching a single contact
contact_idThe contact ID. This matches the id field and is included for clients that expect an explicit contact_id property.
SearchAudienceContactsRequest
audience_idThe audience to search contacts within.
Filter by contact's first name.
Filter by contact's last name.
Filter by job title.
Filter by functional area (e.g. Engineering, Marketing, Sales).
Filter by company name.
Filter by company domain.
Filter by city.
Filter by state or region.
Filter by country.
Filter by postal code.
Filter by LinkedIn profile URL.
pagePage number (1-indexed).
page_sizeNumber of results per page.
SearchAudienceContactsResponse
Contacts belonging to the audience that match the filters.
totalTotal number of matching audience contacts.
pageCurrent page number.
page_sizeNumber of results per page.
SearchAudiencesRequest
Filter audiences by name (partial match)
pagePage number (1-indexed)
page_sizeNumber of results per page
SearchAudiencesResponse
List of audiences matching the search criteria
SearchCompaniesRequest
Filter by company name.
Filter by company domain.
Filter by industry.
Filter by city.
Filter by state.
Filter by country.
Filter by ZIP code.
Filter by employee count range.
Filter by revenue range.
Filter by LinkedIn company URL.
pagePage number (1-indexed).
page_sizeNumber of results per page.
SearchCompaniesResponse
Companies matching the search criteria.
SearchCompanyEmployeesRequest
company_idThe company to search employees within.
Filter by employee's first name.
Filter by employee's last name.
Filter by job title.
pagePage number (1-indexed).
page_sizeNumber of results per page.
SearchCompanyEmployeesResponse
Employees matching the search criteria.
SearchContactsRequest
Filter by first name.
Filter by last name.
Filter by email address (searches both work and personal emails).
Filter by job title.
Filter by functional area.
Filter by company name.
Filter by company domain.
Filter by city.
Filter by state or region.
Filter by country.
Filter by postal code.
Filter by LinkedIn profile URL.
pagePage number (1-indexed).
page_sizeNumber of results per page.
SearchContactsResponse
Contacts matching the search criteria.
SearchWebsiteVisitRequest
Filter by stored visit type: ad_click (campaign-attributed) or return. Omit to include both.
Filter visits by audience.
Filter by visitor's country.
Filter by visitor's city.
Filter by visitor's IP address.
Filter by browser name.
Filter by platform (e.g. macOS, Windows, Linux).
Filter to only visits that have a session recording.
Filter by landing page URL.
limitMaximum number of results to return.
SearchWebsiteVisitResponse
Website visits matching the search criteria.
ValidationErrorItem
fieldDot-path of the field that failed validation. Empty string for body-level errors.
messageThe error message for this field.
codeMachine-readable error code. One of: missing, invalid_uuid, invalid_email, invalid_datetime, invalid_date, invalid_json, invalid_choice, invalid_format, invalid_value, string_too_short, string_too_long, list_too_short, list_too_long, out_of_range, type_error, value_error, unknown_field.
ValidationErrorResponse
One entry per field that failed validation.
WebsiteVisitModel
idUnique identifier for the website visit
timestampISO 8601 timestamp of the visit
cityVisitor's city (IP geolocation)
state_regionVisitor's state or region (IP geolocation)
countryVisitor's country (IP geolocation)
Stored visit classification: ad_click for a campaign-attributed visit, return for a return visit. Campaign attribution is not independent verification of a paid ad click. Null means unclassified.
Landing page URL of the visit
Referrer URL that led to this visit
Visitor's IP address
Visitor's browser user-agent string
Detected browser name
Duration of the visit session in seconds
WebsiteVisitResolutionModel
People resolved from this website visit
WebsiteVisitWithResolutionsModel
idUnique identifier for the website visit
timestampISO 8601 timestamp of the visit
cityVisitor's city (IP geolocation)
state_regionVisitor's state or region (IP geolocation)
countryVisitor's country (IP geolocation)
Identity resolution results including resolved person and company
Stored visit classification: ad_click for a campaign-attributed visit, return for a return visit. Campaign attribution is not independent verification of a paid ad click. Null means unclassified.
Landing page URL of the visit
Referrer URL that led to this visit
Visitor's IP address
Visitor's browser user-agent string
Detected browser name
Duration of the visit session in seconds