Impexium
Impexium is the premier association management software solution for nonprofits and member-based organizations.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | Impexium Support |
URL | https://support.impexium.com |
support@impexium.com |
Connector Metadata | |
---|---|
Publisher | Impexium Corporation |
Website | http://wwww.impexium.com |
Privacy policy | https://www.impexium.com/impexium-information-security-policy/ |
Categories | Sales and CRM |
This connector allows Impexium clients to create automated workflows between the suite of Impexium apps as well as 3rd party services to get notifications, synchronize files, collect data and more.
To use this connector, you must have an Impexium account with access to one or more Impexium environments.
Please contact support@impexium.com to get your API key
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
API URL | string | Specify your API Url e.g. https://abc.mpxapi.com | True |
API Key | securestring | The API Key for your environment | True |
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Add a New Task |
Add a New Task |
Add a Service to an Organization |
Add a Service to an Organization |
Add Activity |
Add Activity. |
Add Activity to Organization |
Add Activity to Organization |
Add Activity to Sales Opportunity |
Add Activity to Sales Opportunity |
Add Award Nomination |
Add a new Award Nomination. |
Add Categories for an Individual |
Add Categories for an Individual |
Add Categories for an Organization |
Add Categories for an Organization |
Add Customer Request |
Add Customer Request |
Add Education Credits to Individual |
Add a new Education Credit to an Individual. |
Add Email to Individual |
Add Email to Individual |
Add Email to Organization |
Add Email to Organization |
Add Exam Scores |
Add Exam Scores |
Add Individual |
Adds an Individual. |
Add Individual to Committee |
Add Individual to Committee. |
Add Nominee |
Add Nominee |
Add Note to Individual |
Add a Note to an Individual. |
Add Note to Organization |
Add a Note to an Organization. |
Add Note to Sales Opportunity |
Add Note to Sales Opportunity |
Add Notification to Individual |
Add Notification to Individual |
Add or Update a List of Custom Fields Per Individual |
Add or Update a List of Custom Fields Per Individual |
Add or Update a List of Custom Fields Per Organization |
Add or Update a List of Custom Fields Per Organization |
Add or Update Address to Individual |
Add or Update Address to Individual |
Add or Update Address to Organization |
Add or Update Address to Organization |
Add Organization |
Add Organization. |
Add Phone to Individual |
Add Phone to Individual |
Add Phone to Organization |
Add Phone to Organization |
Add Relationship to Individual |
Add Relationship to Individual. |
Add Web Link for Individual |
Add Web Link for Individual |
Add Web Link for Organization |
Add Web Link for Organization |
Create a new task or Assign Task to a User |
Create a new task or Assign Task to a User |
Delete a Category for an Individual |
Delete a Category for an Individual |
Delete a Category for an Organization |
Delete a Category for an Organization |
Delete an Individual Web Link |
Delete an Individual Web Link |
Delete an Organization Web Link |
Delete an Organization Web Link |
Delete Record From Custom Data Table |
Delete Record From Custom Data Table |
Find Customer by Phone Number |
Find Customer by Phone Number. |
Find Individual by Id or Email or Record Number |
Find Individual by Id or Email. |
Find Members (Individuals) by First Name |
Find Members (Individuals) by First Name |
Find Members (Individuals) by First Name and Last Name |
Find Members (Individuals) by First Name and Last Name |
Find Members (Individuals) by Last Name |
Find Members (Individuals) by Last Name |
Find Members (Individuals) by Name |
Find Members (Individuals) by Name |
Find Members by Name |
Find Members by Name |
Find Organization by Id or Record Number |
Get organization's profile information by ID or Record Number |
Get a List of All Services of an Organization |
Get a List of All Services of an Organization |
Get a List of Licenses |
Get a List of Licenses |
Get Abandoned Checkouts |
Get Abandoned Checkouts |
Get All Committees |
Get All Committees |
Get All Event Registrations Information for an Individual |
Get All Event Registrations Information for an Individual |
Get All Events |
Get All Events |
Get All Open Orders for an Individual |
Get All Open Orders for an Individual |
Get All States by Country |
Get All States by Country |
Get Committee Information for an Individual |
Get Committee Information for an Individual |
Get Committee Members by committee ID or code |
Get Committee Members by Committee ID or Code |
Get Course Attendees |
Get Course Attendees |
Get Individual's Active Subscriptions |
Get Individual's Active Subscriptions |
Get Individual's Relationships |
Get Individual's Relationships |
Get Individual Active Memberships |
Get Individual Active Memberships |
Get Individual Custom Field Values |
Get Individual Custom Field Values |
Get Individual Inactive Memberships |
Get Individual Inactive Memberships |
Get List of Active Certifications for an Individual |
Get List of Active Certifications for an Individual |
Get List of Active Certifications for an Organization |
Get List of Active Certifications for an Organization |
Get Nominees by Committee |
Get Nominees by Committee |
Get Organization's Active Subscriptions |
Get Organization's Active Subscriptions |
Get Organization's Relationships |
Get Organization's Relationships |
Get Organization Active Memberships |
Get Organization Active Memberships |
Get Organization Custom Field Values |
Get Organization Custom Field Values |
Get Organization Inactive Memberships |
Get Organization Inactive Memberships |
Get Positions by Committee |
Get Positions by Committee |
Get Purchases for an Individual |
Get Purchases for an Individual |
Get Sub-Committees |
Get Sub-Committees |
Get Upcoming Events |
Get Upcoming Events |
List All Awards |
List All Awards |
List All Countries |
List All Countries |
List All Event Cancellations by Event |
List All Event Cancellations by Event |
List All Exhibitors |
List All Exhibitors |
List All Exhibits |
List All Exhibits |
List all Individuals |
List all Individuals |
List All Open Customer Request |
List All Open Customer Request |
List Award Individual Recipients |
List all Individuals that are Award Recipients. |
List Award Organization Recipients |
List all Organizations that are Award Recipients. |
List Completed User Tasks by User ID or Email |
List Completed User Tasks by User ID or Email |
List of All Individual Members |
List of All Individual Members |
List of All Organization Members |
List of All Organization Members |
List of Customer Relationships |
List of Customer Relationships |
List of Exams |
List of Exams |
List Pending User Tasks by User ID or Email |
List Pending User Tasks by User ID or Email |
List Registrants |
List Registrants |
Lookup Individuals |
Lookup Individuals by Name |
Lookup Organizations |
Lookup Organizations by Name or Acronym |
Mark Registrant as Attended |
Mark the Registrant as Attended for the specified Events. |
Register an Individual for a Free Session |
Register an Individual for a Free Session |
Save Relationship for Organization |
Save Relationship for Organization |
Update an Individual Email |
Update an Individual Email |
Update Award Nomination |
Update an existing Award Nomination. |
Update Committee Member |
Update Committee Member. |
Update Customer Request |
Update Customer Request |
Update Individual Custom Field Values |
Update Individual Custom Field Values. |
Update Organization |
Update Organization. |
Update Phone for an Individual |
Update Phone for an Individual |
Update Phone for an Organization |
Update Phone for an Organization |
Update Task by Task Number |
Update Task by Task Number |
Update User Task Progress or Mark as Completed |
Update User Task Progress or Mark as Completed |
Add a New Task
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Title
|
title | string |
Title. |
|
Category
|
category | string |
Category. |
|
Description
|
description | string |
Description. |
|
Start Date
|
startDate | date |
Start Date. |
|
Due Date
|
dueDate | date |
Due Date. |
Returns
- Body
- TaskData
Add a Service to an Organization
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Organization ID.
|
ID | True | string |
Organization ID. |
Code
|
code | string |
Code. |
|
Name
|
name | string |
Name. |
Returns
- Body
- ServiceData
Add Activity.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Individual Id
|
id | True | uuid |
Individual Id. |
Text
|
text | True | string |
Text. |
URL
|
url | string |
URL. |
|
Activity Date
|
activityDate | date |
Activity Date. |
Add Activity to Organization
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Organization ID.
|
ID | True | string |
Organization ID. |
Category
|
category | string |
Category. |
|
Text
|
text | string |
Text. |
|
Url
|
url | string |
Url. |
|
Activity Date
|
activityDate | date |
Activity Date. |
Add Activity to Sales Opportunity
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
ID | True | string |
Opportunity ID |
Category
|
category | string |
Category. |
|
Text
|
text | string |
Text. |
|
Url
|
url | string |
Url. |
|
Activity Date
|
activityDate | date |
Activity Date. |
Add a new Award Nomination.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Award Id
|
id | True | string |
Award Id. |
Nominee Record Number
|
nomineeRecordNumber | True | string |
Nominee Record Number. |
Nominated By Record Number
|
nominatedByCustomerRecordNumber | True | string |
Nominated By Record Number. |
Nomination Date
|
nominationDate | True | date |
Nomination Date. |
Awarded Date
|
awardedDate | date |
Awarded Date. |
|
Status
|
status | string |
Status. |
|
Description
|
description | string |
An explanation why the nominee should be considered for the award. |
Add Categories for an Individual
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Individual Record Number.
|
Record Number | True | string |
Individual Record Number. |
Code
|
code | string |
Code. |
|
Is Primary
|
isPrimary | boolean |
Is Primary. |
Add Categories for an Organization
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Record Number
|
Record Number | True | string |
Record Number |
Code
|
code | string |
Code. |
|
Is Primary
|
isPrimary | boolean |
Is Primary. |
Add Customer Request
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Requested By Customer Record Number
|
requestedByCustomerRecordNumber | string |
Requested By Customer Record Number. |
|
Request Type
|
requestType | string |
Request Type. |
|
Description
|
description | string |
Description. |
|
Source
|
source | string |
Source. |
Add a new Education Credit to an Individual.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id or Record Number
|
idOrRecordNumber | True | string |
Individual Id or Record Number. |
Type
|
type | True | string |
Education Credit Type. |
Description
|
description | True | string |
Description. |
Number of Credits
|
numberOfCredits | True | float |
Number of Credits Earned. |
Earned Date
|
dateEarned | True | date-time |
Earned Date. |
Provider
|
providerName | string |
Provider Name. |
|
State/Province
|
stateName | string |
State or Province Name. |
|
Reference
|
reference | string |
Reference. |
|
Is Self Reported
|
isSelfReported | boolean |
Is Self Reported. |
Add Email to Individual
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Individual ID Or Record Number.
|
ID Or Record Number | True | string |
Individual ID Or Record Number. |
Primary
|
primary | boolean |
Primary |
|
Address
|
address | string |
Address. |
|
Type
|
type | string |
Type. |
|
Show In Directory
|
showInDirectory | boolean |
Show In Directory |
Returns
Email Data.
- Body
- EmailData
Add Email to Organization
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Organization ID.
|
ID | True | string |
Organization ID. |
Is Primary Email
|
primary | boolean |
Is Primary Email. |
|
Address
|
address | string |
Address. |
|
Type
|
type | string |
Type. |
|
Show In Directory
|
showInDirectory | boolean |
Show In Directory. |
Add Exam Scores
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Exam Code.
|
Exam Code | True | string |
Exam Code. |
Individual Record Number
|
individualRecordNumber | string |
Individual Record Number. |
|
Score
|
score | string |
Score. |
Returns
- response
- array of ExamScoreResultData
Adds an Individual.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Create User.
|
createUser | boolean |
Choose True if a user account should be created when the individual is created. |
|
First Name
|
firstName | True | string |
First Name. |
Last Name
|
lastName | True | string |
Last Name. |
Email Address
|
string |
Email Address. |
||
Record Number
|
recordNumber | string |
Record Number. |
Returns
- Body
- IndividualData
Add Individual to Committee.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Committee Code
|
code | True | string |
Committee Code. |
Record Number
|
recordNumber | True | string |
Record Number. |
Code
|
code | string |
Member Code. |
|
Position Code
|
positionCode | True | string |
Position Code. |
Start Date
|
startDate | True | date |
Start Date. |
End Date
|
endDate | date |
End Date. |
|
Representing Organization Record Number
|
representingOrganizationRecordNumber | string |
Representing Organization - Record Number. |
|
Representing Organization Relationship Name
|
representingOrganizationRelationshipName | string |
Representing Organization - Relationship Name. |
|
Nominated By Customer Record Number
|
nominatedByCustomerRecordNumber | string |
Nominated By - Record Number |
|
Committee Term
|
committeeTerm | integer |
Committee Term. |
|
Rank
|
rank | integer |
Rank. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Member Id
|
id | string |
Member Id. |
First Name
|
firstName | string |
First Name. |
Last Name
|
lastName | string |
Last Name. |
Code
|
code | string |
Code. |
Record Number
|
recordNumber | string |
Record Number. |
Position
|
position | string |
Position. |
Position Code
|
positionCode | string |
Position Code. |
Start Date
|
startDate | date-time |
Start Date. |
End Date
|
endDate | date-time |
End Date. |
Contact Ids
|
primaryOrganization.contactIds | array of uuid |
Primary Organization - Contact Ids. |
Parent Company Id
|
primaryOrganization.parentCompanyId | string |
Primary Organization - Parent Company Id. |
Description
|
primaryOrganization.description | string |
Primary Organization - Description. |
Branch Name
|
primaryOrganization.branchName | string |
Primary Organization - Branch Name. |
Tags
|
primaryOrganization.tags | array of string |
Primary Organization - Tags. |
Primary Organization Id
|
primaryOrganization.id | string |
Primary Organization - Id. |
Customer Type
|
primaryOrganization.customerType | string |
Primary Organization - Customer Type. |
Record Number
|
primaryOrganization.recordNumber | string |
Primary Organization - Record Number. |
Title
|
primaryOrganization.title | string |
Primary Organization - Title. |
Name
|
primaryOrganization.name | string |
Primary Organization - Name. |
addresses
|
primaryOrganization.addresses | array of object | |
Address Id
|
primaryOrganization.addresses.id | string |
Primary Organization - Addresses - Address Id. |
Is Primary Address
|
primaryOrganization.addresses.primary | boolean |
Primary Organization - Addresses - Is Primary. |
Address Line 1
|
primaryOrganization.addresses.line1 | string |
Primary Organization - Addresses - Line 1. |
Address Line 2
|
primaryOrganization.addresses.line2 | string |
Primary Organization - Addresses - Line 2. |
Address Line 3
|
primaryOrganization.addresses.line3 | string |
Primary Organization - Addresses - Line 3. |
City
|
primaryOrganization.addresses.city | string |
Primary Organization - Addresses - City. |
State
|
primaryOrganization.addresses.state | string |
Primary Organization - Addresses - State. |
Zip Code
|
primaryOrganization.addresses.zipcode | string |
Primary Organization - Addresses - Zip Code. |
Country
|
primaryOrganization.addresses.country | string |
Primary Organization - Addresses - Country. |
State Abbreviation
|
primaryOrganization.addresses.stateAbbreviation | string |
Primary Organization - Addresses - State Abbreviation. |
State ISO Code
|
primaryOrganization.addresses.stateISOCode | string |
Primary Organization - Addresses - State ISO Code. |
Type
|
primaryOrganization.addresses.type | string |
Primary Organization - Addresses - Type. |
Region
|
primaryOrganization.addresses.region | string |
Primary Organization - Addresses - Region. |
Latitude
|
primaryOrganization.addresses.latitude | number |
Primary Organization - Addresses - Latitude. |
Longitude
|
primaryOrganization.addresses.longitude | number |
Primary Organization - Addresses - Longitude. |
Show In Directory
|
primaryOrganization.addresses.showInDirectory | boolean |
Primary Organization - Addresses - Show In Directory. |
Congressional District
|
primaryOrganization.addresses.congressionalDistrict | string |
Primary Organization - Addresses - Congressional District. |
Country Id
|
primaryOrganization.addresses.countryData.id | string |
Primary Organization - Addresses - Country - Country Id. |
Country Name
|
primaryOrganization.addresses.countryData.name | string |
Primary Organization - Addresses - Country - Country Name. |
Two Letter ISO Code
|
primaryOrganization.addresses.countryData.twoLetterIsoCode | string |
Primary Organization - Addresses - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
primaryOrganization.addresses.countryData.threeLetterIsoCode | string |
Primary Organization - Addresses - Country - Three Letter ISO Code. |
Country Code
|
primaryOrganization.addresses.countryData.code | integer |
Primary Organization - Addresses - Country - Country Code. |
Email
|
primaryOrganization.email | string |
Primary Organization - Email. |
Image URI
|
primaryOrganization.imageUri | string |
Primary Organization - Image URI. |
Twitter
|
primaryOrganization.twitter | string |
Primary Organization - Twitter. |
LinkedIn
|
primaryOrganization.linkedIn | string |
Primary Organization - LinkedIn. |
emails
|
primaryOrganization.emails | array of object | |
Is Primary Email
|
primaryOrganization.emails.primary | boolean |
Primary Organization - Emails - Is Primary. |
Address
|
primaryOrganization.emails.address | string |
Primary Organization - Emails - Address. |
Type
|
primaryOrganization.emails.type | string |
Primary Organization - Emails - Type. |
Show In Directory
|
primaryOrganization.emails.showInDirectory | boolean |
Primary Organization - Emails - Show In Directory. |
phones
|
primaryOrganization.phones | array of object | |
Phone Id
|
primaryOrganization.phones.id | string |
Primary Organization - Phones - Id. |
Is Primary Phone
|
primaryOrganization.phones.primary | boolean |
Primary Organization - Phones - Is Primary. |
Type
|
primaryOrganization.phones.type | integer |
Primary Organization - Phones - Type. |
Country Id
|
primaryOrganization.phones.country.id | string |
Primary Organization - Phones - Country - Country Id. |
Country Name
|
primaryOrganization.phones.country.name | string |
Primary Organization - Phones - Country - Country Name. |
Two Letter ISO Code
|
primaryOrganization.phones.country.twoLetterIsoCode | string |
Primary Organization - Phones - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
primaryOrganization.phones.country.threeLetterIsoCode | string |
Primary Organization - Phones - Country - Three Letter ISO Code. |
Country Code
|
primaryOrganization.phones.country.code | integer |
Primary Organization - Phones - Country - Country Code. |
Show In Directory
|
primaryOrganization.phones.showInDirectory | boolean |
Primary Organization - Phones - Show In Directory. |
Number
|
primaryOrganization.phones.number | string |
Primary Organization - Phones - Number. |
Extension
|
primaryOrganization.phones.extension | string |
Primary Organization - Phones - Extension. |
Type Name
|
primaryOrganization.phones.typeName | string |
Primary Organization - Phones - Type Name. |
Website
|
primaryOrganization.webSite | string |
Primary Organization - Website. |
memberships
|
primaryOrganization.memberships | array of object | |
Membership Type
|
primaryOrganization.memberships.membershipType | string |
Primary Organization - Memberships - Membership Type. |
Membership Type Id
|
primaryOrganization.memberships.membershipTypeId | string |
Primary Organization - Memberships - Membership Type Id. |
Code
|
primaryOrganization.memberships.code | string |
Primary Organization - Memberships - Code. |
Expire Date
|
primaryOrganization.memberships.expireDate | date-time |
Primary Organization - Memberships - Expire Date. |
Grace Expire Date
|
primaryOrganization.memberships.graceExpireDate | date-time |
Primary Organization - Memberships - Grace Expire Date. |
Inherited Membership Benefits
|
primaryOrganization.memberships.inheritedMembershipBenefits | boolean |
Primary Organization - Memberships - Inherited Membership Benefits. |
Renewal URL
|
primaryOrganization.memberships.renewalUrl | string |
Primary Organization - Memberships - Renewal URL. |
Join Date
|
primaryOrganization.memberships.joinDate | date-time |
Primary Organization - Memberships - Join Date. |
Terminate Date
|
primaryOrganization.memberships.terminateDate | date-time |
Primary Organization - Memberships - Terminate Date. |
Effective Date
|
primaryOrganization.memberships.effectiveDate | date-time |
Primary Organization - Memberships - Effective Date. |
Category
|
primaryOrganization.category | string |
Primary Organization - Category. |
categories
|
primaryOrganization.categories | array of object | |
subCategories
|
primaryOrganization.categories.subCategories | array of object |
Primary Organization - Categories - Subcategories. |
Code
|
primaryOrganization.categories.subCategories.code | string |
Primary Organization - Categories - Subcategories - Code. |
Name
|
primaryOrganization.categories.subCategories.name | string |
Primary Organization - Categories - Subcategories - Name. |
Code
|
primaryOrganization.categories.code | string |
Primary Organization - Categories - Code. |
Name
|
primaryOrganization.categories.name | string |
Primary Organization - Categories - Name. |
customFields
|
primaryOrganization.customFields | array of object | |
Name
|
primaryOrganization.customFields.name | string |
Primary Organization - Custom Fields - Name. |
Caption
|
primaryOrganization.customFields.caption | string |
Primary Organization - Custom Fields - Caption. |
Value
|
primaryOrganization.customFields.value | string |
Primary Organization - Custom Fields - Value. |
Show In Directory
|
primaryOrganization.showInDirectory | boolean |
Primary Organization - Show In Directory. |
links
|
primaryOrganization.links | array of object | |
Type
|
primaryOrganization.links.type | string |
Primary Organization - Links - Type. |
URL
|
primaryOrganization.links.url | string |
Primary Organization - Links - URL. |
Old Id
|
primaryOrganization.oldId | string |
Primary Organization - Old Id. |
ContactIds
|
organizationRepresenting.contactIds | array of uuid |
Organization Representing - Contact Ids. |
Parent Company Id
|
organizationRepresenting.parentCompanyId | string |
Organization Representing - Parent Company Id. |
Description
|
organizationRepresenting.description | string |
Organization Representing - Description. |
Branch Name
|
organizationRepresenting.branchName | string |
Organization Representing - Branch Name. |
Tags
|
organizationRepresenting.tags | array of string |
Organization Representing - Tags. |
Representing Organization Id
|
organizationRepresenting.id | string |
Organization Representing - Organization Representing Id. |
Customer Type
|
organizationRepresenting.customerType | string |
Organization Representing - Customer Type. |
Record Number
|
organizationRepresenting.recordNumber | string |
Organization Representing - Record Number. |
Title
|
organizationRepresenting.title | string |
Organization Representing - Title. |
Name
|
organizationRepresenting.name | string |
Organization Representing - Name. |
addresses
|
organizationRepresenting.addresses | array of object | |
Address Id
|
organizationRepresenting.addresses.id | string |
Organization Representing - Addresses - Address Id. |
Is Primary Address
|
organizationRepresenting.addresses.primary | boolean |
Organization Representing - Addresses - Is Primary. |
Address Line 1
|
organizationRepresenting.addresses.line1 | string |
Organization Representing - Addresses - Line 1. |
Address Line 2
|
organizationRepresenting.addresses.line2 | string |
Organization Representing - Addresses - Line 2. |
Address Line 3
|
organizationRepresenting.addresses.line3 | string |
Organization Representing - Addresses - Line 3. |
City
|
organizationRepresenting.addresses.city | string |
Organization Representing - Addresses - City. |
State
|
organizationRepresenting.addresses.state | string |
Organization Representing - Addresses - State. |
Zip Code
|
organizationRepresenting.addresses.zipcode | string |
Organization Representing - Addresses - Zip Code. |
Country
|
organizationRepresenting.addresses.country | string |
Organization Representing - Addresses - Country. |
State Abbreviation
|
organizationRepresenting.addresses.stateAbbreviation | string |
Organization Representing - Addresses - State Abbreviation. |
State ISO Code
|
organizationRepresenting.addresses.stateISOCode | string |
Organization Representing - Addresses - State ISO Code. |
Type
|
organizationRepresenting.addresses.type | string |
Organization Representing - Addresses - Type. |
Region
|
organizationRepresenting.addresses.region | string |
Organization Representing - Addresses - Region. |
Latitude
|
organizationRepresenting.addresses.latitude | number |
Organization Representing - Addresses - Latitude. |
Longitude
|
organizationRepresenting.addresses.longitude | number |
Organization Representing - Addresses - Longitude. |
Show In Directory
|
organizationRepresenting.addresses.showInDirectory | boolean |
Organization Representing - Addresses - Show In Directory. |
Congressional District
|
organizationRepresenting.addresses.congressionalDistrict | string |
Organization Representing - Addresses - Congressional District. |
Country Id
|
organizationRepresenting.addresses.countryData.id | string |
Organization Representing - Addresses - Country - Country Id. |
Country Name
|
organizationRepresenting.addresses.countryData.name | string |
Organization Representing - Addresses - Country - Country Name. |
Two Letter ISO Code
|
organizationRepresenting.addresses.countryData.twoLetterIsoCode | string |
Organization Representing - Addresses - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
organizationRepresenting.addresses.countryData.threeLetterIsoCode | string |
Organization Representing - Addresses - Country - Three Letter ISO Code. |
Country Code
|
organizationRepresenting.addresses.countryData.code | integer |
Organization Representing - Addresses - Country - Country Code. |
Email
|
organizationRepresenting.email | string |
Organization Representing - Email. |
Image URI
|
organizationRepresenting.imageUri | string |
Organization Representing - Image URI. |
Twitter
|
organizationRepresenting.twitter | string |
Organization Representing - Twitter. |
LinkedIn
|
organizationRepresenting.linkedIn | string |
Organization Representing - LinkedIn. |
emails
|
organizationRepresenting.emails | array of object | |
Is Primary Email
|
organizationRepresenting.emails.primary | boolean |
Organization Representing - Emails - Is Primary. |
Address
|
organizationRepresenting.emails.address | string |
Organization Representing - Emails - Address. |
Type
|
organizationRepresenting.emails.type | string |
Organization Representing - Emails - Type. |
Show In Directory
|
organizationRepresenting.emails.showInDirectory | boolean |
Organization Representing - Emails - Show In Directory. |
phones
|
organizationRepresenting.phones | array of object | |
Phone Id
|
organizationRepresenting.phones.id | string |
Organization Representing - Phones - Id. |
Is Primary Phone
|
organizationRepresenting.phones.primary | boolean |
Organization Representing - Phones - Is Primary. |
Type
|
organizationRepresenting.phones.type | integer |
Organization Representing - Phones - Type. |
Country Id
|
organizationRepresenting.phones.country.id | string |
Organization Representing - Phones - Country - Country Id. |
Country Name
|
organizationRepresenting.phones.country.name | string |
Organization Representing - Phones - Country - Country Name. |
Two Letter ISO Code
|
organizationRepresenting.phones.country.twoLetterIsoCode | string |
Organization Representing - Phones - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
organizationRepresenting.phones.country.threeLetterIsoCode | string |
Organization Representing - Phones - Country - Three Letter ISO Code. |
Country Code
|
organizationRepresenting.phones.country.code | integer |
Organization Representing - Phones - Country - Country Code. |
Show In Directory
|
organizationRepresenting.phones.showInDirectory | boolean |
Organization Representing - Phones - Show In Directory. |
Number
|
organizationRepresenting.phones.number | string |
Organization Representing - Phones - Number. |
Extension
|
organizationRepresenting.phones.extension | string |
Organization Representing - Phones - Extension. |
Type Name
|
organizationRepresenting.phones.typeName | string |
Organization Representing - Phones - Type Name. |
Website
|
organizationRepresenting.webSite | string |
Organization Representing - Website. |
memberships
|
organizationRepresenting.memberships | array of object | |
Membership Type
|
organizationRepresenting.memberships.membershipType | string |
Organization Representing - Memberships - Membership Type. |
Membership Type Id
|
organizationRepresenting.memberships.membershipTypeId | string |
Organization Representing - Memberships - Membership Type Id. |
Code
|
organizationRepresenting.memberships.code | string |
Organization Representing - Memberships - Code. |
Expire Date
|
organizationRepresenting.memberships.expireDate | date-time |
Organization Representing - Memberships - Expire Date. |
Grace Expire Date
|
organizationRepresenting.memberships.graceExpireDate | date-time |
Organization Representing - Memberships - Grace Expire Date. |
Inherited Membership Benefits
|
organizationRepresenting.memberships.inheritedMembershipBenefits | boolean |
Organization Representing - Memberships - Inherited Membership Benefits. |
Renewal URL
|
organizationRepresenting.memberships.renewalUrl | string |
Organization Representing - Memberships - Renewal URL. |
Join Date
|
organizationRepresenting.memberships.joinDate | date-time |
Organization Representing - Memberships - Join Date. |
Terminate Date
|
organizationRepresenting.memberships.terminateDate | date-time |
Organization Representing - Memberships - Terminate Date. |
Effective Date
|
organizationRepresenting.memberships.effectiveDate | date-time |
Organization Representing - Memberships - Effective Date. |
Category
|
organizationRepresenting.category | string |
Organization Representing - Category. |
categories
|
organizationRepresenting.categories | array of object |
Organization Representing - Categories. |
subCategories
|
organizationRepresenting.categories.subCategories | array of object |
Organization Representing - Categories - Subcategories. |
Code
|
organizationRepresenting.categories.subCategories.code | string |
Organization Representing - Categories - Subcategories - Code. |
Name
|
organizationRepresenting.categories.subCategories.name | string |
Organization Representing - Categories - Subcategories - Name. |
Code
|
organizationRepresenting.categories.code | string |
Organization Representing - Categories - Code. |
Name
|
organizationRepresenting.categories.name | string |
Organization Representing - Categories - Name. |
customFields
|
organizationRepresenting.customFields | array of object | |
Name
|
organizationRepresenting.customFields.name | string |
Organization Representing - Custom Fields - Name. |
Caption
|
organizationRepresenting.customFields.caption | string |
Organization Representing - Custom Fields - Caption. |
Value
|
organizationRepresenting.customFields.value | string |
Organization Representing - Custom Fields - Value. |
Show In Directory
|
organizationRepresenting.showInDirectory | boolean |
Organization Representing - Show In Directory. |
links
|
organizationRepresenting.links | array of object | |
Type
|
organizationRepresenting.links.type | string |
Organization Representing - Links - Type. |
URL
|
organizationRepresenting.links.url | string |
Organization Representing - Links - URL. |
Old Id
|
organizationRepresenting.oldId | string |
Organization Representing - Old Id. |
Nominated By Customer Id
|
nominatedByCustomer.id | string |
Nominated By Customer - Nominated By Customer Id. |
Customer Type
|
nominatedByCustomer.customerType | string |
Nominated By Customer - Customer Type. |
Record Number
|
nominatedByCustomer.recordNumber | string |
Nominated By Customer - Record Number. |
Title
|
nominatedByCustomer.title | string |
Nominated By Customer - Title. |
Name
|
nominatedByCustomer.name | string |
Nominated By Customer - Name. |
addresses
|
nominatedByCustomer.addresses | array of object | |
Address Id
|
nominatedByCustomer.addresses.id | string |
Nominated By Customer - Addresses - Address Id. |
Is Primary Address
|
nominatedByCustomer.addresses.primary | boolean |
Nominated By Customer - Addresses - Is Primary. |
Address Line 1
|
nominatedByCustomer.addresses.line1 | string |
Nominated By Customer - Addresses - Line 1. |
Address Line 2
|
nominatedByCustomer.addresses.line2 | string |
Nominated By Customer - Addresses - Line 2. |
Address Line 3
|
nominatedByCustomer.addresses.line3 | string |
Nominated By Customer - Addresses - Line 3. |
City
|
nominatedByCustomer.addresses.city | string |
Nominated By Customer - Addresses - City. |
State
|
nominatedByCustomer.addresses.state | string |
Nominated By Customer - Addresses - State. |
Zip Code
|
nominatedByCustomer.addresses.zipcode | string |
Nominated By Customer - Addresses - Zip Code. |
Country
|
nominatedByCustomer.addresses.country | string |
Nominated By Customer - Addresses - Country. |
State Abbreviation
|
nominatedByCustomer.addresses.stateAbbreviation | string |
Nominated By Customer - Addresses - State Abbreviation. |
State ISO Code
|
nominatedByCustomer.addresses.stateISOCode | string |
Nominated By Customer - Addresses - State ISO Code. |
Type
|
nominatedByCustomer.addresses.type | string |
Nominated By Customer - Addresses - Type. |
Region
|
nominatedByCustomer.addresses.region | string |
Nominated By Customer - Addresses - Region. |
Latitude
|
nominatedByCustomer.addresses.latitude | number |
Nominated By Customer - Addresses - Latitude. |
Longitude
|
nominatedByCustomer.addresses.longitude | number |
Nominated By Customer - Addresses - Longitude. |
Show In Directory
|
nominatedByCustomer.addresses.showInDirectory | boolean |
Nominated By Customer - Addresses - Show In Directory. |
Congressional District
|
nominatedByCustomer.addresses.congressionalDistrict | string |
Nominated By Customer - Addresses - Congressional District. |
Country Id
|
nominatedByCustomer.addresses.countryData.id | string |
Nominated By Customer - Addresses - Country - Country Id. |
Country Name
|
nominatedByCustomer.addresses.countryData.name | string |
Nominated By Customer - Addresses - Country - Country Name. |
Two Letter ISO Code
|
nominatedByCustomer.addresses.countryData.twoLetterIsoCode | string |
Nominated By Customer - Addresses - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
nominatedByCustomer.addresses.countryData.threeLetterIsoCode | string |
Nominated By Customer - Addresses - Country - Three Letter ISO Code. |
Country Code
|
nominatedByCustomer.addresses.countryData.code | integer |
Nominated By Customer - Addresses - Country - Country Code. |
Email
|
nominatedByCustomer.email | string |
Nominated By Customer - Email. |
Image URI
|
nominatedByCustomer.imageUri | string |
Nominated By Customer - Image URI. |
Twitter
|
nominatedByCustomer.twitter | string |
Nominated By Customer - Twitter. |
LinkedIn
|
nominatedByCustomer.linkedIn | string |
Nominated By Customer - LinkedIn. |
emails
|
nominatedByCustomer.emails | array of object | |
Is Primary Email
|
nominatedByCustomer.emails.primary | boolean |
Nominated By Customer - Emails - Is Primary. |
Address
|
nominatedByCustomer.emails.address | string |
Nominated By Customer - Emails - Address. |
Type
|
nominatedByCustomer.emails.type | string |
Nominated By Customer - Emails - Type. |
Show In Directory
|
nominatedByCustomer.emails.showInDirectory | boolean |
Nominated By Customer - Emails - Show In Directory. |
phones
|
nominatedByCustomer.phones | array of object | |
Phone Id
|
nominatedByCustomer.phones.id | string |
Nominated By Customer - Phones - Id. |
Is Primary Phone
|
nominatedByCustomer.phones.primary | boolean |
Nominated By Customer - Phones - Is Primary. |
Type
|
nominatedByCustomer.phones.type | integer |
Nominated By Customer - Phones - Type. |
Country Id
|
nominatedByCustomer.phones.country.id | string |
Nominated By Customer - Phones - Country - Country Id. |
Country Name
|
nominatedByCustomer.phones.country.name | string |
Nominated By Customer - Phones - Country - Country Name. |
Two Letter ISO Code
|
nominatedByCustomer.phones.country.twoLetterIsoCode | string |
Nominated By Customer - Phones - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
nominatedByCustomer.phones.country.threeLetterIsoCode | string |
Nominated By Customer - Phones - Country - Three Letter ISO Code. |
Country Code
|
nominatedByCustomer.phones.country.code | integer |
Nominated By Customer - Phones - Country - Country Code. |
Show In Directory
|
nominatedByCustomer.phones.showInDirectory | boolean |
Nominated By Customer - Phones - Show In Directory. |
Number
|
nominatedByCustomer.phones.number | string |
Nominated By Customer - Phones - Number. |
Extension
|
nominatedByCustomer.phones.extension | string |
Nominated By Customer - Phones - Extension. |
Type Name
|
nominatedByCustomer.phones.typeName | string |
Nominated By Customer - Phones - Type Name. |
Website
|
nominatedByCustomer.webSite | string |
Nominated By Customer - Website. |
memberships
|
nominatedByCustomer.memberships | array of object | |
Membership Type
|
nominatedByCustomer.memberships.membershipType | string |
Nominated By Customer - Memberships - Membership Type. |
Membership Type Id
|
nominatedByCustomer.memberships.membershipTypeId | string |
Nominated By Customer - Memberships - Membership Type Id. |
Code
|
nominatedByCustomer.memberships.code | string |
Nominated By Customer - Memberships - Code. |
Expire Date
|
nominatedByCustomer.memberships.expireDate | date-time |
Nominated By Customer - Memberships - Expire Date. |
Grace Expire Date
|
nominatedByCustomer.memberships.graceExpireDate | date-time |
Nominated By Customer - Memberships - Grace Expire Date. |
Inherited Membership Benefits
|
nominatedByCustomer.memberships.inheritedMembershipBenefits | boolean |
Nominated By Customer - Memberships - Inherited Membership Benefits. |
Renewal URL
|
nominatedByCustomer.memberships.renewalUrl | string |
Nominated By Customer - Memberships - Renewal URL. |
Join Date
|
nominatedByCustomer.memberships.joinDate | date-time |
Nominated By Customer - Memberships - Join Date. |
Terminate Date
|
nominatedByCustomer.memberships.terminateDate | date-time |
Nominated By Customer - Memberships - Terminate Date. |
Effective Date
|
nominatedByCustomer.memberships.effectiveDate | date-time |
Nominated By Customer - Memberships - Effective Date. |
Category
|
nominatedByCustomer.category | string |
Nominated By Customer - Category. |
categories
|
nominatedByCustomer.categories | array of object |
Nominated By Customer - Categories. |
subCategories
|
nominatedByCustomer.categories.subCategories | array of object |
Nominated By Customer - Categories - Subcategories. |
Code
|
nominatedByCustomer.categories.subCategories.code | string |
Nominated By Customer - Categories - Subcategories - Code. |
Name
|
nominatedByCustomer.categories.subCategories.name | string |
Nominated By Customer - Categories - Subcategories - Name. |
Code
|
nominatedByCustomer.categories.code | string |
Nominated By Customer - Categories - Code. |
Name
|
nominatedByCustomer.categories.name | string |
Nominated By Customer - Categories - Name. |
customFields
|
nominatedByCustomer.customFields | array of object | |
Name
|
nominatedByCustomer.customFields.name | string |
Nominated By Customer - Custom Fields - Name. |
Caption
|
nominatedByCustomer.customFields.caption | string |
Nominated By Customer - Custom Fields - Caption. |
Value
|
nominatedByCustomer.customFields.value | string |
Nominated By Customer - Custom Fields - Value. |
Show In Directory
|
nominatedByCustomer.showInDirectory | boolean |
Nominated By Customer - Show In Directory. |
links
|
nominatedByCustomer.links | array of object | |
Type
|
nominatedByCustomer.links.type | string |
Nominated By Customer - Links - Type. |
URL
|
nominatedByCustomer.links.url | string |
Nominated By Customer - Links - URL. |
Old Id
|
nominatedByCustomer.oldId | string |
Nominated By Customer - Old Id. |
addresses
|
addresses | array of object | |
Address Id
|
addresses.id | string |
Addresses - Address Id. |
Is Primary Address
|
addresses.primary | boolean |
Addresses - Is Primary. |
Address Line 1
|
addresses.line1 | string |
Addresses - Line 1. |
Address Line 2
|
addresses.line2 | string |
Addresses - Line 2. |
Address Line 3
|
addresses.line3 | string |
Addresses - Line 3. |
City
|
addresses.city | string |
Addresses - City. |
State
|
addresses.state | string |
Addresses - State. |
Zip Code
|
addresses.zipcode | string |
Addresses - Zip Code. |
Country
|
addresses.country | string |
Addresses - Country. |
State Abbreviation
|
addresses.stateAbbreviation | string |
Addresses - State Abbreviation. |
State ISO Code
|
addresses.stateISOCode | string |
Addresses - State ISO Code. |
Type
|
addresses.type | string |
Addresses - Type. |
Region
|
addresses.region | string |
Addresses - Region. |
Latitude
|
addresses.latitude | number |
Addresses - Latitude. |
Longitude
|
addresses.longitude | number |
Addresses - Longitude. |
Show In Directory
|
addresses.showInDirectory | boolean |
Addresses - Show In Directory. |
Congressional District
|
addresses.congressionalDistrict | string |
Addresses - Congressional District. |
Country Id
|
addresses.countryData.id | string |
Addresses - Country - Country Id. |
Country Name
|
addresses.countryData.name | string |
Addresses - Country - Country Name. |
Two Letter ISO Code
|
addresses.countryData.twoLetterIsoCode | string |
Addresses - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
addresses.countryData.threeLetterIsoCode | string |
Addresses - Country - Three Letter ISO Code. |
Country Code
|
addresses.countryData.code | integer |
Addresses - Country - Country Code. |
phones
|
phones | array of object | |
Phone Id
|
phones.id | string |
Phones - Id. |
Is Primary Phone
|
phones.primary | boolean |
Phones - Is Primary. |
Type
|
phones.type | integer |
Phones - Type. |
Country Id
|
phones.country.id | string |
Phones - Country - Country Id. |
Country Name
|
phones.country.name | string |
Phones - Country - Country Name. |
Two Letter ISO Code
|
phones.country.twoLetterIsoCode | string |
Phones - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
phones.country.threeLetterIsoCode | string |
Phones - Country - Three Letter ISO Code. |
Country Code
|
phones.country.code | integer |
Phones - Country - Country Code. |
Show In Directory
|
phones.showInDirectory | boolean |
Phones - Show In Directory. |
Number
|
phones.number | string |
Phones - Number. |
Extension
|
phones.extension | string |
Phones - Extension. |
Type Name
|
phones.typeName | string |
Phones - Type Name. |
emails
|
emails | array of object | |
Is Primary Email
|
emails.primary | boolean |
Emails - Is Primary. |
Address
|
emails.address | string |
Emails - Address. |
Type
|
emails.type | string |
Emails - Type. |
Show In Directory
|
emails.showInDirectory | boolean |
Emails - Show In Directory. |
Rank
|
rank | integer |
Rank. |
Add Nominee
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Committee Code.
|
Code | True | string |
Committee Code. |
Nominee Record Number
|
nomineeRecordNumber | string |
Nominee Record Number. |
|
Code
|
code | string |
Code. |
|
Position Code
|
positionCode | string |
Position Code. |
|
Status
|
status | string |
Status. |
|
Representing Organization Record Number
|
representingOrganizationRecordNumber | string |
Representing Organization Record Number. |
|
Representing Organization Relationship Name
|
representingOrganizationRelationshipName | string |
Representing Organization Relationship Name. |
|
Nominated By Customer Record Number
|
nominatedByCustomerRecordNumber | string |
Nominated By Customer Record Number. |
|
Committee Term
|
committeeTerm | integer |
Committee Term. |
|
Rank
|
rank | integer |
Rank. |
Add a Note to an Individual.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Individual Id
|
id | True | string |
Individual Id. |
Is Alert
|
isAlert | boolean |
Is Alert. |
|
Title
|
title | string |
Title. |
|
Follow Up Date
|
followUpDate | date |
Follow Up Date. |
|
Content
|
content | True | string |
Content. |
Category
|
category | string |
Category. |
|
Is Internal
|
isInternal | boolean |
Is Internal. |
Add a Note to an Organization.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Organization Id
|
id | True | string |
Organization Id. |
Is Alert
|
isAlert | boolean |
Is Alert. |
|
Title
|
title | string |
Title. |
|
Follow Up Date
|
followUpDate | date |
Follow Up Date. |
|
Content
|
content | True | string |
Content. |
Category
|
category | string |
Category. |
|
Is Internal
|
isInternal | boolean |
Is Internal. |
Add Note to Sales Opportunity
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
ID | True | string |
Sales opportunity ID |
Content
|
Content | string |
Content. |
|
Category
|
Category | string |
Category. |
|
Is Internal
|
isInternal | boolean |
Is Internal. |
Add Notification to Individual
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Individual ID.
|
ID | True | string |
Individual ID. |
Title
|
title | string |
Title. |
|
Message
|
message | string |
Message. |
|
Url
|
url | string |
Url. |
|
Date
|
date | date-time |
Date. |
|
Is Read
|
isRead | boolean |
Is Read. |
Add or Update a List of Custom Fields Per Individual
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Individual ID or Record Number.
|
ID or Record Number | True | string |
Individual ID or Record Number. |
Name
|
name | string |
Name. |
|
Value
|
value | string |
Value. |
Returns
- response
- array of CustomFieldResultData
Add or Update a List of Custom Fields Per Organization
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Organization ID or Record Number.
|
ID or Record Number | True | string |
Organization ID or Record Number. |
Name
|
name | string |
Name. |
|
Value
|
value | string |
Value. |
Returns
- response
- array of CustomFieldResultData
Add or Update Address to Individual
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Individual ID or Record Number
|
ID Or Record Number | True | string |
Individual ID or Record Number. |
ID
|
id | string |
ID. |
|
Primary
|
primary | boolean |
Primary. |
|
Line 1
|
line1 | string |
Line 1. |
|
Line 2
|
line2 | string |
Line 2. |
|
Line 3
|
line3 | string |
Line 3. |
|
City
|
city | string |
City. |
|
State
|
state | string |
State. |
|
Zip Code
|
zipcode | string |
Zipcode. |
|
Country
|
country | string |
Country. |
|
Type
|
type | string |
Type. |
|
Show In Directory
|
showInDirectory | boolean |
Show In Directory. |
|
Is Preferred Shipping
|
isPreferredShipping | boolean |
Is Preferred Shipping. |
|
Is Preferred Billing
|
isPreferredBilling | boolean |
Is Preferred Billing. |
|
Is Bad Address
|
isBadAddress | boolean |
Is Bad Address. |
Returns
Address Save Data.
- Body
- AddressSaveData
Add or Update Address to Organization
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Organization ID or Record Number.
|
ID or Record Number | True | string |
Organization ID or Record Number. |
ID
|
id | string |
ID. |
|
Primary
|
primary | boolean |
Primary. |
|
Line 1
|
line1 | string |
Line 1. |
|
Line 2
|
line2 | string |
Line 2. |
|
Line 3
|
line3 | string |
Line 3. |
|
City
|
city | string |
City. |
|
State
|
state | string |
State. |
|
Zip Code
|
zipcode | string |
Zipcode. |
|
Country
|
country | string |
Country. |
|
Type
|
type | string |
Type. |
|
Show In Directory
|
showInDirectory | boolean |
Show In Directory. |
|
Is Preferred Shipping
|
isPreferredShipping | boolean |
Is Preferred Shipping. |
|
Is Preferred Billing
|
isPreferredBilling | boolean |
Is Preferred Billing. |
|
Is Bad Address
|
isBadAddress | boolean |
Is Bad Address. |
Returns
Address Save Data.
- Body
- AddressSaveData
Add Organization.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Name
|
name | True | string |
Name. |
Branch Name
|
branchName | string |
Branch Name. |
|
Website
|
website | string |
Website. |
Returns
- Body
- OrganizationData
Add Phone to Individual
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Individual ID or Record Number
|
ID or Record Number | True | string |
Individual ID or Record Number |
Country Name
|
countryName | True | string |
Country Name. |
Primary
|
primary | boolean |
Primary. |
|
Show in Directory
|
showInDirectory | boolean |
Show in Directory. |
|
Number
|
number | True | string |
Number. |
Extension
|
extension | string |
Extension. |
|
Type Name
|
typeName | True | string |
Type Name. |
Returns
- Body
- PhoneDataSet
Add Phone to Organization
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Organization ID or Record Number
|
ID or Record Number | True | string |
Organization ID or Record Number |
Country Name
|
countryName | True | string |
Country Name. |
Primary
|
primary | boolean |
Primary. |
|
Show in Directory
|
showInDirectory | boolean |
Show in Directory. |
|
Number
|
number | True | string |
Number. |
Extension
|
extension | string |
Extension. |
|
Type Name
|
typeName | True | string |
Type Name. |
Returns
- Body
- PhoneDataSet
Add Relationship to Individual.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Individual Id
|
id | True | string |
Individual Id. |
Relationship Name
|
relationshipName | True | string |
Relationship Name. |
Related To Customer Record Number
|
relatedToCustomerRecordNumber | True | string |
Related To Customer Record Number. |
Reciprocal Relationship Name
|
reciprocalRelationshipName | True | string |
Reciprocal Relationship Name. |
Is Primary
|
isPrimary | boolean |
Is Primary. |
|
Is Reciprocal Primary
|
isReciprocalPrimary | boolean |
Is Reciprocal Primary. |
|
Start Date
|
startDate | date |
Start Date. |
|
End Date
|
endDate | date |
End Date. |
Add Web Link for Individual
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID or Record Number
|
ID or Record Number | True | string |
A valid Individual Id or Record Number. |
Type
|
type | string |
Type. |
|
Url
|
url | string |
Url. |
Add Web Link for Organization
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID or Record Number
|
ID or Record Number | True | string |
Organization ID or Record Number. |
Type
|
type | True | string |
Type. |
Url
|
url | True | string |
Url. |
Create a new task or Assign Task to a User
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
User ID or Email
|
User ID or Email | True | string |
A valid User Id or Email |
Task Number
|
taskNumber | string |
Task Number. |
|
Title
|
title | string |
Title. |
|
Category
|
category | string |
Category. |
|
Description
|
description | string |
Description. |
|
Assigned By
|
assignedBy | string |
Assigned By. |
|
Start Date
|
startDate | date |
Start Date. |
|
Due Date
|
dueDate | date |
Due Date. |
|
Progress
|
progress | string |
Progress. |
|
Completed Date
|
completedDate | date-time |
Completed Date. |
Delete a Category for an Individual
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Record Number.
|
Record Number | True | string |
Record Number. |
Category Code.
|
Category Code | True | string |
Category Code. |
Delete a Category for an Organization
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Record Number
|
Record Number | True | string |
Record Number |
Category Code
|
Category Code | True | string |
Category Code |
Delete an Individual Web Link
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Individual ID or Record Number
|
ID or Record Number | True | string |
A valid Individual ID or Record Number. |
Type
|
type | string |
Type. |
|
Url
|
url | string |
Url. |
Delete an Organization Web Link
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID or Record Number
|
ID or Record Number | True | string |
Organization ID or Record Number |
Type
|
type | True | string |
Type. |
Url
|
url | True | string |
Url. |
Delete Record From Custom Data Table
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Table Name
|
Table Name | True | string |
Custom table name |
ID
|
ID | True | string |
ID of the record to be deleted. |
Find Customer by Phone Number.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Phone Number
|
phoneNumber | True | string |
Phone Number. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of object | |
Full Name
|
dataList.fullName | string |
Full Name. |
Customer Id
|
dataList.id | string |
Customer Id. |
Customer Type
|
dataList.customerType | string |
Customer Type. |
Record Number
|
dataList.recordNumber | string |
Record Number. |
Show In Directory
|
dataList.showInDirectory | boolean |
Show In Directory. |
addresses
|
dataList.addresses | array of object | |
Address Id
|
dataList.addresses.id | string |
Addresses - Address Id. |
Is Primary Address
|
dataList.addresses.primary | boolean |
Addresses - Is Primary. |
Address Line 1
|
dataList.addresses.line1 | string |
Addresses - Line 1. |
Address Line 2
|
dataList.addresses.line2 | string |
Addresses - Line 2. |
Address Line 3
|
dataList.addresses.line3 | string |
Addresses - Line 3. |
City
|
dataList.addresses.city | string |
Addresses - City. |
State
|
dataList.addresses.state | string |
Addresses - State. |
Zip Code
|
dataList.addresses.zipcode | string |
Addresses - Zip Code. |
Country
|
dataList.addresses.country | string |
Addresses - Country. |
State Abbreviation
|
dataList.addresses.stateAbbreviation | string |
Addresses - State Abbreviation. |
State ISO Code
|
dataList.addresses.stateISOCode | string |
Addresses - State ISO Code. |
Type
|
dataList.addresses.type | string |
Addresses - Type. |
Region
|
dataList.addresses.region | string |
Addresses - Region. |
Latitude
|
dataList.addresses.latitude | number |
Addresses - Latitude. |
Longitude
|
dataList.addresses.longitude | number |
Addresses - Longitude. |
Show In Directory
|
dataList.addresses.showInDirectory | boolean |
Addresses - Show In Directory. |
Congressional District
|
dataList.addresses.congressionalDistrict | string |
Addresses - Congressional District. |
Country Id
|
dataList.addresses.countryData.id | string |
Addresses - Country - Country Id. |
Country Name
|
dataList.addresses.countryData.name | string |
Addresses - Country - Country Name. |
Two Letter ISO Code
|
dataList.addresses.countryData.twoLetterIsoCode | string |
Addresses - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
dataList.addresses.countryData.threeLetterIsoCode | string |
Addresses - Country - Three Letter ISO Code. |
Country Code
|
dataList.addresses.countryData.code | integer |
Addresses - Country - Country Code. |
emails
|
dataList.emails | array of object | |
Is Primary Email
|
dataList.emails.primary | boolean |
Emails - Is Primary. |
Address
|
dataList.emails.address | string |
Emails - Address. |
Type
|
dataList.emails.type | string |
Emails - Type. |
Show In Directory
|
dataList.emails.showInDirectory | boolean |
Emails - Show In Directory. |
phones
|
dataList.phones | array of object | |
Phone Id
|
dataList.phones.id | string |
Phones - Id. |
Is Primary Phone
|
dataList.phones.primary | boolean |
Phones - Is Primary. |
Type
|
dataList.phones.type | integer |
Phones - Type. |
Country Id
|
dataList.phones.country.id | string |
Phones - Country - Country Id. |
Country Name
|
dataList.phones.country.name | string |
Phones - Country - Country Name. |
Two Letter ISO Code
|
dataList.phones.country.twoLetterIsoCode | string |
Phones - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
dataList.phones.country.threeLetterIsoCode | string |
Phones - Country - Three Letter ISO Code. |
Country Code
|
dataList.phones.country.code | integer |
Phones - Country - Country Code. |
Show In Directory
|
dataList.phones.showInDirectory | boolean |
Phones - Show In Directory. |
Number
|
dataList.phones.number | string |
Phones - Number. |
Extension
|
dataList.phones.extension | string |
Phones - Extension. |
Type Name
|
dataList.phones.typeName | string |
Phones - Type Name. |
Find Individual by Id or Email.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id or Record Number or Email
|
idOrRecordNumberOrEmail | True | string |
Id or Record Number or Email. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of IndividualData |
Data List. |
Find Members (Individuals) by First Name
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
First Name
|
First Name | True | string |
First Name |
Page Number
|
Page Number | True | integer |
Page Number |
Include Email
|
includeEmail | boolean |
Include Email Data |
Returns
- Body
- IndividualData
Find Members (Individuals) by First Name and Last Name
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
First Name
|
First Name | True | string |
First Name |
Last Name
|
Last Name | True | string |
Last Name |
Page Number
|
Page Number | True | integer |
Page Number. |
Include Email Data.
|
includeEmail | boolean |
Include Email Data. |
Returns
Name | Path | Type | Description |
---|---|---|---|
pageNumber
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of IndividualData |
dataList |
Find Members (Individuals) by Last Name
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Last Name.
|
Last Name | True | string |
Last Name. |
Page Number.
|
Page Number | True | integer |
Page Number. |
Include Email
|
includeEmail | boolean |
Include Email Data. |
Returns
- Body
- IndividualData
Find Members (Individuals) by Name
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Individual Name
|
Name | True | string |
Individual Name. |
Page Number.
|
Page Number | True | integer |
Page Number. |
Include Email Data.
|
includeEmail | boolean |
Include Email Data. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of IndividualData |
dataList |
Find Members by Name
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Name
|
Name | True | string |
Individual or Organization name |
Page Number
|
Page Number | True | integer |
Page Number |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of ContactData |
dataList |
Get organization's profile information by ID or Record Number
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id or Record Number
|
idOrRecordnumber | True | string |
Organization Id or Record Number. |
Returns
- Body
- OrganizationData
Get a List of All Services of an Organization
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Organization ID.
|
ID | True | string |
Organization ID. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of ServiceData |
dataList |
Get a List of Licenses
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Individual ID.
|
ID | True | string |
Individual ID. |
Page Number
|
Page Number | True | integer |
Page Number |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of LicenseData |
dataList |
Get Abandoned Checkouts
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Page Number
|
Page Number | True | integer |
Page Number |
Abandoned From
|
abandonedFrom | True | string |
Abandoned From |
Product Code
|
productCode | string |
Product Code |
|
Customer Record Number
|
customerRecordNumber | string |
Customer Record Number |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number |
dataList
|
dataList | array of AbandonedCheckoutData |
dataList |
Get All Committees
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Page Number
|
Page Number | True | integer |
Page Number |
Committee Code.
|
Code | string |
Committee Code. |
|
Committee Name.
|
Name | string |
Committee Name. |
|
Term.
|
Term | integer |
Term. |
|
Active Only.
|
activeOnly | boolean |
Active Only. |
Returns
Name | Path | Type | Description |
---|---|---|---|
pageNumber
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of CommitteeData |
dataList |
Get All Event Registrations Information for an Individual
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Individual ID or Record Number
|
ID or Record Number | True | string |
Individual ID or Record Number |
Page Number
|
Page Number | True | integer |
Page Number |
Event Code.
|
eventCode | string |
Event Code. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of RegistrationData |
dataList |
Get All Events
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Page Number
|
Page Number | True | integer |
Page Number |
Code.
|
Code | string |
Code. |
|
Name.
|
Name | string |
Name. |
|
Tag.
|
Tag | string |
Tag. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of EventData |
DataList |
Get All Open Orders for an Individual
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Individual ID or Record Number.
|
ID or Record Number | True | string |
Individual ID or Record Number. |
Page Number.
|
Page Number | True | integer |
Page Number. |
Include Line Items.
|
includeLineItems | boolean |
Include Line Items. |
|
From Date.
|
fromDate | string |
From Date. |
|
To Date.
|
toDate | string |
To Date. |
Returns
Name | Path | Type | Description |
---|---|---|---|
pageNumber
|
pageNumber | integer |
Page Number |
dataList
|
dataList | array of PayableOrderData |
dataList |
Get All States by Country
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Country ID
|
Country ID | True | string |
Country ID |
Page Number
|
Page Number | True | integer |
Page Number |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number |
dataList
|
dataList | array of StateProvinceData |
dataList |
Get Committee Information for an Individual
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Individual ID.
|
ID | True | string |
Individual ID. |
Page Number
|
Page Number | True | integer |
Page Number |
Include Inactive
|
includeInactive | boolean |
Include Inactive |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number |
dataList
|
dataList | array of CommitteeMemberData |
Data List. |
Get Committee Members by Committee ID or Code
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Committee ID or Code
|
ID Or Code | True | string |
Committee ID or Code |
Page Number
|
Page Number | True | integer |
Page Number |
Term
|
Term | integer |
Term |
|
Position Codes
|
positionCodes | string |
Position Codes |
Get Course Attendees
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Course Code.
|
Code | True | string |
Course Code. |
Page Number.
|
Page Number | True | integer |
Page Number. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of CourseAttendeeData |
dataList |
Get Individual's Active Subscriptions
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Individual ID
|
ID | True | string |
Individual |
Page Number
|
Page Number | True | integer |
Page Number |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of SubscriptionData |
dataList |
Get Individual's Relationships
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Individual ID
|
ID | True | string |
Individual ID. |
Page Number
|
Page Number | True | integer |
Page Number. |
Relationship Name
|
relationshipName | string |
Name of the Relationship. |
|
Include Details.
|
includeDetails | boolean |
Include Details. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of RelationshipData |
Data List. |
Get Individual Active Memberships
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Individual ID
|
ID | True | string |
Individual ID. |
Returns
- response
- array of MembershipData
Get Individual Custom Field Values
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Individual ID
|
ID | True | string |
Individual ID. |
Returns
- response
- array of CustomFieldData
Get Individual Inactive Memberships
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Individual ID.
|
ID | True | string |
Individual ID. |
Returns
- Body
- MembershipData
Get List of Active Certifications for an Individual
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Individual ID or Record Number.
|
ID or Record Number | True | string |
Individual ID or Record Number. |
Page Number
|
Page Number | True | integer |
Page Number |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of CertificationData |
dataList |
Get List of Active Certifications for an Organization
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Organization ID or Record Number.
|
ID or Record Number | True | string |
Organization ID or Record Number. |
Page Number
|
Page Number | True | integer |
Page Number |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of CertificationData |
dataList |
Get Nominees by Committee
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Committee Code.
|
Code | True | string |
Committee Code. |
Page Number
|
Page Number | True | integer |
Page Number. |
Term
|
Term | string |
Term |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of CommitteeNomineeData |
Data List |
Get Organization's Active Subscriptions
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Organization ID.
|
ID | True | string |
Organization ID. |
Page Number.
|
Page Number | True | integer |
Page Number. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of SubscriptionData |
dataList |
Get Organization's Relationships
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Organization ID.
|
ID | True | string |
Organization ID. |
Page Number.
|
Page Number | True | integer |
Page Number. |
Relationship Name.
|
relationshipName. | string |
Name of the Relationship. |
|
Includes Details.
|
includesDetails | boolean |
Includes Details. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of RelationshipData |
DataList |
Get Organization Active Memberships
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Organization ID.
|
ID | True | string |
Organization ID. |
Returns
- response
- array of MembershipData
Get Organization Custom Field Values
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Organization ID
|
ID | True | string |
Organization ID |
Returns
- response
- array of CustomFieldData
Get Organization Inactive Memberships
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Organization ID
|
ID | True | string |
Organization ID |
Returns
- Body
- MembershipData
Get Positions by Committee
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Committee Code
|
Code | True | string |
Committee Code. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of CommitteePositionData |
dataList |
Get Purchases for an Individual
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Individual ID or Record Number.
|
ID or Record Number | True | string |
Individual ID or Record Number. |
Page Number
|
Page Number | True | integer |
Page Number. |
Product Code.
|
productCode | string |
Product Code. |
|
Purchased Since
|
purchasedSince | string |
yyyy-MM-ddTHH:mm:ss |
|
Product Category Code.
|
productCategoryCode | string |
Product Category Code. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of PurchasedItemData |
dataList |
Get Sub-Committees
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Code
|
Code | True | string |
Code |
Page Number
|
Page Number | True | integer |
Page Number. |
Returns
Name | Path | Type | Description |
---|---|---|---|
pageNumber
|
pageNumber | integer |
pageNumber |
dataList
|
dataList | array of CommitteeData |
dataList |
Get Upcoming Events
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Page Number
|
Page Number | True | integer |
Page Number |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of EventData |
DataList |
List All Awards
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Page Number
|
Page Number | True | integer |
Page Number |
Year.
|
Year | integer |
Year. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of AwardData |
dataList |
List All Countries
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Page Number
|
Page Number | True | integer |
Page Number |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number |
dataList
|
dataList | array of CountryData |
dataList |
List All Event Cancellations by Event
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Event Code
|
Event Code | True | string |
A valid Event Code. |
Page Number.
|
Page Number | True | integer |
Page Number. |
Include Details
|
includeDetails | boolean |
Indicates if additional information should be returned. |
|
Cancelled Since
|
cancelledSince | string |
The initial date to search cancellations (yyyy-MM-ddTHH:mm:ss) |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of RegistrantCancellationData |
dataList |
List All Exhibitors
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Exhibit Code
|
Exhibit Code | True | string |
Exhibit Code. |
Page Number
|
Page Number | True | integer |
Page Number |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number |
dataList
|
dataList | array of ExhibitorData |
dataList |
List All Exhibits
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Page Number
|
Page Number | True | integer |
Page Number |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number |
dataList
|
dataList | array of ExhibitData |
dataList |
List all Individuals
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Page Number
|
Page Number | True | integer |
Page Number |
Individual Name.
|
Name | string |
Individual Name. |
|
Include Details.
|
includeDetails | boolean |
Include Details. |
|
Individual Old ID.
|
oldID | string |
Individual Old ID. |
Returns
Name | Path | Type | Description |
---|---|---|---|
pageNumber
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of IndividualData |
List All Open Customer Request
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Page Number
|
Page Number | True | integer |
Page Number |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of RequestData |
dataList |
List all Individuals that are Award Recipients.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Award Id
|
id | True | string |
Award Id. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of AwardRecipientIndividualData |
Data List. |
List all Organizations that are Award Recipients.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Award Id
|
id | True | string |
Award Id. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of AwardRecipientOrganizationData |
Data List. |
List Completed User Tasks by User ID or Email
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
User ID or Email
|
User ID or Email | True | string |
A valid User ID or Email |
Page Number
|
Page Number | True | integer |
Page Number |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of UserTaskData |
dataList |
List of All Individual Members
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Page Number
|
Page Number | True | integer |
Page Number |
Zip Code
|
zipCode | string |
Zip Code |
|
Radius
|
Radius | float |
Radius in Miles |
|
Membership Type Code
|
membershipTypeCode | string |
A valid code for a Membership Type |
|
Membership Type Category
|
membershipTypeCategory | string |
A valid Membership Type Category name |
|
Tag
|
Tag | string |
Tag |
|
Include Membership
|
includeMembership | boolean |
Include Membership Data |
|
Include Address
|
includeAddress | boolean |
Include Address Data |
|
Include Phone
|
includePhone | boolean |
Include Phone Data |
|
Include Email
|
includeEmail | boolean |
Include Email Data |
|
Include Link
|
includeLink | boolean |
Include Link Data |
|
Include Custom Fields
|
includeCustomFields | boolean |
Include Custom Field Data |
|
Include Categories
|
includeCategories | boolean |
Include Categories Data |
|
Include Membership Renewal URLs
|
includeMembershipRenewalUrl | boolean |
Include Membership Renewal URLs |
|
Expire Date - From:
|
expiringFrom | string |
Expire Date - From |
|
Expire Date - To:
|
expiringTo | string |
Expire Date - To |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of IndividualData |
dataList |
List of All Organization Members
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Page Number
|
Page Number | True | integer |
Page Number |
Zip Code
|
zipCode | string |
Zip Code |
|
Radius
|
Radius | float |
Radius in Miles |
|
State Abbreviation
|
stateAbbreviation | string |
State Abbreviation |
|
Congressional District
|
congressionalDistrict | number |
Congressional District |
|
Membership Type Code
|
membershipTypeCode | string |
A valid code for a Membership Type |
|
Membership Type Category
|
membershipTypeCategory | string |
A valid Membership Type Category name |
|
City
|
City | string |
City |
|
Name
|
Name | string |
Name |
|
Tag
|
Tag | string |
Tag |
|
Latitude
|
Latitude | float |
Latitude |
|
Longitude
|
Longitude | float |
Longitude |
|
Domain
|
Domain | string |
Domain |
|
Include Membership
|
includeMembership | boolean |
Include Membership Data |
|
Include Address
|
includeAddress | boolean |
Include Address Data |
|
Include Phone
|
includePhone | boolean |
Include Phone Data |
|
Include Email
|
includeEmail | boolean |
Include Email Data |
|
Include Custom Fields
|
includeCustomFields | boolean |
Include Custom Field Data |
|
Expire Date - From:
|
expiringFrom | string |
Expire Date - From |
|
Expire Date - To:
|
expiringTo | string |
Expire Date - To |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of OrganizationData |
dataList |
List of Customer Relationships
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Page Number
|
Page Number | True | integer |
Page Number |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of RelationshipTypeData |
dataList |
List of Exams
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Page Number
|
Page Number | True | integer |
The page number of the result set. |
Code
|
Code | string |
A specific Exam code. |
|
Category Name
|
categoryName | string |
A specific Exam Category name. |
|
Is Public
|
isPublic | boolean |
When set to true, only public Exams will be displayed; If it's not specified will display all. |
|
Changed Since
|
changedSince | string |
When a date (yyyy-MM-ddTHH:mm:ss (UTC)) is specified, only Exams modified after this date will be displayed. |
|
Tag
|
Tag | string |
Tag |
|
Include Prices
|
includePrices | boolean |
When set to true, add the active price list for every product. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number |
dataList
|
dataList | array of ExamData |
dataList |
List Pending User Tasks by User ID or Email
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
User ID or Email
|
User ID or Email | True | string |
A valid User ID or Email |
Page Number
|
Page Number | True | integer |
Page Number |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of UserTaskData |
dataList |
List Registrants
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Event Code
|
Event Code | True | string |
Event Code |
Page Number
|
Page Number | True | integer |
Page Number |
Session Code
|
sessionCode | string |
Session Code. |
|
Include Details
|
includeDetails | boolean |
Include Details |
|
Registered Since
|
registeredSince | string |
Registered Since |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of RegistrantData |
dataList |
Lookup Individuals by Name
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Lookup value
|
name | True | string |
Individual Name. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of IndividualLookupBasicData |
Data List. |
Lookup Organizations by Name or Acronym
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Lookup value
|
name | True | string |
Name or Acronym. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Page Number
|
pageNumber | integer |
Page Number. |
dataList
|
dataList | array of OrganizationLookupBasicData |
Data List. |
Mark the Registrant as Attended for the specified Events.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Record Number
|
recordNumber | True | string |
Record Number. |
Code
|
eventOrSessionCode | True | string |
Event or Session Code. |
Register an Individual for a Free Session
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Event Code
|
Event Code | True | string |
A Valid Event Code. |
Customer ID or Record Number
|
Customer ID or Record Number | True | string |
A Valid Individual ID or Record Number. |
Registration Number
|
registrationNumber | string |
A Valid Registration Number. |
|
Session Code
|
sessionCode | string |
Session Code. |
Save Relationship for Organization
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Organization ID.
|
ID | True | string |
Organization ID. |
Relationship Name
|
relationshipName | True | string |
Relationship Name. |
Related To Customer Record Number
|
relatedToCustomerRecordNumber | True | string |
Related To Customer Record Number. |
Reciprocal Relationship Name
|
reciprocalRelationshipName | True | string |
Reciprocal Relationship Name. |
Is Primary
|
isPrimary | boolean |
Is Primary. |
|
Start Date
|
startDate | date |
Start Date. |
|
End Date
|
endDate | date |
End Date. |
|
Is Reciprocal Primary
|
isReciprocalPrimary | boolean |
Is Reciprocal Primary. |
|
Title
|
title | string |
Title. |
Update an Individual Email
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Individual ID or Record Number
|
ID or Record Number | True | string |
Individual ID or Record Number. |
Current Email Address
|
Current Email Address | True | string |
Email Address to Update |
Primary
|
primary | boolean |
Primary. |
|
Address
|
address | string |
Address. |
|
Type
|
type | string |
Type. |
|
Show In Directory
|
showInDirectory | boolean |
Show In Directory |
Update an existing Award Nomination.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Award Id
|
id | True | string |
Award Id. |
Nominee Record Number
|
nomineeRecordNumber | True | string |
Nominee Record Number. |
Nominated By Record Number
|
nominatedByCustomerRecordNumber | True | string |
Nominated By Record Number. |
Nomination Date
|
nominationDate | True | date |
Nomination Date. |
Awarded Date
|
awardedDate | date |
Awarded Date. |
|
Status
|
status | string |
Status. |
|
Description
|
description | string |
An explanation why the nominee should be considered for the award. |
Update Committee Member.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Committee Code
|
code | True | string |
Committee Code. |
Member Record Number
|
memberRecordNumber | True | string |
Member Record Number. |
Current Position Code
|
currentPositionCode | True | string |
Current Position Code. |
Code
|
code | string |
Member Code. |
|
Position Code
|
positionCode | string |
New Position Code. |
|
Start Date
|
startDate | date |
Start Date. |
|
End Date
|
endDate | date |
End Date. |
|
Representing Organization Record Number
|
representingOrganizationRecordNumber | string |
Representing Organization - Record Number. |
|
Representing Organization Relationship Name
|
representingOrganizationRelationshipName | string |
Representing Organization - Relationship Name. |
|
Nominated By Customer Record Number
|
nominatedByCustomerRecordNumber | string |
Nominated By - Record Number |
|
Committee Term
|
committeeTerm | integer |
Committee Term. |
|
Rank
|
rank | integer |
Rank. |
Update Customer Request
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Request Number
|
requestNumber | string |
Request Number. |
|
Closed Date
|
closedDate | date-time |
Closed Date. |
Returns
- Body
- RequestUpdateData
Update Individual Custom Field Values.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Customer ID
|
ID | True | string |
Customer ID. |
Name
|
name | string |
Name. |
|
Caption
|
caption | string |
Caption. |
|
Value
|
value | string |
Custom Field Value. For multi-selects, use "|" as delimiter. |
Update Organization.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Organization Id
|
id | True | uuid |
Organization Id. |
Name
|
name | string |
Name. |
|
Description
|
description | string |
Description. |
|
Show In Directory
|
showInDirectory | boolean |
Show In Directory. |
|
Branch Name
|
branchName | string |
Branch Name. |
|
Website
|
website | string |
Website. |
Returns
- Body
- OrganizationData
Update Phone for an Individual
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Individual ID or Record Number.
|
ID or Record Number | True | string |
Individual ID or Record Number. |
Phone ID.
|
ID | True | string |
Phone ID. |
Country Name
|
countryName | True | string |
Country Name. |
Primary
|
primary | boolean |
Primary. |
|
Show in Directory
|
showInDirectory | boolean |
Show in Directory. |
|
Number
|
number | True | string |
Number. |
Extension
|
extension | string |
Extension. |
|
Type Name
|
typeName | True | string |
Type Name. |
Returns
- Body
- PhoneDataSet
Update Phone for an Organization
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Organization ID or Record Number.
|
ID or Record Number | True | string |
Organization ID or Record Number. |
Phone ID.
|
ID | True | string |
Phone ID. |
Country Name
|
countryName | True | string |
Country Name. |
Primary
|
primary | boolean |
Primary. |
|
Show in Directory
|
showInDirectory | boolean |
Show in Directory. |
|
Number
|
number | True | string |
Number. |
Extension
|
extension | string |
Extension. |
|
Type Name
|
typeName | True | string |
Type Name. |
Returns
- Body
- PhoneDataSet
Update Task by Task Number
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Task Number
|
Task Number | True | string |
A valid Task Number. |
Title
|
title | string |
Title. |
|
Category
|
category | string |
Category. |
|
Description
|
description | string |
Description. |
|
Start Date
|
startDate | date |
Start Date. |
|
Due Date
|
dueDate | date |
Due Date. |
Returns
- Body
- TaskData
Update User Task Progress or Mark as Completed
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
User ID or Email
|
User ID or Email | True | string |
A valid User Id or Email |
Task Number
|
taskNumber | string |
Task Number. |
|
Title
|
title | string |
Title. |
|
Category
|
category | string |
Category. |
|
Description
|
description | string |
Description. |
|
Assigned By
|
assignedBy | string |
Assigned By. |
|
Start Date
|
startDate | date |
Start Date. |
|
Due Date
|
dueDate | date |
Due Date. |
|
Progress
|
progress | string |
Progress. |
|
Completed Date
|
completedDate | date-time |
Completed Date. |
Returns
- Body
- UserTaskData
When a committee member is updated |
Triggers when an individual is added, deleted or updated to/from a commiteee. |
When a customer address is updated |
Triggers when a customer address is added/edited or deleted. |
When a customer custom field value is updated |
Triggers when a customer custom field value is added/edited or deleted. |
When a customer email is updated |
Triggers when an email is added/edited or deleted. |
When a customer is merged |
Triggers when a customer is merged. |
When a customer phone is updated |
Triggers when a customer phone is added/edited or deleted. |
When a customer relationship is updated |
Triggers when a customer relationship is added/edited or deleted. |
When a customer request is updated |
Triggers when a customer request is added or closed. |
When a membership is terminated |
Triggers when a membership is terminated. |
When a product is purchased |
Triggers when a product is purchased. Supported Product Types: Course, Event (Sessions are included), Exam, Fund, Membership, Merchandise and Publication. |
When a purchase is canceled |
Triggers when a purchase is canceled. Supported Product Types: Course, Event (Sessions are included), Exam, Fund, Membership, Merchandise, Publication. |
When a purchase is paid |
Triggers when a product is fully paid. |
When an event registration is substituted |
Triggers when an event registration is substituted. |
When an individual is created |
Triggers when an individual is created. |
When an individual is deleted |
Triggers when an individual is deleted. |
When an individual requests to be forgotten |
Triggers when an individual right-to-be-forgotten request is processed. |
Triggers when an individual is added, deleted or updated to/from a commiteee.
Returns
Committee Member Payload.
Triggers when a customer address is added/edited or deleted.
Returns
Triggers when a customer custom field value is added/edited or deleted.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
filters
|
filters | True | array of string |
Filters. |
Returns
Triggers when a customer relationship is added/edited or deleted.
Returns
Triggers when a customer request is added or closed.
Returns
Customer Request Payload.
Triggers when a product is purchased. Supported Product Types: Course, Event (Sessions are included), Exam, Fund, Membership, Merchandise and Publication.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
filters
|
filters | True | array of string |
Filters. |
Returns
Triggers when a purchase is canceled. Supported Product Types: Course, Event (Sessions are included), Exam, Fund, Membership, Merchandise, Publication.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
filters
|
filters | True | array of string |
Filters. |
Returns
Purchase Canceled Payload.
Triggers when a product is fully paid.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
filters
|
filters | True | array of string |
Filters. |
Returns
Triggers when an event registration is substituted.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
filters
|
filters | True | array of string |
Filters. |
Returns
Triggers when an individual right-to-be-forgotten request is processed.
Returns
Name | Path | Type | Description |
---|---|---|---|
Created On
|
createdOn | string |
Created On |
Created By Email Address
|
createdByEmailAddress | string |
Created By Email Address |
Currency
|
currency | string |
Currency |
Record Number
|
customer.recordNumber | string |
Customer - Record Number |
Type
|
customer.type | string |
Customer - Type |
First Name
|
customer.firstName | string |
Customer - First Name |
Last Name
|
customer.lastName | string |
Customer - Last Name |
Name
|
customer.name | string |
Organization - Name |
Primary Email Address
|
customer.primaryEmailAddress | string |
Customer - Primary Email Address |
lineItems
|
lineItems | array of object |
Line Items |
Product ID
|
lineItems.productId | string |
Line Item - Product ID |
Name
|
lineItems.name | string |
Line Item - Name |
Code
|
lineItems.code | string |
Line Item - Code |
Type
|
lineItems.type | string |
Line Item - Type |
Price
|
lineItems.price | float |
Line Item - Price |
Quantity
|
lineItems.quantity | number |
Line Item - Quantity |
Line Price
|
lineItems.linePrice | float |
Line Item - Line Price |
Line Sub Total
|
lineItems.lineSubTotal | float |
Line Item - Line Sub Total |
Price Code
|
lineItems.priceCode | string |
Line Item - Price Code |
Amount Override
|
lineItems.amountOverride | boolean |
Line Item - Amount Override |
Image Url
|
lineItems.imageUrl | string |
Line Item - Image Url |
Product Purchase Url
|
lineItems.productPurchaseUrl | string |
Line Item - Product Purchase Url |
Badge Name
|
lineItems.registrationInfo.badgeName | string |
Registration Info - Badge Name |
Badge Organization
|
lineItems.registrationInfo.badgeOrganization | string |
Registration Info - Badge Organization |
Badge Title
|
lineItems.registrationInfo.badgeTitle | string |
Registration Info - Badge Title |
Badge City
|
lineItems.registrationInfo.badgeCity | string |
Registration Info - Badge City |
Badge State
|
lineItems.registrationInfo.badgeState | string |
Registration Info - Badge State |
Is Group Registration
|
lineItems.registrationInfo.isGroupRegistration | boolean |
Registration Info - Is Group Registration |
Is Waitlisted
|
lineItems.registrationInfo.isWaitlisted | boolean |
Registration Info - Is Waitlisted |
Guest First Name
|
lineItems.registrationInfo.guestInfo.guestFirstName | string |
Guest Info - Guest First Name |
Guest Last Name
|
lineItems.registrationInfo.guestInfo.guestLastName | string |
Guest Info - Guest Last Name |
Guest Email Address
|
lineItems.registrationInfo.guestInfo.guestEmailAddress | string |
Guest Info - Guest Email Address |
discounts
|
lineItems.discounts | array of object |
Discounts |
Code
|
lineItems.discounts.code | string |
Discount - Code |
Amount
|
lineItems.discounts.amount | float |
Discount - Amount |
Type
|
lineItems.discounts.type | string |
Discount - Type |
relatedProducts
|
lineItems.relatedProducts | array of object |
Related Products |
Product ID
|
lineItems.relatedProducts.productId | string |
Line Item - Product ID |
Name
|
lineItems.relatedProducts.name | string |
Line Item - Name |
Code
|
lineItems.relatedProducts.code | string |
Line Item - Code |
Type
|
lineItems.relatedProducts.type | string |
Line Item - Type |
Price
|
lineItems.relatedProducts.price | float |
Line Item - Price |
Quantity
|
lineItems.relatedProducts.quantity | number |
Line Item - Quantity |
Line Price
|
lineItems.relatedProducts.linePrice | float |
Line Item - Line Price |
Line Sub Total
|
lineItems.relatedProducts.lineSubTotal | float |
Line Item - Line Sub Total |
Price Code
|
lineItems.relatedProducts.priceCode | string |
Line Item - Price Code |
Amount Override
|
lineItems.relatedProducts.amountOverride | boolean |
Line Item - Amount Override |
Image Url
|
lineItems.relatedProducts.imageUrl | string |
Line Item - Image Url |
Product Purchase Url
|
lineItems.relatedProducts.productPurchaseUrl | string |
Line Item - Product Purchase Url |
Badge Name
|
lineItems.relatedProducts.registrationInfo.badgeName | string |
Registration Info - Badge Name |
Badge Organization
|
lineItems.relatedProducts.registrationInfo.badgeOrganization | string |
Registration Info - Badge Organization |
Badge Title
|
lineItems.relatedProducts.registrationInfo.badgeTitle | string |
Registration Info - Badge Title |
Badge City
|
lineItems.relatedProducts.registrationInfo.badgeCity | string |
Registration Info - Badge City |
Badge State
|
lineItems.relatedProducts.registrationInfo.badgeState | string |
Registration Info - Badge State |
Is Group Registration
|
lineItems.relatedProducts.registrationInfo.isGroupRegistration | boolean |
Registration Info - Is Group Registration |
Is Waitlisted
|
lineItems.relatedProducts.registrationInfo.isWaitlisted | boolean |
Registration Info - Is Waitlisted |
Guest First Name
|
lineItems.relatedProducts.registrationInfo.guestInfo.guestFirstName | string |
Guest Info - Guest First Name |
Guest Last Name
|
lineItems.relatedProducts.registrationInfo.guestInfo.guestLastName | string |
Guest Info - Guest Last Name |
Guest Email Address
|
lineItems.relatedProducts.registrationInfo.guestInfo.guestEmailAddress | string |
Guest Info - Guest Email Address |
discounts
|
lineItems.relatedProducts.discounts | array of object |
Discounts |
Code
|
lineItems.relatedProducts.discounts.code | string |
Discount - Code |
Amount
|
lineItems.relatedProducts.discounts.amount | float |
Discount - Amount |
Type
|
lineItems.relatedProducts.discounts.type | string |
Discount - Type |
relatedProducts
|
lineItems.relatedProducts.relatedProducts | array of object |
Related Products |
Product ID
|
lineItems.relatedProducts.relatedProducts.productId | string |
Line Item - Product ID |
Name
|
lineItems.relatedProducts.relatedProducts.name | string |
Line Item - Name |
Code
|
lineItems.relatedProducts.relatedProducts.code | string |
Line Item - Code |
Type
|
lineItems.relatedProducts.relatedProducts.type | string |
Line Item - Type |
Price
|
lineItems.relatedProducts.relatedProducts.price | float |
Line Item - Price |
Quantity
|
lineItems.relatedProducts.relatedProducts.quantity | number |
Line Item - Quantity |
Line Price
|
lineItems.relatedProducts.relatedProducts.linePrice | float |
Line Item - Line Price |
Line Sub Total
|
lineItems.relatedProducts.relatedProducts.lineSubTotal | float |
Line Item - Line Sub Total |
Price Code
|
lineItems.relatedProducts.relatedProducts.priceCode | string |
Line Item - Price Code |
Amount Override
|
lineItems.relatedProducts.relatedProducts.amountOverride | boolean |
Line Item - Amount Override |
Image Url
|
lineItems.relatedProducts.relatedProducts.imageUrl | string |
Line Item - Image Url |
Product Purchase Url
|
lineItems.relatedProducts.relatedProducts.productPurchaseUrl | string |
Line Item - Product Purchase Url |
Badge Name
|
lineItems.relatedProducts.relatedProducts.registrationInfo.badgeName | string |
Registration Info - Badge Name |
Badge Organization
|
lineItems.relatedProducts.relatedProducts.registrationInfo.badgeOrganization | string |
Registration Info - Badge Organization |
Badge Title
|
lineItems.relatedProducts.relatedProducts.registrationInfo.badgeTitle | string |
Registration Info - Badge Title |
Badge City
|
lineItems.relatedProducts.relatedProducts.registrationInfo.badgeCity | string |
Registration Info - Badge City |
Badge State
|
lineItems.relatedProducts.relatedProducts.registrationInfo.badgeState | string |
Registration Info - Badge State |
Is Group Registration
|
lineItems.relatedProducts.relatedProducts.registrationInfo.isGroupRegistration | boolean |
Registration Info - Is Group Registration |
Is Waitlisted
|
lineItems.relatedProducts.relatedProducts.registrationInfo.isWaitlisted | boolean |
Registration Info - Is Waitlisted |
Guest First Name
|
lineItems.relatedProducts.relatedProducts.registrationInfo.guestInfo.guestFirstName | string |
Guest Info - Guest First Name |
Guest Last Name
|
lineItems.relatedProducts.relatedProducts.registrationInfo.guestInfo.guestLastName | string |
Guest Info - Guest Last Name |
Guest Email Address
|
lineItems.relatedProducts.relatedProducts.registrationInfo.guestInfo.guestEmailAddress | string |
Guest Info - Guest Email Address |
discounts
|
lineItems.relatedProducts.relatedProducts.discounts | array of object |
Discounts |
Code
|
lineItems.relatedProducts.relatedProducts.discounts.code | string |
Discount - Code |
Amount
|
lineItems.relatedProducts.relatedProducts.discounts.amount | float |
Discount - Amount |
Type
|
lineItems.relatedProducts.relatedProducts.discounts.type | string |
Discount - Type |
Name | Path | Type | Description |
---|---|---|---|
Name
|
organization.name | string |
Organization - Name |
Acronym
|
organization.acronym | string |
Organization - Acronym |
Branch Name
|
organization.branchName | string |
Organization - Branch Name |
Annual Sales
|
organization.annualSales | float |
Organization - Annual Sales |
Employee Range ID
|
organization.employeeRangeId | string |
Organization - Employee Range ID |
ID
|
organization.id | string |
Organization - ID |
Customer Type
|
organization.customerType | string |
Organization - Customer Type |
Record Number
|
organization.recordNumber | string |
Organization - Record Number |
Show In Directory
|
organization.showInDirectory | boolean |
Organization - Show In Directory |
addresses
|
organization.addresses | array of object |
Addresses. |
Address Id
|
organization.addresses.id | uuid |
Organization - Addresses - Id. |
Is Primary Address
|
organization.addresses.primary | boolean |
Organization - Addresses - Is Primary. |
Address Line 1
|
organization.addresses.line1 | string |
Organization - Addresses - Line 1. |
Address Line 2
|
organization.addresses.line2 | string |
Organization - Addresses - Line 2. |
Address Line 3
|
organization.addresses.line3 | string |
Organization - Addresses - Line 3. |
City
|
organization.addresses.city | string |
Organization - Addresses - City. |
State
|
organization.addresses.state | string |
Organization - Addresses - State. |
Zip Code
|
organization.addresses.zipcode | string |
Organization - Addresses - Zip Code. |
Country
|
organization.addresses.country | string |
Organization - Addresses - Country. |
State Abbreviation
|
organization.addresses.stateAbbreviation | string |
Organization - Addresses - State Abbreviation. |
State ISO Code
|
organization.addresses.stateISOCode | string |
Organization - Addresses - State ISO Code. |
Type
|
organization.addresses.type | string |
Organization - Addresses - Type. |
Region
|
organization.addresses.region | string |
Organization - Addresses - Region. |
Latitude
|
organization.addresses.latitude | number |
Organization - Addresses - Latitude. |
Longitude
|
organization.addresses.longitude | number |
Organization - Addresses - Longitude. |
Show In Directory
|
organization.addresses.showInDirectory | boolean |
Organization - Addresses - Show In Directory. |
Congressional District
|
organization.addresses.congressionalDistrict | string |
Organization - Addresses - Congressional District. |
Country Id
|
organization.addresses.countryData.id | uuid |
Organization - Addresses - Country - Id. |
Country Name
|
organization.addresses.countryData.name | string |
Organization - Addresses - Country - Name. |
Two Letter ISO Code
|
organization.addresses.countryData.twoLetterIsoCode | string |
Organization - Addresses - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
organization.addresses.countryData.threeLetterIsoCode | string |
Organization - Addresses - Country - Three Letter ISO Code. |
Country Code
|
organization.addresses.countryData.code | integer |
Organization - Addresses - Country - Code. |
emails
|
organization.emails | array of object |
Emails. |
Is Primary Email
|
organization.emails.primary | boolean |
Organization - Emails - Is Primary. |
Address
|
organization.emails.address | string |
Organization - Emails - Address. |
Type
|
organization.emails.type | string |
Organization - Emails - Type. |
Show In Directory
|
organization.emails.showInDirectory | boolean |
Organization - Emails - Show In Directory. |
phones
|
organization.phones | array of object |
Phones. |
Phone Id
|
organization.phones.id | string |
Organization - Phones - Id. |
Is Primary Phone
|
organization.phones.primary | boolean |
Organization - Phones - Is Primary. |
Type
|
organization.phones.type | integer |
Organization - Phones - Type. |
Country Id
|
organization.phones.country.id | string |
Organization - Phones - Country - Id. |
Country Name
|
organization.phones.country.name | string |
Organization - Phones - Country - Name. |
Two Letter ISO Code
|
organization.phones.country.twoLetterIsoCode | string |
Organization - Phones - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
organization.phones.country.threeLetterIsoCode | string |
Organization - Phones - Country - Three Letter ISO Code. |
Country Code
|
organization.phones.country.code | integer |
Organization - Phones - Country - Code. |
Show In Directory
|
organization.phones.showInDirectory | boolean |
Organization - Phones - Show In Directory. |
Number
|
organization.phones.number | string |
Organization - Phones - Number. |
Extension
|
organization.phones.extension | string |
Organization - Phones - Extension. |
Type Name
|
organization.phones.typeName | string |
Organization - Phones - Type Name. |
booths
|
booths | array of object |
Booths |
Organization Display Name
|
booths.organizationDisplayName | string |
Booths - Organization Display Name. |
Number
|
booths.number | integer |
Booths - Number. |
Short Description
|
booths.shortDescription | string |
Booths - Short Description. |
Description
|
booths.description | string |
Booths - Description. |
Code
|
booths.hall.code | string |
Booths - Hall - Code. |
Name
|
booths.hall.name | string |
Booths - Hall - Name. |
Description
|
booths.hall.description | string |
Booths - Hall - Description. |
Name | Path | Type | Description |
---|---|---|---|
Exam Start Date
|
examStartDate | date-time |
Exam Start Date |
Exam End Date
|
examEndDate | date-time |
Exam End Date |
Exam Number
|
examNumber | string |
Exam Number |
educationCredits
|
educationCredits | array of object |
Education Credits |
code
|
educationCredits.code | string |
Education Credits - Code |
name
|
educationCredits.name | string |
Education Credits - Name |
shortDescription
|
educationCredits.shortDescription | string |
Education Credits - Short Description |
credits
|
educationCredits.credits | float |
Education Credits - Credits |
categories
|
categories | array of object |
categories |
subCategories
|
categories.subCategories | array of object |
subCategories |
Subcategories
|
categories.subCategories.subCategories | string |
Categories - Subcategories - Subcategories. |
Code
|
categories.subCategories.code | string |
Categories - Subcategories - Code. |
Name
|
categories.subCategories.name | string |
Categories - Subcategories - Name. |
Is Primary
|
categories.subCategories.isPrimary | boolean |
Categories - Subcategories - Is Primary. |
code
|
categories.code | string |
Categories - Code |
name
|
categories.name | string |
Categories - Name |
isPrimary
|
categories.isPrimary | boolean |
Categories - Is Primary |
activePrices
|
activePrices | array of object |
Active Prices |
ID
|
activePrices.id | string |
Active Prices - ID. |
Code
|
activePrices.code | string |
Active Prices - Code. |
Name
|
activePrices.name | string |
Active Prices - Name. |
Start Date
|
activePrices.startDate | date-time |
Active Prices - Start Date. |
End Date
|
activePrices.endDate | date-time |
Active Prices - End Date. |
Amount
|
activePrices.amount | float |
Active Prices - Amount. |
Has Formula
|
activePrices.hasFormula | boolean |
Active Prices - Has Formula. |
Created On
|
activePrices.createdOn | string |
Active Prices - Created On. |
Modified On
|
activePrices.modifiedOn | string |
Active Prices - Modified On. |
relatedProducts
|
relatedProducts | array of object |
Related Products |
Is Required
|
relatedProducts.isRequired | boolean |
Related Products - Is Required. |
ID
|
relatedProducts.id | string |
Related Products - ID. |
Code
|
relatedProducts.code | string |
Related Products - Code. |
Name
|
relatedProducts.name | string |
Related Products - Name. |
Short Description
|
relatedProducts.shortDescription | string |
Related Products - Short Description. |
Long Description
|
relatedProducts.longDescription | string |
Related Products - Long Description |
Type
|
relatedProducts.type | string |
Related Products - Type. |
Url
|
relatedProducts.url | string |
Related Products - Url. |
Image Url
|
relatedProducts.imageUrl | array of string |
Related Products - Image Url |
Is Public
|
relatedProducts.isPublic | boolean |
Related Products - Is Public. |
Available From
|
relatedProducts.availableFrom | string |
Related Products - Available From. |
Available Until
|
relatedProducts.availableUntil | string |
Related Products - Available Until. |
Tags
|
tags | array of string |
Tags. |
ID
|
id | string |
ID. |
Code
|
code | string |
Code. |
Name
|
name | string |
Name. |
Short Description
|
shortDescription | string |
Short Description. |
Long Description
|
longDescription | string |
Long Description. |
Type
|
type | string |
Type. |
Url
|
url | string |
Url. |
Image Url
|
imageUrl | array of string |
Image Url. |
Is Public
|
isPublic | boolean |
Is Public. |
Available From
|
availableFrom | string |
Available From. |
Available Until
|
availableUntil | string |
Available Until. |
Name | Path | Type | Description |
---|---|---|---|
Title
|
title | string |
Title. |
Badge Name
|
badgeName | string |
Badge Name |
Badge Organization
|
badgeOrganization | string |
Badge Organization. |
Badge City
|
badgeCity | string |
Badge City. |
Badge State
|
badgeState | string |
Badge State. |
Attended Date
|
attendedDate | date-time |
Attended Date. |
sessions
|
sessions | array of object | |
ID
|
sessions.id | string |
Sessions - ID. |
Code
|
sessions.code | string |
Sessions - Code. |
Name
|
sessions.name | string |
Sessions - Name. |
Start Date
|
sessions.startDate | date-time |
Sessions - Start Date. |
Start Time
|
sessions.startTime | string |
Sessions - Start Time. |
End Date
|
sessions.endDate | date-time |
Sessions - End Date. |
End Time
|
sessions.endTime | string |
Sessions - End Time. |
Timezone
|
sessions.timezone | string |
Sessions - Timezone. |
Description
|
sessions.description | string |
Sessions - Description. |
Is Public
|
sessions.IsPublic | boolean |
Sessions - Is Public. |
Room
|
sessions.Room | string |
Sessions - Room. |
External Code
|
sessions.externalCode | string |
Sessions - External Code. |
categories
|
sessions.categories | array of object |
Sessions - Categories |
Code
|
sessions.categories.code | string |
Sessions - Categories - Code. |
Name
|
sessions.categories.name | string |
Sessions - Categories - Name. |
Is Primary
|
sessions.categories.IsPrimary | string |
Sessions - Categories - Is Primary. |
subCategories
|
sessions.categories.subCategories | array of object |
Sessions - Categories - Subcategories |
Code
|
sessions.categories.subCategories.code | string |
Sessions - Categories - Subcategories - Code. |
Name
|
sessions.categories.subCategories.name | string |
Sessions - Categories - Subcategories - Name. |
Is Primary
|
sessions.categories.subCategories.IsPrimary | string |
Sessions - Categories - Subcategories - Is Primary. |
itemizedCustomFields
|
itemizedCustomFields | array of object |
Itemized Custom Fields |
Name
|
itemizedCustomFields.name | string |
Itemized Custom Fields - Name. |
Caption
|
itemizedCustomFields.caption | string |
Itemized Custom Fields - Caption. |
Value
|
itemizedCustomFields.value | string |
Itemized Custom Fields - Value. |
Guest Of Record Number
|
guestOfRecordNumber | string |
Guest Of Record Number. |
Registrant Type Code
|
registrantTypeCode | string |
Registrant Type Code. |
Registrant Type Name
|
registrantTypeName | string |
Registrant Type Name. |
Registration Number
|
registrationNumber | string |
Registration Number. |
boughtTogetherWith
|
boughtTogetherWith | array of object | |
Order Number
|
boughtTogetherWith.orderNumber | string |
Bought Together With - Order Number. |
Product Code
|
boughtTogetherWith.productCode | string |
Bought Together With - Product Code. |
Product Name
|
boughtTogetherWith.productName | string |
Bought Together With - Product Name. |
Product Type
|
boughtTogetherWith.productType | string |
Bought Together With - Product Type. |
Purchase Date
|
boughtTogetherWith.purchaseDate | date-time |
Bought Together With - Purchase Date. |
Additional Info
|
boughtTogetherWith.additionalInfo | string |
Bought Together With - Additional Info. |
Quantity
|
boughtTogetherWith.quantity | integer |
Bought Together With - Quantity. |
itemizedCustomFields
|
boughtTogetherWith.itemizedCustomFields | array of object | |
Name
|
boughtTogetherWith.itemizedCustomFields.name | string |
Bought Together With - Itemized Custom Fields - Name. |
Caption
|
boughtTogetherWith.itemizedCustomFields.caption | string |
Bought Together With - Itemized Custom Fields - Caption. |
Value
|
boughtTogetherWith.itemizedCustomFields.value | string |
Bought Together With - Itemized Custom Fields - Value. |
productCategories
|
boughtTogetherWith.productCategories | array of object | |
Code
|
boughtTogetherWith.productCategories.code | string |
Bought Together With - Product Categories - Code. |
Name
|
boughtTogetherWith.productCategories.name | string |
Bought Together With - Product Categories - Name. |
Is Primary
|
boughtTogetherWith.productCategories.IsPrimary | boolean |
Bought Together With - Product Categories - Is Primary. |
Subcategories
|
boughtTogetherWith.productCategories.subCategories | array of object |
Bought Together With - Product Categories - Subcategories. |
Subcategories
|
boughtTogetherWith.productCategories.subCategories.subCategories | string |
Bought Together With - Product categories - Subcategories - Subcategories. |
Code
|
boughtTogetherWith.productCategories.subCategories.code | string |
Bought Together With - Product categories - Subcategories - Code. |
Name
|
boughtTogetherWith.productCategories.subCategories.name | string |
Bought Together With - Product categories - Subcategories - Name. |
Is Primary
|
boughtTogetherWith.productCategories.subCategories.isPrimary | boolean |
Bought Together With - Product categories - Subcategories - Is Primary. |
First Name
|
firstName | string |
First Name. |
Last Name
|
lastName | string |
Last Name. |
Middle Name
|
middleName | string |
Middle Name. |
Preferred First Name
|
preferredFirstName | string |
Preferred First Name. |
Second Last Name
|
secondLastName | string |
Second Last Name. |
Prefix
|
prefix | string |
Prefix. |
Suffix
|
suffix | string |
Suffix. |
Gender
|
gender | string |
Gender. |
Contact Ids
|
primaryOrganization.contactIds | array of uuid |
Primary Organization - Contact Ids. |
Parent Company Id
|
primaryOrganization.parentCompanyId | string |
Primary Organization - Parent Company Id. |
Description
|
primaryOrganization.description | string |
Primary Organization - Description. |
Branch Name
|
primaryOrganization.branchName | string |
Primary Organization - Branch Name. |
Tags
|
primaryOrganization.tags | array of string |
Primary Organization - Tags. |
Primary Organization Id
|
primaryOrganization.id | string |
Primary Organization - Id. |
Customer Type
|
primaryOrganization.customerType | string |
Primary Organization - Customer Type. |
Record Number
|
primaryOrganization.recordNumber | string |
Primary Organization - Record Number. |
Title
|
primaryOrganization.title | string |
Primary Organization - Title. |
Name
|
primaryOrganization.name | string |
Primary Organization - Name. |
addresses
|
primaryOrganization.addresses | array of object | |
Address Id
|
primaryOrganization.addresses.id | string |
Primary Organization - Addresses - Address Id. |
Is Primary Address
|
primaryOrganization.addresses.primary | boolean |
Primary Organization - Addresses - Is Primary. |
Address Line 1
|
primaryOrganization.addresses.line1 | string |
Primary Organization - Addresses - Line 1. |
Address Line 2
|
primaryOrganization.addresses.line2 | string |
Primary Organization - Addresses - Line 2. |
Address Line 3
|
primaryOrganization.addresses.line3 | string |
Primary Organization - Addresses - Line 3. |
City
|
primaryOrganization.addresses.city | string |
Primary Organization - Addresses - City. |
State
|
primaryOrganization.addresses.state | string |
Primary Organization - Addresses - State. |
Zip Code
|
primaryOrganization.addresses.zipcode | string |
Primary Organization - Addresses - Zip Code. |
Country
|
primaryOrganization.addresses.country | string |
Primary Organization - Addresses - Country. |
State Abbreviation
|
primaryOrganization.addresses.stateAbbreviation | string |
Primary Organization - Addresses - State Abbreviation. |
State ISO Code
|
primaryOrganization.addresses.stateISOCode | string |
Primary Organization - Addresses - State ISO Code. |
Type
|
primaryOrganization.addresses.type | string |
Primary Organization - Addresses - Type. |
Region
|
primaryOrganization.addresses.region | string |
Primary Organization - Addresses - Region. |
Latitude
|
primaryOrganization.addresses.latitude | number |
Primary Organization - Addresses - Latitude. |
Longitude
|
primaryOrganization.addresses.longitude | number |
Primary Organization - Addresses - Longitude. |
Show In Directory
|
primaryOrganization.addresses.showInDirectory | boolean |
Primary Organization - Addresses - Show In Directory. |
Congressional District
|
primaryOrganization.addresses.congressionalDistrict | string |
Primary Organization - Addresses - Congressional District. |
Country Id
|
primaryOrganization.addresses.countryData.id | string |
Primary Organization - Addresses - Country - Country Id. |
Country Name
|
primaryOrganization.addresses.countryData.name | string |
Primary Organization - Addresses - Country - Country Name. |
Two Letter ISO Code
|
primaryOrganization.addresses.countryData.twoLetterIsoCode | string |
Primary Organization - Addresses - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
primaryOrganization.addresses.countryData.threeLetterIsoCode | string |
Primary Organization - Addresses - Country - Three Letter ISO Code. |
Country Code
|
primaryOrganization.addresses.countryData.code | integer |
Primary Organization - Addresses - Country - Country Code. |
Email
|
primaryOrganization.email | string |
Primary Organization - Email. |
Image URI
|
primaryOrganization.imageUri | string |
Primary Organization - Image URI. |
Twitter
|
primaryOrganization.twitter | string |
Primary Organization - Twitter. |
LinkedIn
|
primaryOrganization.linkedIn | string |
Primary Organization - LinkedIn. |
emails
|
primaryOrganization.emails | array of object | |
Is Primary Email
|
primaryOrganization.emails.primary | boolean |
Primary Organization - Emails - Is Primary. |
Address
|
primaryOrganization.emails.address | string |
Primary Organization - Emails - Address. |
Type
|
primaryOrganization.emails.type | string |
Primary Organization - Emails - Type. |
Show In Directory
|
primaryOrganization.emails.showInDirectory | boolean |
Primary Organization - Emails - Show In Directory. |
phones
|
primaryOrganization.phones | array of object | |
Phone Id
|
primaryOrganization.phones.id | string |
Primary Organization - Phones - Id. |
Is Primary Phone
|
primaryOrganization.phones.primary | boolean |
Primary Organization - Phones - Is Primary. |
Type
|
primaryOrganization.phones.type | integer |
Primary Organization - Phones - Type. |
Country Id
|
primaryOrganization.phones.country.id | string |
Primary Organization - Phones - Country - Country Id. |
Country Name
|
primaryOrganization.phones.country.name | string |
Primary Organization - Phones - Country - Country Name. |
Two Letter ISO Code
|
primaryOrganization.phones.country.twoLetterIsoCode | string |
Primary Organization - Phones - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
primaryOrganization.phones.country.threeLetterIsoCode | string |
Primary Organization - Phones - Country - Three Letter ISO Code. |
Country Code
|
primaryOrganization.phones.country.code | integer |
Primary Organization - Phones - Country - Country Code. |
Show In Directory
|
primaryOrganization.phones.showInDirectory | boolean |
Primary Organization - Phones - Show In Directory. |
Number
|
primaryOrganization.phones.number | string |
Primary Organization - Phones - Number. |
Extension
|
primaryOrganization.phones.extension | string |
Primary Organization - Phones - Extension. |
Type Name
|
primaryOrganization.phones.typeName | string |
Primary Organization - Phones - Type Name. |
Website
|
primaryOrganization.webSite | string |
Primary Organization - Website. |
memberships
|
primaryOrganization.memberships | array of object | |
Membership Type
|
primaryOrganization.memberships.membershipType | string |
Primary Organization - Memberships - Membership Type. |
Membership Type Id
|
primaryOrganization.memberships.membershipTypeId | string |
Primary Organization - Memberships - Membership Type Id. |
Code
|
primaryOrganization.memberships.code | string |
Primary Organization - Memberships - Code. |
Expire Date
|
primaryOrganization.memberships.expireDate | date-time |
Primary Organization - Memberships - Expire Date. |
Grace Expire Date
|
primaryOrganization.memberships.graceExpireDate | date-time |
Primary Organization - Memberships - Grace Expire Date. |
Inherited Membership Benefits
|
primaryOrganization.memberships.inheritedMembershipBenefits | boolean |
Primary Organization - Memberships - Inherited Membership Benefits. |
Renewal URL
|
primaryOrganization.memberships.renewalUrl | string |
Primary Organization - Memberships - Renewal URL. |
Join Date
|
primaryOrganization.memberships.joinDate | date-time |
Primary Organization - Memberships - Join Date. |
Terminate Date
|
primaryOrganization.memberships.terminateDate | date-time |
Primary Organization - Memberships - Terminate Date. |
Effective Date
|
primaryOrganization.memberships.effectiveDate | date-time |
Primary Organization - Memberships - Effective Date. |
Category
|
primaryOrganization.category | string |
Primary Organization - Category. |
categories
|
primaryOrganization.categories | array of object | |
subCategories
|
primaryOrganization.categories.subCategories | array of object |
Primary Organization - Categories - Subcategories. |
Code
|
primaryOrganization.categories.subCategories.code | string |
Primary Organization - Categories - Subcategories - Code. |
Name
|
primaryOrganization.categories.subCategories.name | string |
Primary Organization - Categories - Subcategories - Name. |
Code
|
primaryOrganization.categories.code | string |
Primary Organization - Categories - Code. |
Name
|
primaryOrganization.categories.name | string |
Primary Organization - Categories - Name. |
customFields
|
primaryOrganization.customFields | array of object | |
Name
|
primaryOrganization.customFields.name | string |
Primary Organization - Custom Fields - Name. |
Caption
|
primaryOrganization.customFields.caption | string |
Primary Organization - Custom Fields - Caption. |
Value
|
primaryOrganization.customFields.value | string |
Primary Organization - Custom Fields - Value. |
Show In Directory
|
primaryOrganization.showInDirectory | boolean |
Primary Organization - Show In Directory. |
links
|
primaryOrganization.links | array of object | |
Type
|
primaryOrganization.links.type | string |
Primary Organization - Links - Type. |
URL
|
primaryOrganization.links.url | string |
Primary Organization - Links - URL. |
Old Id
|
primaryOrganization.oldId | string |
Primary Organization - Old Id. |
ID
|
id | string |
ID. |
Customer Type
|
customerType | string |
Customer Type |
Record Number
|
recordNumber | string |
Record Number. |
Show In Directory
|
showInDirectory | boolean |
Show In Directory. |
addresses
|
addresses | array of object | |
Address Id
|
addresses.id | string |
Addresses - Address Id. |
Is Primary Address
|
addresses.primary | boolean |
Addresses - Is Primary. |
Address Line 1
|
addresses.line1 | string |
Addresses - Line 1. |
Address Line 2
|
addresses.line2 | string |
Addresses - Line 2. |
Address Line 3
|
addresses.line3 | string |
Addresses - Line 3. |
City
|
addresses.city | string |
Addresses - City. |
State
|
addresses.state | string |
Addresses - State. |
Zip Code
|
addresses.zipcode | string |
Addresses - Zip Code. |
Country
|
addresses.country | string |
Addresses - Country. |
State Abbreviation
|
addresses.stateAbbreviation | string |
Addresses - State Abbreviation. |
State ISO Code
|
addresses.stateISOCode | string |
Addresses - State ISO Code. |
Type
|
addresses.type | string |
Addresses - Type. |
Region
|
addresses.region | string |
Addresses - Region. |
Latitude
|
addresses.latitude | number |
Addresses - Latitude. |
Longitude
|
addresses.longitude | number |
Addresses - Longitude. |
Show In Directory
|
addresses.showInDirectory | boolean |
Addresses - Show In Directory. |
Congressional District
|
addresses.congressionalDistrict | string |
Addresses - Congressional District. |
Country Id
|
addresses.countryData.id | string |
Addresses - Country - Country Id. |
Country Name
|
addresses.countryData.name | string |
Addresses - Country - Country Name. |
Two Letter ISO Code
|
addresses.countryData.twoLetterIsoCode | string |
Addresses - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
addresses.countryData.threeLetterIsoCode | string |
Addresses - Country - Three Letter ISO Code. |
Country Code
|
addresses.countryData.code | integer |
Addresses - Country - Country Code. |
phones
|
phones | array of object | |
Phone Id
|
phones.id | string |
Phones - Id. |
Is Primary Phone
|
phones.primary | boolean |
Phones - Is Primary. |
Type
|
phones.type | integer |
Phones - Type. |
Country Id
|
phones.country.id | string |
Phones - Country - Country Id. |
Country Name
|
phones.country.name | string |
Phones - Country - Country Name. |
Two Letter ISO Code
|
phones.country.twoLetterIsoCode | string |
Phones - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
phones.country.threeLetterIsoCode | string |
Phones - Country - Three Letter ISO Code. |
Country Code
|
phones.country.code | integer |
Phones - Country - Country Code. |
Show In Directory
|
phones.showInDirectory | boolean |
Phones - Show In Directory. |
Number
|
phones.number | string |
Phones - Number. |
Extension
|
phones.extension | string |
Phones - Extension. |
Type Name
|
phones.typeName | string |
Phones - Type Name. |
emails
|
emails | array of object | |
Is Primary Email
|
emails.primary | boolean |
Emails - Is Primary. |
Address
|
emails.address | string |
Emails - Address. |
Type
|
emails.type | string |
Emails - Type. |
Show In Directory
|
emails.showInDirectory | boolean |
Emails - Show In Directory. |
Name | Path | Type | Description |
---|---|---|---|
Title
|
title | string |
Title. |
Registered Date
|
registeredDate | date-time |
Registered Date. |
Attended Date
|
attendedDate | date-time |
Attended Date. |
itemizedCustomFields
|
itemizedCustomFields | array of object |
Itemized Custom Fields |
Name
|
itemizedCustomFields.name | string |
Itemized Custom Fields - Name. |
Caption
|
itemizedCustomFields.caption | string |
Itemized Custom Fields - Caption. |
Value
|
itemizedCustomFields.value | string |
Itemized Custom Fields - Value. |
First Name
|
firstName | string |
First Name. |
Last Name
|
lastName | string |
Last Name. |
Middle Name
|
middleName | string |
Middle Name. |
Preferred First Name
|
preferredFirstName | string |
Preferred First Name. |
Second Last Name
|
secondLastName | string |
Second Last Name. |
Prefix
|
prefix | string |
Prefix. |
Suffix
|
suffix | string |
Suffix |
Gender
|
gender | string |
Gender. |
Contact Ids
|
primaryOrganization.contactIds | array of uuid |
Primary Organization - Contact Ids. |
Parent Company Id
|
primaryOrganization.parentCompanyId | string |
Primary Organization - Parent Company Id. |
Description
|
primaryOrganization.description | string |
Primary Organization - Description. |
Branch Name
|
primaryOrganization.branchName | string |
Primary Organization - Branch Name. |
Tags
|
primaryOrganization.tags | array of string |
Primary Organization - Tags. |
Primary Organization Id
|
primaryOrganization.id | string |
Primary Organization - Id. |
Customer Type
|
primaryOrganization.customerType | string |
Primary Organization - Customer Type. |
Record Number
|
primaryOrganization.recordNumber | string |
Primary Organization - Record Number. |
Title
|
primaryOrganization.title | string |
Primary Organization - Title. |
Name
|
primaryOrganization.name | string |
Primary Organization - Name. |
addresses
|
primaryOrganization.addresses | array of object | |
Address Id
|
primaryOrganization.addresses.id | string |
Primary Organization - Addresses - Address Id. |
Is Primary Address
|
primaryOrganization.addresses.primary | boolean |
Primary Organization - Addresses - Is Primary. |
Address Line 1
|
primaryOrganization.addresses.line1 | string |
Primary Organization - Addresses - Line 1. |
Address Line 2
|
primaryOrganization.addresses.line2 | string |
Primary Organization - Addresses - Line 2. |
Address Line 3
|
primaryOrganization.addresses.line3 | string |
Primary Organization - Addresses - Line 3. |
City
|
primaryOrganization.addresses.city | string |
Primary Organization - Addresses - City. |
State
|
primaryOrganization.addresses.state | string |
Primary Organization - Addresses - State. |
Zip Code
|
primaryOrganization.addresses.zipcode | string |
Primary Organization - Addresses - Zip Code. |
Country
|
primaryOrganization.addresses.country | string |
Primary Organization - Addresses - Country. |
State Abbreviation
|
primaryOrganization.addresses.stateAbbreviation | string |
Primary Organization - Addresses - State Abbreviation. |
State ISO Code
|
primaryOrganization.addresses.stateISOCode | string |
Primary Organization - Addresses - State ISO Code. |
Type
|
primaryOrganization.addresses.type | string |
Primary Organization - Addresses - Type. |
Region
|
primaryOrganization.addresses.region | string |
Primary Organization - Addresses - Region. |
Latitude
|
primaryOrganization.addresses.latitude | number |
Primary Organization - Addresses - Latitude. |
Longitude
|
primaryOrganization.addresses.longitude | number |
Primary Organization - Addresses - Longitude. |
Show In Directory
|
primaryOrganization.addresses.showInDirectory | boolean |
Primary Organization - Addresses - Show In Directory. |
Congressional District
|
primaryOrganization.addresses.congressionalDistrict | string |
Primary Organization - Addresses - Congressional District. |
Country Id
|
primaryOrganization.addresses.countryData.id | string |
Primary Organization - Addresses - Country - Country Id. |
Country Name
|
primaryOrganization.addresses.countryData.name | string |
Primary Organization - Addresses - Country - Country Name. |
Two Letter ISO Code
|
primaryOrganization.addresses.countryData.twoLetterIsoCode | string |
Primary Organization - Addresses - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
primaryOrganization.addresses.countryData.threeLetterIsoCode | string |
Primary Organization - Addresses - Country - Three Letter ISO Code. |
Country Code
|
primaryOrganization.addresses.countryData.code | integer |
Primary Organization - Addresses - Country - Country Code. |
Email
|
primaryOrganization.email | string |
Primary Organization - Email. |
Image URI
|
primaryOrganization.imageUri | string |
Primary Organization - Image URI. |
Twitter
|
primaryOrganization.twitter | string |
Primary Organization - Twitter. |
LinkedIn
|
primaryOrganization.linkedIn | string |
Primary Organization - LinkedIn. |
emails
|
primaryOrganization.emails | array of object | |
Is Primary Email
|
primaryOrganization.emails.primary | boolean |
Primary Organization - Emails - Is Primary. |
Address
|
primaryOrganization.emails.address | string |
Primary Organization - Emails - Address. |
Type
|
primaryOrganization.emails.type | string |
Primary Organization - Emails - Type. |
Show In Directory
|
primaryOrganization.emails.showInDirectory | boolean |
Primary Organization - Emails - Show In Directory. |
phones
|
primaryOrganization.phones | array of object | |
Phone Id
|
primaryOrganization.phones.id | string |
Primary Organization - Phones - Id. |
Is Primary Phone
|
primaryOrganization.phones.primary | boolean |
Primary Organization - Phones - Is Primary. |
Type
|
primaryOrganization.phones.type | integer |
Primary Organization - Phones - Type. |
Country Id
|
primaryOrganization.phones.country.id | string |
Primary Organization - Phones - Country - Country Id. |
Country Name
|
primaryOrganization.phones.country.name | string |
Primary Organization - Phones - Country - Country Name. |
Two Letter ISO Code
|
primaryOrganization.phones.country.twoLetterIsoCode | string |
Primary Organization - Phones - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
primaryOrganization.phones.country.threeLetterIsoCode | string |
Primary Organization - Phones - Country - Three Letter ISO Code. |
Country Code
|
primaryOrganization.phones.country.code | integer |
Primary Organization - Phones - Country - Country Code. |
Show In Directory
|
primaryOrganization.phones.showInDirectory | boolean |
Primary Organization - Phones - Show In Directory. |
Number
|
primaryOrganization.phones.number | string |
Primary Organization - Phones - Number. |
Extension
|
primaryOrganization.phones.extension | string |
Primary Organization - Phones - Extension. |
Type Name
|
primaryOrganization.phones.typeName | string |
Primary Organization - Phones - Type Name. |
Website
|
primaryOrganization.webSite | string |
Primary Organization - Website. |
memberships
|
primaryOrganization.memberships | array of object | |
Membership Type
|
primaryOrganization.memberships.membershipType | string |
Primary Organization - Memberships - Membership Type. |
Membership Type Id
|
primaryOrganization.memberships.membershipTypeId | string |
Primary Organization - Memberships - Membership Type Id. |
Code
|
primaryOrganization.memberships.code | string |
Primary Organization - Memberships - Code. |
Expire Date
|
primaryOrganization.memberships.expireDate | date-time |
Primary Organization - Memberships - Expire Date. |
Grace Expire Date
|
primaryOrganization.memberships.graceExpireDate | date-time |
Primary Organization - Memberships - Grace Expire Date. |
Inherited Membership Benefits
|
primaryOrganization.memberships.inheritedMembershipBenefits | boolean |
Primary Organization - Memberships - Inherited Membership Benefits. |
Renewal URL
|
primaryOrganization.memberships.renewalUrl | string |
Primary Organization - Memberships - Renewal URL. |
Join Date
|
primaryOrganization.memberships.joinDate | date-time |
Primary Organization - Memberships - Join Date. |
Terminate Date
|
primaryOrganization.memberships.terminateDate | date-time |
Primary Organization - Memberships - Terminate Date. |
Effective Date
|
primaryOrganization.memberships.effectiveDate | date-time |
Primary Organization - Memberships - Effective Date. |
Category
|
primaryOrganization.category | string |
Primary Organization - Category. |
categories
|
primaryOrganization.categories | array of object | |
subCategories
|
primaryOrganization.categories.subCategories | array of object |
Primary Organization - Categories - Subcategories. |
Code
|
primaryOrganization.categories.subCategories.code | string |
Primary Organization - Categories - Subcategories - Code. |
Name
|
primaryOrganization.categories.subCategories.name | string |
Primary Organization - Categories - Subcategories - Name. |
Code
|
primaryOrganization.categories.code | string |
Primary Organization - Categories - Code. |
Name
|
primaryOrganization.categories.name | string |
Primary Organization - Categories - Name. |
customFields
|
primaryOrganization.customFields | array of object | |
Name
|
primaryOrganization.customFields.name | string |
Primary Organization - Custom Fields - Name. |
Caption
|
primaryOrganization.customFields.caption | string |
Primary Organization - Custom Fields - Caption. |
Value
|
primaryOrganization.customFields.value | string |
Primary Organization - Custom Fields - Value. |
Show In Directory
|
primaryOrganization.showInDirectory | boolean |
Primary Organization - Show In Directory. |
links
|
primaryOrganization.links | array of object | |
Type
|
primaryOrganization.links.type | string |
Primary Organization - Links - Type. |
URL
|
primaryOrganization.links.url | string |
Primary Organization - Links - URL. |
Old Id
|
primaryOrganization.oldId | string |
Primary Organization - Old Id. |
ID
|
id | string |
ID. |
Customer Type
|
customerType | string |
Customer Type. |
Record Number
|
recordNumber | string |
Record Number. |
Show In Directory
|
showInDirectory | boolean |
Show In Directory. |
addresses
|
addresses | array of object |
Addresses. |
Address Id
|
addresses.id | uuid |
Addresses - Address Id. |
Is Primary Address
|
addresses.primary | boolean |
Addresses - Is Primary. |
Address Line 1
|
addresses.line1 | string |
Addresses - Line 1. |
Address Line 2
|
addresses.line2 | string |
Addresses - Line 2. |
Address Line 3
|
addresses.line3 | string |
Addresses - Line 3. |
City
|
addresses.city | string |
Addresses - City. |
State
|
addresses.state | string |
Addresses - State. |
Zip Code
|
addresses.zipcode | string |
Addresses - Zip Code. |
Country
|
addresses.country | string |
Addresses - Country. |
State Abbreviation
|
addresses.stateAbbreviation | string |
Addresses - State Abbreviation. |
State ISO Code
|
addresses.stateISOCode | string |
Addresses - State ISO Code. |
Type
|
addresses.type | string |
Addresses - Type. |
Region
|
addresses.region | string |
Addresses - Region. |
Latitude
|
addresses.latitude | number |
Addresses - Latitude. |
Longitude
|
addresses.longitude | number |
Addresses - Longitude. |
Show In Directory
|
addresses.showInDirectory | boolean |
Addresses - Show In Directory. |
Congressional District
|
addresses.congressionalDistrict | string |
Addresses - Congressional District. |
Country Id
|
addresses.countryData.id | uuid |
Addresses - Country - Country Id. |
Country Name
|
addresses.countryData.name | string |
Addresses - Country - Country Name. |
Two Letter ISO Code
|
addresses.countryData.twoLetterIsoCode | string |
Addresses - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
addresses.countryData.threeLetterIsoCode | string |
Addresses - Country - Three Letter ISO Code. |
Country Code
|
addresses.countryData.code | integer |
Addresses - Country - Country Code. |
emails
|
emails | array of object |
Emails. |
Is Primary Email
|
emails.primary | boolean |
Emails - Is Primary. |
Email Address
|
emails.address |
Emails - Email Address. |
|
Type
|
emails.type | string |
Emails - Type. |
Show In Directory
|
emails.showInDirectory | boolean |
Emails - Show In Directory. |
phones
|
phones | array of object |
Phones. |
Phone Id
|
phones.id | uuid |
Phones - Phone Id. |
Is Primary Phone
|
phones.primary | boolean |
Phones - Is Primary. |
Type
|
phones.type | integer |
Phones - Type. |
Country Id
|
phones.country.id | uuid |
Phones - Country - Country Id. |
Country Name
|
phones.country.name | string |
Phones - Country - Country Name. |
Two Letter ISO Code
|
phones.country.twoLetterIsoCode | string |
Phones - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
phones.country.threeLetterIsoCode | string |
Phones - Country - Three Letter ISO Code. |
Country Code
|
phones.country.code | integer |
Phones - Country - Country Code. |
Show In Directory
|
phones.showInDirectory | boolean |
Phones - Show In Directory. |
Phone Number
|
phones.number | string |
Phones - Phone Number. |
Extension
|
phones.extension | string |
Phones - Extension. |
Type Name
|
phones.typeName | string |
Phones - Type Name. |
Name | Path | Type | Description |
---|---|---|---|
Individual Record Number
|
individualRecordNumber | string |
Individual Record Number. |
Status
|
status | string |
Status. |
Message
|
message | string |
Message. |
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | uuid |
ID. |
Customer Type
|
customerType | string |
Customer Type. |
Record Number
|
recordNumber | string |
Record Number. |
Title
|
title | string |
Title. |
Name
|
name | string |
Name. |
addresses
|
addresses | array of object | |
Address Id
|
addresses.id | string |
Addresses - Address Id. |
Is Primary Address
|
addresses.primary | boolean |
Addresses - Is Primary. |
Address Line 1
|
addresses.line1 | string |
Addresses - Line 1. |
Address Line 2
|
addresses.line2 | string |
Addresses - Line 2. |
Address Line 3
|
addresses.line3 | string |
Addresses - Line 3. |
City
|
addresses.city | string |
Addresses - City. |
State
|
addresses.state | string |
Addresses - State. |
Zip Code
|
addresses.zipcode | string |
Addresses - Zip Code. |
Country
|
addresses.country | string |
Addresses - Country. |
State Abbreviation
|
addresses.stateAbbreviation | string |
Addresses - State Abbreviation. |
State ISO Code
|
addresses.stateISOCode | string |
Addresses - State ISO Code. |
Type
|
addresses.type | string |
Addresses - Type. |
Region
|
addresses.region | string |
Addresses - Region. |
Latitude
|
addresses.latitude | number |
Addresses - Latitude. |
Longitude
|
addresses.longitude | number |
Addresses - Longitude. |
Show In Directory
|
addresses.showInDirectory | boolean |
Addresses - Show In Directory. |
Congressional District
|
addresses.congressionalDistrict | string |
Addresses - Congressional District. |
Country Id
|
addresses.countryData.id | string |
Addresses - Country - Country Id. |
Country Name
|
addresses.countryData.name | string |
Addresses - Country - Country Name. |
Two Letter ISO Code
|
addresses.countryData.twoLetterIsoCode | string |
Addresses - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
addresses.countryData.threeLetterIsoCode | string |
Addresses - Country - Three Letter ISO Code. |
Country Code
|
addresses.countryData.code | integer |
Addresses - Country - Country Code. |
Image Uri
|
imageUri | string |
Image Uri. |
Twitter
|
string |
Twitter. |
|
LinkedIn
|
string |
LinkedIn. |
|
emails
|
emails | array of object |
emails |
Primary
|
emails.primary | boolean |
Emails - Primary. |
Address
|
emails.address | string |
Emails - Address. |
Type
|
emails.type | string |
Emails - Type. |
Show In Directory
|
emails.showInDirectory | boolean |
Emails - Show in Directory. |
phones
|
phones | array of object | |
Phone Id
|
phones.id | string |
Phones - Id. |
Is Primary Phone
|
phones.primary | boolean |
Phones - Is Primary. |
Type
|
phones.type | integer |
Phones - Type. |
Country Id
|
phones.country.id | string |
Phones - Country - Country Id. |
Country Name
|
phones.country.name | string |
Phones - Country - Country Name. |
Two Letter ISO Code
|
phones.country.twoLetterIsoCode | string |
Phones - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
phones.country.threeLetterIsoCode | string |
Phones - Country - Three Letter ISO Code. |
Country Code
|
phones.country.code | integer |
Phones - Country - Country Code. |
Show In Directory
|
phones.showInDirectory | boolean |
Phones - Show In Directory. |
Number
|
phones.number | string |
Phones - Number. |
Extension
|
phones.extension | string |
Phones - Extension. |
Type Name
|
phones.typeName | string |
Phones - Type Name. |
Website
|
webSite | string |
Website. |
Memberships
|
memberships | array of object |
Memberships. |
Membership Type
|
memberships.membershipType | string |
Memberships - Membership Type. |
Membership Type ID
|
memberships.membershipTypeId | string |
Memberships - Membership Type ID. |
Code
|
memberships.code | string |
Memberships - Code. |
Expire Date
|
memberships.expireDate | date-time |
Memberships - Expire Date. |
Grace Expire Date
|
memberships.graceExpireDate | date-time |
Memberships - Grace Expire Date. |
Inherited Membership Benefits
|
memberships.inheritedMembershipBenefits | boolean |
Memberships - Inherited Membership Benefits. |
Renewal URL
|
memberships.renewalUrl | string |
Memberships - Renewal URL. |
Join Date
|
memberships.joinDate | date-time |
Memberships - Join Date. |
Terminate Date
|
memberships.terminateDate | date-time |
Memberships - Terminate Date. |
Effective Date
|
memberships.effectiveDate | date-time |
Memberships - Effective Date. |
Membership Unique ID
|
memberships.membershipUniqueId | string |
Memberships - Membership Unique ID. |
Terms List
|
memberships.termsList | array of object |
Memberships - Terms List |
Start Date
|
memberships.termsList.startDate | date-time |
Terms - Start Date |
End Date
|
memberships.termsList.endDate | date-time |
Terms - End Date |
Category
|
category | string |
Category. |
categories
|
categories | array of object |
Categories |
subCategories
|
categories.subCategories | array of object |
subCategories |
Subcategories
|
categories.subCategories.subCategories | string |
Categories - Subcategories - Subcategories. |
Code
|
categories.subCategories.code | string |
Categories - Subcategories - Code. |
Name
|
categories.subCategories.name | string |
Categories - Subcategories - Name. |
Is Primary
|
categories.subCategories.isPrimary | boolean |
Categories - Subcategories - Is Primary. |
code
|
categories.code | string |
Categories - Code |
name
|
categories.name | string |
Categories - Name |
isPrimary
|
categories.isPrimary | boolean |
Categories - Is Primary |
customFields
|
customFields | array of object |
Custom Fields |
Name
|
customFields.name | string |
Custom Fields - Name. |
Caption
|
customFields.caption | string |
Custom Fields - Caption. |
Show In Directory
|
showInDirectory | boolean |
Show In Directory. |
links
|
links | array of object |
Links |
Type
|
links.type | string |
Links - Type. |
Url
|
links.url | string |
Links - Url. |
Old ID
|
oldId | string |
Old ID. |
Name | Path | Type | Description |
---|---|---|---|
Order Number
|
orderNumber | string |
Order Number. |
Product Code
|
productCode | string |
Product Code. |
Product Name
|
productName | string |
Product Name. |
Product Type
|
productType | string |
Product Type. |
Purchase Date
|
purchaseDate | date-time |
Purchase Date. |
Additional Info
|
additionalInfo | string |
Additional Info. |
Quantity
|
quantity | integer |
Quantity. |
itemizedCustomFields
|
itemizedCustomFields | array of object |
Itemized Custom Fields |
Name
|
itemizedCustomFields.name | string |
Itemized Custom Fields - Name. |
Caption
|
itemizedCustomFields.caption | string |
Itemized Custom Fields - Caption. |
Value
|
itemizedCustomFields.value | string |
Itemized Custom Fields - Value. |
productCategories
|
productCategories | array of object |
Product Categories |
subCategories
|
productCategories.subCategories | array of object |
Subcategories |
subCategories
|
productCategories.subCategories.subCategories | string |
Product Categories - Subcategories - Subcategories |
code
|
productCategories.subCategories.code | string |
Product Categories - Subcategories - Code |
name
|
productCategories.subCategories.name | string |
Product Categories - Subcategories - Name |
isPrimary
|
productCategories.subCategories.isPrimary | boolean |
Product Categories - Subcategories - Is Primary |
code
|
productCategories.code | string |
Product Categories - Code |
name
|
productCategories.name | string |
Product Categories - Name |
isPrimary
|
productCategories.isPrimary | boolean |
Product Categories - Is Primary |
Name | Path | Type | Description |
---|---|---|---|
Title
|
title | string |
Title. |
Registration Number
|
registrationNumber | string |
Registration Number. |
Event Cancellation Date.
|
eventCancellationDate | date-time |
Event Cancellation Date. |
Guest Of Record Number
|
guestOfRecordNumber | string |
Guest Of Record Number. |
cancelledSessions
|
cancelledSessions | array of object |
Cancelled Sessions. |
Session Code
|
cancelledSessions.sessionCode | string |
Cancelled Sessions - Session Code. |
Cancellation Date
|
cancelledSessions.cancellationDate | date-time |
Cancelled Sessions - Cancellation Date. |
First Name
|
firstName | string |
First Name. |
Last Name
|
lastName | string |
Last Name. |
Middle Name
|
middleName | string |
Middle Name. |
Preferred First Name
|
preferredFirstName | string |
Preferred First Name. |
Second Last Name
|
secondLastName | string |
Second Last Name. |
Prefix
|
prefix | string |
Prefix. |
Suffix
|
suffix | string |
Suffix. |
Gender
|
gender | string |
Gender. |
ContactIds
|
primaryOrganization.contactIds | array of uuid |
Primary Organization - Contact Ids. |
Parent Company Id
|
primaryOrganization.parentCompanyId | uuid |
Primary Organization - Parent Company Id. |
Description
|
primaryOrganization.description | string |
Primary Organization - Description. |
Branch Name
|
primaryOrganization.branchName | string |
Primary Organization - Branch Name. |
Tags
|
primaryOrganization.tags | array of string |
Primary Organization - Tags. |
Primary Organization Id
|
primaryOrganization.id | uuid |
Primary Organization Id. |
CustomerType
|
primaryOrganization.customerType | string |
Primary Organization - Customer Type. |
Record Number
|
primaryOrganization.recordNumber | string |
Primary Organization - Record Number. |
Title
|
primaryOrganization.title | string |
Primary Organization - Title. |
Name
|
primaryOrganization.name | string |
Primary Organization - Name. |
addresses
|
primaryOrganization.addresses | array of object |
Primary Organization - Addresses. |
Address Id
|
primaryOrganization.addresses.id | uuid |
Primary Organization - Addresses - Id. |
Is Primary Address
|
primaryOrganization.addresses.primary | boolean |
Primary Organization - Addresses - Is Primary. |
Address Line 1
|
primaryOrganization.addresses.line1 | string |
Primary Organization - Addresses - Line 1. |
Address Line 2
|
primaryOrganization.addresses.line2 | string |
Primary Organization - Addresses - Line 2. |
Address Line 3
|
primaryOrganization.addresses.line3 | string |
Primary Organization - Addresses - Line 3. |
City
|
primaryOrganization.addresses.city | string |
Primary Organization - Addresses - City. |
State
|
primaryOrganization.addresses.state | string |
Primary Organization - Addresses - State. |
Zip Code
|
primaryOrganization.addresses.zipcode | string |
Primary Organization - Addresses - Zip Code. |
Country
|
primaryOrganization.addresses.country | string |
Primary Organization - Addresses - Country. |
State Abbreviation
|
primaryOrganization.addresses.stateAbbreviation | string |
Primary Organization - Addresses - State Abbreviation. |
State ISO Code
|
primaryOrganization.addresses.stateISOCode | string |
Primary Organization - Addresses - State ISO Code. |
Type
|
primaryOrganization.addresses.type | string |
Primary Organization - Addresses - Type. |
Region
|
primaryOrganization.addresses.region | string |
Primary Organization - Addresses - Region. |
Latitude
|
primaryOrganization.addresses.latitude | number |
Primary Organization - Addresses - Latitude. |
Longitude
|
primaryOrganization.addresses.longitude | number |
Primary Organization - Addresses - Longitude. |
Show In Directory
|
primaryOrganization.addresses.showInDirectory | boolean |
Primary Organization - Addresses - Show In Directory. |
Congressional District
|
primaryOrganization.addresses.congressionalDistrict | string |
Primary Organization - Addresses - Congressional District. |
Country Id
|
primaryOrganization.addresses.countryData.id | string |
Primary Organization - Addresses - Country - Id. |
Country Name
|
primaryOrganization.addresses.countryData.name | string |
Primary Organization - Addresses - Country - Name. |
Two Letter ISO Code
|
primaryOrganization.addresses.countryData.twoLetterIsoCode | string |
Primary Organization - Addresses - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
primaryOrganization.addresses.countryData.threeLetterIsoCode | string |
Primary Organization - Addresses - Country - Three Letter ISO Code. |
Country Code
|
primaryOrganization.addresses.countryData.code | integer |
Primary Organization - Addresses - Country - Code. |
Email
|
primaryOrganization.email |
Primary Organization - Email. |
|
Image URI
|
primaryOrganization.imageUri | uri |
Primary Organization - Image URI. |
Twitter
|
primaryOrganization.twitter | uri |
Primary Organization - Twitter. |
LinkedIn
|
primaryOrganization.linkedIn | uri |
Primary Organization - LinkedIn. |
emails
|
primaryOrganization.emails | array of object |
Primary Organization - Emails. |
Is Primary Email
|
primaryOrganization.emails.primary | boolean |
Primary Organization - Emails - Is Primary. |
Address
|
primaryOrganization.emails.address | string |
Primary Organization - Emails - Address. |
Type
|
primaryOrganization.emails.type | string |
Primary Organization - Emails - Type. |
Show In Directory
|
primaryOrganization.emails.showInDirectory | boolean |
Primary Organization - Emails - Show In Directory. |
phones
|
primaryOrganization.phones | array of object |
Primary Organization - Phones. |
Phone Id
|
primaryOrganization.phones.id | uuid |
Primary Organization - Phones - Id. |
Is Primary Phone
|
primaryOrganization.phones.primary | boolean |
Primary Organization - Phones - Is Primary. |
Type
|
primaryOrganization.phones.type | integer |
Primary Organization - Phones - Type. |
Country Id
|
primaryOrganization.phones.country.id | uuid |
Primary Organization - Phones - Country - Id. |
Country Name
|
primaryOrganization.phones.country.name | string |
Primary Organization - Phones - Country - Name. |
Two Letter ISO Code
|
primaryOrganization.phones.country.twoLetterIsoCode | string |
Primary Organization - Phones - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
primaryOrganization.phones.country.threeLetterIsoCode | string |
Primary Organization - Phones - Country - Three Letter ISO Code. |
Country Code
|
primaryOrganization.phones.country.code | integer |
Primary Organization - Phones - Country - Code. |
Show In Directory
|
primaryOrganization.phones.showInDirectory | boolean |
Primary Organization - Phones - Show In Directory. |
Phone Number
|
primaryOrganization.phones.number | string |
Primary Organization - Phones - Number. |
Extension
|
primaryOrganization.phones.extension | string |
Primary Organization - Phones - Extension. |
Type Name
|
primaryOrganization.phones.typeName | string |
Primary Organization - Phones - Type Name. |
Website
|
primaryOrganization.webSite | uri |
Primary Organization - Website. |
memberships
|
primaryOrganization.memberships | array of object |
Primary Organization - Memberships. |
Membership Type
|
primaryOrganization.memberships.membershipType | string |
Primary Organization - Memberships - Membership Type. |
Membership Type Id
|
primaryOrganization.memberships.membershipTypeId | uuid |
Primary Organization - Memberships - Membership Type Id. |
Code
|
primaryOrganization.memberships.code | string |
Primary Organization - Memberships - Code. |
Expire Date
|
primaryOrganization.memberships.expireDate | date-time |
Primary Organization - Memberships - Expire Date. |
Grace Expire Date
|
primaryOrganization.memberships.graceExpireDate | date-time |
Primary Organization - Memberships - Grace Expire Date. |
Inherited Membership Benefits
|
primaryOrganization.memberships.inheritedMembershipBenefits | boolean |
Primary Organization - Memberships - Inherited Membership Benefits. |
Renewal URL
|
primaryOrganization.memberships.renewalUrl | string |
Primary Organization - Memberships - Renewal URL. |
Join Date
|
primaryOrganization.memberships.joinDate | date-time |
Primary Organization - Memberships - Join Date. |
Terminate Date
|
primaryOrganization.memberships.terminateDate | date-time |
Primary Organization - Memberships - Terminate Date. |
Effective Date
|
primaryOrganization.memberships.effectiveDate | date-time |
Primary Organization - Memberships - Effective Date. |
Category
|
primaryOrganization.category | string |
Primary Organization - Category. |
categories
|
primaryOrganization.categories | array of object |
Primary Organization - Categories. |
subCategories
|
primaryOrganization.categories.subCategories | array of object |
Primary Organization - Categories - Subcategories. |
Code
|
primaryOrganization.categories.subCategories.code | string |
Primary Organization - Categories - Subcategories - Code. |
Name
|
primaryOrganization.categories.subCategories.name | string |
Primary Organization - Categories - Subcategories - Name. |
Code
|
primaryOrganization.categories.code | string |
Primary Organization - Categories - Code. |
Name
|
primaryOrganization.categories.name | string |
Primary Organization - Categories - Name. |
customFields
|
primaryOrganization.customFields | array of object |
Primary Organization - Custom Fields. |
Name
|
primaryOrganization.customFields.name | string |
Primary Organization - Custom Fields - Name. |
Caption
|
primaryOrganization.customFields.caption | string |
Primary Organization - Custom Fields - Caption. |
Value
|
primaryOrganization.customFields.value | string |
Primary Organization - Custom Fields - Value. |
Show In Directory
|
primaryOrganization.showInDirectory | boolean |
Primary Organization - Show In Directory. |
links
|
primaryOrganization.links | array of object |
Primary Organization - Links. |
Type
|
primaryOrganization.links.type | string |
Primary Organization - Links - Type. |
URL
|
primaryOrganization.links.url | uri |
Primary Organization - Links - URL. |
Old Id
|
primaryOrganization.oldId | string |
Primary Organization - Old Id. |
ID
|
id | string |
ID. |
Customer Type
|
customerType | string |
Customer Type. |
Record Number
|
recordNumber | string |
Record Number. |
Show In Directory
|
showInDirectory | boolean |
Show In Directory. |
addresses
|
addresses | array of object |
Addresses. |
Address Id
|
addresses.id | uuid |
Addresses - Address Id. |
Is Primary Address
|
addresses.primary | boolean |
Addresses - Is Primary. |
Address Line 1
|
addresses.line1 | string |
Addresses - Line 1. |
Address Line 2
|
addresses.line2 | string |
Addresses - Line 2. |
Address Line 3
|
addresses.line3 | string |
Addresses - Line 3. |
City
|
addresses.city | string |
Addresses - City. |
State
|
addresses.state | string |
Addresses - State. |
Zip Code
|
addresses.zipcode | string |
Addresses - Zip Code. |
Country
|
addresses.country | string |
Addresses - Country. |
State Abbreviation
|
addresses.stateAbbreviation | string |
Addresses - State Abbreviation. |
State ISO Code
|
addresses.stateISOCode | string |
Addresses - State ISO Code. |
Type
|
addresses.type | string |
Addresses - Type. |
Region
|
addresses.region | string |
Addresses - Region. |
Latitude
|
addresses.latitude | number |
Addresses - Latitude. |
Longitude
|
addresses.longitude | number |
Addresses - Longitude. |
Show In Directory
|
addresses.showInDirectory | boolean |
Addresses - Show In Directory. |
Congressional District
|
addresses.congressionalDistrict | string |
Addresses - Congressional District. |
Country Id
|
addresses.countryData.id | uuid |
Addresses - Country - Country Id. |
Country Name
|
addresses.countryData.name | string |
Addresses - Country - Country Name. |
Two Letter ISO Code
|
addresses.countryData.twoLetterIsoCode | string |
Addresses - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
addresses.countryData.threeLetterIsoCode | string |
Addresses - Country - Three Letter ISO Code. |
Country Code
|
addresses.countryData.code | integer |
Addresses - Country - Country Code. |
Is Preferred Shipping
|
addresses.isPreferredShipping | boolean |
Addresses - Is Preferred Shipping |
Is Preferred Billing
|
addresses.isPreferredBilling | boolean |
Addresses - Is Preferred Billing |
Is Bad Address
|
addresses.isBadAddress | boolean |
Addresses - Is Bad Address |
emails
|
emails | array of object |
Emails |
Primary
|
emails.primary | boolean |
Emails - Primary. |
Address
|
emails.address | string |
Emails - Address. |
Type
|
emails.type | string |
Emails - Type. |
Shown In Directory
|
emails.shownInDirectory | boolean |
Emails - Shown In Directory. |
phones
|
phones | array of object |
Phones. |
Phone Id
|
phones.id | uuid |
Phones - Phone Id. |
Is Primary Phone
|
phones.primary | boolean |
Phones - Is Primary. |
Type
|
phones.type | integer |
Phones - Type. |
Country Id
|
phones.country.id | uuid |
Phones - Country - Country Id. |
Country Name
|
phones.country.name | string |
Phones - Country - Country Name. |
Two Letter ISO Code
|
phones.country.twoLetterIsoCode | string |
Phones - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
phones.country.threeLetterIsoCode | string |
Phones - Country - Three Letter ISO Code. |
Country Code
|
phones.country.code | integer |
Phones - Country - Country Code. |
Show In Directory
|
phones.showInDirectory | boolean |
Phones - Show In Directory. |
Phone Number
|
phones.number | string |
Phones - Phone Number. |
Extension
|
phones.extension | string |
Phones - Extension. |
Type Name
|
phones.typeName | string |
Phones - Type Name. |
Name | Path | Type | Description |
---|---|---|---|
Number
|
number | string |
Number. |
Date
|
date | date-time |
Date. |
Balance
|
balance | float |
Balance. |
lineItems
|
lineItems | array of object |
lineItems |
Product Name
|
lineItems.ProductName | string |
Line Items - Product Name. |
Product Code
|
lineItems.ProductCode | string |
Line Items - Product Code. |
Product Type
|
lineItems.ProductType | string |
Line Items - Product Name. |
Quantity
|
lineItems.Quantity | integer |
Line Items - Quantity. |
Item Price
|
lineItems.ItemPrice | float |
Line Items - Item Price. |
Item Discount Total
|
lineItems.ItemDiscountTotal | float |
Line Items - Item Discount Total. |
Item Shipping Total
|
lineItems.ItemShippingTotal | float |
Line Items - Item Shipping Total. |
Item Tax Total
|
lineItems.ItemTaxTotal | float |
Line Items - Tax Total. |
Item Total
|
lineItems.ItemTotal | float |
Line Items - Item Total. |
Additional Info
|
lineItems.AdditionalInfo | float |
Line Items - Additional Info. |
Type
|
type | string |
Type. |
ID
|
id | string |
ID. |
Customer Id
|
customerId | string |
Customer Id. |
Total Amount
|
totalAmount | float |
Total Amount. |
Title
|
title | string |
Title. |
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
ID. |
Name
|
name | string |
Name. |
Two Letter Iso Code
|
twoLetterIsoCode | string |
Two Letter Iso Code. |
Three Letter Iso Code
|
threeLetterIsoCode | string |
Three Letter Iso Code. |
Code
|
code | integer |
Code. |
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
ID. |
Name
|
name | string |
Name. |
Abbreviation
|
abbreviation | string |
Abbreviation. |
Iso Code
|
isoCode | string |
Iso Code. |
Name | Path | Type | Description |
---|---|---|---|
Code
|
code | string |
Code. |
Name
|
name | string |
Name. |
Start Date
|
startDate | date-time |
Start Date. |
Start Time
|
startTime | string |
Start Time. |
End Date
|
endDate | date-time |
End Date. |
End Time
|
endTime | string |
End Time. |
Categories
|
categories | array of object |
Categories |
Subcategories
|
categories.subCategories | array of object |
Subcategories |
Subcategories
|
categories.subCategories.subCategories | string |
Categories - Subcategories - Subcategories. |
Code
|
categories.subCategories.code | string |
Categories - Subcategories - Code. |
Name
|
categories.subCategories.name | string |
Categories - Subcategories - Name. |
Is Primary
|
categories.subCategories.isPrimary | boolean |
Categories - Subcategories - Is Primary. |
Code
|
categories.code | string |
Categories - Code. |
Name
|
categories.name | string |
Categories - Name. |
Is Primary
|
categories.isPrimary | boolean |
Is Primary. |
Short Description
|
shortDescription | string |
Short Description. |
Long Description
|
longDescription | string |
Long Description. |
Featured Start Date
|
featuredListing.featuredStartDate | date-time |
Featured Start Date. |
Featured End Date
|
featuredListing.featuredEndDate | date-time |
Featured End Date. |
Name | Path | Type | Description |
---|---|---|---|
Request Number
|
requestNumber | string |
Request Number. |
Closed Date
|
closedDate | date-time |
Closed Date. |
Name | Path | Type | Description |
---|---|---|---|
Name
|
name | string |
Name. |
Reciprocal Relationship Name
|
reciprocalRelationshipName | string |
Reciprocal Relationship Name. |
Relationship Type
|
relationshipType | string |
Relationship Type. |
Allow Primary
|
allowPrimary | boolean |
Allow Primary. |
Can Purchase For Organization
|
canPurchaseForOrganization | boolean |
Can Purchase For Organization. |
Can Manage PAC
|
canManagePAC | boolean |
Can Manage PAC. |
Can Manage Organization
|
canManageOrganization | boolean |
Can Manage Organization. |
Name | Path | Type | Description |
---|---|---|---|
Request Number
|
requestNumber | string |
Request Number. |
Request Date
|
requestDate | date-time |
Request Date. |
Requested By Customer Record Number
|
requestedByCustomerRecordNumber | string |
Requested By Customer Record Number. |
Request Type
|
requestType | string |
Request Type. |
Description
|
description | string |
Description. |
Source
|
source | string |
Source. |
Closed Date
|
closedDate | date-time |
Closed Date. |
Name | Path | Type | Description |
---|---|---|---|
Task Number
|
taskNumber | string |
Task Number. |
Title
|
title | string |
Title. |
Category
|
category | string |
Category. |
Description
|
description | string |
Description. |
Assigned By
|
assignedBy | string |
Assigned By. |
Start Date
|
startDate | date |
Start Date. |
Due Date
|
dueDate | date |
Due Date. |
Progress
|
progress | string |
Progress. |
Completed Date
|
completedDate | date-time |
Completed Date. |
Name | Path | Type | Description |
---|---|---|---|
Task Number
|
taskNumber | string |
Task Number. |
Title
|
title | string |
Title. |
Category
|
category | string |
Category. |
Description
|
description | string |
Description. |
Start Date
|
startDate | date |
Start Date. |
Due Date
|
dueDate | date |
Due Date. |
Name | Path | Type | Description |
---|---|---|---|
Code
|
code | string |
Code. |
Name
|
name | string |
Name. |
Expire Date
|
expireDate | date-time |
Expire Date. |
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
ID. |
Name
|
name | string |
Name. |
Description
|
description | string |
Description. |
Year
|
year | integer |
Year. |
Customer Type
|
customerType | string |
Customer Type. |
Allow Public Nomination
|
allowPublicNomination | boolean |
Allow Public Nomination. |
Nomination Start Date
|
nominationStartDate | date-time |
Nomination Start Date. |
Nomination End Date
|
nominationEndDate | date-time |
Nomination End Date. |
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
ID. |
License Type
|
licenseType | string |
License Type. |
Number
|
number | string |
Number. |
State
|
state | string |
State. |
Status
|
status | string |
Status. |
Start Date
|
startDate | date-time |
Start Date. |
Expiration Date
|
expirationDate | date-time |
Experation Date. |
Name | Path | Type | Description |
---|---|---|---|
Code
|
code | string |
Code. |
Name
|
name | string |
Name. |
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
ID. |
First Name
|
firstName | string |
First Name. |
Last Name
|
lastName | string |
Last Name. |
Code
|
code | string |
Code. |
Position
|
position | string |
Position. |
Position Code
|
positionCode | string |
Position Code. |
Start Date
|
startDate | date-time |
Start Date. |
End Date
|
endDate | date-time |
End Date. |
Contact Ids
|
primaryOrganization.contactIds | array of uuid |
Primary Organization - Contact Ids. |
Parent Company Id
|
primaryOrganization.parentCompanyId | string |
Primary Organization - Parent Company Id. |
Description
|
primaryOrganization.description | string |
Primary Organization - Description. |
Branch Name
|
primaryOrganization.branchName | string |
Primary Organization - Branch Name. |
Tags
|
primaryOrganization.tags | array of string |
Primary Organization - Tags. |
Primary Organization Id
|
primaryOrganization.id | string |
Primary Organization - Id. |
Customer Type
|
primaryOrganization.customerType | string |
Primary Organization - Customer Type. |
Record Number
|
primaryOrganization.recordNumber | string |
Primary Organization - Record Number. |
Title
|
primaryOrganization.title | string |
Primary Organization - Title. |
Name
|
primaryOrganization.name | string |
Primary Organization - Name. |
addresses
|
primaryOrganization.addresses | array of object | |
Address Id
|
primaryOrganization.addresses.id | string |
Primary Organization - Addresses - Address Id. |
Is Primary Address
|
primaryOrganization.addresses.primary | boolean |
Primary Organization - Addresses - Is Primary. |
Address Line 1
|
primaryOrganization.addresses.line1 | string |
Primary Organization - Addresses - Line 1. |
Address Line 2
|
primaryOrganization.addresses.line2 | string |
Primary Organization - Addresses - Line 2. |
Address Line 3
|
primaryOrganization.addresses.line3 | string |
Primary Organization - Addresses - Line 3. |
City
|
primaryOrganization.addresses.city | string |
Primary Organization - Addresses - City. |
State
|
primaryOrganization.addresses.state | string |
Primary Organization - Addresses - State. |
Zip Code
|
primaryOrganization.addresses.zipcode | string |
Primary Organization - Addresses - Zip Code. |
Country
|
primaryOrganization.addresses.country | string |
Primary Organization - Addresses - Country. |
State Abbreviation
|
primaryOrganization.addresses.stateAbbreviation | string |
Primary Organization - Addresses - State Abbreviation. |
State ISO Code
|
primaryOrganization.addresses.stateISOCode | string |
Primary Organization - Addresses - State ISO Code. |
Type
|
primaryOrganization.addresses.type | string |
Primary Organization - Addresses - Type. |
Region
|
primaryOrganization.addresses.region | string |
Primary Organization - Addresses - Region. |
Latitude
|
primaryOrganization.addresses.latitude | number |
Primary Organization - Addresses - Latitude. |
Longitude
|
primaryOrganization.addresses.longitude | number |
Primary Organization - Addresses - Longitude. |
Show In Directory
|
primaryOrganization.addresses.showInDirectory | boolean |
Primary Organization - Addresses - Show In Directory. |
Congressional District
|
primaryOrganization.addresses.congressionalDistrict | string |
Primary Organization - Addresses - Congressional District. |
Country Id
|
primaryOrganization.addresses.countryData.id | string |
Primary Organization - Addresses - Country - Country Id. |
Country Name
|
primaryOrganization.addresses.countryData.name | string |
Primary Organization - Addresses - Country - Country Name. |
Two Letter ISO Code
|
primaryOrganization.addresses.countryData.twoLetterIsoCode | string |
Primary Organization - Addresses - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
primaryOrganization.addresses.countryData.threeLetterIsoCode | string |
Primary Organization - Addresses - Country - Three Letter ISO Code. |
Country Code
|
primaryOrganization.addresses.countryData.code | integer |
Primary Organization - Addresses - Country - Country Code. |
Email
|
primaryOrganization.email | string |
Primary Organization - Email. |
Image URI
|
primaryOrganization.imageUri | string |
Primary Organization - Image URI. |
Twitter
|
primaryOrganization.twitter | string |
Primary Organization - Twitter. |
LinkedIn
|
primaryOrganization.linkedIn | string |
Primary Organization - LinkedIn. |
emails
|
primaryOrganization.emails | array of object | |
Is Primary Email
|
primaryOrganization.emails.primary | boolean |
Primary Organization - Emails - Is Primary. |
Address
|
primaryOrganization.emails.address | string |
Primary Organization - Emails - Address. |
Type
|
primaryOrganization.emails.type | string |
Primary Organization - Emails - Type. |
Show In Directory
|
primaryOrganization.emails.showInDirectory | boolean |
Primary Organization - Emails - Show In Directory. |
phones
|
primaryOrganization.phones | array of object | |
Phone Id
|
primaryOrganization.phones.id | string |
Primary Organization - Phones - Id. |
Is Primary Phone
|
primaryOrganization.phones.primary | boolean |
Primary Organization - Phones - Is Primary. |
Type
|
primaryOrganization.phones.type | integer |
Primary Organization - Phones - Type. |
Country Id
|
primaryOrganization.phones.country.id | string |
Primary Organization - Phones - Country - Country Id. |
Country Name
|
primaryOrganization.phones.country.name | string |
Primary Organization - Phones - Country - Country Name. |
Two Letter ISO Code
|
primaryOrganization.phones.country.twoLetterIsoCode | string |
Primary Organization - Phones - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
primaryOrganization.phones.country.threeLetterIsoCode | string |
Primary Organization - Phones - Country - Three Letter ISO Code. |
Country Code
|
primaryOrganization.phones.country.code | integer |
Primary Organization - Phones - Country - Country Code. |
Show In Directory
|
primaryOrganization.phones.showInDirectory | boolean |
Primary Organization - Phones - Show In Directory. |
Number
|
primaryOrganization.phones.number | string |
Primary Organization - Phones - Number. |
Extension
|
primaryOrganization.phones.extension | string |
Primary Organization - Phones - Extension. |
Type Name
|
primaryOrganization.phones.typeName | string |
Primary Organization - Phones - Type Name. |
Website
|
primaryOrganization.webSite | string |
Primary Organization - Website. |
memberships
|
primaryOrganization.memberships | array of object | |
Membership Type
|
primaryOrganization.memberships.membershipType | string |
Primary Organization - Memberships - Membership Type. |
Membership Type Id
|
primaryOrganization.memberships.membershipTypeId | string |
Primary Organization - Memberships - Membership Type Id. |
Code
|
primaryOrganization.memberships.code | string |
Primary Organization - Memberships - Code. |
Expire Date
|
primaryOrganization.memberships.expireDate | date-time |
Primary Organization - Memberships - Expire Date. |
Grace Expire Date
|
primaryOrganization.memberships.graceExpireDate | date-time |
Primary Organization - Memberships - Grace Expire Date. |
Inherited Membership Benefits
|
primaryOrganization.memberships.inheritedMembershipBenefits | boolean |
Primary Organization - Memberships - Inherited Membership Benefits. |
Renewal URL
|
primaryOrganization.memberships.renewalUrl | string |
Primary Organization - Memberships - Renewal URL. |
Join Date
|
primaryOrganization.memberships.joinDate | date-time |
Primary Organization - Memberships - Join Date. |
Terminate Date
|
primaryOrganization.memberships.terminateDate | date-time |
Primary Organization - Memberships - Terminate Date. |
Effective Date
|
primaryOrganization.memberships.effectiveDate | date-time |
Primary Organization - Memberships - Effective Date. |
Category
|
primaryOrganization.category | string |
Primary Organization - Category. |
categories
|
primaryOrganization.categories | array of object | |
subCategories
|
primaryOrganization.categories.subCategories | array of object |
Primary Organization - Categories - Subcategories. |
Code
|
primaryOrganization.categories.subCategories.code | string |
Primary Organization - Categories - Subcategories - Code. |
Name
|
primaryOrganization.categories.subCategories.name | string |
Primary Organization - Categories - Subcategories - Name. |
Code
|
primaryOrganization.categories.code | string |
Primary Organization - Categories - Code. |
Name
|
primaryOrganization.categories.name | string |
Primary Organization - Categories - Name. |
customFields
|
primaryOrganization.customFields | array of object | |
Name
|
primaryOrganization.customFields.name | string |
Primary Organization - Custom Fields - Name. |
Caption
|
primaryOrganization.customFields.caption | string |
Primary Organization - Custom Fields - Caption. |
Value
|
primaryOrganization.customFields.value | string |
Primary Organization - Custom Fields - Value. |
Show In Directory
|
primaryOrganization.showInDirectory | boolean |
Primary Organization - Show In Directory. |
links
|
primaryOrganization.links | array of object | |
Type
|
primaryOrganization.links.type | string |
Primary Organization - Links - Type. |
URL
|
primaryOrganization.links.url | string |
Primary Organization - Links - URL. |
Old Id
|
primaryOrganization.oldId | string |
Primary Organization - Old Id. |
ContactIds
|
organizationRepresenting.contactIds | array of uuid |
Organization Representing - Contact Ids. |
Parent Company Id
|
organizationRepresenting.parentCompanyId | string |
Organization Representing - Parent Company Id. |
Description
|
organizationRepresenting.description | string |
Organization Representing - Description. |
Branch Name
|
organizationRepresenting.branchName | string |
Organization Representing - Branch Name. |
Tags
|
organizationRepresenting.tags | array of string |
Organization Representing - Tags. |
Representing Organization Id
|
organizationRepresenting.id | string |
Organization Representing - Organization Representing Id. |
Customer Type
|
organizationRepresenting.customerType | string |
Organization Representing - Customer Type. |
Record Number
|
organizationRepresenting.recordNumber | string |
Organization Representing - Record Number. |
Title
|
organizationRepresenting.title | string |
Organization Representing - Title. |
Name
|
organizationRepresenting.name | string |
Organization Representing - Name. |
addresses
|
organizationRepresenting.addresses | array of object | |
Address Id
|
organizationRepresenting.addresses.id | string |
Organization Representing - Addresses - Address Id. |
Is Primary Address
|
organizationRepresenting.addresses.primary | boolean |
Organization Representing - Addresses - Is Primary. |
Address Line 1
|
organizationRepresenting.addresses.line1 | string |
Organization Representing - Addresses - Line 1. |
Address Line 2
|
organizationRepresenting.addresses.line2 | string |
Organization Representing - Addresses - Line 2. |
Address Line 3
|
organizationRepresenting.addresses.line3 | string |
Organization Representing - Addresses - Line 3. |
City
|
organizationRepresenting.addresses.city | string |
Organization Representing - Addresses - City. |
State
|
organizationRepresenting.addresses.state | string |
Organization Representing - Addresses - State. |
Zip Code
|
organizationRepresenting.addresses.zipcode | string |
Organization Representing - Addresses - Zip Code. |
Country
|
organizationRepresenting.addresses.country | string |
Organization Representing - Addresses - Country. |
State Abbreviation
|
organizationRepresenting.addresses.stateAbbreviation | string |
Organization Representing - Addresses - State Abbreviation. |
State ISO Code
|
organizationRepresenting.addresses.stateISOCode | string |
Organization Representing - Addresses - State ISO Code. |
Type
|
organizationRepresenting.addresses.type | string |
Organization Representing - Addresses - Type. |
Region
|
organizationRepresenting.addresses.region | string |
Organization Representing - Addresses - Region. |
Latitude
|
organizationRepresenting.addresses.latitude | number |
Organization Representing - Addresses - Latitude. |
Longitude
|
organizationRepresenting.addresses.longitude | number |
Organization Representing - Addresses - Longitude. |
Show In Directory
|
organizationRepresenting.addresses.showInDirectory | boolean |
Organization Representing - Addresses - Show In Directory. |
Congressional District
|
organizationRepresenting.addresses.congressionalDistrict | string |
Organization Representing - Addresses - Congressional District. |
Country Id
|
organizationRepresenting.addresses.countryData.id | string |
Organization Representing - Addresses - Country - Country Id. |
Country Name
|
organizationRepresenting.addresses.countryData.name | string |
Organization Representing - Addresses - Country - Country Name. |
Two Letter ISO Code
|
organizationRepresenting.addresses.countryData.twoLetterIsoCode | string |
Organization Representing - Addresses - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
organizationRepresenting.addresses.countryData.threeLetterIsoCode | string |
Organization Representing - Addresses - Country - Three Letter ISO Code. |
Country Code
|
organizationRepresenting.addresses.countryData.code | integer |
Organization Representing - Addresses - Country - Country Code. |
Email
|
organizationRepresenting.email | string |
Organization Representing - Email. |
Image URI
|
organizationRepresenting.imageUri | string |
Organization Representing - Image URI. |
Twitter
|
organizationRepresenting.twitter | string |
Organization Representing - Twitter. |
LinkedIn
|
organizationRepresenting.linkedIn | string |
Organization Representing - LinkedIn. |
emails
|
organizationRepresenting.emails | array of object | |
Is Primary Email
|
organizationRepresenting.emails.primary | boolean |
Organization Representing - Emails - Is Primary. |
Address
|
organizationRepresenting.emails.address | string |
Organization Representing - Emails - Address. |
Type
|
organizationRepresenting.emails.type | string |
Organization Representing - Emails - Type. |
Show In Directory
|
organizationRepresenting.emails.showInDirectory | boolean |
Organization Representing - Emails - Show In Directory. |
phones
|
organizationRepresenting.phones | array of object | |
Phone Id
|
organizationRepresenting.phones.id | string |
Organization Representing - Phones - Id. |
Is Primary Phone
|
organizationRepresenting.phones.primary | boolean |
Organization Representing - Phones - Is Primary. |
Type
|
organizationRepresenting.phones.type | integer |
Organization Representing - Phones - Type. |
Country Id
|
organizationRepresenting.phones.country.id | string |
Organization Representing - Phones - Country - Country Id. |
Country Name
|
organizationRepresenting.phones.country.name | string |
Organization Representing - Phones - Country - Country Name. |
Two Letter ISO Code
|
organizationRepresenting.phones.country.twoLetterIsoCode | string |
Organization Representing - Phones - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
organizationRepresenting.phones.country.threeLetterIsoCode | string |
Organization Representing - Phones - Country - Three Letter ISO Code. |
Country Code
|
organizationRepresenting.phones.country.code | integer |
Organization Representing - Phones - Country - Country Code. |
Show In Directory
|
organizationRepresenting.phones.showInDirectory | boolean |
Organization Representing - Phones - Show In Directory. |
Number
|
organizationRepresenting.phones.number | string |
Organization Representing - Phones - Number. |
Extension
|
organizationRepresenting.phones.extension | string |
Organization Representing - Phones - Extension. |
Type Name
|
organizationRepresenting.phones.typeName | string |
Organization Representing - Phones - Type Name. |
Website
|
organizationRepresenting.webSite | string |
Organization Representing - Website. |
memberships
|
organizationRepresenting.memberships | array of object | |
Membership Type
|
organizationRepresenting.memberships.membershipType | string |
Organization Representing - Memberships - Membership Type. |
Membership Type Id
|
organizationRepresenting.memberships.membershipTypeId | string |
Organization Representing - Memberships - Membership Type Id. |
Code
|
organizationRepresenting.memberships.code | string |
Organization Representing - Memberships - Code. |
Expire Date
|
organizationRepresenting.memberships.expireDate | date-time |
Organization Representing - Memberships - Expire Date. |
Grace Expire Date
|
organizationRepresenting.memberships.graceExpireDate | date-time |
Organization Representing - Memberships - Grace Expire Date. |
Inherited Membership Benefits
|
organizationRepresenting.memberships.inheritedMembershipBenefits | boolean |
Organization Representing - Memberships - Inherited Membership Benefits. |
Renewal URL
|
organizationRepresenting.memberships.renewalUrl | string |
Organization Representing - Memberships - Renewal URL. |
Join Date
|
organizationRepresenting.memberships.joinDate | date-time |
Organization Representing - Memberships - Join Date. |
Terminate Date
|
organizationRepresenting.memberships.terminateDate | date-time |
Organization Representing - Memberships - Terminate Date. |
Effective Date
|
organizationRepresenting.memberships.effectiveDate | date-time |
Organization Representing - Memberships - Effective Date. |
Category
|
organizationRepresenting.category | string |
Organization Representing - Category. |
categories
|
organizationRepresenting.categories | array of object |
Organization Representing - Categories. |
subCategories
|
organizationRepresenting.categories.subCategories | array of object |
Organization Representing - Categories - Subcategories. |
Code
|
organizationRepresenting.categories.subCategories.code | string |
Organization Representing - Categories - Subcategories - Code. |
Name
|
organizationRepresenting.categories.subCategories.name | string |
Organization Representing - Categories - Subcategories - Name. |
Code
|
organizationRepresenting.categories.code | string |
Organization Representing - Categories - Code. |
Name
|
organizationRepresenting.categories.name | string |
Organization Representing - Categories - Name. |
customFields
|
organizationRepresenting.customFields | array of object | |
Name
|
organizationRepresenting.customFields.name | string |
Organization Representing - Custom Fields - Name. |
Caption
|
organizationRepresenting.customFields.caption | string |
Organization Representing - Custom Fields - Caption. |
Value
|
organizationRepresenting.customFields.value | string |
Organization Representing - Custom Fields - Value. |
Show In Directory
|
organizationRepresenting.showInDirectory | boolean |
Organization Representing - Show In Directory. |
links
|
organizationRepresenting.links | array of object | |
Type
|
organizationRepresenting.links.type | string |
Organization Representing - Links - Type. |
URL
|
organizationRepresenting.links.url | string |
Organization Representing - Links - URL. |
Old Id
|
organizationRepresenting.oldId | string |
Organization Representing - Old Id. |
Nominated By Customer Id
|
nominatedByCustomer.id | string |
Nominated By Customer - Nominated By Customer Id. |
Customer Type
|
nominatedByCustomer.customerType | string |
Nominated By Customer - Customer Type. |
Record Number
|
nominatedByCustomer.recordNumber | string |
Nominated By Customer - Record Number. |
Title
|
nominatedByCustomer.title | string |
Nominated By Customer - Title. |
Name
|
nominatedByCustomer.name | string |
Nominated By Customer - Name. |
addresses
|
nominatedByCustomer.addresses | array of object | |
Address Id
|
nominatedByCustomer.addresses.id | string |
Nominated By Customer - Addresses - Address Id. |
Is Primary Address
|
nominatedByCustomer.addresses.primary | boolean |
Nominated By Customer - Addresses - Is Primary. |
Address Line 1
|
nominatedByCustomer.addresses.line1 | string |
Nominated By Customer - Addresses - Line 1. |
Address Line 2
|
nominatedByCustomer.addresses.line2 | string |
Nominated By Customer - Addresses - Line 2. |
Address Line 3
|
nominatedByCustomer.addresses.line3 | string |
Nominated By Customer - Addresses - Line 3. |
City
|
nominatedByCustomer.addresses.city | string |
Nominated By Customer - Addresses - City. |
State
|
nominatedByCustomer.addresses.state | string |
Nominated By Customer - Addresses - State. |
Zip Code
|
nominatedByCustomer.addresses.zipcode | string |
Nominated By Customer - Addresses - Zip Code. |
Country
|
nominatedByCustomer.addresses.country | string |
Nominated By Customer - Addresses - Country. |
State Abbreviation
|
nominatedByCustomer.addresses.stateAbbreviation | string |
Nominated By Customer - Addresses - State Abbreviation. |
State ISO Code
|
nominatedByCustomer.addresses.stateISOCode | string |
Nominated By Customer - Addresses - State ISO Code. |
Type
|
nominatedByCustomer.addresses.type | string |
Nominated By Customer - Addresses - Type. |
Region
|
nominatedByCustomer.addresses.region | string |
Nominated By Customer - Addresses - Region. |
Latitude
|
nominatedByCustomer.addresses.latitude | number |
Nominated By Customer - Addresses - Latitude. |
Longitude
|
nominatedByCustomer.addresses.longitude | number |
Nominated By Customer - Addresses - Longitude. |
Show In Directory
|
nominatedByCustomer.addresses.showInDirectory | boolean |
Nominated By Customer - Addresses - Show In Directory. |
Congressional District
|
nominatedByCustomer.addresses.congressionalDistrict | string |
Nominated By Customer - Addresses - Congressional District. |
Country Id
|
nominatedByCustomer.addresses.countryData.id | string |
Nominated By Customer - Addresses - Country - Country Id. |
Country Name
|
nominatedByCustomer.addresses.countryData.name | string |
Nominated By Customer - Addresses - Country - Country Name. |
Two Letter ISO Code
|
nominatedByCustomer.addresses.countryData.twoLetterIsoCode | string |
Nominated By Customer - Addresses - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
nominatedByCustomer.addresses.countryData.threeLetterIsoCode | string |
Nominated By Customer - Addresses - Country - Three Letter ISO Code. |
Country Code
|
nominatedByCustomer.addresses.countryData.code | integer |
Nominated By Customer - Addresses - Country - Country Code. |
Email
|
nominatedByCustomer.email | string |
Nominated By Customer - Email. |
Image URI
|
nominatedByCustomer.imageUri | string |
Nominated By Customer - Image URI. |
Twitter
|
nominatedByCustomer.twitter | string |
Nominated By Customer - Twitter. |
LinkedIn
|
nominatedByCustomer.linkedIn | string |
Nominated By Customer - LinkedIn. |
emails
|
nominatedByCustomer.emails | array of object | |
Is Primary Email
|
nominatedByCustomer.emails.primary | boolean |
Nominated By Customer - Emails - Is Primary. |
Address
|
nominatedByCustomer.emails.address | string |
Nominated By Customer - Emails - Address. |
Type
|
nominatedByCustomer.emails.type | string |
Nominated By Customer - Emails - Type. |
Show In Directory
|
nominatedByCustomer.emails.showInDirectory | boolean |
Nominated By Customer - Emails - Show In Directory. |
phones
|
nominatedByCustomer.phones | array of object | |
Phone Id
|
nominatedByCustomer.phones.id | string |
Nominated By Customer - Phones - Id. |
Is Primary Phone
|
nominatedByCustomer.phones.primary | boolean |
Nominated By Customer - Phones - Is Primary. |
Type
|
nominatedByCustomer.phones.type | integer |
Nominated By Customer - Phones - Type. |
Country Id
|
nominatedByCustomer.phones.country.id | string |
Nominated By Customer - Phones - Country - Country Id. |
Country Name
|
nominatedByCustomer.phones.country.name | string |
Nominated By Customer - Phones - Country - Country Name. |
Two Letter ISO Code
|
nominatedByCustomer.phones.country.twoLetterIsoCode | string |
Nominated By Customer - Phones - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
nominatedByCustomer.phones.country.threeLetterIsoCode | string |
Nominated By Customer - Phones - Country - Three Letter ISO Code. |
Country Code
|
nominatedByCustomer.phones.country.code | integer |
Nominated By Customer - Phones - Country - Country Code. |
Show In Directory
|
nominatedByCustomer.phones.showInDirectory | boolean |
Nominated By Customer - Phones - Show In Directory. |
Number
|
nominatedByCustomer.phones.number | string |
Nominated By Customer - Phones - Number. |
Extension
|
nominatedByCustomer.phones.extension | string |
Nominated By Customer - Phones - Extension. |
Type Name
|
nominatedByCustomer.phones.typeName | string |
Nominated By Customer - Phones - Type Name. |
Website
|
nominatedByCustomer.webSite | string |
Nominated By Customer - Website. |
memberships
|
nominatedByCustomer.memberships | array of object | |
Membership Type
|
nominatedByCustomer.memberships.membershipType | string |
Nominated By Customer - Memberships - Membership Type. |
Membership Type Id
|
nominatedByCustomer.memberships.membershipTypeId | string |
Nominated By Customer - Memberships - Membership Type Id. |
Code
|
nominatedByCustomer.memberships.code | string |
Nominated By Customer - Memberships - Code. |
Expire Date
|
nominatedByCustomer.memberships.expireDate | date-time |
Nominated By Customer - Memberships - Expire Date. |
Grace Expire Date
|
nominatedByCustomer.memberships.graceExpireDate | date-time |
Nominated By Customer - Memberships - Grace Expire Date. |
Inherited Membership Benefits
|
nominatedByCustomer.memberships.inheritedMembershipBenefits | boolean |
Nominated By Customer - Memberships - Inherited Membership Benefits. |
Renewal URL
|
nominatedByCustomer.memberships.renewalUrl | string |
Nominated By Customer - Memberships - Renewal URL. |
Join Date
|
nominatedByCustomer.memberships.joinDate | date-time |
Nominated By Customer - Memberships - Join Date. |
Terminate Date
|
nominatedByCustomer.memberships.terminateDate | date-time |
Nominated By Customer - Memberships - Terminate Date. |
Effective Date
|
nominatedByCustomer.memberships.effectiveDate | date-time |
Nominated By Customer - Memberships - Effective Date. |
Category
|
nominatedByCustomer.category | string |
Nominated By Customer - Category. |
categories
|
nominatedByCustomer.categories | array of object |
Nominated By Customer - Categories. |
subCategories
|
nominatedByCustomer.categories.subCategories | array of object |
Nominated By Customer - Categories - Subcategories. |
Code
|
nominatedByCustomer.categories.subCategories.code | string |
Nominated By Customer - Categories - Subcategories - Code. |
Name
|
nominatedByCustomer.categories.subCategories.name | string |
Nominated By Customer - Categories - Subcategories - Name. |
Code
|
nominatedByCustomer.categories.code | string |
Nominated By Customer - Categories - Code. |
Name
|
nominatedByCustomer.categories.name | string |
Nominated By Customer - Categories - Name. |
customFields
|
nominatedByCustomer.customFields | array of object | |
Name
|
nominatedByCustomer.customFields.name | string |
Nominated By Customer - Custom Fields - Name. |
Caption
|
nominatedByCustomer.customFields.caption | string |
Nominated By Customer - Custom Fields - Caption. |
Value
|
nominatedByCustomer.customFields.value | string |
Nominated By Customer - Custom Fields - Value. |
Show In Directory
|
nominatedByCustomer.showInDirectory | boolean |
Nominated By Customer - Show In Directory. |
links
|
nominatedByCustomer.links | array of object | |
Type
|
nominatedByCustomer.links.type | string |
Nominated By Customer - Links - Type. |
URL
|
nominatedByCustomer.links.url | string |
Nominated By Customer - Links - URL. |
Old Id
|
nominatedByCustomer.oldId | string |
Nominated By Customer - Old Id. |
addresses
|
addresses | array of object | |
Address Id
|
addresses.id | string |
Addresses - Address Id. |
Is Primary Address
|
addresses.primary | boolean |
Addresses - Is Primary. |
Address Line 1
|
addresses.line1 | string |
Addresses - Line 1. |
Address Line 2
|
addresses.line2 | string |
Addresses - Line 2. |
Address Line 3
|
addresses.line3 | string |
Addresses - Line 3. |
City
|
addresses.city | string |
Addresses - City. |
State
|
addresses.state | string |
Addresses - State. |
Zip Code
|
addresses.zipcode | string |
Addresses - Zip Code. |
Country
|
addresses.country | string |
Addresses - Country. |
State Abbreviation
|
addresses.stateAbbreviation | string |
Addresses - State Abbreviation. |
State ISO Code
|
addresses.stateISOCode | string |
Addresses - State ISO Code. |
Type
|
addresses.type | string |
Addresses - Type. |
Region
|
addresses.region | string |
Addresses - Region. |
Latitude
|
addresses.latitude | number |
Addresses - Latitude. |
Longitude
|
addresses.longitude | number |
Addresses - Longitude. |
Show In Directory
|
addresses.showInDirectory | boolean |
Addresses - Show In Directory. |
Congressional District
|
addresses.congressionalDistrict | string |
Addresses - Congressional District. |
Country Id
|
addresses.countryData.id | string |
Addresses - Country - Country Id. |
Country Name
|
addresses.countryData.name | string |
Addresses - Country - Country Name. |
Two Letter ISO Code
|
addresses.countryData.twoLetterIsoCode | string |
Addresses - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
addresses.countryData.threeLetterIsoCode | string |
Addresses - Country - Three Letter ISO Code. |
Country Code
|
addresses.countryData.code | integer |
Addresses - Country - Country Code. |
phones
|
phones | array of object | |
Phone Id
|
phones.id | string |
Phones - Id. |
Is Primary Phone
|
phones.primary | boolean |
Phones - Is Primary. |
Type
|
phones.type | integer |
Phones - Type. |
Country Id
|
phones.country.id | string |
Phones - Country - Country Id. |
Country Name
|
phones.country.name | string |
Phones - Country - Country Name. |
Two Letter ISO Code
|
phones.country.twoLetterIsoCode | string |
Phones - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
phones.country.threeLetterIsoCode | string |
Phones - Country - Three Letter ISO Code. |
Country Code
|
phones.country.code | integer |
Phones - Country - Country Code. |
Show In Directory
|
phones.showInDirectory | boolean |
Phones - Show In Directory. |
Number
|
phones.number | string |
Phones - Number. |
Extension
|
phones.extension | string |
Phones - Extension. |
Type Name
|
phones.typeName | string |
Phones - Type Name. |
emails
|
emails | array of object | |
Is Primary Email
|
emails.primary | boolean |
Emails - Is Primary. |
Address
|
emails.address | string |
Emails - Address. |
Type
|
emails.type | string |
Emails - Type. |
Show In Directory
|
emails.showInDirectory | boolean |
Emails - Show In Directory. |
Rank
|
rank | integer |
Rank. |
Name | Path | Type | Description |
---|---|---|---|
Status
|
status | string |
Status. |
Message
|
message | string |
Message. |
Custom Field Name
|
customFieldName | string |
Custom Field Name. |
Name | Path | Type | Description |
---|---|---|---|
Relationship Name
|
relationshipName | string |
Relationship Name. |
ID
|
relatedToCustomer.id | string |
Related To Customer - ID. |
Customer Type
|
relatedToCustomer.customerType | string |
Related To Customer - Customer Type. |
Record Number
|
relatedToCustomer.recordNumber | string |
Related To Customer - Record Number. |
Title
|
relatedToCustomer.title | string |
Related To Customer - Title. |
Name
|
relatedToCustomer.name | string |
Related To Customer - Name. |
Addresses
|
relatedToCustomer.addresses | array of object |
Related To Customer - Addresses. |
ID.
|
relatedToCustomer.addresses.id | string |
Addresses - ID. |
Primary
|
relatedToCustomer.addresses.primary | boolean |
Addresses - Primary. |
Line 1
|
relatedToCustomer.addresses.line1 | string |
Addresses - Line 1. |
Line 2
|
relatedToCustomer.addresses.line2 | string |
Addresses - Line 2. |
Line 3
|
relatedToCustomer.addresses.line3 | string |
Addresses - Line 3. |
City
|
relatedToCustomer.addresses.city | string |
Addresses - City. |
State
|
relatedToCustomer.addresses.state | string |
Addresses - State. |
Zipcode
|
relatedToCustomer.addresses.zipcode | string |
Addresses - Zipcode. |
Country
|
relatedToCustomer.addresses.country | string |
Addresses - Country. |
State Abbreviation
|
relatedToCustomer.addresses.stateAbbreviation | string |
Addresses - State Abbreviation. |
State ISO Code
|
relatedToCustomer.addresses.stateISOCode | string |
Addresses - State ISO Code. |
Type
|
relatedToCustomer.addresses.type | string |
Addresses - Type. |
Region
|
relatedToCustomer.addresses.region | string |
Addresses - Region. |
Latitude
|
relatedToCustomer.addresses.latitude | string |
Addresses - Latitude. |
Longitude
|
relatedToCustomer.addresses.longitude | string |
Addresses - Longitude. |
Show In Directory
|
relatedToCustomer.addresses.showInDirectory | boolean |
Addresses - Show In Directory. |
Congressional District
|
relatedToCustomer.addresses.congressionalDistrict | string |
Addresses - Congressional District. |
ID
|
relatedToCustomer.addresses.countryData.id | string |
Country - ID. |
Name
|
relatedToCustomer.addresses.countryData.name | string |
Country - Name. |
Two Letter ISO Code
|
relatedToCustomer.addresses.countryData.twoLetterIsoCode | string |
Country - Two Letter Iso Code. |
Three Letter ISO Code
|
relatedToCustomer.addresses.countryData.threeLetterIsoCode | string |
Country - Three Letter Iso Code. |
Code
|
relatedToCustomer.addresses.countryData.code | integer |
Country - Code. |
Is Preferred Shipping
|
relatedToCustomer.addresses.isPreferredShipping | boolean |
Addresses - Is Preferred Shipping. |
Is Preferred Billing
|
relatedToCustomer.addresses.isPreferredBilling | boolean |
Addresses - Is Preferred Billing. |
Is Bad Address
|
relatedToCustomer.addresses.isBadAddress | boolean |
Addresses - Is Bad Address. |
Image Uri
|
relatedToCustomer.imageUri | string |
Related To Customer - Image Uri. |
Emails
|
relatedToCustomer.emails | array of object |
Related To Customer - Emails. |
Primary
|
relatedToCustomer.emails.primary | boolean |
Emails - Primary. |
Address
|
relatedToCustomer.emails.address | string |
Emails - Address. |
Type
|
relatedToCustomer.emails.type | string |
Emails - Type. |
Show In Directory
|
relatedToCustomer.emails.showInDirectory | boolean |
Emails - Show In Directory. |
Phones
|
relatedToCustomer.phones | array of object |
Related To Customer - Phones. |
ID
|
relatedToCustomer.phones.id | string |
Phones - ID. |
Primary
|
relatedToCustomer.phones.primary | boolean |
Phones - Primary. |
Type
|
relatedToCustomer.phones.type | integer |
Phones - Type. |
Country
|
relatedToCustomer.phones.country | string |
Phones - Country. |
Show In Directory
|
relatedToCustomer.phones.showInDirectory | boolean |
Phones - Show In Directory. |
Number
|
relatedToCustomer.phones.number | string |
Phones - Number. |
Extension
|
relatedToCustomer.phones.extension | string |
Phones - Extension. |
Type Name
|
relatedToCustomer.phones.typeName | string |
Phones - Type Name. |
Web Site
|
relatedToCustomer.webSite | string |
Related To Customer - Web Site. |
Memberships
|
relatedToCustomer.memberships | array of object |
Related To Customer - Memberships. |
Membership Type
|
relatedToCustomer.memberships.membershipType | string |
Memberships - Membership Type. |
Membership Type ID
|
relatedToCustomer.memberships.membershipTypeId | string |
Memberships - Membership Type ID. |
Code
|
relatedToCustomer.memberships.code | string |
Memberships - Code. |
Expire Date
|
relatedToCustomer.memberships.expireDate | date-time |
Memberships - Expire Date. |
Grace Expire Date
|
relatedToCustomer.memberships.graceExpireDate | date-time |
Memberships - Grace Expire Date. |
Inherited Membership Benefits
|
relatedToCustomer.memberships.inheritedMembershipBenefits | boolean |
Memberships - Inherited Membership Benefits. |
Renewal URL
|
relatedToCustomer.memberships.renewalUrl | string |
Memberships - Renewal URL. |
Join Date
|
relatedToCustomer.memberships.joinDate | date-time |
Memberships - Join Date. |
Terminate Date
|
relatedToCustomer.memberships.terminateDate | date-time |
Memberships - Terminate Date. |
Effective Date
|
relatedToCustomer.memberships.effectiveDate | date-time |
Memberships - Effective Date. |
Membership Unique ID
|
relatedToCustomer.memberships.membershipUniqueId | string |
Memberships - Membership Unique ID. |
Terms List
|
relatedToCustomer.memberships.termsList | array of object |
Memberships - Terms List |
Start Date
|
relatedToCustomer.memberships.termsList.startDate | date-time |
Terms - Start Date |
End Date
|
relatedToCustomer.memberships.termsList.endDate | date-time |
Terms - End Date |
Category
|
relatedToCustomer.category | string |
Related To Customer - Category. |
Categories
|
relatedToCustomer.categories | array of object |
Related To Customer - Categories. |
Subcategories
|
relatedToCustomer.categories.subCategories | array of object |
Categories - Subcategories. |
Subcategories
|
relatedToCustomer.categories.subCategories.subCategories | string |
Subcategories - Subcategories. |
Code
|
relatedToCustomer.categories.subCategories.code | string |
Subcategories - Code. |
Name
|
relatedToCustomer.categories.subCategories.name | string |
Subcategories - Name. |
Is Primary
|
relatedToCustomer.categories.subCategories.isPrimary | boolean |
Subcategories - Is Primary. |
Code
|
relatedToCustomer.categories.code | string |
Categories - Code |
Name
|
relatedToCustomer.categories.name | string |
Categories - Name |
Is Primary
|
relatedToCustomer.categories.isPrimary | boolean |
Categories - Is Primary. |
Custom Fields
|
relatedToCustomer.customFields | array of object |
Related To Customer - Custom Fields |
Name
|
relatedToCustomer.customFields.name | string |
Custom Fields - Name. |
Caption
|
relatedToCustomer.customFields.caption | string |
Custom Fields - Caption. |
Value
|
relatedToCustomer.customFields.value | string |
Custom Fields - Value. |
Show In Directory
|
relatedToCustomer.showInDirectory | boolean |
Related To Customer - Show In Directory. |
Links
|
relatedToCustomer.links | array of object |
Related To Customer - Links. |
Type
|
relatedToCustomer.links.type | string |
Links - Type. |
URL
|
relatedToCustomer.links.url | string |
Links - URL. |
Old ID
|
relatedToCustomer.oldId | string |
Related To Customer - Old ID. |
Reciprocal Relationship Name
|
reciprocalRelationshipName | string |
Reciprocal Relationship Name. |
Is Primary
|
isPrimary | boolean |
Is Primary. |
Start Date
|
startDate | date-time |
Start Date. |
End Date
|
endDate | date-time |
End Date. |
Name | Path | Type | Description |
---|---|---|---|
Individual ID
|
individualId | string |
Individual ID. |
ID
|
event.id | string |
Event - ID. |
Code
|
event.code | string |
Event - Code. |
Name
|
event.name | string |
Event - Name. |
Start Date
|
event.startDate | date-time |
Event - Start Date |
Start Time
|
event.startTime | string |
Event - Start Time. |
End Date
|
event.endDate | date-time |
Event - End Date. |
End Time
|
event.endTime | string |
Event - End Time. |
Time Zone
|
event.timezone | string |
Event - Time Zone. |
Description
|
event.description | string |
Event - Description. |
Public Event
|
event.publicEvent | boolean |
Event - Public Event. |
Free Event
|
event.freeEvent | boolean |
Event - Free Event. |
Attended Date
|
event.attendedDate | date-time |
Event - Attended Date. |
Locations
|
event.locations | array of object |
Event - Locations. |
Name
|
event.locations.name | string |
Locations - Name |
Description
|
event.locations.description | string |
Locations - Description |
Addresses
|
event.locations.addresses | array of object |
Locations - Addresses. |
ID
|
event.locations.addresses.id | string |
Addresses - ID. |
Primary
|
event.locations.addresses.primary | boolean |
Addresses - Primary. |
Line 1
|
event.locations.addresses.line1 | string |
Addresses - Line 1. |
Line 2
|
event.locations.addresses.line2 | string |
Addresses - Line 2. |
Line 3
|
event.locations.addresses.line3 | string |
Addresses - Line 3. |
City
|
event.locations.addresses.city | string |
Addresses - City. |
State
|
event.locations.addresses.state | string |
Addresses - State. |
Zipcode
|
event.locations.addresses.zipcode | string |
Addresses - Zipcode. |
Country
|
event.locations.addresses.country | string |
Addresses - Country. |
State Abbreviation
|
event.locations.addresses.stateAbbreviation | string |
Addresses - State Abbreviation. |
State ISO Code
|
event.locations.addresses.stateISOCode | string |
Addresses - State ISO Code. |
Type
|
event.locations.addresses.type | string |
Addresses - Type. |
Region
|
event.locations.addresses.region | string |
Addresses - Region. |
Latitude
|
event.locations.addresses.latitude | float |
Addresses - Latitude. |
Longitude
|
event.locations.addresses.longitude | float |
Addresses - Longitude. |
Show In Directory
|
event.locations.addresses.showInDirectory | boolean |
Addresses - Show In Directory. |
Congressional District
|
event.locations.addresses.congressionalDistrict | string |
Addresses - Congressional District. |
ID
|
event.locations.addresses.countryData.id | string |
Country - ID. |
Name
|
event.locations.addresses.countryData.name | string |
Country - Name. |
Two Letter Iso Code
|
event.locations.addresses.countryData.twoLetterIsoCode | string |
Country - Two Letter Iso Code. |
Three Letter Iso Code
|
event.locations.addresses.countryData.threeLetterIsoCode | string |
Country - Three Letter Iso Code. |
Code
|
event.locations.addresses.countryData.code | integer |
Country - Code. |
Is Preferred Shipping
|
event.locations.addresses.isPreferredShipping | boolean |
Addresses - Is Preferred Shipping. |
Is Preferred Billing
|
event.locations.addresses.isPreferredBilling | boolean |
Addresses - Is Preferred Billing. |
Is Bad Address
|
event.locations.addresses.isBadAddress | boolean |
Addresses - Is Bad Address. |
Registration Date
|
event.registrationDate | date-time |
Event - Registration Date. |
Custom Fields
|
event.customFields | array of object |
Event - Custom Fields. |
Name
|
event.customFields.name | string |
Custom Fields - Name. |
Caption
|
event.customFields.caption | string |
Custom Fields - Caption. |
Value
|
event.customFields.value | string |
Custom Fields - Value. |
Sessions
|
sessions | array of object |
Sessions. |
Code
|
sessions.code | string |
Sessions - Code. |
Name
|
sessions.name | string |
Sessions - Name. |
Start Date
|
sessions.startDate | date-time |
Sessions - Start Date. |
Start Time
|
sessions.startTime | string |
Sessions - Start Time. |
End Date
|
sessions.endDate | date-time |
Sessions - End Date. |
End Time
|
sessions.endTime | string |
Sessions - End Time. |
Description
|
sessions.description | string |
Sessions - Description. |
Free Session
|
sessions.freeSession | boolean |
Sessions - Free Session. |
Attended Date
|
sessions.attendedDate | date-time |
Sessions - Attended Date. |
Registration Date
|
sessions.registrationDate | date-time |
Sessions - Registration Date. |
External Code
|
sessions.externalCode | string |
Sessions - External Code. |
Custom Fields
|
sessions.customFields | array of object |
Sessions - Custom Fields. |
Name
|
sessions.customFields.name | string |
Custom Fields - Name. |
Caption
|
sessions.customFields.caption | string |
Custom Fields - Caption. |
Value
|
sessions.customFields.value | string |
Custom Fields - Value. |
Badge Name
|
badgeName | string |
Badge Name. |
Badge Organization
|
badgeOrganization | string |
Badge Organization. |
Badge City
|
badgeCity | string |
Badge City. |
Badge State
|
badgeState | string |
Badge State. |
boughtTogetherWith
|
boughtTogetherWith | array of object | |
Order Number
|
boughtTogetherWith.orderNumber | string |
Bought Together With - Order Number. |
Product Code
|
boughtTogetherWith.productCode | string |
Bought Together With - Product Code. |
Product Name
|
boughtTogetherWith.productName | string |
Bought Together With - Product Name. |
Product Type
|
boughtTogetherWith.productType | string |
Bought Together With - Product Type. |
Purchase Date
|
boughtTogetherWith.purchaseDate | date-time |
Bought Together With - Purchase Date. |
Additional Info
|
boughtTogetherWith.additionalInfo | string |
Bought Together With - Additional Info. |
Quantity
|
boughtTogetherWith.quantity | integer |
Bought Together With - Quantity. |
itemizedCustomFields
|
boughtTogetherWith.itemizedCustomFields | array of object | |
Name
|
boughtTogetherWith.itemizedCustomFields.name | string |
Itemized Custom Fields - Name. |
Caption
|
boughtTogetherWith.itemizedCustomFields.caption | string |
Itemized Custom Fields - Caption. |
Value
|
boughtTogetherWith.itemizedCustomFields.value | string |
Itemized Custom Fields - Value. |
productCategories
|
boughtTogetherWith.productCategories | array of object | |
Code
|
boughtTogetherWith.productCategories.code | string |
Product Categories - Code. |
Name
|
boughtTogetherWith.productCategories.name | string |
Product Categories - Name. |
Is Primary
|
boughtTogetherWith.productCategories.IsPrimary | boolean |
Product Categories - Is Primary. |
Subcategories
|
boughtTogetherWith.productCategories.subCategories | array of object |
Product Categories - Subcategories. |
Subcategories
|
boughtTogetherWith.productCategories.subCategories.subCategories | string |
Subcategories - Subcategories. |
Code
|
boughtTogetherWith.productCategories.subCategories.code | string |
Subcategories - Code. |
Name
|
boughtTogetherWith.productCategories.subCategories.name | string |
Subcategories - Name. |
Is Primary
|
boughtTogetherWith.productCategories.subCategories.isPrimary | boolean |
Subcategories - Is Primary. |
Registrant Type Code
|
registrantTypeCode | string |
Registrant Type Code. |
Registrant Type Name
|
registrantTypeName | string |
Registrant Type Name. |
Registration Number
|
registrationNumber | string |
Registration Number. |
Name | Path | Type | Description |
---|---|---|---|
Name
|
committee.name | string |
Committee - Name. |
Code
|
committee.code | string |
Committee - Code. |
Website
|
committee.website | string |
Committee - Website. |
Id
|
committee.id | uuid |
Committee - Id. |
Parent Committee Id
|
committee.parentCommitteeId | uuid |
Committee - Parent Committee Id. |
Category Name
|
committee.categoryName | string |
Committee - Category Name. |
Category Code
|
committee.categoryCode | string |
Committee - Category Code. |
Description
|
committee.description | string |
Committee - Description. |
Start Date
|
committee.startDate | date-time |
Committee - Start Date. |
Committee End Date
|
committee.endDate | date-time |
Committee - End Date. |
Show In Directory
|
committee.showInDirectory | boolean |
Committee - Show In Directory. |
Term
|
committee.term.term | integer |
Committee - Term - Term Number. |
Start Date
|
committee.term.startDate | date-time |
Committee - Term - Start Date. |
End Date
|
committee.term.endDate | date-time |
Committee - Term - End Date. |
Show In Directory
|
committee.term.showInDirectory | boolean |
Committee - Term - Show In Directory. |
Tags
|
committee.tags | array of string |
Committee - Tags. |
Position
|
position | string |
Position. |
Position Code
|
positionCode | string |
Position Code. |
Code
|
code | string |
Code. |
Start Date
|
startDate | date-time |
Start Date. |
End Date
|
endDate | date-time |
End Date. |
Name | Path | Type | Description |
---|---|---|---|
Name
|
name | string |
Name. |
Caption
|
caption | string |
Caption. |
Value
|
value | string |
Custom Field Value. For multi-selects, use "|" as delimiter. |
Name | Path | Type | Description |
---|---|---|---|
Membership Type
|
membershipType | string |
Membership Type. |
Membership Type ID
|
membershipTypeId | string |
Membership Type ID. |
Code
|
code | string |
Code. |
Expire Date
|
expireDate | date-time |
Expire Date. |
Grace Expire Date
|
graceExpireDate | date-time |
Grace Expire Date. |
Inherited Membership Benefits
|
inheritedMembershipBenefits | boolean |
Inherited Membership Benefits. |
Renewal URL
|
renewalUrl | string |
Renewal URL. |
Join Date
|
joinDate | date-time |
Join Date. |
Terminate Date
|
terminateDate | date-time |
Terminate Date. |
Effective Date
|
effectiveDate | date-time |
Effective Date. |
Membership Unique ID
|
membershipUniqueId | string |
Membership Unique ID. |
termsList
|
termsList | array of object |
Terms List |
Start Date
|
termsList.startDate | date-time |
Terms - Start Date |
End Date
|
termsList.endDate | date-time |
Terms - End Date |
Name | Path | Type | Description |
---|---|---|---|
Event ID
|
eventId | string |
Event ID. |
Event Code
|
eventCode | string |
Event Code. |
Event Name
|
eventName | string |
Event Name. |
Event Start Date
|
eventStartDate | date-time |
Event Start Date. |
Event Start Time
|
eventStartTime | string |
Event Start Time. |
Event End Date
|
eventEndDate | date-time |
Event End Date. |
Event End Time
|
eventEndTime | string |
Event End Time. |
Event Time Zone
|
eventTimezone | string |
Event Time Zone. |
Event Description
|
eventDescription | string |
Event Description. |
Short Description
|
shortDescription | string |
Short Description. |
Public Event
|
publicEvent | boolean |
Public Event. |
imageUrl
|
imageUrl | array of string |
Image Url. |
External Url
|
externalUrl | string |
External Url. |
External Code
|
externalCode | string |
External Code. |
Event Locations
|
eventLocations | array of object |
Event Locations. |
Name
|
eventLocations.name | string |
Event Locations - Name. |
Description
|
eventLocations.description | string |
Event Locations - Description. |
Addresses
|
eventLocations.addresses | array of object |
Event Locations - Addresses. |
ID
|
eventLocations.addresses.id | string |
Addresses - ID. |
Primary
|
eventLocations.addresses.primary | boolean |
Addresses - Primary. |
Line 1
|
eventLocations.addresses.line1 | string |
Addresses - Line 1. |
Line 2
|
eventLocations.addresses.line2 | string |
Addresses - Line 2. |
Line 3
|
eventLocations.addresses.line3 | string |
Addresses - Line 3. |
City
|
eventLocations.addresses.city | string |
Addresses - City. |
State
|
eventLocations.addresses.state | string |
Addresses - State. |
Zipcode
|
eventLocations.addresses.zipcode | string |
Addresses - Zipcode. |
Country
|
eventLocations.addresses.country | string |
Addresses - Country. |
State Abbreviation
|
eventLocations.addresses.stateAbbreviation | string |
Addresses - State Abbreviation. |
State ISO Code
|
eventLocations.addresses.stateISOCode | string |
Addresses - State ISO Code. |
Type
|
eventLocations.addresses.type | string |
Addresses - Type. |
Region
|
eventLocations.addresses.region | string |
Addresses - Region. |
Latitude
|
eventLocations.addresses.latitude | float |
Addresses - Latitude. |
Longitude
|
eventLocations.addresses.longitude | float |
Addresses - Longitude. |
Show In Directory
|
eventLocations.addresses.showInDirectory | boolean |
Addresses - Show In Directory. |
Congressional District
|
eventLocations.addresses.congressionalDistrict | string |
Addresses - Congressional District. |
ID
|
eventLocations.addresses.countryData.id | string |
Country - ID. |
Name
|
eventLocations.addresses.countryData.name | string |
Country - Name. |
Two Letter Iso Code
|
eventLocations.addresses.countryData.twoLetterIsoCode | string |
Country - Two Letter Iso Code. |
Three Letter ISO Code
|
eventLocations.addresses.countryData.threeLetterIsoCode | string |
Country - Three Letter Iso Code. |
Code
|
eventLocations.addresses.countryData.code | integer |
Country - Code. |
Is Preferred Shipping
|
eventLocations.addresses.isPreferredShipping | boolean |
Addresses - Is Preferred Shipping. |
Is Preferred Billing
|
eventLocations.addresses.isPreferredBilling | boolean |
Addresses - Is Preferred Billing. |
Is Bad Address
|
eventLocations.addresses.isBadAddress | boolean |
Addresses - Is Bad Address. |
Categories
|
categories | array of object |
Event Locations - Categories. |
subCategories
|
categories.subCategories | array of object |
Event Locations - Subcategories. |
Sub Categories
|
categories.subCategories.subCategories | string |
Subcategories - Subcategories. |
Code
|
categories.subCategories.code | string |
Subcategories - Code. |
Name
|
categories.subCategories.name | string |
Subcategories - Name. |
Is Primary
|
categories.subCategories.isPrimary | boolean |
Subcoategories - Is Primary. |
Code
|
categories.code | string |
Categories - Code |
Name
|
categories.name | string |
Categories - Name |
Is Primary
|
categories.isPrimary | boolean |
Categories - Is Primary. |
Education Credits
|
educationCredits | array of object |
Event Locations - Education Credits. |
Code
|
educationCredits.code | string |
Education Credits - Code. |
Name
|
educationCredits.name | string |
Education Credits - Name. |
Short Description
|
educationCredits.shortDescription | string |
Education Credits - Short Description. |
Credits
|
educationCredits.credits | float |
Education Credits - Credits. |
Uploads Data
|
uploadsData | array of object |
Event Locations - Uploads Data |
Title
|
uploadsData.title | string |
Uploads - Title. |
Document Type
|
uploadsData.documentType | string |
Uploads - Document Type. |
Description
|
uploadsData.description | string |
Uploads - Description. |
Extension
|
uploadsData.extension | string |
Uploads - Extension. |
Url
|
uploadsData.url | string |
Uploads - Url. |
Related Products
|
relatedProducts | array of object |
Event Locations - Related Products. |
Is Required
|
relatedProducts.isRequired | boolean |
Related Products - Is Required. |
ID
|
relatedProducts.id | string |
Related Products - ID. |
Code
|
relatedProducts.code | string |
Related Products - Code. |
Name
|
relatedProducts.name | string |
Related Products - Name. |
Short Description
|
relatedProducts.shortDescription | string |
Related Products - Short Description. |
Long Description
|
relatedProducts.longDescription | string |
Related Products - Long Description. |
Type
|
relatedProducts.type | string |
Related Products - Type. |
Url
|
relatedProducts.url | string |
Related Products - Url. |
Image Url
|
relatedProducts.imageUrl | array of string |
Related Products - Image Url. |
Is Public
|
relatedProducts.isPublic | boolean |
Related Products - Is Public. |
Available From
|
relatedProducts.availableFrom | string |
Related Products - Available From. |
Available Until
|
relatedProducts.availableUntil | string |
Related Products - Available Until. |
Tags
|
tags | array of string |
Event Locations - Tags |
Name | Path | Type | Description |
---|---|---|---|
Phone ID
|
id | string |
ID. |
Is Primary Phone
|
primary | boolean |
Is Primary. |
Type
|
type | integer |
Type. |
Country ID
|
country.id | string |
Country - Country ID. |
Country Name
|
country.name | string |
Country - Country Name. |
Two Letter ISO Code
|
country.twoLetterIsoCode | string |
Country - Two Letter ISO Code. |
Three Letter ISO Code
|
country.threeLetterIsoCode | string |
Country - Three Letter ISO Code. |
Country Code
|
country.code | integer |
Country - Country Code. |
Show In Directory
|
showInDirectory | boolean |
Show In Directory. |
Number
|
number | string |
Number. |
Extension
|
extension | string |
Extension. |
Type Name
|
typeName | string |
Type Name. |
Email Data.
Name | Path | Type | Description |
---|---|---|---|
Is Primary Email
|
primary | boolean |
Is Primary Email. |
Address
|
address | string |
Address. |
Type
|
type | string |
Type. |
Show In Directory
|
showInDirectory | boolean |
Show In Directory. |
Address Save Data.
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
ID. |
Primary
|
primary | boolean |
Primary. |
Line 1
|
line1 | string |
Line 1. |
Line 2
|
line2 | string |
Line 2. |
Line 3
|
line3 | string |
Line 3. |
City
|
city | string |
City. |
State
|
state | string |
State. |
Zip Code
|
zipcode | string |
Zipcode. |
Country
|
country | string |
Country. |
Type
|
type | string |
Type. |
Show In Directory
|
showInDirectory | boolean |
Show In Directory. |
Is Preferred Shipping
|
isPreferredShipping | boolean |
Is Preferred Shipping. |
Is Preferred Billing
|
isPreferredBilling | boolean |
Is Preferred Billing. |
Is Bad Address
|
isBadAddress | boolean |
Is Bad Address. |
Name | Path | Type | Description |
---|---|---|---|
First Name
|
firstName | string |
First Name. |
Last Name
|
lastName | string |
Last Name. |
Middle Name
|
middleName | string |
Middle Name. |
Preferred First Name
|
preferredFirstName | string |
Preferred First Name. |
Second Last Name
|
secondLastName | string |
Second Last Name. |
Prefix
|
prefix | string |
Prefix. |
Suffix
|
suffix | string |
Suffix. |
Gender
|
gender | string |
Gender. |
ContactIds
|
primaryOrganization.contactIds | array of uuid |
Primary Organization - Contact Ids. |
Parent Company Id
|
primaryOrganization.parentCompanyId | uuid |
Primary Organization - Parent Company Id. |
Description
|
primaryOrganization.description | string |
Primary Organization - Description. |
Branch Name
|
primaryOrganization.branchName | string |
Primary Organization - Branch Name. |
Tags
|
primaryOrganization.tags | array of string |
Primary Organization - Tags. |
Primary Organization Id
|
primaryOrganization.id | uuid |
Primary Organization Id. |
CustomerType
|
primaryOrganization.customerType | string |
Primary Organization - Customer Type. |
Record Number
|
primaryOrganization.recordNumber | string |
Primary Organization - Record Number. |
Title
|
primaryOrganization.title | string |
Primary Organization - Title. |
Name
|
primaryOrganization.name | string |
Primary Organization - Name. |
addresses
|
primaryOrganization.addresses | array of object |
Primary Organization - Addresses. |
Address Id
|
primaryOrganization.addresses.id | uuid |
Primary Organization - Addresses - Id. |
Is Primary Address
|
primaryOrganization.addresses.primary | boolean |
Primary Organization - Addresses - Is Primary. |
Address Line 1
|
primaryOrganization.addresses.line1 | string |
Primary Organization - Addresses - Line 1. |
Address Line 2
|
primaryOrganization.addresses.line2 | string |
Primary Organization - Addresses - Line 2. |
Address Line 3
|
primaryOrganization.addresses.line3 | string |
Primary Organization - Addresses - Line 3. |
City
|
primaryOrganization.addresses.city | string |
Primary Organization - Addresses - City. |
State
|
primaryOrganization.addresses.state | string |
Primary Organization - Addresses - State. |
Zip Code
|
primaryOrganization.addresses.zipcode | string |
Primary Organization - Addresses - Zip Code. |
Country
|
primaryOrganization.addresses.country | string |
Primary Organization - Addresses - Country. |
State Abbreviation
|
primaryOrganization.addresses.stateAbbreviation | string |
Primary Organization - Addresses - State Abbreviation. |
State ISO Code
|
primaryOrganization.addresses.stateISOCode | string |
Primary Organization - Addresses - State ISO Code. |
Type
|
primaryOrganization.addresses.type | string |
Primary Organization - Addresses - Type. |
Region
|
primaryOrganization.addresses.region | string |
Primary Organization - Addresses - Region. |
Latitude
|
primaryOrganization.addresses.latitude | number |
Primary Organization - Addresses - Latitude. |
Longitude
|
primaryOrganization.addresses.longitude | number |
Primary Organization - Addresses - Longitude. |
Show In Directory
|
primaryOrganization.addresses.showInDirectory | boolean |
Primary Organization - Addresses - Show In Directory. |
Congressional District
|
primaryOrganization.addresses.congressionalDistrict | string |
Primary Organization - Addresses - Congressional District. |
Country Id
|
primaryOrganization.addresses.countryData.id | string |
Primary Organization - Addresses - Country - Id. |
Country Name
|
primaryOrganization.addresses.countryData.name | string |
Primary Organization - Addresses - Country - Name. |
Two Letter ISO Code
|
primaryOrganization.addresses.countryData.twoLetterIsoCode | string |
Primary Organization - Addresses - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
primaryOrganization.addresses.countryData.threeLetterIsoCode | string |
Primary Organization - Addresses - Country - Three Letter ISO Code. |
Country Code
|
primaryOrganization.addresses.countryData.code | integer |
Primary Organization - Addresses - Country - Code. |
Email
|
primaryOrganization.email |
Primary Organization - Email. |
|
Image URI
|
primaryOrganization.imageUri | uri |
Primary Organization - Image URI. |
Twitter
|
primaryOrganization.twitter | uri |
Primary Organization - Twitter. |
LinkedIn
|
primaryOrganization.linkedIn | uri |
Primary Organization - LinkedIn. |
emails
|
primaryOrganization.emails | array of object |
Primary Organization - Emails. |
Is Primary Email
|
primaryOrganization.emails.primary | boolean |
Primary Organization - Emails - Is Primary. |
Address
|
primaryOrganization.emails.address | string |
Primary Organization - Emails - Address. |
Type
|
primaryOrganization.emails.type | string |
Primary Organization - Emails - Type. |
Show In Directory
|
primaryOrganization.emails.showInDirectory | boolean |
Primary Organization - Emails - Show In Directory. |
phones
|
primaryOrganization.phones | array of object |
Primary Organization - Phones. |
Phone Id
|
primaryOrganization.phones.id | uuid |
Primary Organization - Phones - Id. |
Is Primary Phone
|
primaryOrganization.phones.primary | boolean |
Primary Organization - Phones - Is Primary. |
Type
|
primaryOrganization.phones.type | integer |
Primary Organization - Phones - Type. |
Country Id
|
primaryOrganization.phones.country.id | uuid |
Primary Organization - Phones - Country - Id. |
Country Name
|
primaryOrganization.phones.country.name | string |
Primary Organization - Phones - Country - Name. |
Two Letter ISO Code
|
primaryOrganization.phones.country.twoLetterIsoCode | string |
Primary Organization - Phones - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
primaryOrganization.phones.country.threeLetterIsoCode | string |
Primary Organization - Phones - Country - Three Letter ISO Code. |
Country Code
|
primaryOrganization.phones.country.code | integer |
Primary Organization - Phones - Country - Code. |
Show In Directory
|
primaryOrganization.phones.showInDirectory | boolean |
Primary Organization - Phones - Show In Directory. |
Phone Number
|
primaryOrganization.phones.number | string |
Primary Organization - Phones - Number. |
Extension
|
primaryOrganization.phones.extension | string |
Primary Organization - Phones - Extension. |
Type Name
|
primaryOrganization.phones.typeName | string |
Primary Organization - Phones - Type Name. |
Website
|
primaryOrganization.webSite | uri |
Primary Organization - Website. |
memberships
|
primaryOrganization.memberships | array of object |
Primary Organization - Memberships. |
Membership Type
|
primaryOrganization.memberships.membershipType | string |
Primary Organization - Memberships - Membership Type. |
Membership Type Id
|
primaryOrganization.memberships.membershipTypeId | uuid |
Primary Organization - Memberships - Membership Type Id. |
Code
|
primaryOrganization.memberships.code | string |
Primary Organization - Memberships - Code. |
Expire Date
|
primaryOrganization.memberships.expireDate | date-time |
Primary Organization - Memberships - Expire Date. |
Grace Expire Date
|
primaryOrganization.memberships.graceExpireDate | date-time |
Primary Organization - Memberships - Grace Expire Date. |
Inherited Membership Benefits
|
primaryOrganization.memberships.inheritedMembershipBenefits | boolean |
Primary Organization - Memberships - Inherited Membership Benefits. |
Renewal URL
|
primaryOrganization.memberships.renewalUrl | string |
Primary Organization - Memberships - Renewal URL. |
Join Date
|
primaryOrganization.memberships.joinDate | date-time |
Primary Organization - Memberships - Join Date. |
Terminate Date
|
primaryOrganization.memberships.terminateDate | date-time |
Primary Organization - Memberships - Terminate Date. |
Effective Date
|
primaryOrganization.memberships.effectiveDate | date-time |
Primary Organization - Memberships - Effective Date. |
Category
|
primaryOrganization.category | string |
Primary Organization - Category. |
categories
|
primaryOrganization.categories | array of object |
Primary Organization - Categories. |
subCategories
|
primaryOrganization.categories.subCategories | array of object |
Primary Organization - Categories - Subcategories. |
Code
|
primaryOrganization.categories.subCategories.code | string |
Primary Organization - Categories - Subcategories - Code. |
Name
|
primaryOrganization.categories.subCategories.name | string |
Primary Organization - Categories - Subcategories - Name. |
Code
|
primaryOrganization.categories.code | string |
Primary Organization - Categories - Code. |
Name
|
primaryOrganization.categories.name | string |
Primary Organization - Categories - Name. |
customFields
|
primaryOrganization.customFields | array of object |
Primary Organization - Custom Fields. |
Name
|
primaryOrganization.customFields.name | string |
Primary Organization - Custom Fields - Name. |
Caption
|
primaryOrganization.customFields.caption | string |
Primary Organization - Custom Fields - Caption. |
Value
|
primaryOrganization.customFields.value | string |
Primary Organization - Custom Fields - Value. |
Show In Directory
|
primaryOrganization.showInDirectory | boolean |
Primary Organization - Show In Directory. |
links
|
primaryOrganization.links | array of object |
Primary Organization - Links. |
Type
|
primaryOrganization.links.type | string |
Primary Organization - Links - Type. |
URL
|
primaryOrganization.links.url | uri |
Primary Organization - Links - URL. |
Old Id
|
primaryOrganization.oldId | string |
Primary Organization - Old Id. |
committees
|
committees | array of object |
Committees. |
Name
|
committees.committee.name | string |
Committees - Committee - Name. |
Code
|
committees.committee.code | string |
Committees - Committee - Code. |
Website
|
committees.committee.website | string |
Committees - Committee - Website. |
Id
|
committees.committee.id | uuid |
Committees - Committee - Id. |
Parent Committee Id
|
committees.committee.parentCommitteeId | uuid |
Committees - Committee - Parent Committee Id. |
Category Name
|
committees.committee.categoryName | string |
Committees - Committee - Category Name. |
Category Code
|
committees.committee.categoryCode | string |
Committees - Committee - Category Code. |
Description
|
committees.committee.description | string |
Committees - Committee - Description. |
Start Date
|
committees.committee.startDate | date-time |
Committees - Committee - Start Date. |
Committee End Date
|
committees.committee.endDate | date-time |
Committees - Committee - End Date. |
Show In Directory
|
committees.committee.showInDirectory | boolean |
Committees - Committee - Show In Directory. |
Term
|
committees.committee.term.term | integer |
Committees - Committee - Term - Term. |
Start Date
|
committees.committee.term.startDate | date-time |
Committees - Committee - Term - Start Date. |
End Date
|
committees.committee.term.endDate | date-time |
Committees - Committee - Term - End Date. |
Show In Directory
|
committees.committee.term.showInDirectory | boolean |
Committees - Committee - Term - Show In Directory. |
Tags
|
committees.committee.tags | array of string |
Committees - Committee - Tags. |
Position
|
committees.position | string |
Committees - Position. |
Position Code
|
committees.positionCode | string |
Committees - Position Code. |
Code
|
committees.code | string |
Committees - Code. |
Start Date
|
committees.startDate | date-time |
Committees - Start Date. |
End Date
|
committees.endDate | date-time |
Committees - End Date. |
securityRoles
|
securityRoles | array of object |
Security Roles. |
Name
|
securityRoles.name | string |
Security Roles - Name. |
Login Email
|
user.loginEmail | string |
User - Login Email. |
Must Change Password
|
user.mustChangePassword | boolean |
User - Must Change Password. |
Is Approved
|
user.isApproved | boolean |
User - Is Approved. |
designationData
|
designationData | array of object |
Designations. |
Name
|
designationData.name | string |
Designations - Name. |
jobRoles
|
jobRoles | array of object |
Job Roles. |
Code
|
jobRoles.code | string |
Job Roles - Code. |
Name
|
jobRoles.name | string |
Job Roles - Name. |
Tags
|
tags | array of string |
Tags. |
Individual Id
|
id | uuid |
Individual Id. |
Customer Type
|
customerType | string |
Customer Type. |
Record Number
|
recordNumber | string |
Record Number. |
Title
|
title | string |
Title. |
Name
|
name | string |
Name. |
addresses
|
addresses | array of object |
Addresses. |
Address Id
|
addresses.id | uuid |
Addresses - Id. |
Is Primary Address
|
addresses.primary | boolean |
Addresses - Is Primary. |
Address Line 1
|
addresses.line1 | string |
Addresses - Line 1. |
Address Line 2
|
addresses.line2 | string |
Addresses - Line 2. |
Address Line 3
|
addresses.line3 | string |
Addresses - Line 3. |
City
|
addresses.city | string |
Addresses - City. |
State
|
addresses.state | string |
Addresses - State. |
Zip Code
|
addresses.zipcode | string |
Addresses - Zip Code. |
Country
|
addresses.country | string |
Addresses - Country. |
State Abbreviation
|
addresses.stateAbbreviation | string |
Addresses - State Abbreviation. |
State ISO Code
|
addresses.stateISOCode | string |
Addresses - State ISO Code. |
Type
|
addresses.type | string |
Addresses - Type. |
Region
|
addresses.region | string |
Addresses - Region. |
Latitude
|
addresses.latitude | number |
Addresses - Latitude. |
Longitude
|
addresses.longitude | number |
Addresses - Longitude. |
Show In Directory
|
addresses.showInDirectory | boolean |
Addresses - Show In Directory. |
Congressional District
|
addresses.congressionalDistrict | string |
Addresses - Congressional District. |
Country Id
|
addresses.countryData.id | uuid |
Addresses - Country - Id. |
Country Name
|
addresses.countryData.name | string |
Addresses - Country - Name. |
Two Letter ISO Code
|
addresses.countryData.twoLetterIsoCode | string |
Addresses - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
addresses.countryData.threeLetterIsoCode | string |
Addresses - Country - Three Letter ISO Code. |
Country Code
|
addresses.countryData.code | integer |
Addresses - Country - Code. |
Email
|
Email. |
||
Image URI
|
imageUri | uri |
Image URI. |
Twitter
|
uri |
Twitter. |
|
LinkedIn
|
uri |
LinkedIn. |
|
emails
|
emails | array of object |
Emails. |
Is Primary Email
|
emails.primary | boolean |
Emails - Is Primary. |
Address
|
emails.address | string |
Emails - Address. |
Type
|
emails.type | string |
Emails - Type. |
Show In Directory
|
emails.showInDirectory | boolean |
Emails - Show In Directory. |
phones
|
phones | array of object |
Phones. |
Phone Id
|
phones.id | string |
Phones - Id. |
Is Primary Phone
|
phones.primary | boolean |
Phones - Is Primary. |
Type
|
phones.type | integer |
Phones - Type. |
Country Id
|
phones.country.id | string |
Phones - Country - Id. |
Country Name
|
phones.country.name | string |
Phones - Country - Name. |
Two Letter ISO Code
|
phones.country.twoLetterIsoCode | string |
Phones - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
phones.country.threeLetterIsoCode | string |
Phones - Country - Three Letter ISO Code. |
Country Code
|
phones.country.code | integer |
Phones - Country - Code. |
Show In Directory
|
phones.showInDirectory | boolean |
Phones - Show In Directory. |
Number
|
phones.number | string |
Phones - Number. |
Extension
|
phones.extension | string |
Phones - Extension. |
Type Name
|
phones.typeName | string |
Phones - Type Name. |
Website
|
webSite | uri |
Website. |
memberships
|
memberships | array of object |
Memberships. |
Membership Type
|
memberships.membershipType | string |
Memberships - Membership Type. |
Membership Type Id
|
memberships.membershipTypeId | string |
Memberships - Membership Type Id. |
Code
|
memberships.code | string |
Memberships - Code. |
Expire Date
|
memberships.expireDate | date-time |
Memberships - Expire Date. |
Grace Expire Date
|
memberships.graceExpireDate | date-time |
Memberships - Grace Expire Date. |
Inherited Membership Benefits
|
memberships.inheritedMembershipBenefits | boolean |
Memberships - Inherited Membership Benefits. |
Renewal URL
|
memberships.renewalUrl | string |
Memberships - Renewal URL. |
Join Date
|
memberships.joinDate | date-time |
Memberships - Join Date. |
Terminate Date
|
memberships.terminateDate | date-time |
Memberships - Terminate Date. |
Effective Date
|
memberships.effectiveDate | date-time |
Memberships - Effective Date. |
Category
|
category | string |
Category. |
categories
|
categories | array of object |
Categories. |
subCategories
|
categories.subCategories | array of object |
Categories - Subcategories. |
Code
|
categories.subCategories.code | string |
Categories - Subcategories - Code. |
Name
|
categories.subCategories.name | string |
Categories - Subcategories - Name. |
Code
|
categories.code | string |
Categories - Code. |
Name
|
categories.name | string |
Categories - Name. |
customFields
|
customFields | array of object |
Custom Fields. |
Name
|
customFields.name | string |
Custom Fields - Name. |
Caption
|
customFields.caption | string |
Custom Fields - Caption. |
Value
|
customFields.value | string |
Custom Fields - Value. |
Show In Directory
|
showInDirectory | boolean |
Show In Directory. |
links
|
links | array of object |
Links. |
Type
|
links.type | string |
Links - Type. |
URL
|
links.url | string |
Links - URL. |
Old Id
|
oldId | string |
Old Id. |
Is Deceased
|
isDeceased | boolean |
Is Deceased. |
Individual Payload.
Name | Path | Type | Description |
---|---|---|---|
Webhook Id
|
WebhookId | uuid |
Webhook Id. |
Date
|
Properties.Date | date-time |
Properties - Date. |
Notifications
|
Notifications | array of object |
Notifications. |
Action
|
Notifications.Action | string |
Notifications - Action. |
Individual Id
|
Notifications.IndividualId | uuid |
Notifications - Individual Id. |
Record Number
|
Notifications.RecordNumber | string |
Notifications - Record Number. |
First Name
|
Notifications.FirstName | string |
Notifications - First Name. |
Last Name
|
Notifications.LastName | string |
Notifications - Last Name. |
Email Address
|
Notifications.EmailAddress |
Notifications - Email Address. |
Name | Path | Type | Description |
---|---|---|---|
contactIds
|
contactIds | array of string |
Contact Ids. |
Parent Company Id
|
parentCompanyId | uuid |
Parent Company Id. |
Description
|
description | string |
Description. |
Branch Name
|
branchName | string |
Branch Name. |
tags
|
tags | array of string |
Tags. |
Organization Id
|
id | uuid |
Organization Id. |
Customer Type
|
customerType | string |
Customer Type. |
Record Number
|
recordNumber | string |
Record Number. |
Title
|
title | string |
Title. |
Organization Name
|
name | string |
Organization Name. |
addresses
|
addresses | array of object |
Addresses. |
Address Id
|
addresses.id | uuid |
Addresses - Address Id. |
Is Primary Address
|
addresses.primary | boolean |
Addresses - Is Primary. |
Address Line 1
|
addresses.line1 | string |
Addresses - Line 1. |
Address Line 2
|
addresses.line2 | string |
Addresses - Line 2. |
Address Line 3
|
addresses.line3 | string |
Addresses - Line 3. |
City
|
addresses.city | string |
Addresses - City. |
State
|
addresses.state | string |
Addresses - State. |
Zip Code
|
addresses.zipcode | string |
Addresses - Zip Code. |
Country
|
addresses.country | string |
Addresses - Country. |
State Abbreviation
|
addresses.stateAbbreviation | string |
Addresses - State Abbreviation. |
State ISO Code
|
addresses.stateISOCode | string |
Addresses - State ISO Code. |
Type
|
addresses.type | string |
Addresses - Type. |
Region
|
addresses.region | string |
Addresses - Region. |
Latitude
|
addresses.latitude | number |
Addresses - Latitude. |
Longitude
|
addresses.longitude | number |
Addresses - Longitude. |
Show In Directory
|
addresses.showInDirectory | boolean |
Addresses - Show In Directory. |
Congressional District
|
addresses.congressionalDistrict | string |
Addresses - Congressional District. |
Country Id
|
addresses.countryData.id | uuid |
Addresses - Country - Country Id. |
Country Name
|
addresses.countryData.name | string |
Addresses - Country - Country Name. |
Two Letter ISO Code
|
addresses.countryData.twoLetterIsoCode | string |
Addresses - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
addresses.countryData.threeLetterIsoCode | string |
Addresses - Country - Three Letter ISO Code. |
Country Code
|
addresses.countryData.code | integer |
Addresses - Country - Country Code. |
Email
|
Email. |
||
Image URI
|
imageUri | uri |
Image URI. |
Twitter
|
uri |
Twitter. |
|
LinkedIn
|
uri |
LinkedIn. |
|
emails
|
emails | array of object |
Emails. |
Is Primary Email
|
emails.primary | boolean |
Emails - Is Primary. |
Email Address
|
emails.address |
Emails - Email Address. |
|
Type
|
emails.type | string |
Emails - Type. |
Show In Directory
|
emails.showInDirectory | boolean |
Emails - Show In Directory. |
phones
|
phones | array of object |
Phones. |
Phone Id
|
phones.id | uuid |
Phones - Phone Id. |
Is Primary Phone
|
phones.primary | boolean |
Phones - Is Primary. |
Type
|
phones.type | integer |
Phones - Type. |
Country Id
|
phones.country.id | uuid |
Phones - Country - Country Id. |
Country Name
|
phones.country.name | string |
Phones - Country - Country Name. |
Two Letter ISO Code
|
phones.country.twoLetterIsoCode | string |
Phones - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
phones.country.threeLetterIsoCode | string |
Phones - Country - Three Letter ISO Code. |
Country Code
|
phones.country.code | integer |
Phones - Country - Country Code. |
Show In Directory
|
phones.showInDirectory | boolean |
Phones - Show In Directory. |
Phone Number
|
phones.number | string |
Phones - Phone Number. |
Extension
|
phones.extension | string |
Phones - Extension. |
Type Name
|
phones.typeName | string |
Phones - Type Name. |
Website
|
webSite | uri |
Website. |
memberships
|
memberships | array of object |
Memberships. |
Membership Type
|
memberships.membershipType | string |
Memberships - Membership Type. |
Membership Type Id
|
memberships.membershipTypeId | uuid |
Memberships - Membership Type Id. |
Membership Type Code
|
memberships.code | string |
Memberships - Membership Type Code. |
Expire Date
|
memberships.expireDate | date-time |
Memberships - Expire Date. |
Grace Expire Date
|
memberships.graceExpireDate | date-time |
Memberships - Grace Expire Date. |
Inherited Membership Benefits
|
memberships.inheritedMembershipBenefits | boolean |
Memberships - Inherited Membership Benefits. |
Renewal URL
|
memberships.renewalUrl | uri |
Memberships - Renewal URL. |
Join Date
|
memberships.joinDate | date-time |
Memberships - Join Date. |
Terminate Date
|
memberships.terminateDate | date-time |
Memberships - Terminate Date. |
Effective Date
|
memberships.effectiveDate | date-time |
Memberships - Effective Date. |
Category
|
category | string |
Category. |
categories
|
categories | array of object |
Categories. |
subCategories
|
categories.subCategories | array of object |
Categories - Subcategories. |
Subcategory Code
|
categories.subCategories.code | string |
Categories - Subcategories - Subcategory Code. |
Subcategory Name
|
categories.subCategories.name | string |
Categories - Subcategories - Subcategory Name. |
Category Code
|
categories.code | string |
Categories - Category Code. |
Category Name
|
categories.name | string |
Categories - Category Name. |
customFields
|
customFields | array of object |
Custom Fields. |
Name
|
customFields.name | string |
Custom Fields - Name. |
Caption
|
customFields.caption | string |
Custom Fields - Caption. |
Value
|
customFields.value | string |
Custom Fields - Value. |
Show In Directory
|
showInDirectory | boolean |
Show In Directory. |
links
|
links | array of object |
Links. |
Type
|
links.type | string |
Links - Type. |
URL
|
links.url | uri |
Links - URL. |
Old Id
|
oldId | string |
Old Id. |
Committee Member Payload.
Name | Path | Type | Description |
---|---|---|---|
Webhook Id
|
WebhookId | uuid |
Webhook Id. |
Date
|
Properties.Date | date-time |
Properties - Date. |
Notifications
|
Notifications | array of object |
Notifications. |
Action
|
Notifications.Action | string |
Notifications - Action. |
Customer Id
|
Notifications.CustomerId | uuid |
Notifications - Customer Id. |
Action Type
|
Notifications.ActionType | string |
Notifications - Action Type. |
Customer Type
|
Notifications.CustomerType | string |
Notifications - Customer Type. |
Record Number
|
Notifications.RecordNumber | string |
Notifications - Record Number. |
Committee Code
|
Notifications.CommitteeCode | string |
Notifications - Committee Code. |
Committee Name
|
Notifications.CommitteeName | string |
Notifications - Committee Name. |
Position Code
|
Notifications.PositionCode | string |
Notifications - Position Code. |
Position Name
|
Notifications.PositionName | string |
Notifications - Position Name. |
Start Date
|
Notifications.StartDate | date-time |
Notifications - Start Date. |
End Date
|
Notifications.EndDate | date-time |
Notifications - End Date. |
Old Customer Id
|
Notifications.Old.CustomerId | uuid |
Notifications - Old - Customer Id. |
Old Action Type
|
Notifications.Old.ActionType | string |
Notifications - Old - Action Type. |
Old Customer Type
|
Notifications.Old.CustomerType | string |
Notifications - Old - Customer Type. |
Old Record Number
|
Notifications.Old.RecordNumber | string |
Notifications - Old - Record Number. |
Old Committee Code
|
Notifications.Old.CommitteeCode | string |
Notifications - Old - Committee Code. |
Old Committee Name
|
Notifications.Old.CommitteeName | string |
Notifications - Old - Committee Name. |
Old Position Code
|
Notifications.Old.PositionCode | string |
Notifications - Old - Position Code. |
Old Position Name
|
Notifications.Old.PositionName | string |
Notifications - Old - Position Name. |
Old Start Date
|
Notifications.Old.StartDate | date-time |
Notifications - Old - Start Date. |
Old End Date
|
Notifications.Old.EndDate | date-time |
Notifications - Old - End Date. |
Purchase Canceled Payload.
Name | Path | Type | Description |
---|---|---|---|
Webhook Id
|
WebhookId | string |
Webhook Id. |
Additional Filter
|
Properties.AdditionalFilter | string |
Properties - Additional Filter. |
Date
|
Properties.Date | date-time |
Properties - Date. |
Notifications
|
Notifications | array of object |
Notifications. |
Action
|
Notifications.Action | string |
Notifications - Action. |
Order Number
|
Notifications.OrderNumber | string |
Notifications - Order Number. |
Invoice Number
|
Notifications.InvoiceNumber | string |
Notifications - Invoice Number. |
Product Code
|
Notifications.ProductCode | string |
Notifications - Product Code. |
Product Name
|
Notifications.ProductName | string |
Notifications - Product Name. |
Product Type
|
Notifications.ProductType | string |
Notifications - Product Type. |
Parent Product Code
|
Notifications.ParentProductCode | string |
Notifications - Parent Product Code. |
Quantity Canceled
|
Notifications.QuantityCancelled | integer |
Notifications - Quantity Canceled. |
Item Price
|
Notifications.ItemPrice | double |
Notifications - Item Price. |
Customer Type
|
Notifications.CustomerType | string |
Notifications - Customer Type. |
Customer Id
|
Notifications.CustomerId | uuid |
Notifications - Customer Id. |
Full Name
|
Notifications.FullName | string |
Notifications - Full Name. |
First Name
|
Notifications.FirstName | string |
Notifications - First Name. |
Last Name
|
Notifications.LastName | string |
Notifications - Last Name. |
Email Address
|
Notifications.EmailAddress |
Notifications - Email Address. |
|
Record Number
|
Notifications.RecordNumber | string |
Notifications - Record Number. |
Customer Request Payload.
Name | Path | Type | Description |
---|---|---|---|
Webhook Id
|
WebhookId | uuid |
Webhook Id,. |
Date
|
Properties.Date | date-time |
Properties - Date. |
Notifications
|
Notifications | array of object |
Notifications. |
Action
|
Notifications.Action | string |
Notifications - Action. |
Action Type
|
Notifications.ActionType | string |
Notifications - Action Type. |
Request Number
|
Notifications.RequestNumber | string |
Notifications - Request Number. |
Request Type
|
Notifications.RequestType | string |
Notifications - Request Type. |
Request Description
|
Notifications.RequestDescription | string |
Notifications - Request Description. |
Source
|
Notifications.Source | string |
Notifications - Source. |
Closed Date
|
Notifications.ClosedDate | date-time |
Notifications - Closed Date. |
Email Address
|
Notifications.EmailAddress |
Notifications - Email Address. |
|
Full Name
|
Notifications.FullName | string |
Notifications - Full Name. |
First Name
|
Notifications.FirstName | string |
Notifications - First Name. |
Last Name
|
Notifications.LastName | string |
Notifications - Last Name. |
Customer Id
|
Notifications.CustomerId | uuid |
Notifications - Customer Id. |
Customer Type
|
Notifications.CustomerType | string |
Notifications - Customer Type. |
Record Number
|
Notifications.RecordNumber | string |
Notifications - Record Number. |
Email Payload.
Name | Path | Type | Description |
---|---|---|---|
Webhook Id
|
WebhookId | uuid |
Webhook Id. |
Date
|
Properties.Date | date-time |
Properties - Date. |
Notifications
|
Notifications | array of object |
Notifications. |
Action
|
Notifications.Action | string |
Notifications - Action. |
Action Type
|
Notifications.ActionType | string |
Notifications - Action Type. |
Email Address
|
Notifications.EmailAddress |
Notifications - Email Address. |
|
Email Type
|
Notifications.EmailType | string |
Notifications - Email Type. |
Is Login Email
|
Notifications.IsLoginEmail | boolean |
Notifications - Is Login Email. |
Customer Id
|
Notifications.CustomerId | uuid |
Notifications - Customer Id. |
Customer Type
|
Notifications.CustomerType | string |
Notifications - Customer Type. |
Record Number
|
Notifications.RecordNumber | string |
Notifications - Record Number. |
Is Primary
|
Notifications.IsPrimary | boolean |
Notifications - Is Primary. |
Action Type
|
Notifications.Old.ActionType | string |
Notifications - Old - Action Type. |
Email Address
|
Notifications.Old.EmailAddress |
Notifications - Old - Email Address. |
|
Email Type
|
Notifications.Old.EmailType | string |
Notifications - Old - Email Type. |
Is Login Email
|
Notifications.Old.IsLoginEmail | boolean |
Notifications - Old - Is Login Email. |
Customer Id
|
Notifications.Old.CustomerId | uuid |
Notifications - Old - Customer Id. |
Customer Type
|
Notifications.Old.CustomerType | string |
Notifications - Old - Customer Type. |
Record Number
|
Notifications.Old.RecordNumber | string |
Notifications - Old - Record Number. |
Is Primary
|
Notifications.Old.IsPrimary | boolean |
Notifications - Old - Is Primary. |
Name | Path | Type | Description |
---|---|---|---|
Code
|
code | string |
Code. |
Name
|
name | string |
Name. |
Expire Date
|
expireDate | date-time |
Expire Date. |
Quantity
|
quantity | integer |
Quantity. |
Name | Path | Type | Description |
---|---|---|---|
Code
|
code | string |
Code. |
Name
|
name | string |
Name. |
Term
|
term | integer |
Term. |
Description
|
description | string |
Description. |
Is Admin
|
isAdmin | boolean |
Is Admin. |
Name | Path | Type | Description |
---|---|---|---|
Name
|
name | string |
Name. |
Code
|
code | string |
Code. |
Website
|
website | string |
Website. |
Id
|
id | uuid |
Id. |
Parent Committee Id
|
parentCommitteeId | uuid |
Parent Committee Id. |
Category Name
|
categoryName | string |
Category Name. |
Category Code
|
categoryCode | string |
Category Code. |
Description
|
description | string |
Description. |
Start Date
|
startDate | date-time |
Start Date. |
Committee End Date
|
endDate | date-time |
End Date. |
Show In Directory
|
showInDirectory | boolean |
Show In Directory. |
Term
|
term.term | integer |
Term - Term Number. |
Start Date
|
term.startDate | date-time |
Term - Start Date. |
End Date
|
term.endDate | date-time |
Term - End Date. |
Show In Directory
|
term.showInDirectory | boolean |
Term - Show In Directory. |
Tags
|
tags | array of string |
Tags. |
Name | Path | Type | Description |
---|---|---|---|
Awarded Date
|
awardedDate | date-time |
Awarded Date. |
First Name
|
firstName | string |
First Name. |
Last Name
|
lastName | string |
Last Name. |
Middle Name
|
middleName | string |
Middle Name. |
Preferred First Name
|
preferredFirstName | string |
Preferred First Name. |
Second Last Name
|
secondLastName | string |
Second Last Name. |
Prefix
|
prefix | string |
Prefix. |
Suffix
|
suffix | string |
Suffix. |
Gender
|
gender | string |
Gender. |
ContactIds
|
primaryOrganization.contactIds | array of uuid |
Primary Organization - Contact Ids. |
Parent Company Id
|
primaryOrganization.parentCompanyId | uuid |
Primary Organization - Parent Company Id. |
Description
|
primaryOrganization.description | string |
Primary Organization - Description. |
Branch Name
|
primaryOrganization.branchName | string |
Primary Organization - Branch Name. |
Tags
|
primaryOrganization.tags | array of string |
Primary Organization - Tags. |
Primary Organization Id
|
primaryOrganization.id | uuid |
Primary Organization Id. |
CustomerType
|
primaryOrganization.customerType | string |
Primary Organization - Customer Type. |
Record Number
|
primaryOrganization.recordNumber | string |
Primary Organization - Record Number. |
Title
|
primaryOrganization.title | string |
Primary Organization - Title. |
Name
|
primaryOrganization.name | string |
Primary Organization - Name. |
addresses
|
primaryOrganization.addresses | array of object |
Primary Organization - Addresses. |
Address Id
|
primaryOrganization.addresses.id | uuid |
Primary Organization - Addresses - Id. |
Is Primary Address
|
primaryOrganization.addresses.primary | boolean |
Primary Organization - Addresses - Is Primary. |
Address Line 1
|
primaryOrganization.addresses.line1 | string |
Primary Organization - Addresses - Line 1. |
Address Line 2
|
primaryOrganization.addresses.line2 | string |
Primary Organization - Addresses - Line 2. |
Address Line 3
|
primaryOrganization.addresses.line3 | string |
Primary Organization - Addresses - Line 3. |
City
|
primaryOrganization.addresses.city | string |
Primary Organization - Addresses - City. |
State
|
primaryOrganization.addresses.state | string |
Primary Organization - Addresses - State. |
Zip Code
|
primaryOrganization.addresses.zipcode | string |
Primary Organization - Addresses - Zip Code. |
Country
|
primaryOrganization.addresses.country | string |
Primary Organization - Addresses - Country. |
State Abbreviation
|
primaryOrganization.addresses.stateAbbreviation | string |
Primary Organization - Addresses - State Abbreviation. |
State ISO Code
|
primaryOrganization.addresses.stateISOCode | string |
Primary Organization - Addresses - State ISO Code. |
Type
|
primaryOrganization.addresses.type | string |
Primary Organization - Addresses - Type. |
Region
|
primaryOrganization.addresses.region | string |
Primary Organization - Addresses - Region. |
Latitude
|
primaryOrganization.addresses.latitude | number |
Primary Organization - Addresses - Latitude. |
Longitude
|
primaryOrganization.addresses.longitude | number |
Primary Organization - Addresses - Longitude. |
Show In Directory
|
primaryOrganization.addresses.showInDirectory | boolean |
Primary Organization - Addresses - Show In Directory. |
Congressional District
|
primaryOrganization.addresses.congressionalDistrict | string |
Primary Organization - Addresses - Congressional District. |
Country Id
|
primaryOrganization.addresses.countryData.id | string |
Primary Organization - Addresses - Country - Id. |
Country Name
|
primaryOrganization.addresses.countryData.name | string |
Primary Organization - Addresses - Country - Name. |
Two Letter ISO Code
|
primaryOrganization.addresses.countryData.twoLetterIsoCode | string |
Primary Organization - Addresses - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
primaryOrganization.addresses.countryData.threeLetterIsoCode | string |
Primary Organization - Addresses - Country - Three Letter ISO Code. |
Country Code
|
primaryOrganization.addresses.countryData.code | integer |
Primary Organization - Addresses - Country - Code. |
Email
|
primaryOrganization.email |
Primary Organization - Email. |
|
Image URI
|
primaryOrganization.imageUri | uri |
Primary Organization - Image URI. |
Twitter
|
primaryOrganization.twitter | uri |
Primary Organization - Twitter. |
LinkedIn
|
primaryOrganization.linkedIn | uri |
Primary Organization - LinkedIn. |
emails
|
primaryOrganization.emails | array of object |
Primary Organization - Emails. |
Is Primary Email
|
primaryOrganization.emails.primary | boolean |
Primary Organization - Emails - Is Primary. |
Address
|
primaryOrganization.emails.address | string |
Primary Organization - Emails - Address. |
Type
|
primaryOrganization.emails.type | string |
Primary Organization - Emails - Type. |
Show In Directory
|
primaryOrganization.emails.showInDirectory | boolean |
Primary Organization - Emails - Show In Directory. |
phones
|
primaryOrganization.phones | array of object |
Primary Organization - Phones. |
Phone Id
|
primaryOrganization.phones.id | uuid |
Primary Organization - Phones - Id. |
Is Primary Phone
|
primaryOrganization.phones.primary | boolean |
Primary Organization - Phones - Is Primary. |
Type
|
primaryOrganization.phones.type | integer |
Primary Organization - Phones - Type. |
Country Id
|
primaryOrganization.phones.country.id | uuid |
Primary Organization - Phones - Country - Id. |
Country Name
|
primaryOrganization.phones.country.name | string |
Primary Organization - Phones - Country - Name. |
Two Letter ISO Code
|
primaryOrganization.phones.country.twoLetterIsoCode | string |
Primary Organization - Phones - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
primaryOrganization.phones.country.threeLetterIsoCode | string |
Primary Organization - Phones - Country - Three Letter ISO Code. |
Country Code
|
primaryOrganization.phones.country.code | integer |
Primary Organization - Phones - Country - Code. |
Show In Directory
|
primaryOrganization.phones.showInDirectory | boolean |
Primary Organization - Phones - Show In Directory. |
Phone Number
|
primaryOrganization.phones.number | string |
Primary Organization - Phones - Number. |
Extension
|
primaryOrganization.phones.extension | string |
Primary Organization - Phones - Extension. |
Type Name
|
primaryOrganization.phones.typeName | string |
Primary Organization - Phones - Type Name. |
Website
|
primaryOrganization.webSite | uri |
Primary Organization - Website. |
memberships
|
primaryOrganization.memberships | array of object |
Primary Organization - Memberships. |
Membership Type
|
primaryOrganization.memberships.membershipType | string |
Primary Organization - Memberships - Membership Type. |
Membership Type Id
|
primaryOrganization.memberships.membershipTypeId | uuid |
Primary Organization - Memberships - Membership Type Id. |
Code
|
primaryOrganization.memberships.code | string |
Primary Organization - Memberships - Code. |
Expire Date
|
primaryOrganization.memberships.expireDate | date-time |
Primary Organization - Memberships - Expire Date. |
Grace Expire Date
|
primaryOrganization.memberships.graceExpireDate | date-time |
Primary Organization - Memberships - Grace Expire Date. |
Inherited Membership Benefits
|
primaryOrganization.memberships.inheritedMembershipBenefits | boolean |
Primary Organization - Memberships - Inherited Membership Benefits. |
Renewal URL
|
primaryOrganization.memberships.renewalUrl | string |
Primary Organization - Memberships - Renewal URL. |
Join Date
|
primaryOrganization.memberships.joinDate | date-time |
Primary Organization - Memberships - Join Date. |
Terminate Date
|
primaryOrganization.memberships.terminateDate | date-time |
Primary Organization - Memberships - Terminate Date. |
Effective Date
|
primaryOrganization.memberships.effectiveDate | date-time |
Primary Organization - Memberships - Effective Date. |
Category
|
primaryOrganization.category | string |
Primary Organization - Category. |
categories
|
primaryOrganization.categories | array of object |
Primary Organization - Categories. |
subCategories
|
primaryOrganization.categories.subCategories | array of object |
Primary Organization - Categories - Subcategories. |
Code
|
primaryOrganization.categories.subCategories.code | string |
Primary Organization - Categories - Subcategories - Code. |
Name
|
primaryOrganization.categories.subCategories.name | string |
Primary Organization - Categories - Subcategories - Name. |
Code
|
primaryOrganization.categories.code | string |
Primary Organization - Categories - Code. |
Name
|
primaryOrganization.categories.name | string |
Primary Organization - Categories - Name. |
customFields
|
primaryOrganization.customFields | array of object |
Primary Organization - Custom Fields. |
Name
|
primaryOrganization.customFields.name | string |
Primary Organization - Custom Fields - Name. |
Caption
|
primaryOrganization.customFields.caption | string |
Primary Organization - Custom Fields - Caption. |
Value
|
primaryOrganization.customFields.value | string |
Primary Organization - Custom Fields - Value. |
Show In Directory
|
primaryOrganization.showInDirectory | boolean |
Primary Organization - Show In Directory. |
links
|
primaryOrganization.links | array of object |
Primary Organization - Links. |
Type
|
primaryOrganization.links.type | string |
Primary Organization - Links - Type. |
URL
|
primaryOrganization.links.url | uri |
Primary Organization - Links - URL. |
Old Id
|
primaryOrganization.oldId | string |
Primary Organization - Old Id. |
Individual Id
|
id | uuid |
Individual Id. |
Customer Type
|
customerType | string |
Customer Type. |
Record Number
|
recordNumber | string |
Record Number. |
Title
|
title | string |
Title. |
addresses
|
addresses | array of object |
Addresses. |
Address Id
|
addresses.id | uuid |
Addresses - Id. |
Is Primary Address
|
addresses.primary | boolean |
Addresses - Is Primary. |
Address Line 1
|
addresses.line1 | string |
Addresses - Line 1. |
Address Line 2
|
addresses.line2 | string |
Addresses - Line 2. |
Address Line 3
|
addresses.line3 | string |
Addresses - Line 3. |
City
|
addresses.city | string |
Addresses - City. |
State
|
addresses.state | string |
Addresses - State. |
Zip Code
|
addresses.zipcode | string |
Addresses - Zip Code. |
Country
|
addresses.country | string |
Addresses - Country. |
State Abbreviation
|
addresses.stateAbbreviation | string |
Addresses - State Abbreviation. |
State ISO Code
|
addresses.stateISOCode | string |
Addresses - State ISO Code. |
Type
|
addresses.type | string |
Addresses - Type. |
Region
|
addresses.region | string |
Addresses - Region. |
Latitude
|
addresses.latitude | number |
Addresses - Latitude. |
Longitude
|
addresses.longitude | number |
Addresses - Longitude. |
Show In Directory
|
addresses.showInDirectory | boolean |
Addresses - Show In Directory. |
Congressional District
|
addresses.congressionalDistrict | string |
Addresses - Congressional District. |
Country Id
|
addresses.countryData.id | uuid |
Addresses - Country - Id. |
Country Name
|
addresses.countryData.name | string |
Addresses - Country - Name. |
Two Letter ISO Code
|
addresses.countryData.twoLetterIsoCode | string |
Addresses - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
addresses.countryData.threeLetterIsoCode | string |
Addresses - Country - Three Letter ISO Code. |
Country Code
|
addresses.countryData.code | integer |
Addresses - Country - Code. |
emails
|
emails | array of object |
Emails. |
Is Primary Email
|
emails.primary | boolean |
Emails - Is Primary. |
Address
|
emails.address | string |
Emails - Address. |
Type
|
emails.type | string |
Emails - Type. |
Show In Directory
|
emails.showInDirectory | boolean |
Emails - Show In Directory. |
phones
|
phones | array of object |
Phones. |
Phone Id
|
phones.id | string |
Phones - Id. |
Is Primary Phone
|
phones.primary | boolean |
Phones - Is Primary. |
Type
|
phones.type | integer |
Phones - Type. |
Country Id
|
phones.country.id | string |
Phones - Country - Id. |
Country Name
|
phones.country.name | string |
Phones - Country - Name. |
Two Letter ISO Code
|
phones.country.twoLetterIsoCode | string |
Phones - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
phones.country.threeLetterIsoCode | string |
Phones - Country - Three Letter ISO Code. |
Country Code
|
phones.country.code | integer |
Phones - Country - Code. |
Show In Directory
|
phones.showInDirectory | boolean |
Phones - Show In Directory. |
Number
|
phones.number | string |
Phones - Number. |
Extension
|
phones.extension | string |
Phones - Extension. |
Type Name
|
phones.typeName | string |
Phones - Type Name. |
Show In Directory
|
showInDirectory | boolean |
Show In Directory. |
Name | Path | Type | Description |
---|---|---|---|
Awarded Date
|
awardedDate | date-time |
Awarded Date. |
Organization Name
|
name | string |
Organization Name. |
Acronym
|
acronym | string |
Acronym. |
Branch Name
|
branchName | string |
Branch Name. |
Annual Sales
|
annualSales | double |
Annual Sales. |
Employee Range Id
|
employeeRangeId | uuid |
Employee Range Id. |
Organization Id
|
id | uuid |
Organization Id. |
Customer Type
|
customerType | string |
Customer Type. |
Record Number
|
recordNumber | string |
Record Number. |
Show In Directory
|
showInDirectory | boolean |
Show In Directory. |
addresses
|
addresses | array of object |
Addresses. |
Address Id
|
addresses.id | uuid |
Addresses - Address Id. |
Is Primary Address
|
addresses.primary | boolean |
Addresses - Is Primary. |
Address Line 1
|
addresses.line1 | string |
Addresses - Line 1. |
Address Line 2
|
addresses.line2 | string |
Addresses - Line 2. |
Address Line 3
|
addresses.line3 | string |
Addresses - Line 3. |
City
|
addresses.city | string |
Addresses - City. |
State
|
addresses.state | string |
Addresses - State. |
Zip Code
|
addresses.zipcode | string |
Addresses - Zip Code. |
Country
|
addresses.country | string |
Addresses - Country. |
State Abbreviation
|
addresses.stateAbbreviation | string |
Addresses - State Abbreviation. |
State ISO Code
|
addresses.stateISOCode | string |
Addresses - State ISO Code. |
Type
|
addresses.type | string |
Addresses - Type. |
Region
|
addresses.region | string |
Addresses - Region. |
Latitude
|
addresses.latitude | number |
Addresses - Latitude. |
Longitude
|
addresses.longitude | number |
Addresses - Longitude. |
Show In Directory
|
addresses.showInDirectory | boolean |
Addresses - Show In Directory. |
Congressional District
|
addresses.congressionalDistrict | string |
Addresses - Congressional District. |
Country Id
|
addresses.countryData.id | uuid |
Addresses - Country - Country Id. |
Country Name
|
addresses.countryData.name | string |
Addresses - Country - Country Name. |
Two Letter ISO Code
|
addresses.countryData.twoLetterIsoCode | string |
Addresses - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
addresses.countryData.threeLetterIsoCode | string |
Addresses - Country - Three Letter ISO Code. |
Country Code
|
addresses.countryData.code | integer |
Addresses - Country - Country Code. |
emails
|
emails | array of object |
Emails. |
Is Primary Email
|
emails.primary | boolean |
Emails - Is Primary. |
Email Address
|
emails.address |
Emails - Email Address. |
|
Type
|
emails.type | string |
Emails - Type. |
Show In Directory
|
emails.showInDirectory | boolean |
Emails - Show In Directory. |
phones
|
phones | array of object |
Phones. |
Phone Id
|
phones.id | uuid |
Phones - Phone Id. |
Is Primary Phone
|
phones.primary | boolean |
Phones - Is Primary. |
Type
|
phones.type | integer |
Phones - Type. |
Country Id
|
phones.country.id | uuid |
Phones - Country - Country Id. |
Country Name
|
phones.country.name | string |
Phones - Country - Country Name. |
Two Letter ISO Code
|
phones.country.twoLetterIsoCode | string |
Phones - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
phones.country.threeLetterIsoCode | string |
Phones - Country - Three Letter ISO Code. |
Country Code
|
phones.country.code | integer |
Phones - Country - Country Code. |
Show In Directory
|
phones.showInDirectory | boolean |
Phones - Show In Directory. |
Phone Number
|
phones.number | string |
Phones - Phone Number. |
Extension
|
phones.extension | string |
Phones - Extension. |
Type Name
|
phones.typeName | string |
Phones - Type Name. |
Name | Path | Type | Description |
---|---|---|---|
Organization Name
|
name | string |
Organization Name. |
Acronym
|
acronym | string |
Acronym. |
Branch Name
|
branchName | string |
Branch Name. |
Employee Range Id
|
employeeRangeId | uuid |
Employee Range Id. |
Organization Id
|
id | uuid |
Organization Id. |
Record Number
|
recordNumber | string |
Record Number. |
addresses
|
addresses | array of object |
Addresses. |
Address Id
|
addresses.id | uuid |
Addresses - Address Id. |
Is Primary Address
|
addresses.primary | boolean |
Addresses - Is Primary. |
Address Line 1
|
addresses.line1 | string |
Addresses - Line 1. |
Address Line 2
|
addresses.line2 | string |
Addresses - Line 2. |
Address Line 3
|
addresses.line3 | string |
Addresses - Line 3. |
City
|
addresses.city | string |
Addresses - City. |
State
|
addresses.state | string |
Addresses - State. |
Zip Code
|
addresses.zipcode | string |
Addresses - Zip Code. |
Country
|
addresses.country | string |
Addresses - Country. |
State Abbreviation
|
addresses.stateAbbreviation | string |
Addresses - State Abbreviation. |
State ISO Code
|
addresses.stateISOCode | string |
Addresses - State ISO Code. |
Type
|
addresses.type | string |
Addresses - Type. |
Region
|
addresses.region | string |
Addresses - Region. |
Latitude
|
addresses.latitude | number |
Addresses - Latitude. |
Longitude
|
addresses.longitude | number |
Addresses - Longitude. |
Show In Directory
|
addresses.showInDirectory | boolean |
Addresses - Show In Directory. |
Congressional District
|
addresses.congressionalDistrict | string |
Addresses - Congressional District. |
Country Id
|
addresses.countryData.id | uuid |
Addresses - Country - Country Id. |
Country Name
|
addresses.countryData.name | string |
Addresses - Country - Country Name. |
Two Letter ISO Code
|
addresses.countryData.twoLetterIsoCode | string |
Addresses - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
addresses.countryData.threeLetterIsoCode | string |
Addresses - Country - Three Letter ISO Code. |
Country Code
|
addresses.countryData.code | integer |
Addresses - Country - Country Code. |
Name | Path | Type | Description |
---|---|---|---|
First Name
|
firstName | string |
First Name. |
Last Name
|
lastName | string |
Last Name. |
Middle Name
|
middleName | string |
Middle Name. |
Preferred First Name
|
preferredFirstName | string |
Preferred First Name. |
Second Last Name
|
secondLastName | string |
Second Last Name. |
Prefix
|
prefix | string |
Prefix. |
Suffix
|
suffix | string |
Suffix. |
Gender
|
gender | string |
Gender. |
Title
|
title | string |
Title. |
Organization Name
|
primaryOrganization.name | string |
Primary Organization - Organization Name. |
Acronym
|
primaryOrganization.acronym | string |
Primary Organization - Acronym. |
Branch Name
|
primaryOrganization.branchName | string |
Primary Organization - Branch Name. |
Employee Range Id
|
primaryOrganization.employeeRangeId | uuid |
Primary Organization - Employee Range Id. |
Organization Id
|
primaryOrganization.id | uuid |
Primary Organization - Organization Id. |
Record Number
|
primaryOrganization.recordNumber | string |
Primary Organization - Record Number. |
addresses
|
primaryOrganization.addresses | array of object |
Primary Organization - Addresses. |
Address Id
|
primaryOrganization.addresses.id | uuid |
Primary Organization - Addresses - Address Id. |
Is Primary Address
|
primaryOrganization.addresses.primary | boolean |
Primary Organization - Addresses - Is Primary. |
Address Line 1
|
primaryOrganization.addresses.line1 | string |
Primary Organization - Addresses - Line 1. |
Address Line 2
|
primaryOrganization.addresses.line2 | string |
Primary Organization - Addresses - Line 2. |
Address Line 3
|
primaryOrganization.addresses.line3 | string |
Primary Organization - Addresses - Line 3. |
City
|
primaryOrganization.addresses.city | string |
Primary Organization - Addresses - City. |
State
|
primaryOrganization.addresses.state | string |
Primary Organization - Addresses - State. |
Zip Code
|
primaryOrganization.addresses.zipcode | string |
Primary Organization - Addresses - Zip Code. |
Country
|
primaryOrganization.addresses.country | string |
Primary Organization - Addresses - Country. |
State Abbreviation
|
primaryOrganization.addresses.stateAbbreviation | string |
Primary Organization - Addresses - State Abbreviation. |
State ISO Code
|
primaryOrganization.addresses.stateISOCode | string |
Primary Organization - Addresses - State ISO Code. |
Type
|
primaryOrganization.addresses.type | string |
Primary Organization - Addresses - Type. |
Region
|
primaryOrganization.addresses.region | string |
Primary Organization - Addresses - Region. |
Latitude
|
primaryOrganization.addresses.latitude | number |
Primary Organization - Addresses - Latitude. |
Longitude
|
primaryOrganization.addresses.longitude | number |
Primary Organization - Addresses - Longitude. |
Show In Directory
|
primaryOrganization.addresses.showInDirectory | boolean |
Primary Organization - Addresses - Show In Directory. |
Congressional District
|
primaryOrganization.addresses.congressionalDistrict | string |
Primary Organization - Addresses - Congressional District. |
Country Id
|
primaryOrganization.addresses.countryData.id | uuid |
Primary Organization - Addresses - Country - Country Id. |
Country Name
|
primaryOrganization.addresses.countryData.name | string |
Primary Organization - Addresses - Country - Country Name. |
Two Letter ISO Code
|
primaryOrganization.addresses.countryData.twoLetterIsoCode | string |
Primary Organization - Addresses - Country - Two Letter ISO Code. |
Three Letter ISO Code
|
primaryOrganization.addresses.countryData.threeLetterIsoCode | string |
Primary Organization - Addresses - Country - Three Letter ISO Code. |
Country Code
|
primaryOrganization.addresses.countryData.code | integer |
Primary Organization - Addresses - Country - Country Code. |
Individual Id
|
id | uuid |
Individual Id. |
Record Number
|
recordNumber | string |
Record Number. |
Name | Path | Type | Description |
---|---|---|---|
Webhook Id
|
WebhookId | string |
Webhook Id. |
Additional Filter
|
Properties.AdditionalFilter | string |
Properties - Additional Filter. |
Date
|
Properties.Date | date-time |
Properties - Date. |
Notifications
|
Notifications | array of object | |
Action
|
Notifications.Action | string |
Notifications - Action. |
Customer Id
|
Notifications.CustomerId | string |
Notifications - Customer Id. |
Custom Field Name
|
Notifications.CustomFieldName | string |
Notifications - Custom Field Name. |
Custom Field Value
|
Notifications.CustomFieldValue | string |
Notifications - Custom Field Value. |
Name | Path | Type | Description |
---|---|---|---|
Webhook Id
|
WebhookId | string |
Webhook Id. |
Date
|
Properties.Date | date-time |
Properties - Date. |
Notifications
|
Notifications | array of object | |
Action
|
Notifications.Action | string |
Notifications - Action. |
Customer Type
|
Notifications.Type | string |
Notifications - Customer Type. |
New Record Number
|
Notifications.NewRecordNumber | string |
Notifications - New Record Number. |
Old Id
|
Notifications.OldId | string |
Notifications - Old Id. |
New Id
|
Notifications.NewId | string |
Notifications - New Id. |
Name | Path | Type | Description |
---|---|---|---|
Webhook Id
|
WebhookId | string |
Webhook Id. |
Date
|
Properties.Date | date-time |
Properties - Date. |
Notifications
|
Notifications | array of object | |
Action
|
Notifications.Action | string |
Notifications - Action. |
Action Type
|
Notifications.ActionType | string |
Notifications - Action Type. |
Customer Id
|
Notifications.CustomerId | string |
Notifications - Customer Id. |
Customer Type
|
Notifications.CustomerType | string |
Notifications - Customer Type. |
Related To Customer Id
|
Notifications.RelatedToCustomerId | string |
Notifications - Related To Customer Id. |
Related To Customer Type
|
Notifications.RelatedToCustomerType | string |
Notifications - Related To Customer Type. |
Relationship
|
Notifications.Relationship | string |
Notifications - Relationship. |
Reciprocal Relationship
|
Notifications.ReciprocalRelationship | string |
Notifications - Reciprocal Relationship. |
Start Date
|
Notifications.StartDate | date-time |
Notifications - Start Date. |
End Date
|
Notifications.EndDate | date-time |
Notifications - End Date. |
Name | Path | Type | Description |
---|---|---|---|
Webhook Id
|
WebhookId | string |
Webhook Id. |
Date
|
Properties.Date | date-time |
Properties - Date. |
Notifications
|
Notifications | array of object | |
Action
|
Notifications.Action | string |
Notifications - Action. |
Action Type
|
Notifications.ActionType | string |
Notifications - Action Type. |
Phone Id
|
Notifications.Id | string |
Notifications - Id. |
Phone Type
|
Notifications.PhoneType | string |
Notifications - Phone Type. |
Phone Number
|
Notifications.Number | string |
Notifications - Number. |
Phone Extension
|
Notifications.Extension | string |
Notifications - Extension. |
Is Primary
|
Notifications.IsPrimary | boolean |
Notifications - Is Primary. |
Customer Id
|
Notifications.CustomerId | string |
Notifications - Customer Id. |
Customer Type
|
Notifications.CustomerType | string |
Notifications - Customer Type. |
Customer Record Number
|
Notifications.RecordNumber | string |
Notifications - Record Number. |
Old Phone Id
|
Notifications.Old.Id | string |
Notifications - Old - Id. |
Old Phone Type
|
Notifications.Old.PhoneType | string |
Notifications - Old - Phone Type. |
Old Phone Number
|
Notifications.Old.Number | string |
Notifications - Old - Number. |
Old Phone Extension
|
Notifications.Old.Extension | string |
Notifications - Old - Extension. |
Old Is Primary
|
Notifications.Old.IsPrimary | boolean |
Notifications - Old - Is Primary. |
Old Customer Id
|
Notifications.Old.CustomerId | string |
Notifications - Old - Customer Id. |
Old Customer Type
|
Notifications.Old.CustomerType | string |
Notifications - Old - Customer Type. |
Old Customer Record Number
|
Notifications.Old.RecordNumber | string |
Notifications - Old - Record Number. |
Name | Path | Type | Description |
---|---|---|---|
Webhook Id
|
WebhookId | string |
Webhook Id. |
Date
|
Properties.Date | date-time |
Properties - Date. |
Notifications
|
Notifications | array of object | |
Action
|
Notifications.Action | string |
Notifications - Action. |
Action Type
|
Notifications.ActionType | string |
Notifications - Action Type. |
Customer Id
|
Notifications.CustomerId | string |
Notifications - Customer Id. |
Customer Type
|
Notifications.CustomerType | string |
Notifications - Customer Type. |
Customer Record Number
|
Notifications.RecordNumber | string |
Notifications - Record Number. |
Address Id
|
Notifications.Id | string |
Notifications - Id. |
Is Primary
|
Notifications.Primary | boolean |
Notifications - Primary. |
Line 1
|
Notifications.Line1 | string |
Notifications - Line 1. |
Line 2
|
Notifications.Line2 | string |
Notifications - Line 2. |
Line 3
|
Notifications.Line3 | string |
Notifications - Line 3. |
City
|
Notifications.City | string |
Notifications - City. |
State
|
Notifications.State | string |
Notifications - State. |
Zip Code
|
Notifications.Zipcode | string |
Notifications - Zip Code. |
Country
|
Notifications.Country | string |
Notifications - Country. |
Old Address Id
|
Notifications.Old.Id | string |
Notifications - Old - Id. |
Old Is Primary
|
Notifications.Old.Primary | boolean |
Notifications - Old - Primary. |
Old Line 1
|
Notifications.Old.Line1 | string |
Notifications - Old - Line 1. |
Old Line 2
|
Notifications.Old.Line2 | string |
Notifications - Old - Line 2. |
Old Line 3
|
Notifications.Old.Line3 | string |
Notifications - Old - Line 3. |
Old City
|
Notifications.Old.City | string |
Notifications - Old - City. |
Old State
|
Notifications.Old.State | string |
Notifications - Old - State. |
Old Zip Code
|
Notifications.Old.Zipcode | string |
Notifications - Old - Zip Code. |
Old Country
|
Notifications.Old.Country | string |
Notifications - Old - Country. |
Name | Path | Type | Description |
---|---|---|---|
Webhook Id
|
WebhookId | string |
Webhook Id. |
Date
|
Properties.Date | date-time |
Properties - Date. |
Notifications
|
Notifications | array of object | |
Action
|
Notifications.Action | string |
Notifications - Action. |
Order Number
|
Notifications.OrderNumber | string |
Notifications - Order Number. |
Invoice Number
|
Notifications.InvoiceNumber | string |
Notifications - Invoice Number. |
Product Code
|
Notifications.ProductCode | string |
Notifications - Product Code. |
Product Name
|
Notifications.ProductName | string |
Notifications - Product Name. |
Product Type
|
Notifications.ProductType | string |
Notifications - Product Type. |
Parent Product Code
|
Notifications.ParentProductCode | string |
Notifications - Parent Product Code. |
Substituted For Customer Id
|
Notifications.SubstitutedForCustomerId | string |
Notifications - Substituted For Customer Id. |
Substituted For Customer Record Number
|
Notifications.SubstitutedForCustomerRecordNumber | string |
Notifications - Substituted For Customer Record Number. |
Substituted By Customer Id
|
Notifications.SubstitutedByCustomerId | string |
Notifications - Substituted By Customer Id. |
Substituted By Customer Record Number
|
Notifications.SubstitutedByCustomerRecordNumber | string |
Notifications - Substituted By Customer Record Number. |
Substituted By Customer First Name
|
Notifications.SubstitutedByCustomerFirstName | string |
Notifications - Substituted By Customer First Name. |
Substituted By Customer Last Name
|
Notifications.SubstitutedByCustomerLastName | string |
Notifications - Substituted By Customer Last Name. |
Substituted By Customer Email Address
|
Notifications.SubstitutedByCustomerEmailAddress | string |
Notifications - Substituted By Customer Email Address. |
Name | Path | Type | Description |
---|---|---|---|
Webhook Id
|
WebhookId | string |
Webhook Id. |
Date
|
Properties.Date | date-time |
Properties - Date. |
Notifications
|
Notifications | array of object | |
Action
|
Notifications.Action | string |
Notifications - Action. |
Individual Id
|
Notifications.IndividualId | string |
Notifications - Individual Id. |
Record Number
|
Notifications.RecordNumber | string |
Notifications - Record Number. |
Name | Path | Type | Description |
---|---|---|---|
Webhook Id
|
WebhookId | string |
Webhook Id. |
Date
|
Properties.Date | date-time |
Properties - Date. |
Notifications
|
Notifications | array of object | |
Action
|
Notifications.Action | string |
Notifications - Action. |
Order Number
|
Notifications.OrderNumber | string |
Notifications - Order Number. |
Invoice Number
|
Notifications.InvoiceNumber | string |
Notifications - Invoice Number. |
Product Code
|
Notifications.ProductCode | string |
Notifications - Product Code. |
Product Name
|
Notifications.ProductName | string |
Notifications - Product Name. |
Product Type
|
Notifications.ProductType | string |
Notifications - Product Type. |
Parent Product Code
|
Notifications.ParentProductCode | string |
Notifications - Parent Product Code. |
Quantity
|
Notifications.Quantity | integer |
Notifications - Quantity. |
Item Price
|
Notifications.ItemPrice | double |
Notifications - Item Price. |
Customer Type
|
Notifications.CustomerType | string |
Notifications - Customer Type. |
Customer Id
|
Notifications.CustomerId | string |
Notifications - Customer Id. |
Full Name
|
Notifications.FullName | string |
Notifications - Full Name. |
First Name
|
Notifications.FirstName | string |
Notifications - First Name. |
Last Name
|
Notifications.LastName | string |
Notifications - Last Name. |
Email Address
|
Notifications.EmailAddress | string |
Notifications - Email Address. |
Record Number
|
Notifications.RecordNumber | string |
Notifications - Record Number. |
Name | Path | Type | Description |
---|---|---|---|
Webhook Id
|
WebhookId | uuid |
Webhook Id. |
Date
|
Properties.Date | date-time |
Properties - Date. |
Notifications
|
Notifications | array of object | |
Action
|
Notifications.Action | string |
Notifications - Action. |
Customer Id
|
Notifications.CustomerId | string |
Notifications - Customer Id. |
Customer Type
|
Notifications.CustomerType | string |
Notifications - Customer Type. |
Record Number
|
Notifications.RecordNumber | string |
Notifications - Record Number. |
Membership Type
|
Notifications.MembershipType | string |
Notifications - Membership Type. |
Membership Type Code
|
Notifications.MembershipTypeCode | string |
Notifications - Membership Type Code. |
Terminate Date
|
Notifications.TerminateDate | date-time |
Notifications - Terminate Date. |
Terminate Reason
|
Notifications.TerminateReason | string |
Notifications - Terminate Reason. |