locations_getlocationscontactslist
Retrieve contact records for specific locations by tenant ID, with filters for modified or created dates, pagination, and optional total count inclusion.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| createdBefore | No | Format - date-time (as date-time in RFC3339). Returns items created before the requested date (in UTC) | |
| createdOnOrAfter | No | Format - date-time (as date-time in RFC3339). Returns items created on or after the requested date (in UTC) | |
| includeTotal | No | ||
| locationIds | No | Returns specific contact records by location IDs. | |
| modifiedBefore | No | Format - date-time (as date-time in RFC3339). Return items modified before certain date/time (in UTC). Either modifiedBefore or modifiedOnOrAfter parameter must be specified | |
| modifiedOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return items modified on/after certain date/time (in UTC). Either modifiedBefore or modifiedOnOrAfter parameter must be specified | |
| page | No | Format - int32. | |
| pageSize | No | Format - int32. | |
| tenant | Yes | Format - int64. Tenant ID |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"createdBefore": {
"description": "Format - date-time (as date-time in RFC3339). Returns items created before the requested date (in UTC)",
"format": "date-time",
"type": "string"
},
"createdOnOrAfter": {
"description": "Format - date-time (as date-time in RFC3339). Returns items created on or after the requested date (in UTC)",
"format": "date-time",
"type": "string"
},
"includeTotal": {
"type": "boolean"
},
"locationIds": {
"description": "Returns specific contact records by location IDs.",
"type": "string"
},
"modifiedBefore": {
"description": "Format - date-time (as date-time in RFC3339). Return items modified before certain date/time (in UTC). Either modifiedBefore or modifiedOnOrAfter parameter must be specified",
"format": "date-time",
"type": "string"
},
"modifiedOnOrAfter": {
"description": "Format - date-time (as date-time in RFC3339). Return items modified on/after certain date/time (in UTC). Either modifiedBefore or modifiedOnOrAfter parameter must be specified",
"format": "date-time",
"type": "string"
},
"page": {
"description": "Format - int32.",
"type": "integer"
},
"pageSize": {
"description": "Format - int32.",
"type": "integer"
},
"tenant": {
"description": "Format - int64. Tenant ID",
"type": "integer"
}
},
"required": [
"tenant"
],
"type": "object"
}