Sessions are a specific interaction that you have with a lead at an event or in a facility. That same lead may interact with Momentify multiple times at an event generated multiple sessions. These endpoints allow you to interact your sessions viewing any leads attached to them (or no lead if it is anonymous).
Sessions associated with an event will return an eventId property. See Read Event to obtain details on the event
Read Sessions
Endpoint:
GET https://api.momentifyapp.com/v1/sessions
Parameters
Name | Type | Default | Description |
after | string | — | ISO 8601 date/time string. Returns sessions created after this date/time. |
hideLeadProperties | comma-delimited string | — | If populateLead is true, specify certain lead properties not to return |
hideProperties | comma-delimited string | — | Specify certain session properties not to return |
limit | number | 1000 | Number of sessions to return. (Max 10,000) |
offset | number | 0 | Number of sessions to skip (for pagination). |
populateLead | boolean | false | Attach the lead to the session |
Sample Request:
curl -X GET "https://api.momentifyapp.com/v1/sessions?after=2025-01-01T00:00:00Z&limit=1000&offset=0" \
-H "Authorization: [Your API Key]" \
-H"Content-Type:application/json"
Response
Returns a JSON object containing an array of session objects and a total count. All properties are potentially null (including lead in the case of an anonymous session) and should be null checked before consuming.
Sample Response:
{
"totalCount": 245,
"data": [
{
"metrics": [],
"workspaceId": "workspace id",
"updatedBy": "user id",
"deviceName": "Self Registration",
"endMethod": null,
"createdBy": "user id",
"lead": {
"id": "lead id",
"followUpGroup": null,
"notes": null,
"zip": "75000",
"firstName": "John",
"followUp": null,
"custom": {
customProperty: "value"
},
"lastName": "Smith",
"country": "Country",
"state": "State",
"city":"City",
"company": "Company",
"title":"Job title",
"updatedBy": "JTbrULOMqfanonBzDUviGJzHqq72",
"temp": "hot",
"address2": null,
"optIn": true,
"school":"School",
"updated": "2025-10-14T18:58:41.701000Z",
"address": "123 Address",
"smartProperties": [
{
"name": "Dealer Code",
"number": null,
"text": "E140"
},
{
"number": null,
"text": "HOLT TEXAS",
"name": "Dealer Name"
}
],
"created": "2025-09-08T14:58:29.617000Z",
"createdBy": "user id",
"phone": "7732279110",
"email": "johnsmith@gmail.com"
},
"id": "session id",
"moment": {
"id": 2,
"title": "Moment title"
},
"template": {
"id": "template id",
"title": "title"
},
"traits": [
{
"groupTitle": "Interest",
"title": "Energy",
"traitId": null
},
{
"traitId": null,
"groupTitle": "Objective",
"title": "Hydrogen"
},
{
"traitId": null,
"groupTitle": "Objective",
"title": "Rental Generators"
}
],
"created": "2025-09-08T14:58:29.730000Z",
"event": {
"id": "event id",
"title": "event title"
},
"appName": "self-registration",
"updated": "2025-09-08T14:58:29.730000Z"
}
]
}