SpotMe API overview

Basic information

• The SpotMe REST API allows data to be exchanged between SpotMe and your applications, using HTTPS requests.
  
  
• All API requests and responses are using JSON (JavaScript Object Notation), except when uploading image files.
  
  
• SpotMe API used POST instead of PUT in order to UPSERT records.
  
  
• In order to UPSERT a record, you must provide the record “_id” in the payload.
  
  
• The SpotMe API base URL for all requests is https://api.spotme.com/api/v2/workspace.
  
  
• Find more information on authentication.
  
  
• For a general list of available API endpoints, please check api.spotme.com.
  For a full list of the available API endpoints, please check your workspace API page.

Getting started

• Find out how to get access to and start working the SpotMe API. More information in the Getting started with the API article.

API documentation

Refer to the API documentation here, where you will find:

• A tab for the Organization routes/authentication/models.
• A tab for the Workspace routes/authentication/models.
• A tab for the Modules routes/authentication/models.

You can also refer to the data model diagram to help you navigate through the documentation.

Data model diagram

Below is a high-level overview of the data entities and the connections, to help developers navigate through the above described API documentation.

Please note that the diagram does not include a full list of all the data attributes. To find a full list of attributes for a data entity, please refer to the Accessing a full list of data attributes via the API documentation section.

Color code:
grey = at or above event-level data
blue = event content data
red = attendee data generated during the event

"..." means that additional data attributes are available.

Download and open the file in full screen

How to access a full list of data attributes via the API documentation section

The above API data model diagram does not include an exhaustive list of attributes for each data entity. To see all attributes for each data entity:

1. Go to https://developer.spotme.com/docs/workspace, where you will see a list of the default data entities.
2. Select the GET request for a data entity, for example Feed:
   
3. Scroll down to the Responses section for the Feed data entity, and click on More details:
   
4. A full list of the Feed attributes are displayed to the left in the "Property" column:
   You can also click on the Example value tab to access a code example for the data attributes:
   

Integration recipes

• Find out how to use a customer portal in order to authenticate end-users and allow them direct  access SpotMe events. See Integration recipe - customer portal
  
  
• Find out how to keep a third party system’s data consistent with SpotMe registrant data. See Integration recipe - CRM

Rate limits

• The API access is currently rate-limited to no more than 3 requests per seconds, with bursts not exceeding 5 requests per second maximum for a given API user (i.e. for a given authorization header).
  
  
• If this rate is exceeded, the caller will receive a "429" error code and will need to retry later.
  
  
• In the create/update context, the best way to minimize the number of calls is to create/update multiple documents at once in one call.
  
  
• There is a hard limit at max. 5,000 documents in one call, as well as a maximum payload of 5 MB.
  
  
• If you need to upload more than 5,000 documents, then you will need to break your input data into batches of 5,000 documents max. Please wait for an answer to the first batch request before submitting the next one.

Need support?

Should you have any questions or require assistance, please reach out to SpotMe Support.