Get the meeting engagement list
Name: get_the_meeting_engagement_list
Description: Retrieves a paginated list of meeting type engagements that are accessible to the user for a given CRM context.
Schema
{
"type": "object",
"properties": {
"contextType": {
"type": "string",
"enum": [
"Account",
"Opportunity",
"Contact",
"Lead"
],
"description": "The CRM object's Context type. Supported values: Account | Opportunity | Contact | Lead. Example: contextType=Account"
},
"contextId": {
"type": "string",
"description": "The CRM object's Id in CRM system."
},
"continuation": {
"type": "string",
"description": "Continuation token for pagination."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 10,
"description": "The query results' page size. Default is 10. Range from 1 to 100."
},
"engagementTypes": {
"type": "string",
"enum": [
"DSR",
"Meeting",
"EmailBlast",
"Email",
"Link",
"PrintOrder"
],
"default": "Meeting",
"description": "Filter by engagement's type. Supported values: DSR | Meeting | EmailBlast | Email | Link | PrintOrder. Example: engagementTypes=DSR"
},
"from": {
"type": "string",
"format": "date-time",
"description": "Filter engagements that created datetime greater than or equals 'from'. UTC Format example:2024-01-19T07:25:05.00Z."
},
"to": {
"type": "string",
"format": "date-time",
"description": "Filter engagements that created datetime less than or equals 'to'. UTC Format example:2024-01-19T07:25:05.00Z."
}
},
"required": []
}
{
"type": "object",
"properties": {
"continuationToken": {
"type": "string",
"description": "Next page token"
},
"totalCount": {
"type": "integer",
"description": "Indicates that the total count of results"
},
"limit": {
"type": "integer",
"description": "The limit count of results per page"
},
"pageCap": {
"type": "integer",
"description": "Max limit capacity per page"
},
"entries": {
"type": "array",
"description": "A limit of engagements",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique document id, which is hashed from the engagementId + engagementSource"
},
"engagementId": {
"type": "string",
"description": "Unique id of engagement"
},
"engagementSource": {
"type": "string",
"description": "Source service name of ingested engagement"
},
"email": {
"type": "string",
"description": "The email of invitee"
},
"contexts": {
"type": "array",
"description": "A set of context of the engagement, which indicate the engagement is derived from what kind of source.",
"items": {
"type": "object",
"properties": {
"contextId": {
"type": "string",
"description": "The context id of the context"
},
"contextName": {
"type": "string",
"description": "The context name of the context"
},
"contextType": {
"type": "string",
"description": "The context type of the context"
},
"source": {
"type": "string",
"description": "The source of the context"
},
"sourceType": {
"type": "string",
"description": "The source type of the context"
},
"systemId": {
"type": "string",
"description": "The system id of the context"
},
"systemType": {
"type": "string",
"description": "The system type of the context"
},
"dynamicFields": {
"type": "array",
"description": "A set of dynamic field of the context",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The key of the field"
},
"label": {
"type": "string",
"description": "The label of the field"
},
"value": {
"type": "string",
"description": "The value of the field"
},
"fieldName": {
"type": "string",
"description": "The field name of the field"
}
}
}
}
}
}
},
"name": {
"type": "string",
"description": "The name of the engagement"
},
"type": {
"type": "string",
"description": "The type of the engagement"
},
"status": {
"type": "string",
"description": "The status of the engagement"
},
"createdTime": {
"type": "string",
"format": "date-time",
"description": "The UTC timestamp when the engagement was created, in RFC 3339 date-time format."
},
"updatedTime": {
"type": [
"string",
"null"
],
"description": "The updated time of the engagement"
},
"isDeleted": {
"type": "boolean",
"description": "Indicates if the engagement is deleted or not"
},
"creator": {
"type": "object",
"description": "The creator information of the engagement",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the user who created the engagement in Seismic."
},
"name": {
"type": "string",
"description": "The name of the engagement creator"
},
"email": {
"type": "string",
"description": "The email of the engagement creator"
}
}
},
"owner": {
"type": "object",
"description": "The owner information of the engagement",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the user who currently owns the engagement in Seismic."
},
"name": {
"type": "string",
"description": "The name of the engagement owner"
},
"email": {
"type": "string",
"description": "The email of the engagement owner"
}
}
},
"detailPageUrl": {
"type": "string",
"description": "A link to the specific engagement detail page in EngagementCenter for a tenant"
},
"isArchived": {
"type": "boolean",
"description": "Indicates if the engagement is archived or not"
}
}
}
}
},
"required": []
}
Updated 1 day ago