Custom integrations can be achieved using the Conferences i/o API.

Note: API settings are an account setting enabled by Conferences i/o. If these settings are missing in your app, contact Customer Support to have them enabled.

API documentation

Manage API keys

Create a new API key

API documentation

Full reference documentation for the Conferences i/o API is below.

Authentication Scheme Reference

• API Key (ApiKeyHeader)
  • Parameter Name: API-Key, in: header.

Conferences i/o App REST API v2

Availability

API access must be activated by Conferences i/o before any API endpoint will work. Please reach out to your Conferences i/o Account Representative or to Conferences i/o Support (support@conferences.io) if you would like more information about activating API access. There may be an additional cost associated with activating API access.

Endpoint

Your endpoint for this API lives under your Conferences i/o URL. If your Conferences i/o URL was example.cnf.io, your endpoint would be: https://example.cnf.io/api/v2

The App identifier used when calling App resources is the App's URI (e.g. example for example.cnf.io). Be aware that this value may occasionally change if and when you send a change_uri instruction.

Authentication

All requests require an API-Key HTTP header. Multiple API keys can be created and managed by an administrator to control access.

Data Format

All request and response bodies are JSON (application/json).

Responses

Successful responses generally include a status ("ok") and a code (HTTP status code). Response body shape varies by endpoint. Some DELETE endpoints return 200 with a body, while others return 204 with no body.

Null Value Behavior

• In GET responses: A null value indicates a field has no setting.
• In PUT requests: A null value means the field will be ignored (same as omitting it). To unset a field, pass a blank string ("").

Timestamps

All timestamps are in ISO-8601 format.

Base URLs:

• https://{subdomain}.cnf.io/api/v2
  • subdomain - Your Conferences i/o subdomain (e.g. "example" for example.cnf.io) Default: YOUR_URL

App

App-level settings and configuration.

Retrieve App Settings

GET /app

Retrieves the current settings for the app. The App identifier is the app's URI (e.g. "example" for example.cnf.io). This value may occasionally change when a change_uri instruction is sent.

Example responses

200 Response

{
  "status": "ok",
  "code": "200",
  "data": {
    "app_password": null,
    "custom_attendee_field_1": "Registration ID",
    "custom_attendee_field_2": "Region",
    "custom_attendee_field_3": null,
    "custom_attendee_field_4": null,
    "custom_attendee_field_5": null,
    "end_date": "2019-01-29",
    "moderator_password": "example_moderator_secret",
    "name": "Example Event",
    "start_date": "2019-01-24",
    "timezone": "America/Chicago"
  }
}

500 Response

{
  "status": "error",
  "code": "500",
  "message": "A description of an error that occurred during this request."
}

Responses

Response Schema

Enumerated Values

Authentication required: ApiKeyHeader

Update App Settings

PUT /app

Updates app settings. Only send fields you want to update. A null value for any field means that field will be ignored (no change). To unset a field, pass an empty string ("").

Body parameter

{
  "name": "string",
  "start_date": "2019-01-24",
  "end_date": "2019-01-26",
  "timezone": "America/Chicago",
  "app_password": "string",
  "moderator_password": "string",
  "custom_attendee_field_1": "string",
  "custom_attendee_field_2": "string",
  "custom_attendee_field_3": "string",
  "custom_attendee_field_4": "string",
  "custom_attendee_field_5": "string"
}

Parameters

Example responses

200 Response

{
  "status": "ok",
  "code": "200",
  "data": null
}

500 Response

{
  "status": "error",
  "code": "500",
  "message": "A description of an error that occurred during this request."
}

Responses

Authentication required: ApiKeyHeader

Sessions

Session management, including creation, retrieval, updating, deletion, and polling/Q&A data.

Retrieve a List of Sessions

GET /sessions

Example responses

200 Response

{
  "status": "ok",
  "code": "200",
  "data": {
    "count": 5,
    "data": [
      {
        "access_code": null,
        "checkin_code": null,
        "checkin_required": true,
        "checkout_code": null,
        "checkout_required": true,
        "date": "2026-01-12",
        "delivery_format": "virtual",
        "end_time": "00:00:00",
        "external_id": null,
        "fields_of_study": [
          {
            "credits": "1",
            "name": "Ethics"
          }
        ],
        "id": "abcd",
        "learning_objectives": null,
        "location": null,
        "moderator_password": null,
        "name": "Example Session",
        "presenters": null,
        "start_time": "00:00:00",
        "url": "https://example.cnf.io/sessions/abcd"
      }
    ]
  }
}

500 Response

{
  "status": "error",
  "code": "500",
  "message": "A description of an error that occurred during this request."
}

Responses

Response Schema

Enumerated Values

Authentication required: ApiKeyHeader

Create a Session

POST /sessions

Creates a new session. date is preferred in YYYY-MM-DD format, but other date strings like "January 23, 2023" are also parsed. start_time and end_time are preferred in 24-hour HH:MM format (e.g. "20:00" for 8:00PM), but strings like "8pm" or "8:00PM" are also accepted. There is no need to account for timezone — use the dates and times appropriate to the event's geographic context. Presenters can be created inline via the presenters array. See the Presenters section for deduplication logic.

Body parameter

{
  "external_id": "string",
  "name": "Example Session",
  "location": "Ballroom A",
  "description": "string",
  "date": "2019-01-24",
  "start_time": "08:30:00",
  "end_time": "09:15:00",
  "access_code": "string",
  "moderator_password": "string",
  "presenters": [
    {
      "id": "abcdefghijkl",
      "external_id": "PRESENTER-001",
      "name": "Jordan Example"
    }
  ],
  "fields_of_study": [
    {
      "name": "Accounting",
      "credits": "2.5"
    }
  ],
  "learning_objectives": [
    "string"
  ],
  "checkin_required": true,
  "checkout_required": true,
  "checkin_code": "string",
  "checkout_code": "string",
  "delivery_format": "string"
}

Parameters

Example responses

201 Response

{
  "status": "ok",
  "code": "201",
  "data": {
    "object": "session",
    "id": "abcd",
    "url": "https://example.cnf.io/sessions/abcd"
  }
}

500 Response

{
  "status": "error",
  "code": "500",
  "message": "A description of an error that occurred during this request."
}

Responses

Response Schema

Enumerated Values

Authentication required: ApiKeyHeader

Retrieve a Session

GET /sessions/{session_id}

Parameters

Example responses

200 Response

{
  "status": "ok",
  "code": "200",
  "data": {
    "id": "abcd",
    "external_id": null,
    "name": "Example Session",
    "location": "Ballroom A",
    "date": "2026-06-01",
    "start_time": "08:30:00",
    "end_time": "09:15:00",
    "access_code": null,
    "moderator_password": null,
    "checkin_code": null,
    "checkin_required": false,
    "checkout_code": null,
    "checkout_required": false,
    "delivery_format": null,
    "url": "https://example.cnf.io/sessions/abcd",
    "presenters": null,
    "fields_of_study": [
      {
        "name": "Accounting",
        "credits": "2"
      }
    ],
    "learning_objectives": null
  }
}

500 Response

{
  "status": "error",
  "code": "500",
  "message": "A description of an error that occurred during this request."
}

Responses

Response Schema

Enumerated Values

Authentication required: ApiKeyHeader

Update a Session

PUT /sessions/{session_id}

Updates a session. You only need to send the fields you want updated. A null value means the field will be ignored (no change). To unset a field, pass an empty string (""). If fields_of_study is not included in the request, no change will be made to existing fields of study. Presenters can be updated inline via the presenters array. See the Presenters section for deduplication and update logic.

Body parameter

{
  "external_id": "string",
  "name": "Example Session",
  "location": "Ballroom A",
  "description": "string",
  "date": "2019-01-24",
  "start_time": "08:30:00",
  "end_time": "09:15:00",
  "access_code": "string",
  "moderator_password": "string",
  "presenters": [
    {
      "id": "abcdefghijkl",
      "external_id": "PRESENTER-001",
      "name": "Jordan Example"
    }
  ],
  "fields_of_study": [
    {
      "name": "Accounting",
      "credits": "2.5"
    }
  ],
  "learning_objectives": [
    "string"
  ],
  "checkin_required": true,
  "checkout_required": true,
  "checkin_code": "string",
  "checkout_code": "string",
  "delivery_format": "string"
}

Parameters

Example responses

200 Response

{
  "status": "ok",
  "code": "200",
  "data": null
}

500 Response

{
  "status": "error",
  "code": "500",
  "message": "A description of an error that occurred during this request."
}

Responses

Authentication required: ApiKeyHeader

Delete a Session

DELETE /sessions/{session_id}

Parameters

Responses

Authentication required: ApiKeyHeader

Retrieve Session Polling and Q&A Data

GET /sessions/{session_id}/data

Returns polling and Social Q&A data for a session (added December 2019). This endpoint only supports retrieving data — modifying polling or Q&A data is not supported. Useful for moving raw response datasets into your own database or service. Important: This endpoint is not intended for real-time consumption of polling and Q&A data, and no real-time method exists in this API.

Parameters

Example responses

200 Response

{
  "status": "ok",
  "code": "200",
  "data": {
    "polls": {},
    "questions": []
  }
}

500 Response

{
  "status": "error",
  "code": "500",
  "message": "A description of an error that occurred during this request."
}

Responses

Response Schema

Enumerated Values

Authentication required: ApiKeyHeader

Attendance Tracking

Session attendance check-ins, check-outs, preloading, and removal. Includes support for fields of study, codewords, and delivery format tracking.

Retrieve All Attendance Tracking Data for a Session

GET /sessions/{session_id}/attendance

Parameters

Example responses

200 Response

{
  "status": "ok",
  "code": "200",
  "data": [
    {
      "user": {
        "first_name": "Alex",
        "last_name": "Example",
        "email": "attendee@example.com",
        "external_id": "ATTENDEE-001",
        "field_1": null,
        "field_2": null,
        "field_3": null,
        "field_4": null,
        "field_5": null
      },
      "checkin_time": "2019-01-08T11:47:02-05:00",
      "checkout_time": null,
      "checkin_time_actual": "2019-01-08T12:38:02-05:00",
      "checkout_time_actual": null,
      "delivery_format": null,
      "admin_note": null,
      "attendee_note": null,
      "checkin_source": null,
      "checkout_source": null,
      "fields_of_study": [
        {
          "name": "Accounting",
          "credits": 2,
          "codewords": {
            "possible": 4,
            "valid": 0,
            "missed": 4,
            "valid_list": [],
            "missed_list": [
              "code1",
              "code2",
              "code3",
              "code4"
            ]
          }
        },
        {
          "name": "Taxes",
          "credits": 1,
          "codewords": {
            "possible": 2,
            "valid": 0,
            "missed": 2,
            "valid_list": [],
            "missed_list": [
              "code5",
              "code6"
            ]
          }
        }
      ],
      "history": [
        {
          "action": "checkin",
          "timestamp": "2019-01-08T11:47:02-05:00"
        }
      ]
    }
  ]
}

500 Response

{
  "status": "error",
  "code": "500",
  "message": "A description of an error that occurred during this request."
}

Responses

Response Schema

Enumerated Values

Authentication required: ApiKeyHeader

Clear All Check-Ins for a Session

DELETE /sessions/{session_id}/attendance

Removes all check-ins and attendance data for an individual session. This method cannot remove individual attendee check-ins — use the /attendance/remove endpoint for that.

Parameters

Example responses

200 Response

{
  "status": "ok",
  "code": "200",
  "data": {
    "count": 3
  }
}

Responses

Response Schema

Enumerated Values

Authentication required: ApiKeyHeader

Remove Check-Ins for a Session

POST /sessions/{session_id}/attendance/remove

Removes individual attendee check-ins using filters. Can remove check-ins by email, external_id, or remove all check-ins with all: true. Filter rules: - Filters cannot be combined. Using more than one (e.g. all: true + an email) returns a "Too many possible filters" error.

• Passing all attributes as null or omitting them returns a "No valid filters were passed" error.
• email and external_id are mutually exclusive. - Matches are exact and case-insensitive. If two user records share the same email, both check-ins will be removed.

Use preview: true to see what would be removed without executing the removal. Added October 2021.

Body parameter

{
  "preview": false,
  "all": true,
  "email": "string",
  "external_id": "string"
}

Parameters

Enumerated Values

Example responses

200 Response

{
  "status": "ok",
  "code": "200",
  "data": {
    "preview": false,
    "found": 1,
    "checkins": [],
    "filters": {
      "all": false,
      "email": "attendee@example.com",
      "external_id": null
    }
  }
}

500 Response

{
  "status": "error",
  "code": "500",
  "message": "Too many possible filters"
}

Responses

Response Schema

Enumerated Values

Authentication required: ApiKeyHeader

Preload Attendees to a Session

POST /sessions/{session_id}/attendance/preload

Pre-loads attendees for check-in, primarily used with Kiosk Mode. No pre-existing pre-loaded attendees will be removed when pre-loading. If you need to re-synchronize, clear existing attendance data for the session first, then use this method again.

Body parameter

[
  {
    "external_id": "ATTENDEE-001",
    "first_name": "Alex",
    "last_name": "Example",
    "email": "attendee@example.com",
    "field_1": "North Region",
    "field_2": "string",
    "field_3": "string",
    "field_4": "string",
    "field_5": "string"
  }
]

Parameters

Example responses

200 Response

{
  "status": "ok",
  "code": "200",
  "data": {
    "count": 2
  }
}

500 Response

{
  "status": "error",
  "code": "500",
  "message": "A description of an error that occurred during this request."
}

Responses

Response Schema

Enumerated Values

Authentication required: ApiKeyHeader

Session Evaluations

Session evaluation response data (read-only).

Retrieve All Evaluation Response Data

GET /evaluations/responses

Returns all session evaluation response data across the app. Each record represents a single question/response pair, associated with a session, user, and optionally a presenter.

Example responses

200 Response

{
  "status": "ok",
  "code": "200",
  "data": {
    "count": 0,
    "responses": []
  }
}

500 Response

{
  "status": "error",
  "code": "500",
  "message": "A description of an error that occurred during this request."
}

Responses

Response Schema

Enumerated Values

Authentication required: ApiKeyHeader

Schemas

SuccessResponse

{
  "status": "ok",
  "code": "200",
  "data": null
}

Properties

Enumerated Values

ErrorResponse

{
  "status": "error",
  "code": "500",
  "message": "string"
}

Properties

Enumerated Values

AppSettings

{
  "name": "string",
  "url": "string",
  "start_date": "2019-01-24",
  "end_date": "2019-01-26",
  "timezone": "America/Chicago",
  "app_password": "string",
  "moderator_password": "string",
  "custom_attendee_field_1": "string",
  "custom_attendee_field_2": "string",
  "custom_attendee_field_3": "string",
  "custom_attendee_field_4": "string",
  "custom_attendee_field_5": "string"
}

Properties

SessionListData

{
  "count": 5,
  "data": [
    {
      "id": "abcd",
      "external_id": "string",
      "name": "Example Session",
      "location": "Ballroom A",
      "description": "string",
      "date": "2019-01-24",
      "start_time": "08:30:00",
      "end_time": "09:15:00",
      "access_code": "string",
      "moderator_password": "string",
      "url": "https://example.cnf.io/sessions/abcd",
      "presenters": [
        {
          "id": "7yzhmasgrdeys6fwyx64hx41",
          "external_id": null,
          "name": "Casey Example"
        }
      ],
      "fields_of_study": [
        {
          "name": "Accounting",
          "credits": "2.5"
        }
      ],
      "learning_objectives": [
        "string"
      ],
      "checkin_required": true,
      "checkout_required": true,
      "checkin_code": "string",
      "checkout_code": "string",
      "delivery_format": "string"
    }
  ]
}

Properties

CountData

{
  "count": 2
}

Properties

FieldOfStudy

{
  "name": "Accounting",
  "credits": "2.5"
}

Both name and credits are required. If fields_of_study is not passed in a create or update request, no change will be made. Poorly formatted fields_of_study will not produce an error — instead, the field will silently become empty for the session.

Properties

PresenterRef

{
  "id": "abcdefghijkl",
  "name": "Jordan Example",
  "external_id": "PRESENTER-001"
}

Presenter objects used when creating or updating a session. The simplest form passes only name. If no external_id is specified, the API attempts to find a presenter with a matching name to avoid duplicates. If external_id is specified, the API looks for a presenter with that external_id and creates one if none exists. If the internal id is specified, name and external_id will be updated in Conferences i/o.

Properties

PresenterSummary

{
  "id": "7yzhmasgrdeys6fwyx64hx41",
  "external_id": null,
  "name": "Casey Example"
}

Properties

Session

{
  "id": "abcd",
  "external_id": "string",
  "name": "Example Session",
  "location": "Ballroom A",
  "description": "string",
  "date": "2019-01-24",
  "start_time": "08:30:00",
  "end_time": "09:15:00",
  "access_code": "string",
  "moderator_password": "string",
  "url": "https://example.cnf.io/sessions/abcd",
  "presenters": [
    {
      "id": "7yzhmasgrdeys6fwyx64hx41",
      "external_id": null,
      "name": "Casey Example"
    }
  ],
  "fields_of_study": [
    {
      "name": "Accounting",
      "credits": "2.5"
    }
  ],
  "learning_objectives": [
    "string"
  ],
  "checkin_required": true,
  "checkout_required": true,
  "checkin_code": "string",
  "checkout_code": "string",
  "delivery_format": "string"
}

Properties

Codewords

{
  "possible": 4,
  "valid": 0,
  "missed": 4,
  "valid_list": [
    "string"
  ],
  "missed_list": [
    "code1",
    "code2",
    "code3",
    "code4"
  ]
}

Properties

FieldOfStudyCheckin

{
  "name": "Accounting",
  "credits": 2,
  "codewords": {
    "possible": 4,
    "valid": 0,
    "missed": 4,
    "valid_list": [
      "string"
    ],
    "missed_list": [
      "code1",
      "code2",
      "code3",
      "code4"
    ]
  }
}

Field of study as it appears in a check-in record. If an administrator has manually adjusted the awarded credits within the application, that adjusted value will be reflected here.

Properties

CheckinHistoryEntry

{
  "action": "checkin",
  "timestamp": "2019-01-08T11:47:02-05:00"
}

Properties

Enumerated Values

AttendeeUser

{
  "first_name": "Alex",
  "last_name": "Example",
  "email": "attendee@example.com",
  "external_id": "ATTENDEE-001",
  "field_1": "string",
  "field_2": "string",
  "field_3": "string",
  "field_4": "string",
  "field_5": "string"
}

Properties

CheckinRecord

{
  "user": {
    "first_name": "Alex",
    "last_name": "Example",
    "email": "attendee@example.com",
    "external_id": "ATTENDEE-001",
    "field_1": "string",
    "field_2": "string",
    "field_3": "string",
    "field_4": "string",
    "field_5": "string"
  },
  "checkin_time": "2019-01-08T11:47:02-05:00",
  "checkout_time": "string",
  "checkin_time_actual": "2019-01-08T12:38:02-05:00",
  "checkout_time_actual": "string",
  "delivery_format": "string",
  "admin_note": "string",
  "attendee_note": "string",
  "checkin_source": "string",
  "checkout_source": "string",
  "evaluation_complete": "0",
  "total_time_attended": "string",
  "fields_of_study": [
    {
      "name": "Accounting",
      "credits": 2,
      "codewords": {
        "possible": 4,
        "valid": 0,
        "missed": 4,
        "valid_list": [
          "string"
        ],
        "missed_list": [
          "code1",
          "code2",
          "code3",
          "code4"
        ]
      }
    }
  ],
  "history": [
    {
      "action": "checkin",
      "timestamp": "2019-01-08T11:47:02-05:00"
    }
  ]
}

Properties

PreloadAttendee

{
  "external_id": "ATTENDEE-001",
  "first_name": "Alex",
  "last_name": "Example",
  "email": "attendee@example.com",
  "field_1": "North Region",
  "field_2": "string",
  "field_3": "string",
  "field_4": "string",
  "field_5": "string"
}

Properties

PollData

{
  "created": "string",
  "name": "An example poll",
  "rank": 0,
  "type": "multiple_choice",
  "choices": [
    "Choice 1",
    "Choice 2",
    "Choice 3"
  ],
  "responses": null
}

Properties

SessionQAData

{
  "polls": {
    "property1": {
      "created": "string",
      "name": "An example poll",
      "rank": 0,
      "type": "multiple_choice",
      "choices": [
        "Choice 1",
        "Choice 2",
        "Choice 3"
      ],
      "responses": null
    },
    "property2": {
      "created": "string",
      "name": "An example poll",
      "rank": 0,
      "type": "multiple_choice",
      "choices": [
        "Choice 1",
        "Choice 2",
        "Choice 3"
      ],
      "responses": null
    }
  },
  "questions": [
    {}
  ]
}

Properties

EvaluationResponseListData

{
  "count": 0,
  "responses": [
    {
      "session": {
        "name": "Breakout A",
        "external_id": "string"
      },
      "user": {
        "id": "10000001",
        "external_id": "string",
        "first_name": "Alex",
        "last_name": "Example",
        "field_1": "ATTENDEE-001",
        "field_2": "Yes",
        "field_3": "string",
        "field_4": "string",
        "field_5": "string"
      },
      "presenter": null,
      "question": "How was this session?",
      "response": "5 - Great",
      "response_value": 5,
      "timestamp": "Tue, 21 Jan 2018 11:47:08 -0500"
    }
  ]
}

Properties

EvaluationUser

{
  "id": "10000001",
  "external_id": "string",
  "first_name": "Alex",
  "last_name": "Example",
  "field_1": "ATTENDEE-001",
  "field_2": "Yes",
  "field_3": "string",
  "field_4": "string",
  "field_5": "string"
}

Properties

EvaluationResponse

{
  "session": {
    "name": "Breakout A",
    "external_id": "string"
  },
  "user": {
    "id": "10000001",
    "external_id": "string",
    "first_name": "Alex",
    "last_name": "Example",
    "field_1": "ATTENDEE-001",
    "field_2": "Yes",
    "field_3": "string",
    "field_4": "string",
    "field_5": "string"
  },
  "presenter": null,
  "question": "How was this session?",
  "response": "5 - Great",
  "response_value": 5,
  "timestamp": "Tue, 21 Jan 2018 11:47:08 -0500"
}

Properties

Manage API keys

1. Sign-in to the Admin panel
2. Under Advanced Settings, click API Keys & Settings
   
3. View an API key by clicking the blurred text area or disable a key by clicking Disable This Key
   

Create a new API key

1. In API Keys & Settings, click Add API Key
   
    

2. Enter a description for the key, then click Create Now

   
    

3. Get the API key by clicking the blurred text area in the API Keys & Settings area