Snapshots

Snapshots API

Documentación de la API de Snapshots

Servidor base: https://services.leadconnectorhq.com

Endpoints

• GET /snapshots/ — Obtener snapshots
• POST /snapshots/share/link — Crear Snapshot Share Link
• GET /snapshots/snapshot-status/{snapshotId} — Obtener Snapshot Push between Dates
• GET /snapshots/snapshot-status/{snapshotId}/location/{locationId} — Obtener Last Snapshot Push

GET /snapshots/

Obtener snapshots Get a list of all own and imported Snapshots

Parametros: - Versión (header, string) (requerido) — Versión de la API - companyId (query, string) (requerido) — Id de empresa

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado

POST /snapshots/share/link

Crear Snapshot Share Link Create a share link for snapshot

Parametros: - companyId (query, string) (requerido) — - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - snapshot_id (requerido) — string — id for snapshot to be shared - share_type (requerido) — string — Type of share link to generate - relationship_number — string — Comma separated Relationship number of Agencies to create agency restricted share link - share_location_id — string — Comma separated Sub-Account ids to create sub-account restricted share link

Respuestas: - 201 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado

GET /snapshots/snapshot-status/{snapshotId}

Obtener Snapshot Push between Dates Get list of sub-accounts snapshot pushed in time period

Parametros: - snapshotId (path, string) (requerido) — - companyId (query, string) (requerido) — - from (query, string) (requerido) — Only accepts ISO 8601 format - to (query, string) (requerido) — Only accepts ISO 8601 format - lastDoc (query, string) (requerido) — Id for last document till what you want to skip - limit (query, string) — Limit of documents to return. Default is 20 - Versión (header, string) (requerido) — Versión de la API

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado

GET /snapshots/snapshot-status/{snapshotId}/location/{locationId}

Obtener Last Snapshot Push Get Latest Snapshot Push Status for a location id

Parametros: - companyId (query, string) (requerido) — - snapshotId (path, string) (requerido) — - locationId (path, string) (requerido) — - Versión (header, string) (requerido) — Versión de la API

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado