Skip to main content

PM lookups

Reference data, users, groups, and roles that most other PM tool groups depend on. Enabling a PM group usually enables a group from this area too.

This area has 2 groups and 22 tools, 19 of them currently available.

How to read this page
  • Groups are the unit of access. An admin enables tool groups on a client registration, and a tool appears in an agent's tool list only when its group is enabled. See Tool Groups.
  • Needs. Enabling a group also enables every group it needs. Each group below lists them.
  • Read-only groups are intended for look-up access without the ability to change data.
  • Visibility is not authorization. Every tool call executes as the authenticated user, and a visible tool can still return an authorization error. See the MCP Tool Permission Map.
  • Destructive tools are labelled as such. They delete or irreversibly overwrite data, and will not act unless the call sets both confirmed and confirmedDestructive to true.
  • Not currently available tools are registered but are not offered in any tool list at this time.
  • Activity and Project labels vary by tenant. Where this page says Activity or Project, your tenant's own configured terminology is substituted at runtime.

Groups in this area​

GroupAccessNeedsTools
Look Up PM Reference DataRead-onlyNone10
Look Up PM Users, Groups & RolesCan change dataNone12

Look Up PM Reference Data​

Read-only · 10 tools (8 currently available) · Group ID look-up-pm-reference-data

Needs: no other groups.

ToolWhat it does
get_active_system_type_valuesRetrieves only the active values for a system type, by its name, paged, in Aprimo Marketing Operations.
get_allowed_child_pick_list_optionsNot currently available. Retrieves the allowed child pick list options for a parent pick list item, by the extended attribute's integer ID and the parent pick list item's integer ID, in Aprimo Marketing Operations.
get_lookup_listRetrieves a lookup list by its integer ID in Aprimo Marketing Operations.
get_metadataRetrieves metadata for a resource by its object name (e.g. "Activity", "Project") in Aprimo Marketing Operations -- field definitions, data types, and lookup/selection-list bindings.
get_metadata_for_groupsRetrieves metadata for the group resource in Aprimo Marketing Operations (field definitions, data types, and lookup/selection-list bindings).
get_pick_list_optionsNot currently available. Retrieves the pick list options for an extended attribute, by the attribute's integer ID, in Aprimo Marketing Operations.
get_selection_listRetrieves a selection list by name in Aprimo Marketing Operations (e.g. "ActivityTypeList").
get_system_type_valueRetrieves a single value for a system type, by the system type's name and the value's integer ID, in Aprimo Marketing Operations.
get_system_type_valuesRetrieves the values for a system type, by its name, paged, in Aprimo Marketing Operations.
list_system_typesLists all system types (name + API endpoint) in Aprimo Marketing Operations.

get_active_system_type_values​

Retrieves only the active values for a system type, by its name, paged, in Aprimo Marketing Operations. Use get_system_type_values to see all values (active and inactive).

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
systemTypestringYesThe system type's name (e.g. "Country").
limitintegerNoMaximum number of results to return (1-50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
sortFieldstringNoOptional field name to sort by. Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.

Returns:

FieldTypeDescription
systemTypestring (optional)The system type's name (echoes the caller's parameter).
totalRecordsintegerTotal record count across all pages.
countintegerNumber of items returned in this page (precomputed for the llm).
itemsarray of SystemTypeValueProjectionThe values for this page.
items[].systemTypeIdintegerThe value's integer identifier.
items[].resourceIdstring (optional)Resource-bundle key for the value's display label.
items[].descriptionstring (optional)The value's description.
items[].activeFlagintegerThe active flag (PM wires this as an integer, not a bool).
items[].sequenceinteger (optional)Sort sequence, when set.

get_allowed_child_pick_list_options​

Not currently available

Retrieves the allowed child pick list options for a parent pick list item, by the extended attribute's integer ID and the parent pick list item's integer ID, in Aprimo Marketing Operations.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
eaIdstringYesThe parent extended attribute's integer ID.
parentPicklistItemIdstringYesThe parent pick list item's integer ID.
filterstringNoOptional text used to filter the child pick list options. Omit for the full list.
limitintegerNoMaximum number of results to return (1-50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
childValueintegerNoOptional currently selected child list item value.

Returns:

FieldTypeDescription
listNamestring (optional)The list's name/identifier, when returned by the wire (named selection lists only -- EA pick-lists and allowed-child-lists don't carry one).
descriptionstring (optional)The list's description, when present.
countintegerNumber of items (precomputed for the llm).
itemsarray of SelectionListItemProjectionThe list's items.
items[].itemIdintegerThe item's integer value (PM's itemId).
items[].resourceIdstring (optional)Resource-bundle key for the item's display label -- not human-readable on its own (see ResourceTools' get_resource to resolve it).
items[].displayValuestring (optional)Display value identifier.
items[].sequenceinteger (optional)Sort sequence, when set.
items[].activebooleanWhether this item is active.
items[].systemNamestring (optional)Optional system (code) name for this item.
items[].colorstring (optional)Optional css color for this item.

get_lookup_list​

Retrieves a lookup list by its integer ID in Aprimo Marketing Operations.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
lookupIdstringYesThe lookup list's integer ID.
subListIdintegerNoOptional integer ID of a sub-list to retrieve. Default 0 (the top-level list).
filterTextstringNoOptional text used to filter the lookup entries. Omit for the full list.

Returns:

FieldTypeDescription
lookupIdintegerThe lookup list's integer identifier (echoes the caller's parameter).
descriptionstring (optional)The lookup list's description, if any.
countintegerNumber of items (precomputed for the llm; PM's own count field is also captured here, so the two should agree).
itemsarray of LookupListItemProjectionThe lookup list's items.
items[].keyintegerThe item's integer key.
items[].valuestring (optional)The item's display value.
items[].sequenceinteger (optional)Sort sequence, when set.
items[].activebooleanWhether this item is active.

get_metadata​

Retrieves metadata for a resource by its object name (e.g. "Activity", "Project") in Aprimo Marketing Operations -- field definitions, data types, and lookup/selection-list bindings. Not the groups variant (use get_metadata_for_groups for that).

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
resourceNamestringYesThe resource's object name (e.g. "Activity", "Project", "activity-forecast").

Returns:

FieldTypeDescription
objectNamestring (optional)The name of the resource this metadata describes.
supportsEAsbooleanWhether this object supports extended attributes.
supportsSecureEAsbooleanWhether this object supports secure extended attributes.
nameResourceIdstring (optional)Resource id for this resource's display name.
contentTypestring (optional)The mime type returned by the API for this resource, if any.
fieldCountintegerNumber of fields (precomputed for the llm).
fieldsarray of FieldMetadataProjectionThis resource's fields, flattened to their scalar properties.
fields[].fieldNamestring (optional)The field's name.
fields[].titleResourceIdstring (optional)Resource-bundle key for the field's display label.
fields[].fieldDataTypeintegerThe field's data type (PM's MetadataDataType enum, wired as an integer code).
fields[].lookupListIdinteger (optional)The lookup list id used by this field, if any.
fields[].attributeHelpTextIdstring (optional)Resource id for this field's attribute help text, if any.
fields[].timeValueTypeintegerHow a DateTime value on this field should be interpreted (PM's TimeConversionMethod enum, wired as an integer code).
fields[].amsAttributeIdinteger (optional)The ams attribute id used to identify this field, if any.
fields[].isSecurebooleanWhether this field has its own security controls.
fields[].isReadOnlybooleanWhether this field is read-only during an update.
fields[].allowInitialValuebooleanWhether this field can be set during creation.
fields[].inactivebooleanWhether this field is inactive.
fields[].selectionListNamestring (optional)The name of the selection list backing this field, if any.
fields[].entityFieldNamestring (optional)The corresponding field name on the entity.
fields[].systemTypeNamestring (optional)The system type name used when accessing the system-type API for this field, if any.
fields[].parentNamestring (optional)The name of the parent resource, if any.
fields[].parentFieldNamestring (optional)The name of the parent field for a pick-list relationship, if any.
fields[].parentFieldTypeinteger (optional)The parent field type (PM's MetadataFieldType enum, wired as an integer code), if any.
fields[].fieldTypeintegerThe metadata field type (PM's MetadataFieldType enum, wired as an integer code).
fields[].defaultValuestring (optional)The field's default value, if any.
fields[].tabSequenceintegerThe tab sequence identifier.
rawobject (optional)/// The full, untouched data object -- preserves the nested sub-structures (validation rules, value-manipulation rules, valid values, lookup values, child objects, EA sections) that doesn't flatten, same "Raw" precedent as AssociatedActivitiesResponse.

get_metadata_for_groups​

Retrieves metadata for the group resource in Aprimo Marketing Operations (field definitions, data types, and lookup/selection-list bindings). Deprecated on PM's side in favor of get_metadata with resourceName "groups" but retained for backward compatibility.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters: none.

Returns:

FieldTypeDescription
objectNamestring (optional)The name of the resource this metadata describes.
supportsEAsbooleanWhether this object supports extended attributes.
supportsSecureEAsbooleanWhether this object supports secure extended attributes.
nameResourceIdstring (optional)Resource id for this resource's display name.
contentTypestring (optional)The mime type returned by the API for this resource, if any.
fieldCountintegerNumber of fields (precomputed for the llm).
fieldsarray of FieldMetadataProjectionThis resource's fields, flattened to their scalar properties.
fields[].fieldNamestring (optional)The field's name.
fields[].titleResourceIdstring (optional)Resource-bundle key for the field's display label.
fields[].fieldDataTypeintegerThe field's data type (PM's MetadataDataType enum, wired as an integer code).
fields[].lookupListIdinteger (optional)The lookup list id used by this field, if any.
fields[].attributeHelpTextIdstring (optional)Resource id for this field's attribute help text, if any.
fields[].timeValueTypeintegerHow a DateTime value on this field should be interpreted (PM's TimeConversionMethod enum, wired as an integer code).
fields[].amsAttributeIdinteger (optional)The ams attribute id used to identify this field, if any.
fields[].isSecurebooleanWhether this field has its own security controls.
fields[].isReadOnlybooleanWhether this field is read-only during an update.
fields[].allowInitialValuebooleanWhether this field can be set during creation.
fields[].inactivebooleanWhether this field is inactive.
fields[].selectionListNamestring (optional)The name of the selection list backing this field, if any.
fields[].entityFieldNamestring (optional)The corresponding field name on the entity.
fields[].systemTypeNamestring (optional)The system type name used when accessing the system-type API for this field, if any.
fields[].parentNamestring (optional)The name of the parent resource, if any.
fields[].parentFieldNamestring (optional)The name of the parent field for a pick-list relationship, if any.
fields[].parentFieldTypeinteger (optional)The parent field type (PM's MetadataFieldType enum, wired as an integer code), if any.
fields[].fieldTypeintegerThe metadata field type (PM's MetadataFieldType enum, wired as an integer code).
fields[].defaultValuestring (optional)The field's default value, if any.
fields[].tabSequenceintegerThe tab sequence identifier.
rawobject (optional)/// The full, untouched data object -- preserves the nested sub-structures (validation rules, value-manipulation rules, valid values, lookup values, child objects, EA sections) that doesn't flatten, same "Raw" precedent as AssociatedActivitiesResponse.

get_pick_list_options​

Not currently available

Retrieves the pick list options for an extended attribute, by the attribute's integer ID, in Aprimo Marketing Operations.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
eaIdstringYesThe extended attribute's integer ID.
filterstringNoOptional text used to filter the pick list options. Omit for the full list.

Returns:

FieldTypeDescription
listNamestring (optional)The list's name/identifier, when returned by the wire (named selection lists only -- EA pick-lists and allowed-child-lists don't carry one).
descriptionstring (optional)The list's description, when present.
countintegerNumber of items (precomputed for the llm).
itemsarray of SelectionListItemProjectionThe list's items.
items[].itemIdintegerThe item's integer value (PM's itemId).
items[].resourceIdstring (optional)Resource-bundle key for the item's display label -- not human-readable on its own (see ResourceTools' get_resource to resolve it).
items[].displayValuestring (optional)Display value identifier.
items[].sequenceinteger (optional)Sort sequence, when set.
items[].activebooleanWhether this item is active.
items[].systemNamestring (optional)Optional system (code) name for this item.
items[].colorstring (optional)Optional css color for this item.

get_selection_list​

Retrieves a selection list by name in Aprimo Marketing Operations (e.g. "ActivityTypeList").

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
selectionListNamestringYesThe selection list's name (e.g. "ActivityTypeList") -- a bare string, not numeric.
parentValueintegerNoOptional parent list item value used to filter dependent list items. Omit for the full list.
filterstringNoOptional text used to filter the selection list items. Omit for the full list.

Returns:

FieldTypeDescription
listNamestring (optional)The list's name/identifier, when returned by the wire (named selection lists only -- EA pick-lists and allowed-child-lists don't carry one).
descriptionstring (optional)The list's description, when present.
countintegerNumber of items (precomputed for the llm).
itemsarray of SelectionListItemProjectionThe list's items.
items[].itemIdintegerThe item's integer value (PM's itemId).
items[].resourceIdstring (optional)Resource-bundle key for the item's display label -- not human-readable on its own (see ResourceTools' get_resource to resolve it).
items[].displayValuestring (optional)Display value identifier.
items[].sequenceinteger (optional)Sort sequence, when set.
items[].activebooleanWhether this item is active.
items[].systemNamestring (optional)Optional system (code) name for this item.
items[].colorstring (optional)Optional css color for this item.

get_system_type_value​

Retrieves a single value for a system type, by the system type's name and the value's integer ID, in Aprimo Marketing Operations.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
systemTypestringYesThe system type's name (e.g. "Country").
systemTypeIdstringYesThe value's integer ID.

Returns:

FieldTypeDescription
systemTypestring (optional)The system type's name (echoes the caller's parameter).
systemTypeIdintegerThe requested value's integer identifier (echoes the caller's parameter).
itemsarray of SystemTypeValueProjectionThe matching value(s) -- normally 0 or 1 entries.
items[].systemTypeIdintegerThe value's integer identifier.
items[].resourceIdstring (optional)Resource-bundle key for the value's display label.
items[].descriptionstring (optional)The value's description.
items[].activeFlagintegerThe active flag (PM wires this as an integer, not a bool).
items[].sequenceinteger (optional)Sort sequence, when set.

get_system_type_values​

Retrieves the values for a system type, by its name, paged, in Aprimo Marketing Operations. Use get_active_system_type_values to only see active values.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
systemTypestringYesThe system type's name (e.g. "Country").
limitintegerNoMaximum number of results to return (1-50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
sortFieldstringNoOptional field name to sort by. Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.

Returns:

FieldTypeDescription
systemTypestring (optional)The system type's name (echoes the caller's parameter).
totalRecordsintegerTotal record count across all pages.
countintegerNumber of items returned in this page (precomputed for the llm).
itemsarray of SystemTypeValueProjectionThe values for this page.
items[].systemTypeIdintegerThe value's integer identifier.
items[].resourceIdstring (optional)Resource-bundle key for the value's display label.
items[].descriptionstring (optional)The value's description.
items[].activeFlagintegerThe active flag (PM wires this as an integer, not a bool).
items[].sequenceinteger (optional)Sort sequence, when set.

list_system_types​

Lists all system types (name + API endpoint) in Aprimo Marketing Operations.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters: none.

Returns:

FieldTypeDescription
countintegerNumber of system types (precomputed for the llm).
itemsarray of SystemTypeSummaryProjectionThe system types.
items[].systemTypeNamestring (optional)The system type's name.
items[].uristring (optional)The API endpoint for this system type.

Look Up PM Users, Groups & Roles​

Can change data · 12 tools (11 currently available) · Group ID look-up-pm-users-groups

Needs: no other groups.

ToolWhat it does
get_current_pm_userReturns the calling user's own profile in Aprimo Marketing Operations.
get_my_region_preferencesReturns the calling user's region and language preferences (locale, language, date/time/number formats, timezone, currency, paper size, theme) in Aprimo Marketing Operations.
get_pm_groupReturns a single group by id in Aprimo Marketing Operations.
get_pm_group_membershipNot currently available. Lists the member users of a group by its integer ID in Aprimo Marketing Operations, paged.
get_pm_userReturns a single user by id in Aprimo Marketing Operations.
get_user_roleReturns a single user role by id in Aprimo Marketing Operations, including who last modified it.
list_domain_rightsLists domain rights configured in Aprimo Marketing Operations, paged.
list_pm_groupsLists groups in Aprimo Marketing Operations, paged and unfiltered.
list_user_rolesLists user roles in Aprimo Marketing Operations, paged.
search_pm_groupsSearches groups in Aprimo Marketing Operations by name, paged.
search_pm_usersSearches users in Aprimo Marketing Operations by name, paged.
update_my_region_preferencesUpdates the calling user's region and language preferences in Aprimo Marketing Operations.

get_current_pm_user​

Returns the calling user's own profile in Aprimo Marketing Operations. Use when the user asks about "my account"/"my profile"/"who am I".

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters: none.

Returns:

FieldTypeDescription
idstring (optional)The user's id. String because Users_GetById/Users_UpdateItem/Users_DeleteItem declare id as a bare string path parameter (no numeric route constraint) per the snapshot -- but the confirmed UserGroupProjection.userId wire field is declared as an ambiguous int32-or-string ("type": ["integer", "string"], ditto every other id/flag field in this hardened schema): kept as a dual-type-tolerant extraction (single confirmed key, not a casing guess) rather than a blind strict deserialize, since that ambiguity is genuine per the schema itself, not a guess.
namestring (optional)Composed from the confirmed firstName/lastName wire fields. UserGroupProjection has no name/userName field at all -- the old code's guess at those key names was wrong; corrected here now that the real field list is known.
rightsarray of UserRightProjection (optional)/// The PM functional rights this user holds, resolved from the api repo's own UserGroupProjection.Rights (ICollection<UserGroupRightsProjection>) -- confirmed via the PM OpenAPI hardening pass (features/pm-openapi-hardening) that this field is genuinely returned by Users_GetById/Users_GetUser (get_pm_user/get_current_pm_user), just never previously surfaced. Each is the same numbering space as api's UserRightsEnum (e.g. ProgramView = 15) -- the primitive a PM tool-visibility permission check would probe. Null if the raw response predates this field or omits it.
rights[].functionIdintegerSame numbering space as api's UserRightsEnum (e.g. ProgramView = 15).
rights[].functionNamestring (optional)
rights[].domainIdinteger
rawobject (optional)The complete wire object, verbatim -- see the class remarks.

get_my_region_preferences​

Returns the calling user's region and language preferences (locale, language, date/time/number formats, timezone, currency, paper size, theme) in Aprimo Marketing Operations.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters: none.

Returns:

FieldTypeDescription
localeIdinteger
languageIdinteger
dateFormatinteger
adamUiLanguagestring (optional)
timeFormatinteger
adamContentLanguagestring (optional)
numberFormatIdinteger
timezoneIdinteger (optional)
currencyCodeinteger
paperSizeinteger
autoSaveinteger (optional)
themeIdinteger (optional)

get_pm_group​

Returns a single group by id in Aprimo Marketing Operations. Not a specific membership (use get_pm_group_membership for that).

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Alternatively, identify the group by name instead of groupId.

Parameters:

ParameterTypeRequiredDescription
groupIdstringNoThe group's id. Provide either groupId or name, not both.
namestringNoThe group's name. Provide either groupId or name, not both.

Returns:

FieldTypeDescription
idstring (optional)The group's id. String because Groups_GetById/Groups_UpdateItem/Groups_DeleteItem declare id as a bare string path parameter (no numeric route constraint) per the snapshot -- but the confirmed GroupProjection.groupId wire field is declared as an ambiguous int32-or-string, same as : kept as a dual-type-tolerant extraction (single confirmed key) rather than a blind strict deserialize.
namestring (optional)From the confirmed name wire field (the old guess happened to be right, but was hedging against a PascalCase variant that the hardened schema confirms never occurs).
rawobject (optional)

get_pm_group_membership​

Not currently available

Lists the member users of a group by its integer ID in Aprimo Marketing Operations, paged. Resolves each member's user name.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
groupIdstringYesThe group's integer ID.
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
sortFieldstringNoOptional field name to sort by. Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of GroupMembershipItemProjectionThe items returned in this response.
items[].userIdinteger
items[].userNamestring (optional)

get_pm_user​

Returns a single user by id in Aprimo Marketing Operations.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
userIdstringYesThe user's id.

Returns:

FieldTypeDescription
idstring (optional)The user's id. String because Users_GetById/Users_UpdateItem/Users_DeleteItem declare id as a bare string path parameter (no numeric route constraint) per the snapshot -- but the confirmed UserGroupProjection.userId wire field is declared as an ambiguous int32-or-string ("type": ["integer", "string"], ditto every other id/flag field in this hardened schema): kept as a dual-type-tolerant extraction (single confirmed key, not a casing guess) rather than a blind strict deserialize, since that ambiguity is genuine per the schema itself, not a guess.
namestring (optional)Composed from the confirmed firstName/lastName wire fields. UserGroupProjection has no name/userName field at all -- the old code's guess at those key names was wrong; corrected here now that the real field list is known.
rightsarray of UserRightProjection (optional)/// The PM functional rights this user holds, resolved from the api repo's own UserGroupProjection.Rights (ICollection<UserGroupRightsProjection>) -- confirmed via the PM OpenAPI hardening pass (features/pm-openapi-hardening) that this field is genuinely returned by Users_GetById/Users_GetUser (get_pm_user/get_current_pm_user), just never previously surfaced. Each is the same numbering space as api's UserRightsEnum (e.g. ProgramView = 15) -- the primitive a PM tool-visibility permission check would probe. Null if the raw response predates this field or omits it.
rights[].functionIdintegerSame numbering space as api's UserRightsEnum (e.g. ProgramView = 15).
rights[].functionNamestring (optional)
rights[].domainIdinteger
rawobject (optional)The complete wire object, verbatim -- see the class remarks.

get_user_role​

Returns a single user role by id in Aprimo Marketing Operations, including who last modified it.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Alternatively, identify the role by name instead of roleId. Note: resolving by name scans the full role list.

Parameters:

ParameterTypeRequiredDescription
roleIdstringNoThe role's id. Provide either roleId or name, not both.
namestringNoThe role's name. Provide either roleId or name, not both.
excludeInactiveUserbooleanNoIf true, excludes inactive users from the role's membership count. Defaults to false.

Returns:

FieldTypeDescription
roleIdinteger
namestring (optional)
descriptionstring (optional)
activeFlagboolean (optional)
colorstring (optional)
currencyCodeinteger (optional)
usedInAnnotationsboolean (optional)
modifiedUserIdinteger (optional)
modifiedUserNamestring (optional)
modifiedDatestring (optional)
laborRateEnterednumber (optional)Gets or sets the LaborRateEntered. Confirmed against the now-real UserRole component schema (wave-10 field list was incomplete) -- added here, was previously missing entirely.
laborRateBasenumber (optional)Gets or sets the LaborRateBase. Confirmed against the now-real UserRole component schema -- added here, was previously missing entirely.
excludeFromChatboardsboolean (optional)Flag indicating whether the role excludes its users from the chatboard, wired as a 0/1 int (same convention as /). Confirmed against the now-real UserRole component schema -- added here, was previously missing entirely.

list_domain_rights​

Lists domain rights configured in Aprimo Marketing Operations, paged.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
sortFieldstringNoOptional field name to sort by. Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of RightProjectionThe items returned in this response.
items[].functionIDintegerThe function id -- same numbering space as api's UserRightsEnum/ (e.g. ProgramView = 15). Wire key is functionID (capitalized "ID", not the camelCase-policy-default functionId).
items[].namestring (optional)
items[].descriptionstring (optional)

list_pm_groups​

Lists groups in Aprimo Marketing Operations, paged and unfiltered. Use search_pm_groups when you need to filter by name; use this to browse.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
sortFieldstringNoOptional field name to sort by. Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of GroupProjectionThe items returned in this response.
items[].idstring (optional)The group's id. String because Groups_GetById/Groups_UpdateItem/Groups_DeleteItem declare id as a bare string path parameter (no numeric route constraint) per the snapshot -- but the confirmed GroupProjection.groupId wire field is declared as an ambiguous int32-or-string, same as : kept as a dual-type-tolerant extraction (single confirmed key) rather than a blind strict deserialize.
items[].namestring (optional)From the confirmed name wire field (the old guess happened to be right, but was hedging against a PascalCase variant that the hardened schema confirms never occurs).
items[].rawobject (optional)

list_user_roles​

Lists user roles in Aprimo Marketing Operations, paged. Resolves who last modified each role.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
sortFieldstringNoOptional field name to sort by (default 'RoleId'). Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of UserRoleProjectionThe items returned in this response.
items[].roleIdinteger
items[].namestring (optional)
items[].descriptionstring (optional)
items[].activeFlagboolean (optional)
items[].colorstring (optional)
items[].currencyCodeinteger (optional)
items[].usedInAnnotationsboolean (optional)
items[].modifiedUserIdinteger (optional)
items[].modifiedUserNamestring (optional)
items[].modifiedDatestring (optional)
items[].laborRateEnterednumber (optional)Gets or sets the LaborRateEntered. Confirmed against the now-real UserRole component schema (wave-10 field list was incomplete) -- added here, was previously missing entirely.
items[].laborRateBasenumber (optional)Gets or sets the LaborRateBase. Confirmed against the now-real UserRole component schema -- added here, was previously missing entirely.
items[].excludeFromChatboardsboolean (optional)Flag indicating whether the role excludes its users from the chatboard, wired as a 0/1 int (same convention as /). Confirmed against the now-real UserRole component schema -- added here, was previously missing entirely.

search_pm_groups​

Searches groups in Aprimo Marketing Operations by name, paged.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
nameFilterstringNoOptional case-insensitive substring filter on the group's name. Omit to match all groups.
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
sortFieldstringNoOptional field name to sort by. Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of GroupProjectionThe items returned in this response.
items[].idstring (optional)The group's id. String because Groups_GetById/Groups_UpdateItem/Groups_DeleteItem declare id as a bare string path parameter (no numeric route constraint) per the snapshot -- but the confirmed GroupProjection.groupId wire field is declared as an ambiguous int32-or-string, same as : kept as a dual-type-tolerant extraction (single confirmed key) rather than a blind strict deserialize.
items[].namestring (optional)From the confirmed name wire field (the old guess happened to be right, but was hedging against a PascalCase variant that the hardened schema confirms never occurs).
items[].rawobject (optional)

search_pm_users​

Searches users in Aprimo Marketing Operations by name, paged. A nameFilter is required -- PM has no match-all query for this endpoint.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
nameFilterstringNoRequired case-insensitive substring filter on the user's name -- PM has no match-all query for this endpoint, so this cannot be omitted.
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
sortFieldstringNoOptional field name to sort by. Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of UserProjectionThe items returned in this response.
items[].idstring (optional)The user's id. String because Users_GetById/Users_UpdateItem/Users_DeleteItem declare id as a bare string path parameter (no numeric route constraint) per the snapshot -- but the confirmed UserGroupProjection.userId wire field is declared as an ambiguous int32-or-string ("type": ["integer", "string"], ditto every other id/flag field in this hardened schema): kept as a dual-type-tolerant extraction (single confirmed key, not a casing guess) rather than a blind strict deserialize, since that ambiguity is genuine per the schema itself, not a guess.
items[].namestring (optional)Composed from the confirmed firstName/lastName wire fields. UserGroupProjection has no name/userName field at all -- the old code's guess at those key names was wrong; corrected here now that the real field list is known.
items[].rightsarray of UserRightProjection (optional)/// The PM functional rights this user holds, resolved from the api repo's own UserGroupProjection.Rights (ICollection<UserGroupRightsProjection>) -- confirmed via the PM OpenAPI hardening pass (features/pm-openapi-hardening) that this field is genuinely returned by Users_GetById/Users_GetUser (get_pm_user/get_current_pm_user), just never previously surfaced. Each is the same numbering space as api's UserRightsEnum (e.g. ProgramView = 15) -- the primitive a PM tool-visibility permission check would probe. Null if the raw response predates this field or omits it.
items[].rights[].functionIdintegerSame numbering space as api's UserRightsEnum (e.g. ProgramView = 15).
items[].rights[].functionNamestring (optional)
items[].rights[].domainIdinteger
items[].rawobject (optional)The complete wire object, verbatim -- see the class remarks.

update_my_region_preferences​

Updates the calling user's region and language preferences in Aprimo Marketing Operations. Only include the fields you intend to change (partial update; omitted fields are left as-is). Requires confirmed=true after showing the user the exact changes. Returns the updated preferences.

Parameters:

ParameterTypeRequiredDescription
bodystringYesJSON object with the fields to change (PM wire names, e.g. localeId/languageId/timezoneId/currencyCode). Omit fields you don't want to modify.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change.

Returns:

FieldTypeDescription
localeIdinteger
languageIdinteger
dateFormatinteger
adamUiLanguagestring (optional)
timeFormatinteger
adamContentLanguagestring (optional)
numberFormatIdinteger
timezoneIdinteger (optional)
currencyCodeinteger
paperSizeinteger
autoSaveinteger (optional)
themeIdinteger (optional)