Get Customers
The following endpoint can be used to retrieve the details of Customers within the Hyfin application.
Point de terminaison
The following endpoint can be used to retrieve Customers. You must replace the {base_url} , {site_id} and {updated_after} variables with the appropriate values.
GET
{base_url}/api/v4/site/{site_id}/customers?updated_after={updated_after}
Demander les paramètres de la requête
Champ
Type
Description
updated_after
Date
Un horodatage à utiliser comme début de la plage de dates (exclusif) de la requête. Pour les requêtes suivantes, vous devez transmettre la valeur nextUpdatedAfter qui était dans la réponse de la requête précédente. 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
Réponse
Champ
Type
Description
recordsMatched
Number
Le nombre d'enregistrements qui correspondent aux paramètres de la requête.
recordsReturned
Number
Le nombre d'enregistrements qui ont été retournés.
nextUpdatedAfter
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
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 liste des contacts qui correspondent aux paramètres de la requête.
success
Boolean
Whether the query completed successfully.