Introduction

Getting Started with the API

Contacts

Contacts
Contact Notes

Customer

Customer
Customer Note
Customer Contact
Customer Contact Notes
Customer Contact Roles
Customer Journeys
Customer Activity

Lifecycle

Lifecycle Definitions
Lifecycle Step Dictionary
Lifecycle Versions
Lifecycle Operations
Journeys
Entity Type
- Get Entity Type Identifier listget
External Entity Type
Lifecycle Process Event Definitions
Lifecycle Process Event Subscriptions
Lifecycle Managed Event Definition Groups
Lifecycle Managed Event Definitions
Managed Event Subscriptions
- Get a list of managed event subscription detailsget
Lifecycle Metrics
Event Definitions
- List all Event Definitionsget
Event Subscriptions
Lifecycle Utilization
Lifecycle Exceptions

Get all contacts

get https://<<tenantUriId>>.api.chassi.com/<<applicationSpaceUriId>>/contacts/<<serviceUriVersion>>/contacts

This will get all contacts or match contacts by constraint in the given Operational Application Space.

Operational Application Space

URL Expired

The URL for this request expired after 30 days.

Query Params

pageOffset

number

Defaults to 0

Number of pages away from the first one. The first one is zero (0).

pageSize

number

Defaults to 0

Number of items per page

tags[]

string

Optional parameter to filter by one or more tags using the tagId

fromDatetime

date-time

Optional parameter to limit search results for records created after the specified date-time

toDatetime

date-time

Optional parameter to limit search results for records created before the specified date-time

sortBy

string

Optional parameter to sort by specified field name

sortOrder

string

Defaults to asc

Optional parameter to sort by ascending or descending order

searchText

string

Optional parameter to limit search results containing specified text

Response

Response body

array of objects

object

contactId

string

contactTitle

string

contactName

string

The full name of the contact.

emailAddresses

array of objects

An optional list of email addresses

emailAddresses

object

emailAddressId

string

contactId

string

label

string

A user defined label for this email address

emailAddress

string

primaryEmailAddress

boolean

Defaults to false

phoneNumbers

array of objects

An optional list of phone numbers

phoneNumbers

object

phoneNumberId

string

contactId

string

label

string

A user defined label for this phone number.

countryCode

string

Phone number country code

phoneNumber

string

primaryPhoneNumber

boolean

Defaults to false

physicalAddresses

array of objects

An optional of mailing addresses.

physicalAddresses

object

physicalAddressId

string

contactId

string

label

string

A user defined label for this mailing address.

attention

string

addressLine1

string

addressLine2

string

city

string

stateOrProvince2Digit

string

postalCode

string

countryCode2Digit

string

primaryAddress

boolean

contactTags

array of objects

contactTags

object

contactTagId

string

contactId

string

tagId

string

tagName

string

primaryEmailAddressId

string

The id of the primary contact email

primaryPhoneNumberId

string

The id of the primary contact phone number

contactBirthday

string

contactSupportPIN

string

contactCreatedByUserId

string

The id of the user creating this Contact

contactCreatedBy

string

The name of the user creating this Contact

metadata

array of objects

User defined data

metadata

object

metadataTag

string

A namespace to group similar data

key

string

required

Attribute name of metadata

displayLabel

string

Used to display the field label for the value

value

string

Data value of metadata

valueFormat

string

Controlled enumerated types that realize value

String Text Number Date Time Datetime Boolean

dateCreated

date-time

The date and time the entity was created.

lastUpdated

date-time

The date and time the entity was last modified.

Updated about 6 years ago

Contacts

Create a new contact

Language

Credentials

OAuth2

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https:///%3C%3CtenantUriId%3E%3E.api.chassi.com/%3C%3CapplicationSpaceUriId%3E%3E/contacts/%3C%3CserviceUriVersion%3E%3E/contacts?pageOffset=0&pageSize=0&sortOrder=asc' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated about 6 years ago

Contacts

Create a new contact

Introduction
Getting Started with the API

Contacts
Contacts
Delete a contactdelete
Update contactput
Get a contactget
Create a new contactpost
Get all contactsget
Contact Notes
Delete a note for the specified contactdelete
Update a note for the specified contactput
Get a note for the specified contactget
Create a new contact notepost
Get all contact notesget

Customer
Customer
Delete a customerdelete
Update a customerput
Get a customerget
Create a new customerpost
Returns a list of all customersget
Customer Note
Delete a customer notedelete
Update a customer noteput
Get a customer noteget
Create a customer notepost
Get all notes for a customerget
Customer Contact
Returns a list of customers associated with the specified contact idget
Attach a list of existing contacts to the specified customerpost
Delete a customer contactdelete
Update a customer contactput
Get a customer contactget
Create or attach a customer contactpost
Get all contacts for customerget
Customer Contact Notes
Delete a customer contact notedelete
Update a customer contact noteput
Get a customer contact noteget
Create a customer contact notepost
Get all notes for a customer contactget
Customer Contact Roles
Deletes a customer contact roledelete
Updates a customer contact roleput
Returns a customer contact roleget
Create a customer contact rolepost
Returns a list of customer contact rolesget
Customer Journeys
[deprecated] Delete a customer journey (unlink)delete
[deprecated] Get a customer journeyget
[deprecated] Customer's most recent journeyget
[deprecated] Create a Customer Journeypost
[deprecated] Get all journeys for customerget
Customer Activity
Delete a customer activitydelete
Update a customer activityput
Get a customer activityget
Log a customer activitypost
Get all customer activityget

Lifecycle
Lifecycle Definitions
Deletes a lifecycledelete
Update a lifecycleput
Get a lifecycleget
Create a new lifecyclepost
Returns a list of all lifecyclesget
Lifecycle Step Dictionary
Delete a specific step definitiondelete
Update a step definitionput
Get a specific step definitionget
Update all steps in dictionaryput
Create a step definitionpost
Get step dictionary for lifecycleget
Lifecycle Versions
Migrate journeys of a published version to anotherpost
Publish version to one or more Operational Application Spacespost
Duplicate a versionpost
Update just a versions nameput
Get latest version of lifecycleget
Deletes a version of a lifecycledelete
Update a version of a lifecycleput
Get a version of a lifecycleget
Create a lifecycle versionpost
Get versions of a lifecycleget
Lifecycle Operations
[deprecated] Get a list of metadata found in entityLifecycles for the appSpaceget
[deprecated] Migrate an entity lifecycle to a different published lifecycle versionpost
[deprecated] Change entity lifecycle's current stepput
[deprecated] Get possible next steps for entityget
[deprecated] Delete a history record for the entity lifecycledelete
[deprecated] Update a history record for the entity lifecycleput
[deprecated] Get a history record for the entity lifecycleget
[deprecated] Create or log a history record for the entity lifecyclepost
[deprecated] History of the entity lifecycleget
[deprecated] Stop tracking an entity and delete historydelete
[deprecated] Update an entity's situation and metadataput
[deprecated] Get an entity's current situation and metadataget
[deprecated] Get a list of entityLifecycle journeysget
[deprecated] Start tracking an entitypost
[deprecated] Get all the entities being trackedget
Journeys
Get a list of metdata based off of journeysget
Get a summary of all journeysget
Delete a journey historydelete
Update a journey historyput
Get a journey historyget
Log history of a journeypost
Get a list of journey historiesget
Migrate journey to another version of lifecyclepost
Change Stepput
Next possible steps to which a journey can moveget
Delete a journeydelete
Update a journeyput
Get a journeyget
Start tracking a journeypost
Get all journeysget
Entity Type
Get Entity Type Identifier listget
External Entity Type
Deletes an externalEntityTypeIdentifierdelete
Update an externalEntityTypeIdentifierput
Get an externalEntityTypeIdentifierget
Create an external-entity-type-identifierpost
Get externalEntityTypeIdentifier listget
Lifecycle Process Event Definitions
Delete a lifecycle event definitiondelete
Update a lifecycle event definitionput
Get a lifecycle event definitionget
Create a lifecycle event definitionpost
Get lifecycle event definitions listget
Publish a lifecycle event definition grouppost
Delete a lifecycle event definitiondelete
Update a lifecycle event definitionput
Get a lifecycle event definitionget
Create a lifecycle event definitionpost
Get lifecycle event definitions listget
Lifecycle Process Event Subscriptions
Delete event subscription (unsubscribe)delete
Update lifecycle event subscriptionput
Get a lifecycle event subscriptionget
Get lifecycle event subscription detail listget
Create lifecycle event subscriptionpost
Get all lifecycle event subscriptionsget
Lifecycle Managed Event Definition Groups
Delete a managed event definition groupdelete
Get a managed event definition groupget
Get lifecycle managed event definition groups listget
Lifecycle Managed Event Definitions
Delete managed event subscription (unsubscribe)delete
Update managed event subscriptionput
Get a managed event subscriptionget
Create a managed event subscriptionpost
Get all managedevent subscriptionsget
Delete a managed event definitiondelete
Update a managed event definitionput
Get a managed event definitionget
Create a managed event definitionpost
Get managed event definitions (filterable)get
Managed Event Subscriptions
Get a list of managed event subscription detailsget
Lifecycle Metrics
Get Lifecycle Cumulative Flowget
Get Lifecycle Trend Metricsget
Get lifecycle metric top pathwaysget
Get lifecyle metric cycle timesget
Event Definitions
List all Event Definitionsget
Event Subscriptions
Unsubscribe to an eventdelete
Update event subscriptionput
Get an event subscriptionget
Subscribe to eventpost
Get all subscriptions to eventsget
Lifecycle Utilization
Utilization this year (YTD)get
Utilization previous 3 monthsget
Utilization previous monthget
Utilization this monthget
Utilization last 7 daysget
Get a Lifecycle Resource Utilization summary using a search filterget
Log a utilization event (or list of events) and return a Resource Utilization Aggregation.post
Lifecycle Exceptions
Get an exceptionget
Search / filter exceptionsget
Available log streamsget
Log an Exceptionpost

Tag
Tag Namespaces
Get namespace full pathget
Get namespace with all tag detailget
Delete a tag namespacedelete
Update a tag namespaceput
Get a tag namespaceget
Create a tag namespacepost
Get all tag namespacesget
Tag Namespace Changes
Delete a tag namespace changedelete
Update a tag namespace changeput
Get a tag namespace changeget
Post a tag namespace changepost
Get all tag namespace changesget
Tags
Loads global tag data into the given appSpacepost
Delete a Tagdelete
Update a tagput
Get a tagget
Create a Tagpost
Returns a list of all tags (with optional search)get
Tag Field
Get all tags (with namespace) for tag fieldget
Delete a tag fielddelete
Update a tag fieldput
Get a field where tags are usedget
Create a tag field where tags is usedpost
Get all fields where tags are usedget
Tag Field Namespaces
Delete a tag field namespacedelete
Update a tag field namespaceput
Get a tag field namespaceget
Create a tag field namespace where tags are usedpost
Get all namespaces where for a tag fieldget

200Status 200