invantive documentation
Invantive Support ForumsLog In / Sign Up

ContactPersons: Bouw7 Contact Persons

read only REST

  • Catalog: Bouw7
  • Schema: Contact
  • Label: Contact Persons

Returns a list of contact persons associated with any contact for your organization. Returns a list of contact persons associated with any contact for your organization.

Can only retrieve data.

Summary

Returns a list of contact persons associated with any contact for your organization.

API Source

  • Endpoint: /list/contact-persons
  • Operation: get /list/contact-persons

Performance Characteristics

Characteristic Value
Average access latency (ms) 90
Full scan rows per minute 275,000
Point query rows per minute 666

The result can be cached on the client.

Parameters

Name Data Type Required Default Documentation
q `` A Heimdall Query Language string

Table Columns

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

Name Data Type Label Required Marks Documentation
city varchar2 City filters on the platform, writable, city The city of this contact person.
contact_emailAddress varchar2 Contact Email Address filters on the platform, writable, contact.emailAddress The email address of the contact.
contact_id int64 Contact ID filters on the platform, writable, contact.id The ID of the contact.
contact_name varchar2 Contact Name filters on the platform, writable, contact.name The name of this contact.
contact_type varchar2 Contact Type filters on the platform, writable, contact.type The type of this contact.
contact_typeId int64 Contact Type ID filters on the platform, writable, contact.typeId The type ID of this contact.
createdAt datetime Created at filters on the platform, writable, createdAt The creation date of the object in ATOM/ISO-8601 format
createdBy_id int64 Created by ID filters on the platform, writable, createdBy.id The ID of the user.
createdBy_username varchar2 Created by User Name filters on the platform, writable, createdBy.username The username of the user.
emailAddress varchar2 Email Address filters on the platform, writable, emailAddress The email address of this contact person.
firstName varchar2 First Name filters on the platform, writable, firstName The given name of this contact person.
houseNumber varchar2 House Number filters on the platform, writable, houseNumber The house number of this contact person.
id int64 ID filters on the platform, writable, id The ID of contact person.
jobTitle varchar2 Job Title filters on the platform, writable, jobTitle The job title of this contact person.
lastName varchar2 Last Name filters on the platform, writable, lastName The family name of this contact person.
phoneNumber varchar2 Phone Number filters on the platform, writable, phoneNumber The phone number of the contact person.
salutation varchar2 Salutation filters on the platform, writable, salutation The salutation of this contact person.
streetName varchar2 Street Name filters on the platform, writable, streetName The street name of this contact person.
updatedAt datetime Updated At filters on the platform, writable, updatedAt The creation date of the object in ATOM/ISO-8601 format
updatedBy_id int64 Updated by ID filters on the platform, writable, updatedBy.id The ID of the user.
updatedBy_username varchar2 Updated by User Name filters on the platform, writable, updatedBy.username The username of the user.
zipCode varchar2 ZIP Code filters on the platform, writable, zipCode The zip code of this contact person.

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: