For the complete documentation index, see llms.txt. This page is also available as Markdown.

Mobly REST API

List events

get

List events for the authenticated organization.

Authorizations
x-api-keystringRequired
Query parameters
limitinteger · max: 50OptionalDefault: 20
offsetintegerOptionalDefault: 0
Responses
200

Events list.

application/json
statusintegerRequiredExample: 200
get/events

Create event

post

Create an event for the authenticated organization.

Authorizations
x-api-keystringRequired
Body
eventNamestringRequired
eventTypestring · enumRequired

Event type classification.

Possible values:
startDatestring · dateRequired
endDatestring · dateRequired
createdByEmailstring · emailRequired
registrationEnabledbooleanOptional
Responses
200

Created event.

application/json
statusintegerRequiredExample: 200
post/events

Get event

get

Fetch a single event by ID.

Authorizations
x-api-keystringRequired
Path parameters
eventIdintegerRequired

Event ID

Responses
200

Event.

application/json
statusintegerRequiredExample: 200
get/events/{eventId}

Update event

put

Update the full event record for the authenticated organization.

Authorizations
x-api-keystringRequired
Path parameters
eventIdintegerRequired

Event ID

Body
eventNamestringRequired
eventTypestring · enumRequired

Event type classification.

Possible values:
startDatestring · dateRequired
endDatestring · dateRequired
registrationEnabledbooleanOptional
Responses
200

Updated event.

application/json
statusintegerRequiredExample: 200
put/events/{eventId}

Delete event

delete

Delete an event for the authenticated organization.

Authorizations
x-api-keystringRequired
Path parameters
eventIdintegerRequired

Event ID

Responses
200

Event deleted.

application/json
statusintegerRequiredExample: 200
resultsobjectRequired
delete/events/{eventId}

List event leads

get

Retrieve the leads associated with a specific event, including registration and check-in status.

Authorizations
x-api-keystringRequired
Path parameters
eventIdintegerRequired

Event ID

Query parameters
limitinteger · max: 50OptionalDefault: 20
offsetintegerOptionalDefault: 0
Responses
200

Event leads list.

application/json
statusintegerRequiredExample: 200
get/events/{eventId}/leads
200

Event leads list.

Add or update event leads

put

Associate existing leads with an event and optionally update their registered and checkedIn status.

  • Creates association if missing.

  • Updates flags if association exists.

Authorizations
x-api-keystringRequired
Path parameters
eventIdintegerRequired

Event ID

Body
Responses
200

Updated event lead associations.

application/json
statusintegerRequiredExample: 200
put/events/{eventId}/leads
200

Updated event lead associations.

Remove lead from event

delete

Delete a lead's association with an event for the authenticated organization.

Authorizations
x-api-keystringRequired
Path parameters
eventIdintegerRequired

Event ID

leadIdstringRequired

Lead ID

Responses
200

Association removed.

application/json
statusintegerRequiredExample: 200
resultsobjectRequired
delete/events/{eventId}/leads/{leadId}
200

Association removed.

List event users

get

Retrieve the users assigned to a specific event for the authenticated organization.

Authorizations
x-api-keystringRequired
Path parameters
eventIdintegerRequired

Event ID

Query parameters
limitinteger · max: 50OptionalDefault: 20
offsetintegerOptionalDefault: 0
Responses
200

Event users list.

application/json
statusintegerRequiredExample: 200
get/events/{eventId}/users
200

Event users list.

List leads

get

List leads for the authenticated organization.

Authorizations
x-api-keystringRequired
Query parameters
limitinteger · max: 50OptionalDefault: 20
offsetintegerOptionalDefault: 0
Responses
200

Leads list.

application/json
statusintegerRequiredExample: 200
get/leads
200

Leads list.

Create lead

post

Create a lead for the authenticated organization.

Authorizations
x-api-keystringRequired
Body
createdByEmailstring · emailRequired
firstNamestringRequired
lastNamestringRequired
companyNamestringRequired
emailstring · emailOptional
Responses
200

Created lead.

application/json
statusintegerRequiredExample: 200
post/leads
200

Created lead.

Get lead

get

Fetch a single lead by ID.

Authorizations
x-api-keystringRequired
Path parameters
leadIdstringRequired

Lead ID

Responses
200

Lead.

application/json
statusintegerRequiredExample: 200
get/leads/{leadId}

Delete lead

delete

Delete a lead for the authenticated organization.

Authorizations
x-api-keystringRequired
Path parameters
leadIdstringRequired

Lead ID

Responses
200

Lead deleted.

application/json
statusintegerRequiredExample: 200
resultsobjectRequired
delete/leads/{leadId}
200

Lead deleted.

Patch lead

patch

Partially update a lead and its associated persona record.

Authorizations
x-api-keystringRequired
Path parameters
leadIdstringRequired

Lead ID

Body
firstNamestring · nullableOptional
lastNamestring · nullableOptional
emailstring · email · nullableOptional
addressstring · nullableOptional
linkedinstring · nullableOptional
facebookstring · nullableOptional
twitterstring · nullableOptional
profilePicturestring · nullableOptional
descriptionstring · nullableOptional
jobTitlestring · nullableOptional
Responses
200

Updated lead.

application/json
statusintegerRequiredExample: 200
patch/leads/{leadId}
200

Updated lead.

List lead activity events

get

List lead activity events for the authenticated organization.

Authorizations
x-api-keystringRequired
Query parameters
limitinteger · max: 50OptionalDefault: 20
offsetintegerOptionalDefault: 0
leadIdstringOptional

Filter by associated lead ID

eventTypestring · enumOptional

Lead activity event type.

Possible values:
Responses
200

Lead activity events list.

application/json
statusintegerRequiredExample: 200
get/leadActivityEvents
200

Lead activity events list.

Get lead activity event

get

Fetch a single lead activity event by ID.

Authorizations
x-api-keystringRequired
Path parameters
leadActivityEventIdstringRequired

Lead activity event ID

Responses
200

Lead activity event.

application/json
statusintegerRequiredExample: 200
get/leadActivityEvents/{leadActivityEventId}

List activations

get

List activations for the organization.

Authorizations
x-api-keystringRequired
Query parameters
limitinteger · max: 50OptionalDefault: 20
offsetintegerOptionalDefault: 0
Responses
200

Activations list.

application/json
statusintegerRequiredExample: 200
get/activations
200

Activations list.

Get activation

get

Fetch a single activation by ID.

Authorizations
x-api-keystringRequired
Path parameters
activationIdstringRequired

Activation ID

Responses
200

Activation.

application/json
statusintegerRequiredExample: 200
get/activations/{activationId}

List tag groups

get

List tag groups defined for the organization, including tag options.

Authorizations
x-api-keystringRequired
Query parameters
limitinteger · max: 50OptionalDefault: 20
offsetintegerOptionalDefault: 0
Responses
200

Tag groups list.

application/json
statusintegerRequiredExample: 200
get/tagGroups
200

Tag groups list.

Get tag group

get

Fetch a single tag group by ID.

Authorizations
x-api-keystringRequired
Path parameters
tagGroupIdstringRequired

Tag group ID

Responses
200

Tag group.

application/json
statusintegerRequiredExample: 200
get/tagGroups/{tagGroupId}

List industry events

get

List industry events. Supports filtering by URL or full-text search.

  • eventUrl — return only the event matching this exact URL

  • q — full-text search across name, venueCity, venueState, venueCountry, description, keywords, industries, personas

If eventUrl is provided, q is ignored. If neither is provided, all industry events are returned (paginated).

Authorizations
x-api-keystringRequired
Query parameters
limitinteger · max: 50OptionalDefault: 20
offsetintegerOptionalDefault: 0
eventUrlstringOptional

Filter by exact event URL

qstringOptional

Full-text search query

Responses
200

Industry events list.

application/json
statusintegerRequiredExample: 200
get/industryEvents

Create industry event

post

Create an industry event with automatic deduplication:

  1. If an event with the same eventUrl already exists, the existing record is returned (created: false).

  2. If no URL match but name and startDate match, the event is still created but potentialDuplicates are returned.

Authorizations
x-api-keystringRequired
Body
namestringRequired
startDatestring · date-time · nullableOptional
endDatestring · date-time · nullableOptional
sourceTypestring · nullableOptional
sourceIdstring · nullableOptional
eventTypestring · nullableOptional
venueCitystring · nullableOptional
venueStatestring · nullableOptional
venueCountrystring · nullableOptional
venueNamestring · nullableOptional
venueFullAddressstring · nullableOptional
venueCoordinatesstring · nullableOptional
numberOfAttendeesinteger · nullableOptional
numberOfExhibitorsinteger · nullableOptional
attendeeCoststring · nullableOptional
boothCoststring · nullableOptional
exhibitorIndustriesstring[] · nullableOptional
attendeePersonasstring[] · nullableOptional
keywordsstring[] · nullableOptional
websitestring · nullableOptional
descriptionstring · nullableOptional
eventUrlstring · nullableOptional
Responses
200

Created or existing industry event.

application/json
statusintegerRequiredExample: 200
post/industryEvents

List bookmarked industry events

get

List industry events bookmarked by the authenticated organization.

Authorizations
x-api-keystringRequired
Responses
200

Bookmarked industry events.

application/json
statusintegerOptionalExample: 200
get/industryEvents/bookmarks
200

Bookmarked industry events.

Get industry event

get

Fetch a single industry event by ID. Includes isBookmarked for the authenticated organization.

Authorizations
x-api-keystringRequired
Path parameters
industryEventIdstring · uuidRequired

Industry event ID

Responses
200

Industry event.

application/json
statusintegerRequiredExample: 200
get/industryEvents/{industryEventId}

Update industry event

put

Partially update an industry event. Only fields included in the body are modified.

Authorizations
x-api-keystringRequired
Path parameters
industryEventIdstring · uuidRequired

Industry event ID

Body
namestringOptional
startDatestring · date-time · nullableOptional
endDatestring · date-time · nullableOptional
sourceTypestring · nullableOptional
sourceIdstring · nullableOptional
eventTypestring · nullableOptional
venueCitystring · nullableOptional
venueStatestring · nullableOptional
venueCountrystring · nullableOptional
venueNamestring · nullableOptional
venueFullAddressstring · nullableOptional
venueCoordinatesstring · nullableOptional
numberOfAttendeesinteger · nullableOptional
numberOfExhibitorsinteger · nullableOptional
attendeeCoststring · nullableOptional
boothCoststring · nullableOptional
exhibitorIndustriesstring[] · nullableOptional
attendeePersonasstring[] · nullableOptional
keywordsstring[] · nullableOptional
websitestring · nullableOptional
descriptionstring · nullableOptional
eventUrlstring · nullableOptional
Responses
200

Updated industry event.

application/json
statusintegerRequiredExample: 200
put/industryEvents/{industryEventId}

Bookmark industry event

post

Add an industry event to the authenticated organization's bookmarks.

Authorizations
x-api-keystringRequired
Path parameters
industryEventIdstring · uuidRequired

Industry event ID

Responses
200

Bookmarked.

application/json
statusintegerOptionalExample: 200
post/industryEvents/{industryEventId}/bookmark

Unbookmark industry event

delete

Remove an industry event from the authenticated organization's bookmarks.

Authorizations
x-api-keystringRequired
Path parameters
industryEventIdstring · uuidRequired

Industry event ID

Responses
200

Unbookmarked.

application/json
statusintegerOptionalExample: 200
delete/industryEvents/{industryEventId}/bookmark

Last updated

Was this helpful?