Get Contacts
The following endpoint can be used to retrieve the details of Contacts within the Hyfin application.
Endpoint
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}
Request Query Parameters
Field
Type
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 nextUpdatedAfter value that was in the response of the previous request. 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
Response
Field
Type
Description
recordsMatched
Number
The number of records that matched the query parameters.
recordsReturned
Number
The number of records that were returned.
nextUpdatedAfter
Date
A timestamp to be used as the start of the date range (exclusive) of the next query for the same endpoint. This is used for pagination when querying with an updated_after parameter. 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
The list of contacts that matched the query parameters.
success
Boolean
Whether the query completed successfully.