Get Contacts
The following endpoint can be used to retrieve the details of Contacts within the Hyfin application.
Punto Final
The following endpoint can be used to retrieve Contacts. You must replace the {base_url} , {site_id} and {updated_after} variables with the appropriate values.
GET
{base_url}/api/v4/site/{site_id}/contacts?updated_after={updated_after}
Solicitar parámetros de consulta
Campo
Tipo
Descripción
updated_after
Date
Un sello de tiempo que se utilizará como el inicio del rango de fechas (exclusivo) de la consulta. En solicitudes posteriores, debes pasar el valor nextUpdatedAfter que estaba en la respuesta de la solicitud anterior. Queries look back a maximum of 7 days. A timestamp older than that is moved forward to the limit rather than rejected, so records that last changed before it are not returned. Omitting this parameter returns the last 7 days. An integration that sends back the nextUpdatedAfter of each response never reaches the limit. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
Respuesta
Campo
Tipo
Descripción
recordsMatched
Number
El número de registros que coincidieron con los parámetros de la consulta.
recordsReturned
Number
El número de registros que fueron devueltos.
nextUpdatedAfter
Date
Un sello de tiempo que se utilizará como el inicio del rango de fechas (exclusivo) de la próxima consulta para el mismo punto final. Esto se utiliza para la paginación al consultar con un parámetro updated_after. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
queryTime
Date
The time the query ran. nextUpdatedAfter is derived from it, so it is the same value whenever a full page was returned. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
limit
Number
The maximum number of records a single response will return. When recordsReturned equals this, more records are likely waiting and another request should be made with the returned nextUpdatedAfter.
records
La lista de contactos que coinciden con los parámetros de la consulta.
success
Boolean
Whether the query completed successfully.