Get Contacts
The following endpoint can be used to retrieve the details of Contacts within the Hyfin application.
Point de terminaison
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}
Demander les paramètres de la requête
Champ
Type
Requis
Description
updated_after
Date
--
A timestamp to be used as the start of the date range (exclusive) of the query. On subsequent requests, you should pass in the `next_updated_after` value that was in the response of the previous request. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
Réponse
Champ
Type
Description
records_matched
Number
Le nombre d'enregistrements qui correspondent aux paramètres de la requête.
records_returned
Number
Le nombre d'enregistrements qui ont été retournés.
next_updated_after
Date
Un horodatage à utiliser comme début de la plage de dates (exclusif) de la prochaine requête pour le même point de terminaison. Cela est utilisé pour la pagination lors de la requête avec un paramètre updated_after. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
records
La liste des contacts qui correspondent aux paramètres de la requête.