Events (Meetings & Shows) (v1-2025-04-18)

The Meetings & Shows, or Events, API is used to manage all aspects of events from recurring webinars to annual trade shows. From this API you can access Registrants, Speakers, and Abstracts as well as update the details of your events themselves.

Like most of the other Rhythm apps, the Events API includes endpoints for Query Definitions. These endpoints are commonly used to retrieve saved queries, which can then be executed using the Query endpoints of the System API.

Download OpenAPI description
Languages
Servers
Mock server
https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/
https://events.api.rhythmsoftware.com/

Abstract Approval Processes

Abstract Approval Processes

Operations

Abstract Decision Processes

Abstract Decision Processes

Operations

Abstract Review Processes

Abstract Review Processes

Operations

Abstract Review Rounds

Abstract Review Rounds

Operations

Abstract Reviews

Abstract Reviews

Operations

Abstract Settings

Abstract Settings

Operations

Abstract Submission Processes

Abstract Submission Processes

Operations

Abstract Types

Abstract Types

Operations

Abstracts

Abstracts

Operations

Coupons

Coupons

Operations

Events

Events

Operations

Exhibitor Add On Products

Exhibitor Add On Products

Operations

Exhibitor Booth Fees

Exhibitor Booth Fees

Operations

Exhibitor Booth Types

Exhibitor Booth Types

Operations

Exhibitor Booths

Exhibitor Booths

Operations

Exhibitor Categories

Exhibitor Categories

Operations

Exhibitor Contact Types

Exhibitor Contact Types

Operations

Exhibitor Priority Point Types

Exhibitor Priority Point Types

Operations

Exhibitor Reg Processes

Exhibitor Reg Processes

Operations

Exhibitor Registrations

Exhibitor Registrations

Operations

Exhibitor Settings

Exhibitor Settings

Operations

Exhibitor Show Floors

Exhibitor Show Floors

Operations

Exhibitors

Exhibitors

Operations

Function Fees

Function Fees

Operations

Function Tickets

Function Tickets

Operations

Function Types

Function Types

Operations

Functions

Functions

Operations

Miscellaneous Events

Miscellaneous Events

Operations

Priority Point Assignments

Priority Point Assignments

Operations

Query Definitions

Query Definitions

Operations

Registrant Directories

Registrant Directories

Operations

Registration Add On Products

Registration Add On Products

Operations

Registration Add On Types

Registration Add On Types

Operations

Registration Categories

Registration Categories

Operations

Registration Change Fees

Registration Change Fees

Operations

Registration Deadlines

Registration Deadlines

Operations

Registration Groups

Registration Groups

Operations

Registration Packages

Registration Packages

Operations

Registration Processes

Registration Processes

Operations

Registration Settings

Registration Settings

Operations

Registration Substitutions

Registration Substitutions

Operations

Registration Types

Registration Types

Operations

Registrations

Registrations

Operations

Execute Batch Operations

Request

TAllows you to perform up to 100 parallel patch/delete operations

Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The batch request

operationsArray of objects
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/registrations/{tenantId}/batch' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "operations": [
      {
        "id": null,
        "object": {},
        "operation": "create",
        "patch_directives": {
          "0": {
            "op": "add",
            "path": "string",
            "value": "string"
          }
        },
        "payload": {
          "abstract": {
            "approval_process_id": "string",
            "average_score": 0.1,
            "body": "string",
            "bucket_id": null,
            "city": "string",
            "co_author_1": {
              "email_address": "string",
              "first_name": "string",
              "last_name": "string",
              "phone_number": "string",
              "speaker_type_id": "string"
            },
            "co_author_2": {
              "email_address": "string",
              "first_name": "string",
              "last_name": "string",
              "phone_number": "string",
              "speaker_type_id": "string"
            },
            "co_author_3": {
              "email_address": "string",
              "first_name": "string",
              "last_name": "string",
              "phone_number": "string",
              "speaker_type_id": "string"
            },
            "co_author_4": {
              "email_address": "string",
              "first_name": "string",
              "last_name": "string",
              "phone_number": "string",
              "speaker_type_id": "string"
            },
            "co_author_5": {
              "email_address": "string",
              "first_name": "string",
              "last_name": "string",
              "phone_number": "string",
              "speaker_type_id": "string"
            },
            "co_authors": {
              "0": {
                "co_author_contact_id": "string",
                "co_author_contact_info": {},
                "speaker_type_id": "string"
              }
            },
            "country": "string",
            "custom_field_values": [
              {
                "boolean_value": true,
                "custom_field_id": "string",
                "file_url_value": "string",
                "list_value": [
                  null
                ],
                "numeric_value": 0.1,
                "string_value": "string",
                "table_value": [
                  {}
                ]
              }
            ],
            "date": "2019-08-24T14:15:22Z",
            "email_address": "string",
            "event_id": "string",
            "first_name": "string",
            "has_co_authors": true,
            "id": null,
            "job_title": "string",
            "last_name": "string",
            "last_review_status_change": "2019-08-24T14:15:22Z",
            "main_presenter_id": "string",
            "max_contact_submissions": 0.1,
            "name": "string",
            "notes": "string",
            "number": 0.1,
            "organization_id": "string",
            "override_bucket_assignment": true,
            "pending_console_review": true,
            "presenter_info": {
              "contact_info": {},
              "email_presenter": true
            },
            "process_id": "string",
            "review_process_id": "string",
            "review_round_id": null,
            "review_status": "accepted",
            "reviewer_recommendation": "string",
            "reviews_assigned": true,
            "room_ids": [
              "string"
            ],
            "round_id": "string",
            "round_scores": [
              {
                "round_id": "string",
                "score": 0.1
              }
            ],
            "session_has_been_generated": true,
            "session_track_ids": [
              "string"
            ],
            "state": "string",
            "status": "accepted",
            "submission_space_id": "string",
            "submitter_id": "string",
            "submitting_on_behalf_of_presenter": true,
            "sys_bulk_load_at": "string",
            "sys_bulk_load_id": "string",
            "sys_bulk_load_pk": "string",
            "sys_bulk_load_record_no": 0.1,
            "sys_bulk_load_source_file": "string",
            "sys_calculated_field_error": "string",
            "sys_calculated_field_errors": [
              {
                "error": "string",
                "field": "string"
              }
            ],
            "sys_configuration_snapshot_id": "string",
            "sys_created_at": null,
            "sys_created_by_id": null,
            "sys_deleted_by_id": "string",
            "sys_directive": "string",
            "sys_external_id": "string",
            "sys_has_files_in_s3": true,
            "sys_last_bulk_data_operation_id": "string",
            "sys_last_bulk_data_operation_sys_version": "string",
            "sys_last_modified_at": null,
            "sys_last_modified_by_id": null,
            "sys_last_security_context": {},
            "sys_locked": true,
            "sys_snapshot_base_version": 0.1,
            "sys_version": 0.1,
            "title": "string",
            "total_score": 0.1,
            "type_id": "string"
          },
          "allow_duplicates": true,
          "main_presenter_speaker_type_id": "string",
          "make_co_authors_speakers": true,
          "new_status": "accepted",
          "suppress_email_notifications": true,
          "type_id": "string"
        }
      }
    ]
  }'

Responses

Request completed successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
error_countnumber(float)(Error Count)

Number of error results

resultsArray of objects
success_countnumber(float)(Success Count)

Number of successful results

Response
application/json
{ "error_count": 0.1, "results": [ {} ], "success_count": 0.1 }

Downloads a Certificate

Request

Returns the HTML for the certificate

Path
tenantIdstringrequired

The id of the tenant being accessed

idstringrequired

The ID of the certifications

Query
downloadAsHtmlboolean

If true, return the receipt as HTML

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/registrations/{tenantId}/certificate/{id}?downloadAsHtml=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The certifications was downloaded successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
string
Response
application/json
"string"

Returns a list of records with the specified contact_id

Request

Returns a list of records with the specified contact_id

Path
tenantIdstringrequired

The tenant

contact_idstringrequired

The contact_id to use to for record lookup

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/registrations/{tenantId}/contact/{contact_id}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
Countinteger
ItemsArray of objects(Registration)
LastEvaluatedKeystring
Response
application/json
{ "Count": 0, "Items": [ {} ], "LastEvaluatedKey": "string" }

Ribbon Types

Ribbon Types

Operations

Rooms

Rooms

Operations

Session Fees

Session Fees

Operations

Session Registrations

Session Registrations

Operations

Session Tracks

Session Tracks

Operations

Session Types

Session Types

Operations

Sessions

Sessions

Operations

Settings

Settings

Operations

Show Floors

Show Floors

Operations

Speaker Profiles

Speaker Profiles

Operations

Speaker Topics

Speaker Topics

Operations

Speaker Types

Speaker Types

Operations

Speakers

Speakers

Operations

Sponsors

Sponsors

Operations

Statistics

Statistics

Operations

Types

Types

Operations

Venues

Venues

Operations

Waitlist Processes

Waitlist Processes

Operations

Waitlisted Contacts

Waitlisted Contacts

Operations