Contacts

List the contacts related to a contact

Returns the contacts tied to this one, in both directions of the relationship, each with the role of the relationship.

Tool

filmo_contacts_related_list

Readcontacts:read

contacts:read
120/min
Server annotation: Read-only
Server annotation: Idempotent

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_contacts_related_list",
    "arguments": {
      "contactId": "cont_8f2a1c"
    }
  }
}

{
  "structuredContent": {
    "data": [
      {
        "id": "id_8f2a1c",
        "name": "Example",
        "commercialName": "Example",
        "contactType": "person",
        "role": "client",
        "status": "active",
        "relationRole": "<relationRole>"
      }
    ],
    "meta": {
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      },
      "etag": "\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""
    }
  }
}

generated from the schema

The contact detail returns the same list under relatedContacts; this is the sub-resource for reading it on its own.

Arguments

contactIdstringRequired

Contact identifier.

Limits: min length 1

Result

On success the result carries structuredContent with data and meta. These are the attributes of data.

Show the attributes of data

idstring

Unique identifier of the related contact.

namestring

Name of the related contact.

commercialNamestring | null

Trade name of the related contact; null if not recorded.

contactTypestring

Type of the related contact: person or company.

Available options: person, company

rolestring

Role of the related contact.

Available options: client, provider, lead, debtor, creditor, student, teacher, unspecified

statusstring

Status of the related contact: active, inactive or archived.

Available options: active, inactive, archived

relationRolestring | null

Role of the relationship between the two contacts (e.g. "employee of"); null if not recorded.

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs GET /api/v1/contacts/{contactId}/related-contacts.

Contacts
List the contacts related to a contact
Returns the contacts tied to this one, in both directions of the relationship, each with the role of the relationship.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with isError: true and the problem in the first text block. Branch on its code.

Was this page helpful?

Result

Arguments

Result

The same operation by REST

Related pages

List the contacts related to a contact

Safe writes

Errors