Skip to main content
Modem logo
  • Category: analytics
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 30
  • Triggers: 0
  • Slug: MODEM
  • Version: 20261101_00

Tools

Slug: MODEM_ADD_PEOPLE_TO_COMPANYAssociate one or more existing people with an existing company. People already associated with the company are reported as skipped. This changes company membership, and the approved API surface has no inverse removal operation.

Input Parameters

string
required
Decimal Modem company ID that receives the people.
array
required
One or more decimal IDs of existing people to associate with the company.
string
Optional retry key; reuse only for the identical request within 24 hours.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_CREATE_COMPANIESCreate one to 50 companies in one batch. Each item succeeds or fails independently; use a one-item array to create one company.

Input Parameters

array
required
Companies to create (1-50); use a one-item array for one company.
string
Optional retry key; reuse only for the identical request within 24 hours.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_CREATE_PEOPLECreate one to 50 people in one batch. Each item succeeds or fails independently; use a one-item array to create one person.

Input Parameters

array
required
People to create (1-50); use a one-item array for one person.
string
Optional retry key; reuse only for the identical request within 24 hours.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_GET_CHANNELGet one channel’s source details, connection state, context, timestamps, and message count by UUID.

Input Parameters

string
required
Modem channel UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_GET_COMPANYGet one company’s core details, connection values, domain, logo, and VIP status by decimal ID.

Input Parameters

string
required
Decimal Modem company ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_GET_COMPANY_ACTIVITYGet one company’s message count, weekly activity series, and source-level message breakdown.

Input Parameters

string
required
Decimal Modem company ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_GET_COMPANY_HISTORYGet up to 50 company audit records plus merge history. The API reports the total audit count but exposes no cursor or page parameter, so this tool cannot retrieve records beyond the requested limit.

Input Parameters

integer
Maximum audit records returned (1-50). The API provides no cursor or page parameter, so records beyond this limit cannot be retrieved.
array
Actor types to include; omit for the provider default of user and agent changes, which excludes system changes.
string
required
Decimal Modem company ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_GET_COMPANY_IDENTITIESGet external platform identities linked to one company by Modem’s identify operation.

Input Parameters

string
required
Decimal Modem company ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_GET_CURRENT_ORGANIZATIONReturn the organization selected by the connected API key. Use this as an authentication smoke test and to confirm the active tenant; it returns no member, credential, or plan details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_GET_PERSONGet one person’s profile, including company, connections, tags, sources, timestamps, identity count, and message activity aggregates.

Input Parameters

string
required
Decimal Modem person ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_GET_PERSON_HISTORYGet up to 50 person audit records plus merge history. The API reports the total audit count but exposes no cursor or page parameter, so this tool cannot retrieve records beyond the requested limit.

Input Parameters

integer
Maximum audit records returned (1-50). The API provides no cursor or page parameter, so records beyond this limit cannot be retrieved.
string
required
Decimal Modem person ID.
array
Actor types to include; omit for the provider default of user and agent changes, which excludes system changes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_GET_PERSON_IDENTITIESGet all external platform identities linked to one person.

Input Parameters

string
required
Decimal Modem person ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_GET_PERSON_SOURCE_STATSGet one person’s message counts broken down by source platform.

Input Parameters

string
required
Decimal Modem person ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_GET_TOPICGet one topic’s complete details, including its summary, classification, lifecycle, priority, keywords, time range, archive state, and event count.

Input Parameters

string
required
Modem topic UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_GET_TOPIC_GROUPSGet every message group assigned to one topic in ascending or descending group-time order. Modem does not paginate or limit this endpoint, so topics with many deeply nested messages can return a large response.

Input Parameters

string ("asc" | "desc")
Ascending or descending group-time order.
string
required
Modem topic UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_GET_TOPIC_HISTORYGet up to 50 topic audit records plus merge history and the total audit count. The actions list is always empty; audit records beyond the requested limit cannot be retrieved by this tool.

Input Parameters

integer
Maximum audit records returned (1-50). The API provides no cursor or page parameter, so records beyond this limit cannot be retrieved.
string
required
Modem topic UUID.
array
Actor types to include; omit for the provider default of user and agent changes, which excludes system changes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_GET_TOPIC_PEOPLEGet every unique person who participated in one topic, including source identities, company, profile, VIP state, and contribution count.

Input Parameters

string
required
Modem topic UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_IDENTIFY_EXTERNAL_RECORDSUpsert links from external platform records to Modem people and companies in batches of 50. Modem matches platform identities before natural keys, can create records only from the documented creation fields, links resolved memberships, and reports probable duplicate conflicts without merging them.

Input Parameters

string
Optional retry key; reuse only for the identical request within 24 hours.
array
required
External records to resolve and link (1-50). Each item may contain person facts, company facts, or both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_LIST_CHANNELSList organization channels with connection state and message counts, optionally filtered by source, name, or channel IDs.

Input Parameters

integer
Maximum channels in this page (1-100).
string
Opaque continuation cursor returned by a previous call; omit for the first page.
Non-empty channel-name search text.
array
UUID channel IDs to return; omit when not filtering by ID.
string
Source slug to match, such as slack or discord; omit for every source.
boolean
When true, exclude channels whose backing integration is no longer connected; currently affects GitHub repository channels only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_LIST_COMPANIESList companies with person and message aggregates, optionally searching and sorting the result. Returns one page and an opaque continuation cursor.

Input Parameters

integer
Maximum companies in this page (1-100).
string
Opaque continuation cursor returned by a previous call; omit for the first page.
string
Non-empty company search text.
string ("lastSeen" | "messageCount" | "personCount")
Company field used to sort results.
string ("asc" | "desc")
Ascending or descending result order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_LIST_GROUPSList message groups for exactly one company or one person, returning compact message content and topic context one page at a time.

Input Parameters

integer
Maximum groups in this page (1-50); use a conservative value because each group includes messages.
string
Opaque continuation cursor returned by a previous call; omit for the first page.
string
Decimal person ID whose groups to list; provide this or company_id, never both.
string
Decimal company ID whose groups to list; provide this or person_id, never both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_LIST_PEOPLEList people with aggregated message statistics, optionally filtering by search text, ecosystem tags, or company and sorting the result. Returns one page and an opaque continuation cursor.

Input Parameters

integer
Maximum people in this page (1-100).
string
Opaque continuation cursor returned by a previous call; omit for the first page.
string
Non-empty person search text.
string ("lastSeen" | "messageCount")
Person field used to sort results.
string
Decimal company ID whose current people to return.
string ("asc" | "desc")
Ascending or descending result order.
array
Ecosystem tags to OR-match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_LIST_TOPICSList or search topics by keywords or semantic meaning with organization, participant, source, status, date, and classification filters, one page at a time. Semantic search takes precedence when both search modes are supplied.

Input Parameters

string ("v1" | "v2")
Requested topic pipeline. v2 is honored only when enabled for the organization; otherwise Modem may serve v1.
integer
Maximum topics in this page (1-100).
string
Opaque continuation cursor returned by a previous call; omit for the first page.
string
Keyword title search. Ignored when embedding_search is provided; wrap a token in double quotes for exact matching.
string ("date" | "groups" | "lifecycle" | "priority" | "similarity")
Topic ordering field; similarity is most useful with semantic search.
array
Message sources to include with case-insensitive OR matching.
string
ISO 8601 end of the topic-overlap range; provide with date_start.
array
Categories to include with case-insensitive OR matching.
string
ISO 8601 start of the topic-overlap range; provide with date_end.
array
Person IDs to include with OR matching.
array
Priority levels to include.
string ("asc" | "desc")
Ascending or descending result order.
array
Company IDs to include with OR matching.
array
Issue classifications to include.
array
Product UUIDs to include; use the literal none to also match topics without product attribution.
array
Team response states to include.
number
Minimum cosine similarity for semantic search (0-1).
array
Message sources topics must not contain, using OR exclusion.
array
Linked-ticket presence states to include.
Semantic query that searches by meaning and takes precedence over search.
array
Lifecycle states to include; unknown also matches topics without an assessment.
array
Categories topics must not have, using case-insensitive OR exclusion.
array
Person IDs to exclude with OR exclusion.
array
Priority levels to exclude.
array
Company IDs to exclude with OR exclusion.
array
Issue classifications to exclude.
array
Product UUIDs to exclude; use the literal none to exclude unattributed topics.
array
Linked-ticket presence states to exclude.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_MERGE_COMPANIESIrreversibly merge one or more source companies into one surviving target. All domains, person associations, and Slack workspaces move to the target, and source records cannot be restored by this API. Requires explicit confirm_irreversible=true. Supply an Idempotency-Key when retrying the same merge to avoid applying it twice.

Input Parameters

string
Optional Idempotency-Key for safe retries. Reuse it only for the identical merge request within 24 hours; changing the payload with the same key causes a conflict.
string
required
Decimal company ID that survives and receives all source data.
array
required
One to 50 unique decimal company IDs that will be absorbed and cease to remain independent; must exclude target_company_id.
boolean
required
Must be true to acknowledge that the merge is irreversible and source companies cannot be restored. This confirmation is validated locally and is not sent to Modem.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_MERGE_PEOPLEIrreversibly merge one or more source people into one surviving target. All identities, emails, and company associations move to the target, and source records cannot be restored by this API. Requires explicit confirm_irreversible=true. Supply an Idempotency-Key when retrying the same merge to avoid applying it twice.

Input Parameters

string
Optional Idempotency-Key for safe retries. Reuse it only for the identical merge request within 24 hours; changing the payload with the same key causes a conflict.
string
required
Decimal person ID that survives and receives all source data.
array
required
One to 50 unique decimal person IDs that will be absorbed and cease to remain independent; must exclude target_person_id.
boolean
required
Must be true to acknowledge that the merge is irreversible and source people cannot be restored. This confirmation is validated locally and is not sent to Modem.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_MERGE_TOPICSSubmit a request to merge up to 50 source topics into a target, with explicit irreversible confirmation. Modem currently does not support topic merging: the request changes nothing and returns an error.

Input Parameters

string
Optional Idempotency-Key for safe retries. Reuse it only for the identical merge request within 24 hours; changing the payload with the same key causes a conflict.
string
required
Topic UUID that remains active and receives copies of the source topics’ group and event associations.
array
required
Topic UUIDs to archive and merge into the target (1-50). Each source topic is marked merged, ceases to remain an active independent topic, and must not equal target_topic_id. Already archived sources are rejected.
boolean
required
Must be true to acknowledge that every source topic will be archived and marked merged, and that this operation cannot be undone through the Modem API. This confirmation is validated locally and is not sent to Modem.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_UPDATE_COMPANIESUpdate one to 50 companies in one batch. Omitted fields remain unchanged, explicit null values clear nullable fields, and each item reports success independently.

Input Parameters

array
required
Company updates (1-50). Use a one-item array for one company.
string
Optional retry key; reuse only for the identical request within 24 hours.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_UPDATE_PEOPLEUpdate one to 50 people in one batch. Omitted fields remain unchanged, explicit null values clear nullable fields, and each item reports success independently.

Input Parameters

array
required
Person updates (1-50). Use a one-item array for one person.
string
Optional retry key; reuse only for the identical request within 24 hours.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_UPDATE_TOPICUpdate one topic’s priority, lifecycle, or archive state; omitted fields remain unchanged. Requests that set issue type or keywords are rejected by Modem.

Input Parameters

boolean
True archives the topic; false unarchives it; omit to leave it unchanged.
array
Complete replacement keyword/category list (up to 20). An empty list clears all keywords; omit the field to leave them unchanged.
string ("very_low" | "low" | "default" | "high" | "very_high")
New topic priority. Omit to leave it unchanged.
string
required
Modem topic UUID.
string ("bug_report" | "complaint" | "discussion" | "feature_request" | "praise")
New issue classification, null to clear it, or omit to leave it unchanged.
string
Archive reason, allowed only when archived is explicitly true.
string
Optional retry key; reuse only for the identical request within 24 hours.
string ("open" | "in_progress" | "completed" | "dismissed")
New lifecycle state. Omit to leave it unchanged; unknown is AI-assessed and cannot be set directly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MODEM_UPDATE_TOPICSSet priority or archive state for one to 100 topics at once. Provide at least one change, use archived=false to unarchive, and provide an archive reason only with archived=true.

Input Parameters

boolean
True archives every selected topic; false unarchives them.
string ("very_low" | "low" | "default" | "high" | "very_high")
Priority to assign to every selected topic.
array
required
Modem topic UUIDs to update (1-100).
string
Optional archive reason, allowed only when archived is true.
string
Optional retry key; reuse only for the identical request within 24 hours.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not