EAI API Documentation
Get Events in Scope
2 min
to get the leads in scope for a particular group, chapter, or channel, use one of the following rest apis if events from all the groups are required, use only the required zone id param https //{subdomain} teleskope io/1/eai/graph?geteventsinscope\&zone id={zone id} if events from a specific group is required, use the relevant encoded group id param https //{subdomain} teleskope io/1/eai/graph?geteventsinscope\&zone id={zone id}\&group id={group id} https //{subdomain} teleskope io/1/eai/graph?geteventsinscope\&zone id={zone id}\&group id={group id}\&chapter id={chapter id} https //{subdomain} teleskope io/1/eai/graph?geteventsinscope\&zone id={zone id}\&group id={group id}\&channel id={channel id} replace {subdomain} with the customer's assigned subdomain, {group id} with the group id obtained from the previous api call, {chapter id} with the chapter id obtained from the previous api call (optional), and {channel id} with the channel id obtained from the previous api call (optional) these apis return a list of members in scope for the specified group, chapter, or channel note zone id it is a required attribute group id it is an optional attribute to get events for all groups and admin level events in the specified zone, do not set the group id attribute in the url to get events for a specific group in the zone, set the group id attribute in the url to get admin level events in the zone, set group id to 0 or empty/no value chapter id it is an optional attribute to get events for all chapters in the group, including events that do not have chapters associated with them, do not set the chapter id attribute in the url to get events for a specific chapter in the group, set the chapter id attribute in the url to get global group level events only, i e events that do not have chapters associated with them, set chapterid to 0 or empty/no value channel id it is an optional attribute to get events for all channels in the group, including events that do not have channels associated with them, do not set the channel id attribute in the url to get events for a specific channel in the group, set the channe id attribute in the url to get global group level events only, i e events that do not have channels associated with them, set channel id to 0 or empty/no value return values most of the returned attributes are self explanatory with additional details for some of the attributes listed below created at a utc date timestamp when the event record was created in the system publish at a utc date timestamp when the event was published or is scheduled to be published (events can be scheduled to be published 30 days in the future) modified at a utc date timestamp when the event was last modified canceled at a utc date timestamp when the event was canceled, it is available only for canceled events event timezone timezone set for the event event url a unique url to access the event in the teleskope platform