> ## Documentation Index > Fetch the complete documentation index at: https://docs.pruff.com/llms.txt > Use this file to discover all available pages before exploring further. # Obtener prospectos > Obtiene los prospectos de la pestaña Prospectos del CRM: empresas que no están en tu cartera y que ceden facturas de deudores que sí están en ella. Por cada prospecto entrega el monto cedido en el período, el factoring que más le compra y el reparto del monto entre cada factoring, con los deudores cuyas facturas compra cada uno. Los prospectos no son registros guardados: se calculan en el momento a partir de las cesiones del período. Por eso no tienen `id` ni fechas de creación o modificación, y no se pueden pedir solo los cambios desde una fecha. Los registros vienen ordenados desde el prospecto con mayor monto cedido; si dos tienen el mismo monto, por RUT. El servicio está paginado y el tamaño máximo de página es 500. Cualquier query param que no esté en esta lista responde un error 400. ## OpenAPI ````yaml openapi/clients.yaml GET /crm/opportunities openapi: 3.1.0 info: title: API de clientes de Pruff version: '1' description: >- Endpoints que tus sistemas llaman para leer y operar los datos de tu empresa en Pruff. Todas las solicitudes van por HTTPS y se autentican con el header `x-api-key`. Las convenciones de formato, paginación y errores se describen en https://docs.pruff.com/api/introduccion. servers: - url: https://api.pruff.com/api/clients security: - ApiKeyAuth: [] tags: - name: Facturas description: Consulta de facturas electrónicas, facturas transables y cesiones. - name: Documentos description: Consulta y creación de documentos asociados a tus clientes. - name: Archivos description: Carga de archivos a operaciones y a los requerimientos de tus documentos. - name: Financiamiento description: >- Simula créditos, crea solicitudes de factoring y consulta las prórrogas de tu empresa. - name: Comité description: >- Consulta las aprobaciones de una solicitud en los comités de riesgo y de operaciones, y registra nuevas firmas. - name: Chat description: Exporta y envía mensajes del chat de una solicitud. - name: Reportes description: >- Reportes de operaciones, cartera, recaudaciones, cuentas pendientes y flujos de tu empresa. - name: Datahub description: >- Consulta de la información tributaria, financiera y de riesgo que Pruff tiene de tus clientes y deudores. - name: Mercado Público description: >- Licitaciones y órdenes de compra de Mercado Público (ChileCompra) cargadas en Pruff. - name: CRM description: >- Datos comerciales de tu CRM en Pruff: empresas con su ficha, pipeline, prospectos, gestiones y simulaciones. - name: SGR description: Operaciones SGR (garantías) de tu empresa. - name: Sincronizador description: >- Pide sincronizar a un cliente con el SII o la TGR para obtener su información más actualizada, y consulta el estado de esas sincronizaciones. - name: Usuarios description: >- Administra los usuarios de tu empresa en Pruff (crear, editar, eliminar, consultar su perfil y asignar subordinados) y consulta las cuentas (empresas conectadas) a las que cada usuario tiene acceso. - name: Contactos description: Crea contactos asociados a las empresas de tu cartera. paths: /crm/opportunities: get: tags: - CRM summary: Obtener prospectos description: >- Obtiene los prospectos de la pestaña Prospectos del CRM: empresas que no están en tu cartera y que ceden facturas de deudores que sí están en ella. Por cada prospecto entrega el monto cedido en el período, el factoring que más le compra y el reparto del monto entre cada factoring, con los deudores cuyas facturas compra cada uno. Los prospectos no son registros guardados: se calculan en el momento a partir de las cesiones del período. Por eso no tienen `id` ni fechas de creación o modificación, y no se pueden pedir solo los cambios desde una fecha. Los registros vienen ordenados desde el prospecto con mayor monto cedido; si dos tienen el mismo monto, por RUT. El servicio está paginado y el tamaño máximo de página es 500. Cualquier query param que no esté en esta lista responde un error 400. operationId: getCrmOpportunities parameters: - name: period in: query required: false description: >- Meses hacia atrás sobre los que se calculan las cesiones. Valores posibles: 3, 6 o 12. schema: type: integer enum: - 3 - 6 - 12 default: 12 example: 6 - name: businessIdentifier in: query required: false description: RUT del prospecto, sin puntos y con guion. schema: type: string example: 11111111-1 - $ref: '#/components/parameters/CrmPage' - $ref: '#/components/parameters/CrmPageSize' responses: '200': description: Página de prospectos. content: application/json: schema: $ref: '#/components/schemas/CrmOpportunityListResponse' example: data: - businessIdentifier: 11111111-1 businessName: Comercial Prospecto SpA amount: 2000000 cessionCount: 3 competitorName: Factoring Competidor S.A. competitorShare: 0.75 factoringShare: - factoringIdentifier: 77777777-7 factoringName: Factoring Competidor S.A. amount: 1500000 percentage: 0.75 payers: - payerIdentifier: 22222222-2 payerName: Deudor Ejemplo S.A. - factoringIdentifier: 88888888-8 factoringName: Otro Factoring SpA amount: 500000 percentage: 0.25 payers: - payerIdentifier: 22222222-2 payerName: Deudor Ejemplo S.A. factoringSharePeriod: months: 12 startMonth: 2025-12 endMonth: 2026-11 pagination: total: 1 page: 1 pageSize: 10 totalPages: 1 '400': description: Algún query param no es válido. content: application/json: schema: $ref: '#/components/schemas/ValidationError' examples: periodoInvalido: summary: Período fuera de los valores permitidos value: message: custom displayMessage: period must be one of 3, 6, 12 data: errors: - path: period message: period must be one of 3, 6, 12 code: custom pageSizeExcedido: summary: Tamaño de página sobre el máximo value: message: too_big displayMessage: pageSize must be less or equal to 500 data: errors: - path: pageSize message: pageSize must be less or equal to 500 code: too_big rutInvalido: summary: RUT inválido value: message: invalid_union displayMessage: El RUT o Nit ingresado no es válido. data: errors: - path: businessIdentifier message: El RUT o Nit ingresado no es válido. code: invalid_union '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' '504': $ref: '#/components/responses/Timeout' components: parameters: CrmPage: name: page in: query required: false description: Página que quieres obtener, desde 1. schema: type: integer minimum: 1 default: 1 example: 1 CrmPageSize: name: pageSize in: query required: false description: Cantidad de elementos por página. Máximo 500. schema: type: integer minimum: 1 maximum: 500 default: 10 example: 100 schemas: CrmOpportunityListResponse: type: object required: - data - pagination properties: data: type: array items: $ref: '#/components/schemas/CrmOpportunityItem' pagination: $ref: '#/components/schemas/Pagination' ValidationError: type: object required: - message - displayMessage - data description: Error de validación del body, de los query params o de los path params. properties: message: type: string description: >- Código del primer error de validación (por ejemplo `custom`, `invalid_type`, `invalid_format`, `invalid_value`, `invalid_union`). displayMessage: type: string description: >- Mensaje del primer error de validación, pensado para mostrarlo a una persona. Normalmente en español; algunos mensajes de validación vienen en inglés. data: type: object required: - errors properties: errors: type: array description: Todos los errores de validación encontrados. items: type: object required: - path - message - code properties: path: type: string description: >- Campo con el error. Para listas incluye la posición, por ejemplo `types.0`. `(root)` si el error es del body completo. message: type: string description: Descripción del error en español. code: type: string description: Código del tipo de error. CrmOpportunityItem: type: object required: - businessIdentifier - businessName - amount - cessionCount - competitorName - competitorShare - factoringShare - factoringSharePeriod properties: businessIdentifier: type: string description: RUT del prospecto. example: 11111111-1 businessName: type: string description: Nombre del prospecto. Si no se conoce, trae su RUT. example: Comercial Prospecto SpA amount: type: number description: Monto total cedido en el período, en pesos chilenos (CLP). example: 2000000 cessionCount: type: integer description: Cantidad de cesiones en el período. example: 3 competitorName: type: - string - 'null' description: >- Nombre del factoring que más le compra. Es `null` si el prospecto no tiene ningún factoring en el período. example: Factoring Competidor S.A. competitorShare: type: - number - 'null' description: >- Fracción del monto que se lleva ese factoring, entre 0 y 1 (`0.75` equivale a 75%). Es `null` si el prospecto no tiene ningún factoring en el período. example: 0.75 factoringShare: type: array description: >- Reparto del monto cedido entre cada factoring, desde el que más compra. items: $ref: '#/components/schemas/CrmOpportunityFactoringShare' factoringSharePeriod: $ref: '#/components/schemas/CrmOpportunitySharePeriod' Pagination: type: object required: - total - page - pageSize - totalPages properties: total: type: integer description: Cantidad total de elementos que cumplen los filtros. page: type: integer description: Página devuelta, desde 1. pageSize: type: integer description: Cantidad de elementos por página. totalPages: type: integer description: Cantidad total de páginas. Error: type: object required: - message properties: message: type: string description: >- Identifica el error. En algunos casos es un texto en inglés con valores variables. Para tu lógica, usa el código HTTP y, cuando exista, `data.code`. displayMessage: type: string description: >- Mensaje pensado para mostrarlo a una persona. Normalmente en español; algunos mensajes de validación vienen en inglés. data: description: Detalle adicional del error, cuando existe. CrmOpportunityFactoringShare: type: object required: - factoringIdentifier - factoringName - amount - percentage - payers properties: factoringIdentifier: type: string description: RUT del factoring. example: 77777777-7 factoringName: type: string description: Nombre del factoring. example: Factoring Competidor S.A. amount: type: number description: Monto cedido a ese factoring en el período, en pesos chilenos (CLP). example: 1500000 percentage: type: number description: >- Fracción del monto total del prospecto que se lleva este factoring, entre 0 y 1 (`0.75` equivale a 75%). example: 0.75 payers: type: array description: Deudores cuyas facturas compra ese factoring, ordenados por RUT. items: $ref: '#/components/schemas/CrmOpportunityPayer' CrmOpportunitySharePeriod: type: object required: - months - startMonth - endMonth properties: months: type: integer description: Cantidad de meses del período (igual al query param `period`). example: 12 startMonth: type: string description: Primer mes del período, en formato YYYY-MM. example: 2025-12 endMonth: type: string description: Último mes del período, en formato YYYY-MM. example: 2026-11 CrmOpportunityPayer: type: object required: - payerIdentifier - payerName properties: payerIdentifier: type: string description: RUT del deudor. example: 22222222-2 payerName: type: - string - 'null' description: >- Nombre del deudor. Si no se conoce, trae su RUT. `null` si el deudor no tiene monto cedido en el período. example: Deudor Ejemplo S.A. responses: Unauthorized: description: >- Falta el header `x-api-key`, su valor no es válido o la cuenta de API de tu empresa no está habilitada. content: application/json: schema: type: object required: - message properties: message: type: string example: message: 'Unauthorized: Invalid API Key' TooManyRequests: description: >- Tu empresa superó el límite de solicitudes. Todas las API keys de tu empresa comparten el mismo límite. Espera los segundos que indica el header `Retry-After` (o `data.retryAfterSeconds`) antes de reintentar. headers: Retry-After: description: Segundos que debes esperar antes de reintentar. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/Error' example: message: >- Rate limit exceeded: 501 requests in the current 60s window, limit is 500. Retry in 12s. displayMessage: >- Superaste el límite de 500 solicitudes cada 60 segundos. Vuelve a intentarlo en 12 segundos. data: code: RATE_LIMIT_EXCEEDED scope: All API keys of your company share this budget. limit: 500 used: 501 windowSeconds: 60 retryAfterSeconds: 12 resetAt: '2026-11-04T15:00:12.000Z' hint: >- Wait until resetAt (or honor the Retry-After header) before retrying. Avoid repeating identical requests: reuse responses you already fetched, use filters and larger pageSize values instead of one request per item, and cap your client concurrency. InternalError: description: >- Error inesperado en Pruff. El texto de `message` puede variar (por ejemplo en mayúsculas); no dependas de él. content: application/json: schema: $ref: '#/components/schemas/Error' example: message: Internal server error Timeout: description: >- La solicitud superó el tiempo máximo de 55 segundos. La operación puede haberse completado igual: antes de reintentar una solicitud que crea o modifica datos, verifica su estado. content: application/json: schema: $ref: '#/components/schemas/Error' example: message: request_timeout displayMessage: La solicitud excedió el tiempo máximo permitido securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: API key que Pruff entrega a tu empresa. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.