/intapp | Type: Application | PCID required: Yes
Tools
intapp_add_choice_field_values
Add choice field values Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fieldId | integer | Yes | — | ID of the choice field to add values to |
body | string[] | Yes | — | Array of choice value strings to add |
intapp_create_entry_data
Create entry data (cells) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entryTypeId | string | Yes | — | Unique identifier of the entry type (numeric ID or apiName) |
storeRequests | object[] | No | — | Array of cell store requests |
intapp_create_rows
Create data (rows) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entryTypeId | string | Yes | — | Unique identifier of the entry type (numeric ID or apiName) |
body | object[] | Yes | — | Array of entry objects to create. Each object must include EntryId (negative) and field values. |
intapp_create_user
Create user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | Yes | — | User’s email address |
federationId | string | No | — | Identifier for SSO users |
firstName | string | No | — | User’s first name |
groups | integer[] | No | — | User group IDs for assignment |
ipRestrictionsEnabled | boolean | No | — | Toggle IP restrictions |
isActive | boolean | No | — | Creates active or inactive user |
lastName | string | No | — | User’s last name |
password | string | No | — | Password. If blank, a password reset email will be sent. |
twoFactorEnabled | boolean | No | — | Enable 2FA. Cannot be disabled via API. |
intapp_delete_entries
Delete entries Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entryTypeId | string | Yes | — | Unique identifier of the entry type (numeric ID or apiName) |
body | integer[] | Yes | — | Array of entry IDs to delete |
intapp_delete_user
Delete user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | integer | Yes | — | ID of user to delete |
intapp_download_file
Download file Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entryId | integer | Yes | — | ID of the entry/record holding the file |
fieldId | integer | Yes | — | ID of the binary or photo field |
intapp_filter_entries
Filter entries Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entryTypeId | string | Yes | — | Unique identifier of the entry type (numeric ID or apiName) |
body | object[] | Yes | — | Request body |
intapp_get_cell_data
Get cell data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fillExtendedData | boolean | No | — | When true, appends modified DateTime and Modified By to entry data |
resolveReferenceUrls | boolean | No | — | When true, returns URL of entry for reference fields |
wrapIntoArrays | boolean | No | — | When true, improves consistency for multi-value fields |
dateTimeBehavior | integer | No | — | Controls timezone handling. 0 = UTC (default), 1 = localized timezone |
body | object[] | Yes | — | Request body |
intapp_get_entry_type
Get entry type by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entryTypeId | string | Yes | — | Unique identifier of the entry type (numeric ID or apiName) |
intapp_get_field_by_id
Get field by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fieldId | integer | Yes | — | Unique identifier of the field |
intapp_get_fields_by_ids
Get multiple fields by IDs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | integer[] | Yes | — | Array of field IDs to retrieve |
intapp_get_mappings
Get mappings by type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
mappingsTypeId | integer | Yes | — | Mapping type identifier |
intapp_get_row_data
Get data (rows) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entryTypeId | string | Yes | — | Unique identifier of the entry type (numeric ID or apiName) |
query | string | No | — | Filter query using DealCloud filter syntax |
fields | string | No | — | Subset of fields to return (comma-separated field names) |
limit | integer | No | — | Maximum records to return (default 1000) |
skip | integer | No | — | Records to skip for pagination (default 0) |
resolveReferenceUrls | boolean | No | — | When true, returns URL for reference fields |
wrapIntoArrays | boolean | No | — | When true, improves consistency for multi-value fields |
dateTimeBehavior | integer | No | — | 0 = UTC (default), 1 = localized timezone |
intapp_get_user_activity
Get user activity Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageNumber | integer | No | — | Page number for pagination |
pageSize | integer | No | — | Page size (default 10) |
activity | integer | No | — | Activity type filter |
dateFrom | string | No | — | Start date filter (default: 90 days ago) |
dateTo | string | No | — | End date filter (default: current date) |
exportDataType | integer | No | — | Export data type filter |
source | integer | No | — | Source type filter |
userIDs | integer[] | No | — | Filter by specific user IDs |
intapp_get_user_group_by_id
Get user group by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | integer | Yes | — | ID of the user group |
intapp_get_users_by_ids
Get users by IDs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | integer[] | Yes | — | Array of user IDs to retrieve |
intapp_get_view_data
Get data using view Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
viewId | integer | Yes | — | View ID |
limit | integer | No | — | Maximum rows to return |
skip | integer | No | — | Pagination offset |
wrapIntoArrays | boolean | No | — | When true, improves consistency for multi-value fields |
body | object[] | No | — | Optional filter overrides for view parameters |
intapp_list_all_fields
List all fieldsintapp_list_currencies
List currenciesintapp_list_entries
List all entries Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entryTypeId | string | Yes | — | Unique identifier of the entry type (numeric ID or apiName, e.g. ‘company’ or 2011) |
intapp_list_entry_types
List all entry typesintapp_list_field_types
List field typesintapp_list_fields_by_entry_type
List fields by entry type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entryTypeId | string | Yes | — | Unique identifier of the entry type (numeric ID or apiName) |
intapp_list_filter_operations
List filter operationsintapp_list_schema_users
List site users (schema) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
activeOnly | boolean | No | — | When true, returns only active users |
intapp_list_user_groups
List user groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageNumber | integer | No | — | Starting page number |
pageSize | integer | No | — | Maximum entries per page (max 1000) |
intapp_list_users
List users Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
modifiedSince | string | No | — | Filter by users modified since this date (ISO 8601 format) |
email | string | No | — | Filter by user email address |
userGroupID | integer | No | — | Filter by user group ID |
pageNumber | integer | No | — | Page number for pagination |
pageSize | integer | No | — | Page size (default 10, max 1000) |
intapp_list_views
List views Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | string | No | — | Search string to filter views by name |
isPrivate | boolean | No | — | When true, retrieve only private views |
limit | integer | No | — | Maximum records per page (default 1000) |
skip | integer | No | — | Pagination offset (default 0) |
intapp_merge_entries
Merge entries Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entryTypeId | string | Yes | — | Entry type ID or apiName |
overwriteEmptyValues | boolean | No | — | When true, migrates values from deleted entries when the winning entry has blank fields (only for 2-entry merges) |
body | object[] | Yes | — | Request body |
intapp_patch_rows
Patch data (rows) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entryTypeId | string | Yes | — | Unique identifier of the entry type (numeric ID or apiName) |
body | object[] | Yes | — | Array of entry objects to patch. Each must include EntryId and fields to modify. |
intapp_query_rows
Query data (rows) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entryTypeId | string | Yes | — | Unique identifier of the entry type (numeric ID or apiName) |
dateTimeBehavior | integer | No | — | 0 = UTC (default), 1 = localized timezone |
fields | string[] | No | — | Subset of field names to return (e.g. [‘firstName’, ‘lastName’]) |
limit | integer | No | — | Maximum records to return. Defaults to 1000. |
query | string | No | — | Filter query string using DealCloud filter syntax (e.g. ‘{entryid: 2553146}‘) |
resolveReferenceUrls | boolean | No | — | When true, returns URLs for reference field entries |
skip | integer | No | — | Number of records to skip for pagination. Defaults to 0. |
wrapIntoArrays | boolean | No | — | When true, improves consistency for multi-value fields |
intapp_update_rows
Update data (rows, upsert) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entryTypeId | string | Yes | — | Unique identifier of the entry type (numeric ID or apiName) |
body | object[] | Yes | — | Array of entry objects to update. Each must include EntryId (positive) and fields to modify. |
intapp_update_user
Update user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | No | — | User’s email address |
federationId | string | No | — | Federation identifier |
firstName | string | No | — | User’s first name |
groups | integer[] | No | — | Group IDs to assign |
id | integer | Yes | — | User ID to update |
lastName | string | No | — | User’s last name |
password | string | No | — | User’s password |
intapp_upsert_entry_data
Update or upsert entry data (cells) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entryTypeId | string | Yes | — | Unique identifier of the entry type (numeric ID or apiName) |
storeRequests | object[] | No | — | Array of cell store requests |

