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.
Request examples
curl https://app.filmo.io/api/v1/contacts/cont_8f2a1c/related-contacts \
--header "Authorization: Bearer $FILMO_API_KEY"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
Contact identifier.
Limits: min length 1
Response
Successful response.
Response schema: RelatedContactDto
Envelope: RelatedContactItems. meta. is present only when the operation is deprecated.
Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Show child attributesHide child attributes
Unique identifier of the related contact.
Name of the related contact.
Trade name of the related contact; null if not recorded.
Type of the related contact: person or company.
Available options: person, company
Role of the related contact.
Available options: client, provider, lead, debtor, creditor, student, teacher, unspecified
Status of the related contact: active, inactive or archived.
Available options: active, inactive, archived
Role of the relationship between the two contacts (e.g. "employee of"); null if not recorded.
Additional information about the response.
Show child attributesHide child attributes
Lifecycle warnings; present only when the operation is deprecated.
Show child attributesHide child attributes
Stable warning code.
Available options: deprecated
For people: what is deprecated, until when, and what to use.
Day (YYYY-MM-DD) the operation stops being served.
operationId of the operation to use instead, or null if there is none.
Where the deprecation is documented (the changelog).
Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin).
Headers: X-Request-Id · Content-Language
Not allowed (insufficient_scope: the API key does not have the required scope, named in requiredScope; forbidden: the owner of the key lacks the permission the operation requires). insufficient_scope is answered before the request counts against the rate limit, so it carries no RateLimit-* headers; forbidden does.
Headers: X-Request-Id · Content-Language
Resource not found (not_found): it does not exist or is outside the scope of the API key.
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Rate limit exceeded (rate_limited): retry after Retry-After seconds; RateLimit-* says which quota ran out.
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Retry-After
Internal error (internal_error).
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Errors
Deprecation
This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date. Versioning policy
Related pages
Link to this section: Related pagesCRM
Related contact
The related contact, as returned by the API.
Was this page helpful?