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.

GET
/api/v1/contacts/{contactId}/related-contacts

Request examples

curl https://app.filmo.io/api/v1/contacts/cont_8f2a1c/related-contacts \
  --header "Authorization: Bearer $FILMO_API_KEY"
{
  "data": [
    {
      "id": "related_contact_9f3a2b",
      "name": "Example related contact",
      "commercialName": "Example commercial name",
      "contactType": "person",
      "role": "client",
      "status": "active",
      "relationRole": "Example relation role"
    }
  ]
}

Generated from the schema

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

Authorizations

Bearer API key with the scope below. contacts:read

Path parameters

contactIdstringRequired

Contact identifier.

Limits: min length 1

Response

application/json

Successful response.

Response schema: RelatedContactDto

Envelope: RelatedContactItems. meta.warnings is present only when the operation is deprecated.

Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset

dataobject[]

Show child attributes
data.idstring

Unique identifier of the related contact.

data.namestring

Name of the related contact.

data.commercialNamestring | null

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

data.contactTypestring

Type of the related contact: person or company.

Available options: person, company

data.rolestring

Role of the related contact.

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

data.statusstring

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

Available options: active, inactive, archived

data.relationRolestring | null

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

metaobject

Additional information about the response.

Show child attributes
meta.warningsobject[]

Lifecycle warnings; present only when the operation is deprecated.

Show child attributes
meta.warnings.codestring

Stable warning code.

Available options: deprecated

meta.warnings.messagestring

For people: what is deprecated, until when, and what to use.

meta.warnings.sunsetstring

Day (YYYY-MM-DD) the operation stops being served.

meta.warnings.replacementstring | null

operationId of the operation to use instead, or null if there is none.

Errors

StatusCodesMeaning
404not_foundIt does not exist or is outside the scope of the API key.

401, 403, 429, 500 can be returned by any operation. Errors

Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date. Versioning policy