CRM

Related contact

The related contact, as returned by the API.

Schemas: RelatedContactDto

{
  "id": "id_8f2a1c",
  "name": "Example",
  "commercialName": "Example",
  "contactType": "person",
  "role": "client",
  "status": "active",
  "relationRole": "string"
}

Generated from the schema

The link between two contacts, with the role the related contact plays (relationRole): a person at a company, for example. The relationship works in both directions, and removing it does not delete either contact. List the contacts related to one contact with GET /api/v1/contacts/{contactId}/related-contacts.

Attributes

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.

Values

contactType: person, company
role: client, provider, lead, debtor, creditor, student, teacher, unspecified
status: active, inactive, archived

Returned by

GET /api/v1/contacts/{contactId}/related-contacts — List the contacts related to a contact

Modified by

No operation.

Was this page helpful?