Observadores

Personas que pueden ver el contrato sin firmarlo.

GET/api/contracts/{contractId}/spectators

Listar observadores

Personas que pueden ver el contrato sin firmarlo.

Autenticación. Cabecera apikey con tu API key, o Authorization: Bearer con un token.

Parámetros de ruta

  • contractIdstringobligatorio

    ID del contrato.

Respuestas

  • 200array<object>
  • 400Petición no válida: parámetros, contrato inexistente o en un estado que no lo permite.
  • 401Credencial ausente, caducada o de otro entorno.
  • 403Al usuario le falta un privilegio (p. ej. API_ACCESS).

Petición

GET
/api/contracts/{contractId}/spectators
curl "https://enterprise-stage.api.trato.io/api/contracts/{contractId}/spectators" \
  -H "apikey: $TRATO_API_KEY"

Respuesta

[
  {
    "_id": "string",
    "attachments": [
      {}
    ],
    "email": "string",
    "jwt": "string",
    "linkExpirationDate": "2026-01-01T00:00:00.000Z",
    "name": "string",
    "phone": "string"
  }
]
POST/api/contracts/{contractId}/spectators

Añadir un observador

Autenticación. Cabecera apikey con tu API key, o Authorization: Bearer con un token.

Parámetros de ruta

  • contractIdstringobligatorio

    ID del contrato.

Cuerpo application/json

  • emailstring

    Correo del observador.

  • linkExpirationDatestring

    Caducidad del acceso (fecha ISO 8601).

  • namestring

    Nombre del observador.

  • phonestring

    Teléfono con prefijo internacional.

Respuestas

  • 200object
    Campos de la respuesta
    • successbooleanobligatorio
  • 400Petición no válida: parámetros, contrato inexistente o en un estado que no lo permite.
  • 401Credencial ausente, caducada o de otro entorno.
  • 403Al usuario le falta un privilegio (p. ej. API_ACCESS).

Petición

POST
/api/contracts/{contractId}/spectators
curl -X POST "https://enterprise-stage.api.trato.io/api/contracts/{contractId}/spectators" \
  -H "apikey: $TRATO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "marta@example.com",
  "linkExpirationDate": "2026-12-31T23:59:59Z",
  "name": "Marta Ruiz",
  "phone": "+34600000000"
}'

Respuesta

{
  "success": true
}
PUT/api/contracts/{contractId}/spectators/{spectatorId}

Editar un observador

Autenticación. Cabecera apikey con tu API key, o Authorization: Bearer con un token.

Parámetros de ruta

  • contractIdstringobligatorio

    ID del contrato.

  • spectatorIdstringobligatorio

    ID del observador (_id en el listado).

Cuerpo application/json

  • emailstring

    Correo del observador.

  • linkExpirationDatestring

    Caducidad del acceso (fecha ISO 8601).

  • namestring

    Nombre del observador.

  • phonestring

    Teléfono con prefijo internacional.

Respuestas

  • 200object
    Campos de la respuesta
    • successbooleanobligatorio
  • 400Petición no válida: parámetros, contrato inexistente o en un estado que no lo permite.
  • 401Credencial ausente, caducada o de otro entorno.
  • 403Al usuario le falta un privilegio (p. ej. API_ACCESS).

Petición

PUT
/api/contracts/{contractId}/spectators/{spectatorId}
curl -X PUT "https://enterprise-stage.api.trato.io/api/contracts/{contractId}/spectators/{spectatorId}" \
  -H "apikey: $TRATO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "marta@example.com",
  "linkExpirationDate": "2026-12-31T23:59:59Z",
  "name": "Marta Ruiz",
  "phone": "+34600000000"
}'

Respuesta

{
  "success": true
}
DELETE/api/contracts/{contractId}/spectators/{spectatorId}

Quitar un observador

Autenticación. Cabecera apikey con tu API key, o Authorization: Bearer con un token.

Parámetros de ruta

  • contractIdstringobligatorio

    ID del contrato.

  • spectatorIdstringobligatorio

    ID del observador.

Respuestas

  • 200object
    Campos de la respuesta
    • successbooleanobligatorio
  • 400Petición no válida: parámetros, contrato inexistente o en un estado que no lo permite.
  • 401Credencial ausente, caducada o de otro entorno.
  • 403Al usuario le falta un privilegio (p. ej. API_ACCESS).

Petición

DELETE
/api/contracts/{contractId}/spectators/{spectatorId}
curl -X DELETE "https://enterprise-stage.api.trato.io/api/contracts/{contractId}/spectators/{spectatorId}" \
  -H "apikey: $TRATO_API_KEY"

Respuesta

{
  "success": true
}