Contactos

Buscar contactos por referencia externa

A partir de una lista de tus referencias, indica cuáles ya existen en Filmo y cuáles no.

POST
/api/v1/contacts/lookup

Ejemplos de petición

curl https://app.filmo.io/api/v1/contacts/lookup \
  --request POST \
  --header "Authorization: Bearer $FILMO_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "references": [
    "ERP-CLI-0042",
    "ERP-CLI-0043",
    "ERP-CLI-9999"
  ]
}'
{
  "data": {
    "contacts": [
      {
        "id": "contact_9f3a2b",
        "name": "Example contact",
        "contactNumber": "2026-0001"
      }
    ],
    "notFound": [
      "Example not found"
    ]
  }
}

Generado a partir del esquema

notFound son las que hay que crear. Es la primitiva de cualquier sincronización: sin ella, la alternativa es una llamada por referencia y deducirlo del 404. NO escribe NADA, aunque sea un POST: la lista de referencias no cabe en una query string.

Autorizaciones

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

Cuerpo

application/json

Esquema del cuerpo: ContactsLookupBody

referencesstring[]Obligatorio

Referencias externas que buscar. Al menos una, como máximo 200.

Límites: mín. 1 elementos, máx. 200 elementos, cada uno: longitud mín. 1

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: ContactsLookupResultDto

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

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

dataobject

Resultado de buscar contactos por referencia externa.

Mostrar atributos hijos
data.contactsobject[]

Contactos que coincidieron con al menos una referencia.

Mostrar atributos hijos
data.contacts.idstring

Identificador del contacto en Filmo.

data.contacts.namestring

Nombre del contacto.

data.contacts.contactNumberstring

Número del contacto en Filmo.

data.notFoundstring[]

Referencias que no coincidieron con ningún contacto. Son las que hay que crear.

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
400validation_errorConsulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable.
404not_foundNo existe o queda fuera del alcance de la clave de API.
409conflictEl estado actual del recurso impide la operación, ya hay en curso una petición con esa Idempotency-Key, u otra escritura condicional (If-Match) retuvo el recurso durante más de cinco segundos. errors[0].code indica cuál: in_progress y lock_timeout se resuelven reintentando; invalid_state no, porque el estado del recurso prohíbe la operación.

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