Contactos

Listar los contactos relacionados con un contacto

Devuelve los contactos vinculados a este, en ambos sentidos de la relación, cada uno con el rol de la relación.

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

Ejemplos de petición

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"
    }
  ]
}

Generado a partir del esquema

El detalle del contacto devuelve la misma lista en relatedContacts; este es el subrecurso para leerla por separado.

Autorizaciones

Clave de API como Bearer, con el permiso de abajo. contacts:read

Parámetros de ruta

contactIdstringObligatorio

Identificador del contacto.

Límites: longitud mín. 1

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: RelatedContactDto

Sobre: RelatedContactItems. meta.warnings solo aparece cuando la operación está obsoleta.

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

dataobject[]

Mostrar atributos hijos
data.idstring

Identificador único del contacto relacionado.

data.namestring

Nombre del contacto relacionado.

data.commercialNamestring | null

Nombre comercial del contacto relacionado; null si no consta.

data.contactTypestring

Tipo del contacto relacionado: person o company.

Opciones disponibles: person, company

data.rolestring

Rol del contacto relacionado.

Opciones disponibles: client, provider, lead, debtor, creditor, student, teacher, unspecified

data.statusstring

Estado del contacto relacionado: active, inactive o archived.

Opciones disponibles: active, inactive, archived

data.relationRolestring | null

Rol de la relación entre los dos contactos (p. ej. "empleado de"); null si no consta.

metaobject

Información adicional sobre la respuesta.

Mostrar atributos hijos
meta.warningsobject[]

Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.

Mostrar atributos hijos
meta.warnings.codestring

Código de aviso estable.

Opciones disponibles: deprecated

meta.warnings.messagestring

Para personas: qué está obsoleto, hasta cuándo y qué usar.

meta.warnings.sunsetstring

Día (YYYY-MM-DD) en que la operación deja de estar disponible.

meta.warnings.replacementstring | null

operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.

Errores

EstadoCódigosSignificado
404not_foundNo existe o queda fuera del alcance de la clave de API.

401, 403, 429, 500 los puede devolver cualquier operación. Errores

Obsolescencia

Esta operación no está obsoleta. Las obsolescencias se anuncian con la cabecera Deprecation y una fecha de retirada. Política de versiones