Skip to main content
Server path: /intapp | Type: Application | PCID required: Yes

Tools

ToolDescription
intapp_add_choice_field_valuesAdd choice field values
intapp_create_entry_dataCreate entry data (cells)
intapp_create_rowsCreate data (rows)
intapp_create_userCreate user
intapp_delete_entriesDelete entries
intapp_delete_userDelete user
intapp_download_fileDownload file
intapp_filter_entriesFilter entries
intapp_get_cell_dataGet cell data
intapp_get_entry_typeGet entry type by ID
intapp_get_field_by_idGet field by ID
intapp_get_fields_by_idsGet multiple fields by IDs
intapp_get_mappingsGet mappings by type
intapp_get_row_dataGet data (rows)
intapp_get_user_activityGet user activity
intapp_get_user_group_by_idGet user group by ID
intapp_get_users_by_idsGet users by IDs
intapp_get_view_dataGet data using view
intapp_list_all_fieldsList all fields
intapp_list_currenciesList currencies
intapp_list_entriesList all entries
intapp_list_entry_typesList all entry types
intapp_list_field_typesList field types
intapp_list_fields_by_entry_typeList fields by entry type
intapp_list_filter_operationsList filter operations
intapp_list_schema_usersList site users (schema)
intapp_list_user_groupsList user groups
intapp_list_usersList users
intapp_list_viewsList views
intapp_merge_entriesMerge entries
intapp_patch_rowsPatch data (rows)
intapp_query_rowsQuery data (rows)
intapp_update_rowsUpdate data (rows, upsert)
intapp_update_userUpdate user
intapp_upsert_entry_dataUpdate or upsert entry data (cells)

intapp_add_choice_field_values

Add choice field values Parameters:
ParameterTypeRequiredDefaultDescription
fieldIdintegerYesID of the choice field to add values to
bodystring[]YesArray of choice value strings to add

intapp_create_entry_data

Create entry data (cells) Parameters:
ParameterTypeRequiredDefaultDescription
entryTypeIdstringYesUnique identifier of the entry type (numeric ID or apiName)
storeRequestsobject[]NoArray of cell store requests

intapp_create_rows

Create data (rows) Parameters:
ParameterTypeRequiredDefaultDescription
entryTypeIdstringYesUnique identifier of the entry type (numeric ID or apiName)
bodyobject[]YesArray of entry objects to create. Each object must include EntryId (negative) and field values.

intapp_create_user

Create user Parameters:
ParameterTypeRequiredDefaultDescription
emailstringYesUser’s email address
federationIdstringNoIdentifier for SSO users
firstNamestringNoUser’s first name
groupsinteger[]NoUser group IDs for assignment
ipRestrictionsEnabledbooleanNoToggle IP restrictions
isActivebooleanNoCreates active or inactive user
lastNamestringNoUser’s last name
passwordstringNoPassword. If blank, a password reset email will be sent.
twoFactorEnabledbooleanNoEnable 2FA. Cannot be disabled via API.

intapp_delete_entries

Delete entries Parameters:
ParameterTypeRequiredDefaultDescription
entryTypeIdstringYesUnique identifier of the entry type (numeric ID or apiName)
bodyinteger[]YesArray of entry IDs to delete

intapp_delete_user

Delete user Parameters:
ParameterTypeRequiredDefaultDescription
userIdintegerYesID of user to delete

intapp_download_file

Download file Parameters:
ParameterTypeRequiredDefaultDescription
entryIdintegerYesID of the entry/record holding the file
fieldIdintegerYesID of the binary or photo field

intapp_filter_entries

Filter entries Parameters:
ParameterTypeRequiredDefaultDescription
entryTypeIdstringYesUnique identifier of the entry type (numeric ID or apiName)
bodyobject[]YesRequest body

intapp_get_cell_data

Get cell data Parameters:
ParameterTypeRequiredDefaultDescription
fillExtendedDatabooleanNoWhen true, appends modified DateTime and Modified By to entry data
resolveReferenceUrlsbooleanNoWhen true, returns URL of entry for reference fields
wrapIntoArraysbooleanNoWhen true, improves consistency for multi-value fields
dateTimeBehaviorintegerNoControls timezone handling. 0 = UTC (default), 1 = localized timezone
bodyobject[]YesRequest body

intapp_get_entry_type

Get entry type by ID Parameters:
ParameterTypeRequiredDefaultDescription
entryTypeIdstringYesUnique identifier of the entry type (numeric ID or apiName)

intapp_get_field_by_id

Get field by ID Parameters:
ParameterTypeRequiredDefaultDescription
fieldIdintegerYesUnique identifier of the field

intapp_get_fields_by_ids

Get multiple fields by IDs Parameters:
ParameterTypeRequiredDefaultDescription
bodyinteger[]YesArray of field IDs to retrieve

intapp_get_mappings

Get mappings by type Parameters:
ParameterTypeRequiredDefaultDescription
mappingsTypeIdintegerYesMapping type identifier

intapp_get_row_data

Get data (rows) Parameters:
ParameterTypeRequiredDefaultDescription
entryTypeIdstringYesUnique identifier of the entry type (numeric ID or apiName)
querystringNoFilter query using DealCloud filter syntax
fieldsstringNoSubset of fields to return (comma-separated field names)
limitintegerNoMaximum records to return (default 1000)
skipintegerNoRecords to skip for pagination (default 0)
resolveReferenceUrlsbooleanNoWhen true, returns URL for reference fields
wrapIntoArraysbooleanNoWhen true, improves consistency for multi-value fields
dateTimeBehaviorintegerNo0 = UTC (default), 1 = localized timezone

intapp_get_user_activity

Get user activity Parameters:
ParameterTypeRequiredDefaultDescription
pageNumberintegerNoPage number for pagination
pageSizeintegerNoPage size (default 10)
activityintegerNoActivity type filter
dateFromstringNoStart date filter (default: 90 days ago)
dateTostringNoEnd date filter (default: current date)
exportDataTypeintegerNoExport data type filter
sourceintegerNoSource type filter
userIDsinteger[]NoFilter by specific user IDs

intapp_get_user_group_by_id

Get user group by ID Parameters:
ParameterTypeRequiredDefaultDescription
groupIdintegerYesID of the user group

intapp_get_users_by_ids

Get users by IDs Parameters:
ParameterTypeRequiredDefaultDescription
bodyinteger[]YesArray of user IDs to retrieve

intapp_get_view_data

Get data using view Parameters:
ParameterTypeRequiredDefaultDescription
viewIdintegerYesView ID
limitintegerNoMaximum rows to return
skipintegerNoPagination offset
wrapIntoArraysbooleanNoWhen true, improves consistency for multi-value fields
bodyobject[]NoOptional filter overrides for view parameters

intapp_list_all_fields

List all fields

intapp_list_currencies

List currencies

intapp_list_entries

List all entries Parameters:
ParameterTypeRequiredDefaultDescription
entryTypeIdstringYesUnique identifier of the entry type (numeric ID or apiName, e.g. ‘company’ or 2011)

intapp_list_entry_types

List all entry types

intapp_list_field_types

List field types

intapp_list_fields_by_entry_type

List fields by entry type Parameters:
ParameterTypeRequiredDefaultDescription
entryTypeIdstringYesUnique identifier of the entry type (numeric ID or apiName)

intapp_list_filter_operations

List filter operations

intapp_list_schema_users

List site users (schema) Parameters:
ParameterTypeRequiredDefaultDescription
activeOnlybooleanNoWhen true, returns only active users

intapp_list_user_groups

List user groups Parameters:
ParameterTypeRequiredDefaultDescription
pageNumberintegerNoStarting page number
pageSizeintegerNoMaximum entries per page (max 1000)

intapp_list_users

List users Parameters:
ParameterTypeRequiredDefaultDescription
modifiedSincestringNoFilter by users modified since this date (ISO 8601 format)
emailstringNoFilter by user email address
userGroupIDintegerNoFilter by user group ID
pageNumberintegerNoPage number for pagination
pageSizeintegerNoPage size (default 10, max 1000)

intapp_list_views

List views Parameters:
ParameterTypeRequiredDefaultDescription
querystringNoSearch string to filter views by name
isPrivatebooleanNoWhen true, retrieve only private views
limitintegerNoMaximum records per page (default 1000)
skipintegerNoPagination offset (default 0)

intapp_merge_entries

Merge entries Parameters:
ParameterTypeRequiredDefaultDescription
entryTypeIdstringYesEntry type ID or apiName
overwriteEmptyValuesbooleanNoWhen true, migrates values from deleted entries when the winning entry has blank fields (only for 2-entry merges)
bodyobject[]YesRequest body

intapp_patch_rows

Patch data (rows) Parameters:
ParameterTypeRequiredDefaultDescription
entryTypeIdstringYesUnique identifier of the entry type (numeric ID or apiName)
bodyobject[]YesArray of entry objects to patch. Each must include EntryId and fields to modify.

intapp_query_rows

Query data (rows) Parameters:
ParameterTypeRequiredDefaultDescription
entryTypeIdstringYesUnique identifier of the entry type (numeric ID or apiName)
dateTimeBehaviorintegerNo0 = UTC (default), 1 = localized timezone
fieldsstring[]NoSubset of field names to return (e.g. [‘firstName’, ‘lastName’])
limitintegerNoMaximum records to return. Defaults to 1000.
querystringNoFilter query string using DealCloud filter syntax (e.g. ‘{entryid: 2553146}‘)
resolveReferenceUrlsbooleanNoWhen true, returns URLs for reference field entries
skipintegerNoNumber of records to skip for pagination. Defaults to 0.
wrapIntoArraysbooleanNoWhen true, improves consistency for multi-value fields

intapp_update_rows

Update data (rows, upsert) Parameters:
ParameterTypeRequiredDefaultDescription
entryTypeIdstringYesUnique identifier of the entry type (numeric ID or apiName)
bodyobject[]YesArray of entry objects to update. Each must include EntryId (positive) and fields to modify.

intapp_update_user

Update user Parameters:
ParameterTypeRequiredDefaultDescription
emailstringNoUser’s email address
federationIdstringNoFederation identifier
firstNamestringNoUser’s first name
groupsinteger[]NoGroup IDs to assign
idintegerYesUser ID to update
lastNamestringNoUser’s last name
passwordstringNoUser’s password

intapp_upsert_entry_data

Update or upsert entry data (cells) Parameters:
ParameterTypeRequiredDefaultDescription
entryTypeIdstringYesUnique identifier of the entry type (numeric ID or apiName)
storeRequestsobject[]NoArray of cell store requests