Listar propuestas

Solo lectura. Pase external_system + external_id juntos para buscar una sola propuesta por un ID externo en lugar de listar propuestas.

GET /v1/proposals

Token Bearer

curl 'https://api.sendapropos.com/v1/proposals?limit=1&cursor=example&status=draft&external_system=example&external_id=external_01JXY9AZK4KV' \
  --request GET \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "id": "123e4567-e89b-42d3-a456-426614174000",
      "proposalNumber": 1,
      "name": "example",
      "customerId": "123e4567-e89b-42d3-a456-426614174000",
      "status": "draft",
      "clientName": "example",
      "clientEmail": "[email protected]",
      "createdAt": "2026-01-01T12:00:00Z"
    }
  ],
  "nextCursor": "example"
}

Una página de propuestas.

Parámetros de consulta

· 5

limit integer · min: 1· max: 100

Tamaño de página, 1-100. El valor predeterminado es 25.

cursor string

Cursor de paginación opaco de la propiedad nextCursor de una respuesta anterior.

status ProposalStatus · enumeración

expired se calcula en el momento de la lectura según la fecha de vencimiento de la propuesta; no es un estado que se escriba en la base de datos. No existe un valor viewed en la respuesta: se registra internamente como una entrada del registro de actividad, no como un estado.

valores

draft
sent
accepted
partially_signed
signed
expired

external_system string

Nombre del sistema externo propietario de external_id (por ejemplo, zapier, quickbase). Debe combinarse con external_id.

external_id string

ID del registro del sistema externo. Debe combinarse con external_system.

Parámetros de consulta

Respuestas