Please enable JavaScript to view this site.

ActiveCampaign Forums

ActiveCampaign API Data Model

Navigation: Schema: V3 > Tables

Contacts: ActiveCampaign Contacts

Catalog: ActiveCampaign

Schema: V3

Primary Keys: id

Label: Contacts

Can retrieve data and change data using insert, update and delete.

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function Contacts. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name

Data Type

Required

Default Value

Documentation

exclude

int32

☐

 

Exclude from the response the contact with the given ID.

formid

int32

☐

 

Filter contacts associated with the given form.

in_group_lists

string

☐

 

Set this to 'true' in order to return only contacts that the current user has permissions to see.

listid

string

☐

 

Filter contacts associated with the given list.

segmentid

int32

☐

 

Return only contacts that match a list segment (this param initially returns segment information, when it is run a second time it will return contacts that match the segment).

seriesid

int32

☐

 

Filter contacts associated with the given automation.

status

string

☐

 

-1 = Any, 0 = Unconfirmed, 1 = Active, 2 = Unsubscribed, 3 = Bounced.

tag

int32

☐

 

Filter contacts associated with the given tag.

waitid

int32

☐

 

Filter by contacts in the wait queue of an automation block.

 

Columns of Table Function

The columns of the table function Contacts are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name

Data Type

Label

Required

Documentation

adate

datetime

 

☐

 

bounced_date

datetime

Bounced Date

☐

 

bounced_hard

int64

Bounced Hard

☑

 

bounced_soft

int64

Bounced Soft

☑

 

cdate

datetime

Created

☐

 

deleted

int64

Deleted

☑

 

edate

datetime

 

☐

 

email_domain

string

 

☐

 

email_local

string

 

☐

 

email

string

Email Address

☐

 

firstName

string

First Name

☐

 

gravatar

int64

Gravatar

☑

 

hash

string

Hash

☐

 

id

int64

ID

☑

 

ip

int64

IP Address

☑

 

lastName

string

Last Name

☐

 

organization

int64

Account

☐

Deprecated. Do not use.

orgid

int64

Organization ID

☑

 

phone

string

Phone

☐

 

rating_tstamp

datetime

Rating Date

☐

 

segmentio_id

int64

 

☐

 

sentcnt

int64

 

☑

 

socialdata_lastcheck

datetime

Social Data Last Check

☐

 

ua

string

 

☐

 

udate

datetime

Last Updated

☐

 

 

22-12-2022 20:43 Version 22.1.101-BETA+3681

X

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

  • Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
  • Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
  • Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
  • Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
  • Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
  • Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
  • Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
  • Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.
  
Disclaimer