ONontraport
CalendarPotentialGuests

Retrieve a list of contacts and staff who can be added as guests to an event

An ineditable list of contacts and staff who can be added as guests to an event.

####ObjectID: 174#### This is the ID of the Object. It can be used in generic object calls, or in places that need the objectID param.

get/CalendarPotentialGuests

Request

  • Base URL
    https://api.ontraport.com/1
  • Auth
    none declared

Query parameters

startinteger

The position from which to start pagination.

rangeinteger

The number or records to retrieve. Defaults to 200. Maximum is 500.

searchstring

A string to search potential guests for.

guestmodeinteger

A binary integer flag to indicate the mode. If set to 1, type and email will be returned in addition to id and label.

Response

Successfully retrieved list of potential guests

codeinteger required
dataobject required
account_idinteger required

Changes

No recorded changes to this operation across all 5 revisions of this API.