# WebinarGeek

> Work with your WebinarGeek webinars: look up webinars and broadcasts, register people and unsubscribe them, search registrations, read chat, questions and payments, and check who received and opened each webinar email.

App · 15 actions. Web page: https://docs.lodol.com/docs/integrations/webinargeek

## Actions

### Get account

Get the WebinarGeek account the API key belongs to: its company name and email.

**Inputs**: None.

**Outputs**

- `account` (object): The account

**Example output**

```json
{
  "account": {
    "company": "Acme Webinars",
    "email": "jo@example.com"
  }
}
```

### Get broadcast

Get one broadcast: its date, state, replay link, viewer counts and AI summaries, with its episode and webinar.

**Inputs**

- Broadcast (`broadcast_id`, text, required): The broadcast (one dated showing). Pick one, or give its id.

**Outputs**

- `broadcast` (object): The broadcast

**Example output**

```json
{
  "broadcast": {
    "active_jit": false,
    "active_yesterdays_replay": false,
    "cancelled": false,
    "date": 1790848800,
    "duration": 0,
    "ended_at": 0,
    "enrichments": {},
    "episode": {
      "estimated_duration": 3600,
      "id": 21,
      "internal_title": "",
      "subscriptions_count": 12,
      "title": "Getting started",
      "type": "live"
    },
    "has_ended": false,
    "id": 31,
    "live_viewers_count": 0,
    "public_replay_link": "https://webinars.webinargeek.com/watch/replay/abc123/",
    "replay_available": true,
    "replay_available_until": 0,
    "replay_viewers_count": 0,
    "started_at": 0,
    "subscriptions_count": 12,
    "viewers_count": 0,
    "webinar": {
      "id": 11,
      "internal_title": "",
      "ondemand": false,
      "title": "Getting started",
      "url": "https://webinars.webinargeek.com/getting-started"
    }
  }
}
```

### Get registration

Get one registration with watch times, poll and quiz answers, messages, questions and payments.

**Inputs**

- Registration ID (`subscription_id`, text, required): The registration's id, from 'List registrations', 'Register for a broadcast' or an earlier step.

**Outputs**

- `subscription` (object): The registration

**Example output**

```json
{
  "subscription": {
    "assessment": {},
    "auto_subscribe": false,
    "broadcast": {
      "active_jit": false,
      "active_yesterdays_replay": false,
      "cancelled": false,
      "date": 1790848800,
      "duration": 0,
      "ended_at": 0,
      "enrichments": {},
      "has_ended": false,
      "id": 31,
      "live_viewers_count": 0,
      "public_replay_link": "https://webinars.webinargeek.com/watch/replay/abc123/",
      "replay_available": true,
      "replay_available_until": 0,
      "replay_viewers_count": 0,
      "started_at": 0,
      "subscriptions_count": 12,
      "viewers_count": 0
    },
    "browser_language": "",
    "calls_to_action": [],
    "captions_language": "",
    "city": "",
    "company": "Acme",
    "confirmation_link": "https://webinars.webinargeek.com/webinar/subscribed/abc123/",
    "consent_fields": {},
    "country": "NL",
    "created_at": 1790848800,
    "custom_field": "",
    "eligible_to_watch": false,
    "email": "jo@example.com",
    "email_verified": false,
    "email_verified_at": 0,
    "episode": {
      "estimated_duration": 3600,
      "id": 21,
      "internal_title": "",
      "subscriptions_count": 12,
      "title": "Getting started",
      "type": "live"
    },
    "evaluation_form_answers": [],
    "external_id": "crm-123",
    "extra_fields": {},
    "firstname": "Jo",
    "house_number": "",
    "id": 301,
    "job_title": "",
    "messages": [],
    "payment_to_watch_completed": false,
    "payments": [],
    "phone": "",
    "poll_votes": [],
    "postcode": "",
    "province": "",
    "questions": [],
    "quiz_answers": [],
    "registration_ip": "",
    "registration_source": "api",
    "street": "",
    "surname": "Bloggs",
    "time_zone": "Europe/Amsterdam",
    "unsubscribed": false,
    "unsubscribed_at": 0,
    "unsubscription_source": "",
    "utm_campaign": "",
    "utm_content": "",
    "utm_medium": "",
    "utm_source": "",
    "utm_term": "",
    "watch_duration": 0,
    "watch_duration_replay": 0,
    "watch_end": 0,
    "watch_end_replay": 0,
    "watch_link": "https://webinars.webinargeek.com/watch/abc123/",
    "watch_start": 0,
    "watch_start_replay": 0,
    "watched": false,
    "watched_live": false,
    "watched_replay": false,
    "watched_true_set_at": 0,
    "webinar": {
      "id": 11,
      "internal_title": "",
      "ondemand": false,
      "title": "Getting started",
      "url": "https://webinars.webinargeek.com/getting-started"
    }
  }
}
```

### Get webinar

Get one webinar with its episodes, broadcasts, presenters' links and the fields on its registration form.

**Inputs**

- Webinar (`webinar_id`, text, required): The webinar. Pick one, or give its id from an earlier step.
- Include past broadcasts (`include_past`, true/false): Also show broadcasts that already happened.

**Outputs**

- `webinar` (object): The webinar

**Example output**

```json
{
  "webinar": {
    "archived": false,
    "created_at": 1790841600,
    "episodes": [
      {
        "broadcasts": [
          {
            "active_jit": false,
            "active_yesterdays_replay": false,
            "cancelled": false,
            "date": 1790848800,
            "duration": 0,
            "ended_at": 0,
            "enrichments": {},
            "has_ended": false,
            "id": 31,
            "live_viewers_count": 0,
            "public_replay_link": "https://webinars.webinargeek.com/watch/replay/abc123/",
            "replay_available": true,
            "replay_available_until": 0,
            "replay_viewers_count": 0,
            "started_at": 0,
            "subscriptions_count": 12,
            "viewers_count": 0
          }
        ],
        "created_at": 1790841600,
        "estimated_duration": 3600,
        "id": 21,
        "internal_title": "",
        "jit_enabled": false,
        "ondemand_ended_at": 0,
        "ondemand_limited_availability": false,
        "ondemand_watch_start_at": 0,
        "published": true,
        "subscriptions_count": 12,
        "team_members": [
          {
            "created_at": 1790841600,
            "email": "sam@example.com",
            "firstname": "Sam",
            "id": 5,
            "lastname": "Presenter",
            "live_invitation_url": "",
            "role": "presenter",
            "test_invitation_url": ""
          }
        ],
        "title": "Getting started",
        "type": "live",
        "video": {},
        "yesterdays_replay_enabled": false
      }
    ],
    "id": 11,
    "internal_title": "",
    "language": "en",
    "maximum_number_of_subscribers": 100,
    "maximum_number_of_viewers": 95,
    "metadata_description": "",
    "metadata_image": "",
    "metadata_title": "",
    "ondemand": false,
    "registration_fields": [
      {
        "extra_field": false,
        "field_options": [],
        "input_type": "text_field",
        "label": "First name",
        "mandatory": true,
        "name": "firstname",
        "position": 1
      }
    ],
    "title": "Getting started",
    "url": "https://webinars.webinargeek.com/getting-started",
    "view_without_registration_url": ""
  }
}
```

### Get webinar email

Get one email of a webinar: its name, subject, type and schedule.

**Inputs**

- Webinar (`webinar_id`, text, required): The webinar. Pick one, or give its id from an earlier step.
- Email (`email_id`, text, required): The webinar's email. Pick one, or give its id.

**Outputs**

- `email` (object): The email

**Example output**

```json
{
  "email": {
    "active": true,
    "created_at": 1790848800,
    "episode_id": 21,
    "id": 2,
    "invocation": "scheduled_before",
    "name": "Reminder email",
    "schedule": {
      "days": 1,
      "hours": 0,
      "minutes": 0
    },
    "scope": "episode",
    "subject": "The webinar starts tomorrow",
    "template_type": "reminder",
    "updated_at": 1790852400,
    "webinar_id": 11
  }
}
```

### List broadcasts

List broadcasts (the dated showings of episodes) with their registration and viewer counts. Gets one page.

**Inputs**

- Include details of (`nested_resources`, list): Add the episode or webinar each broadcast belongs to. One or more of: `episode`, `webinar`.
- Sort by (`order`, text): What to sort by. Defaults to when it was created. One of: `created_at` (When it was created (default)), `date` (When it starts).
- Order (`sort`, text): Which end to start from. Defaults to newest first. One of: `desc` (Newest first (default)), `asc` (Oldest first).
- Page (`page`, number): Which page to get, starting at 1. Use 'next_page' from the last result. At least 1.
- Page size (`per_page`, number): How many to return per page, 1 to 1000. WebinarGeek's default is 50. From 1 to 1000.

**Outputs**

- `broadcasts` (list): The broadcasts
- `count` (number): How many records this page has
- `next_page` (number): The number of the next page, or 0 on the last page
- `page` (number): This page's number, from 1
- `per_page` (number): The page size used
- `total_count` (number): How many records match across all pages
- `total_pages` (number): How many pages there are

**Example output**

```json
{
  "broadcasts": [
    {
      "active_jit": false,
      "active_yesterdays_replay": false,
      "cancelled": false,
      "date": 1790848800,
      "duration": 0,
      "ended_at": 0,
      "enrichments": {},
      "episode": {
        "estimated_duration": 3600,
        "id": 21,
        "internal_title": "",
        "subscriptions_count": 12,
        "title": "Getting started",
        "type": "live"
      },
      "has_ended": false,
      "id": 31,
      "live_viewers_count": 0,
      "public_replay_link": "https://webinars.webinargeek.com/watch/replay/abc123/",
      "replay_available": true,
      "replay_available_until": 0,
      "replay_viewers_count": 0,
      "started_at": 0,
      "subscriptions_count": 12,
      "viewers_count": 0,
      "webinar": {
        "id": 11,
        "internal_title": "",
        "ondemand": false,
        "title": "Getting started",
        "url": "https://webinars.webinargeek.com/getting-started"
      }
    }
  ],
  "count": 1,
  "next_page": 0,
  "page": 1,
  "per_page": 50,
  "total_count": 1,
  "total_pages": 1
}
```

### List chat messages

List public chat, private chat and question-box messages sent during webinars, for the account or one webinar, episode or broadcast.

**Inputs**

- Webinar (`webinar_id`, text): Only this webinar's.
- Episode (`episode_id`, text): Only this episode's.
- Broadcast (`broadcast_id`, text): Only this broadcast's.
- Type (`message_type`, text): Only this kind of message. One of: `public` (Public chat), `private` (Private chat), `question` (Question box).
- Sort by (`order`, text): What to sort by. Defaults to when it was sent. One of: `created_at` (When it was sent (default)), `recipient_id` (Conversation (groups replies together)).
- Order (`sort`, text): Which end to start from. Defaults to newest first. One of: `desc` (Newest first (default)), `asc` (Oldest first).
- Page (`page`, number): Which page to get, starting at 1. Use 'next_page' from the last result. At least 1.
- Page size (`per_page`, number): How many to return per page, 1 to 1000. WebinarGeek's default is 50. From 1 to 1000.

**Outputs**

- `count` (number): How many records this page has
- `messages` (list): The messages
- `next_page` (number): The number of the next page, or 0 on the last page
- `page` (number): This page's number, from 1
- `per_page` (number): The page size used
- `total_count` (number): How many records match across all pages
- `total_pages` (number): How many pages there are

**Example output**

```json
{
  "count": 1,
  "messages": [
    {
      "created_at": 1790848800,
      "id": 1,
      "is_reply": false,
      "is_viewer": true,
      "message": "Hello from Amsterdam!",
      "recipient_id": 0,
      "reply_to_id": 0,
      "reply_to_message": "",
      "reply_to_name": "",
      "subscription": {
        "assessment": {},
        "auto_subscribe": false,
        "broadcast": {
          "active_jit": false,
          "active_yesterdays_replay": false,
          "cancelled": false,
          "date": 1790848800,
          "duration": 0,
          "ended_at": 0,
          "enrichments": {},
          "has_ended": false,
          "id": 31,
          "live_viewers_count": 0,
          "public_replay_link": "https://webinars.webinargeek.com/watch/replay/abc123/",
          "replay_available": true,
          "replay_available_until": 0,
          "replay_viewers_count": 0,
          "started_at": 0,
          "subscriptions_count": 12,
          "viewers_count": 0
        },
        "browser_language": "",
        "calls_to_action": [],
        "captions_language": "",
        "city": "",
        "company": "Acme",
        "confirmation_link": "https://webinars.webinargeek.com/webinar/subscribed/abc123/",
        "consent_fields": {},
        "country": "NL",
        "created_at": 1790848800,
        "custom_field": "",
        "eligible_to_watch": false,
        "email": "jo@example.com",
        "email_verified": false,
        "email_verified_at": 0,
        "episode": {
          "estimated_duration": 3600,
          "id": 21,
          "internal_title": "",
          "subscriptions_count": 12,
          "title": "Getting started",
          "type": "live"
        },
        "evaluation_form_answers": [],
        "external_id": "crm-123",
        "extra_fields": {},
        "firstname": "Jo",
        "house_number": "",
        "id": 301,
        "job_title": "",
        "messages": [],
        "payment_to_watch_completed": false,
        "payments": [],
        "phone": "",
        "poll_votes": [],
        "postcode": "",
        "province": "",
        "questions": [],
        "quiz_answers": [],
        "registration_ip": "",
        "registration_source": "api",
        "street": "",
        "surname": "Bloggs",
        "time_zone": "Europe/Amsterdam",
        "unsubscribed": false,
        "unsubscribed_at": 0,
        "unsubscription_source": "",
        "utm_campaign": "",
        "utm_content": "",
        "utm_medium": "",
        "utm_source": "",
        "utm_term": "",
        "watch_duration": 0,
        "watch_duration_replay": 0,
        "watch_end": 0,
        "watch_end_replay": 0,
        "watch_link": "https://webinars.webinargeek.com/watch/abc123/",
        "watch_start": 0,
        "watch_start_replay": 0,
        "watched": false,
        "watched_live": false,
        "watched_replay": false,
        "watched_true_set_at": 0,
        "webinar": {
          "id": 11,
          "internal_title": "",
          "ondemand": false,
          "title": "Getting started",
          "url": "https://webinars.webinargeek.com/getting-started"
        }
      },
      "type": "public"
    }
  ],
  "next_page": 0,
  "page": 1,
  "per_page": 50,
  "total_count": 1,
  "total_pages": 1
}
```

### List email deliveries

See who one webinar email was sent to and whether it was delivered, opened or bounced.

**Inputs**

- Webinar (`webinar_id`, text, required): The webinar. Pick one, or give its id from an earlier step.
- Email (`email_id`, text, required): The webinar's email. Pick one, or give its id.
- Episode (`episode_id`, text): Only deliveries for this episode.
- Broadcast (`broadcast_id`, text): Only deliveries for this broadcast.
- State (`state`, text): Only deliveries in this state. One of: `requested`, `delivered`, `opened`, `soft_bounced` (Soft bounced), `hard_bounced` (Hard bounced).
- State changed after (`updated_from`, date and time): Only deliveries whose state changed at or after this time.
- State changed before (`updated_to`, date and time): Only deliveries whose state changed at or before this time.
- Sort by (`order`, text): What to sort by. Defaults to when it was queued. One of: `created_at` (When it was queued (default)), `state_updated_at` (When its state last changed).
- Order (`sort`, text): Which end to start from. Defaults to newest first. One of: `desc` (Newest first (default)), `asc` (Oldest first).
- Page (`page`, number): Which page to get, starting at 1. Use 'next_page' from the last result. At least 1.
- Page size (`per_page`, number): How many to return per page, 1 to 1000. WebinarGeek's default is 50. From 1 to 1000.

**Outputs**

- `count` (number): How many records this page has
- `email_sendings` (list): The deliveries
- `next_page` (number): The number of the next page, or 0 on the last page
- `page` (number): This page's number, from 1
- `per_page` (number): The page size used
- `total_count` (number): How many records match across all pages
- `total_pages` (number): How many pages there are

**Example output**

```json
{
  "count": 1,
  "email_sendings": [
    {
      "created_at": 1790848800,
      "email_id": 2,
      "id": 9001,
      "resend": false,
      "state": "opened",
      "state_updated_at": 1790852400,
      "subscriptions": [
        {
          "broadcast_id": 31,
          "email": "jo@example.com",
          "external_id": "crm-123",
          "firstname": "Jo",
          "id": 301,
          "surname": "Bloggs"
        }
      ]
    }
  ],
  "next_page": 0,
  "page": 1,
  "per_page": 50,
  "total_count": 1,
  "total_pages": 1
}
```

### List payments

List completed and refunded payments for paid webinars, for the account or one webinar, episode or broadcast.

**Inputs**

- Webinar (`webinar_id`, text): Only this webinar's.
- Episode (`episode_id`, text): Only this episode's.
- Broadcast (`broadcast_id`, text): Only this broadcast's.
- Include details of (`nested_resources`, list): Add the broadcast, episode or webinar each record belongs to. One or more of: `broadcast`, `episode`, `webinar`.
- Order (`sort`, text): Which end to start from. Defaults to newest first. One of: `desc` (Newest first (default)), `asc` (Oldest first).
- Page (`page`, number): Which page to get, starting at 1. Use 'next_page' from the last result. At least 1.
- Page size (`per_page`, number): How many to return per page, 1 to 1000. WebinarGeek's default is 50. From 1 to 1000.

**Outputs**

- `count` (number): How many records this page has
- `next_page` (number): The number of the next page, or 0 on the last page
- `page` (number): This page's number, from 1
- `per_page` (number): The page size used
- `subscription_payments` (list): The payments
- `total_count` (number): How many records match across all pages
- `total_pages` (number): How many pages there are

**Example output**

```json
{
  "count": 1,
  "next_page": 0,
  "page": 1,
  "per_page": 50,
  "subscription_payments": [
    {
      "amount": "10.00",
      "amount_includes_taxes": false,
      "amount_paid": "12.10",
      "application_fee": "",
      "created_at": 1790848800,
      "currency": "EUR",
      "discount_used": false,
      "payment_completed_at": 1790848900,
      "payment_key": "abc123",
      "payment_method": "ideal",
      "provider_payment_id": "tr_1234567890",
      "provider_payment_state": "paid",
      "subscription": {
        "assessment": {},
        "auto_subscribe": false,
        "broadcast": {
          "active_jit": false,
          "active_yesterdays_replay": false,
          "cancelled": false,
          "date": 1790848800,
          "duration": 0,
          "ended_at": 0,
          "enrichments": {},
          "has_ended": false,
          "id": 31,
          "live_viewers_count": 0,
          "public_replay_link": "https://webinars.webinargeek.com/watch/replay/abc123/",
          "replay_available": true,
          "replay_available_until": 0,
          "replay_viewers_count": 0,
          "started_at": 0,
          "subscriptions_count": 12,
          "viewers_count": 0
        },
        "browser_language": "",
        "calls_to_action": [],
        "captions_language": "",
        "city": "",
        "company": "Acme",
        "confirmation_link": "https://webinars.webinargeek.com/webinar/subscribed/abc123/",
        "consent_fields": {},
        "country": "NL",
        "created_at": 1790848800,
        "custom_field": "",
        "eligible_to_watch": false,
        "email": "jo@example.com",
        "email_verified": false,
        "email_verified_at": 0,
        "episode": {
          "estimated_duration": 3600,
          "id": 21,
          "internal_title": "",
          "subscriptions_count": 12,
          "title": "Getting started",
          "type": "live"
        },
        "evaluation_form_answers": [],
        "external_id": "crm-123",
        "extra_fields": {},
        "firstname": "Jo",
        "house_number": "",
        "id": 301,
        "job_title": "",
        "messages": [],
        "payment_to_watch_completed": false,
        "payments": [],
        "phone": "",
        "poll_votes": [],
        "postcode": "",
        "province": "",
        "questions": [],
        "quiz_answers": [],
        "registration_ip": "",
        "registration_source": "api",
        "street": "",
        "surname": "Bloggs",
        "time_zone": "Europe/Amsterdam",
        "unsubscribed": false,
        "unsubscribed_at": 0,
        "unsubscription_source": "",
        "utm_campaign": "",
        "utm_content": "",
        "utm_medium": "",
        "utm_source": "",
        "utm_term": "",
        "watch_duration": 0,
        "watch_duration_replay": 0,
        "watch_end": 0,
        "watch_end_replay": 0,
        "watch_link": "https://webinars.webinargeek.com/watch/abc123/",
        "watch_start": 0,
        "watch_start_replay": 0,
        "watched": false,
        "watched_live": false,
        "watched_replay": false,
        "watched_true_set_at": 0,
        "webinar": {
          "id": 11,
          "internal_title": "",
          "ondemand": false,
          "title": "Getting started",
          "url": "https://webinars.webinargeek.com/getting-started"
        }
      }
    }
  ],
  "total_count": 1,
  "total_pages": 1
}
```

### List questions

List questions asked in the question box with their answers and upvotes, for the account or one webinar, episode or broadcast.

**Inputs**

- Webinar (`webinar_id`, text): Only this webinar's.
- Episode (`episode_id`, text): Only this episode's.
- Broadcast (`broadcast_id`, text): Only this broadcast's.
- Order (`sort`, text): Which end to start from. Defaults to newest first. One of: `desc` (Newest first (default)), `asc` (Oldest first).
- Page (`page`, number): Which page to get, starting at 1. Use 'next_page' from the last result. At least 1.
- Page size (`per_page`, number): How many to return per page, 1 to 1000. WebinarGeek's default is 50. From 1 to 1000.

**Outputs**

- `count` (number): How many records this page has
- `next_page` (number): The number of the next page, or 0 on the last page
- `page` (number): This page's number, from 1
- `per_page` (number): The page size used
- `questions` (list): The questions
- `total_count` (number): How many records match across all pages
- `total_pages` (number): How many pages there are

**Example output**

```json
{
  "count": 1,
  "next_page": 0,
  "page": 1,
  "per_page": 50,
  "questions": [
    {
      "answers": [],
      "broadcast_id": 31,
      "created_at": 1790848800,
      "id": 1,
      "question": "Will there be a replay?",
      "subscription_email": "jo@example.com",
      "subscription_level": "viewer",
      "subscription_name": "Jo Bloggs",
      "upvotes_count": 3
    }
  ],
  "total_count": 1,
  "total_pages": 1
}
```

### List registrations

List and search registrations for the whole account, or for one webinar, episode or broadcast. Search by email, or filter by who watched or unsubscribed. People who have not yet confirmed their email are not included.

**Inputs**

- Email (`email`, text): Only the registration with this email address.
- Your own ID (`external_id`, text): Only registrations with this external id.
- Webinar (`webinar_id`, text): Only registrations for this webinar.
- Episode (`episode_id`, text): Only registrations for this episode.
- Broadcast (`broadcast_id`, text): Only registrations for this broadcast.
- Watched (`watched`, true/false): Only people who watched the webinar, live or replay.
- Watched live (`watched_live`, true/false): Only people who watched it live.
- Watched the replay (`watched_replay`, true/false): Only people who watched the replay.
- Broadcast has ended (`broadcast_ended`, true/false): Only registrations for broadcasts of live or automated webinars that are over.
- Unsubscribed (`unsubscribed`, true/false): Only people who have unsubscribed.
- Passed the assessment (`assessment_passed`, true/false): Only people who passed the webinar's assessment.
- Stopped watching after (`watch_end_from`, date and time): Only people who stopped watching at or after this time. Give 'Stopped watching before' too.
- Stopped watching before (`watch_end_to`, date and time): Only people who stopped watching at or before this time.
- Include details of (`nested_resources`, list): Add the broadcast, episode or webinar each record belongs to. One or more of: `broadcast`, `episode`, `webinar`.
- Sort by (`order`, text): What to sort by. Defaults to when they registered. One of: `created_at` (When they registered (default)), `unsubscribed_at` (When they unsubscribed), `watched_true_set_at` (When they were marked as watched), `watch_end` (When they stopped watching).
- Order (`sort`, text): Which end to start from. Defaults to newest first. One of: `desc` (Newest first (default)), `asc` (Oldest first).
- Page (`page`, number): Which page to get, starting at 1. Use 'next_page' from the last result. At least 1.
- Page size (`per_page`, number): How many to return per page, 1 to 1000. WebinarGeek's default is 50. From 1 to 1000.

**Outputs**

- `count` (number): How many records this page has
- `next_page` (number): The number of the next page, or 0 on the last page
- `page` (number): This page's number, from 1
- `per_page` (number): The page size used
- `subscriptions` (list): The registrations
- `total_count` (number): How many records match across all pages
- `total_pages` (number): How many pages there are

**Example output**

```json
{
  "count": 1,
  "next_page": 0,
  "page": 1,
  "per_page": 50,
  "subscriptions": [
    {
      "assessment": {},
      "auto_subscribe": false,
      "broadcast": {
        "active_jit": false,
        "active_yesterdays_replay": false,
        "cancelled": false,
        "date": 1790848800,
        "duration": 0,
        "ended_at": 0,
        "enrichments": {},
        "has_ended": false,
        "id": 31,
        "live_viewers_count": 0,
        "public_replay_link": "https://webinars.webinargeek.com/watch/replay/abc123/",
        "replay_available": true,
        "replay_available_until": 0,
        "replay_viewers_count": 0,
        "started_at": 0,
        "subscriptions_count": 12,
        "viewers_count": 0
      },
      "browser_language": "",
      "calls_to_action": [],
      "captions_language": "",
      "city": "",
      "company": "Acme",
      "confirmation_link": "https://webinars.webinargeek.com/webinar/subscribed/abc123/",
      "consent_fields": {},
      "country": "NL",
      "created_at": 1790848800,
      "custom_field": "",
      "eligible_to_watch": false,
      "email": "jo@example.com",
      "email_verified": false,
      "email_verified_at": 0,
      "episode": {
        "estimated_duration": 3600,
        "id": 21,
        "internal_title": "",
        "subscriptions_count": 12,
        "title": "Getting started",
        "type": "live"
      },
      "evaluation_form_answers": [],
      "external_id": "crm-123",
      "extra_fields": {},
      "firstname": "Jo",
      "house_number": "",
      "id": 301,
      "job_title": "",
      "messages": [],
      "payment_to_watch_completed": false,
      "payments": [],
      "phone": "",
      "poll_votes": [],
      "postcode": "",
      "province": "",
      "questions": [],
      "quiz_answers": [],
      "registration_ip": "",
      "registration_source": "api",
      "street": "",
      "surname": "Bloggs",
      "time_zone": "Europe/Amsterdam",
      "unsubscribed": false,
      "unsubscribed_at": 0,
      "unsubscription_source": "",
      "utm_campaign": "",
      "utm_content": "",
      "utm_medium": "",
      "utm_source": "",
      "utm_term": "",
      "watch_duration": 0,
      "watch_duration_replay": 0,
      "watch_end": 0,
      "watch_end_replay": 0,
      "watch_link": "https://webinars.webinargeek.com/watch/abc123/",
      "watch_start": 0,
      "watch_start_replay": 0,
      "watched": false,
      "watched_live": false,
      "watched_replay": false,
      "watched_true_set_at": 0,
      "webinar": {
        "id": 11,
        "internal_title": "",
        "ondemand": false,
        "title": "Getting started",
        "url": "https://webinars.webinargeek.com/getting-started"
      }
    }
  ],
  "total_count": 1,
  "total_pages": 1
}
```

### List webinar emails

List the emails a webinar sends (confirmation, reminders, follow-ups), active or not, with when each is sent.

**Inputs**

- Webinar (`webinar_id`, text, required): The webinar. Pick one, or give its id from an earlier step.
- Episode (`episode_id`, text): Only the webinar's shared emails and this episode's emails.
- Order (`sort`, text): Which end to start from. Defaults to newest first. One of: `desc` (Newest first (default)), `asc` (Oldest first).
- Page (`page`, number): Which page to get, starting at 1. Use 'next_page' from the last result. At least 1.
- Page size (`per_page`, number): How many to return per page, 1 to 1000. WebinarGeek's default is 50. From 1 to 1000.

**Outputs**

- `count` (number): How many records this page has
- `emails` (list): The emails
- `next_page` (number): The number of the next page, or 0 on the last page
- `page` (number): This page's number, from 1
- `per_page` (number): The page size used
- `total_count` (number): How many records match across all pages
- `total_pages` (number): How many pages there are

**Example output**

```json
{
  "count": 1,
  "emails": [
    {
      "active": true,
      "created_at": 1790848800,
      "episode_id": 21,
      "id": 2,
      "invocation": "scheduled_before",
      "name": "Reminder email",
      "schedule": {
        "days": 1,
        "hours": 0,
        "minutes": 0
      },
      "scope": "episode",
      "subject": "The webinar starts tomorrow",
      "template_type": "reminder",
      "updated_at": 1790852400,
      "webinar_id": 11
    }
  ],
  "next_page": 0,
  "page": 1,
  "per_page": 50,
  "total_count": 1,
  "total_pages": 1
}
```

### List webinars

List webinars with their episodes, upcoming broadcasts and registration form fields. Gets one page; run it again with the 'next_page' it gives to see more.

**Inputs**

- Include past broadcasts (`include_past`, true/false): Also show broadcasts that already happened.
- Series only (`series_only`, true/false): Only webinars made of two or more episodes.
- Language (`language`, text): Only webinars in this language. One of: `nl` (Dutch), `en` (English), `de` (German), `fr` (French), `es` (Spanish), `it` (Italian), `pl` (Polish), `sv` (Swedish), `da` (Danish), `nb` (Norwegian), and 6 more.
- Include details of (`nested_resources`, list): Add the presenters and team members of each episode. One or more of: `team_member` (Presenters and team members).
- Type (`webinar_type`, text): Only webinars with episodes of this type. One of: `live`, `automated`, `ondemand` (On demand).
- Order (`sort`, text): Which end to start from. Defaults to newest first. One of: `desc` (Newest first (default)), `asc` (Oldest first).
- Page (`page`, number): Which page to get, starting at 1. Use 'next_page' from the last result. At least 1.
- Page size (`per_page`, number): How many to return per page, 1 to 1000. WebinarGeek's default is 50. From 1 to 1000.

**Outputs**

- `count` (number): How many records this page has
- `next_page` (number): The number of the next page, or 0 on the last page
- `page` (number): This page's number, from 1
- `per_page` (number): The page size used
- `total_count` (number): How many records match across all pages
- `total_pages` (number): How many pages there are
- `webinars` (list): The webinars

**Example output**

```json
{
  "count": 1,
  "next_page": 0,
  "page": 1,
  "per_page": 50,
  "total_count": 1,
  "total_pages": 1,
  "webinars": [
    {
      "archived": false,
      "created_at": 1790841600,
      "episodes": [
        {
          "broadcasts": [
            {
              "active_jit": false,
              "active_yesterdays_replay": false,
              "cancelled": false,
              "date": 1790848800,
              "duration": 0,
              "ended_at": 0,
              "enrichments": {},
              "has_ended": false,
              "id": 31,
              "live_viewers_count": 0,
              "public_replay_link": "https://webinars.webinargeek.com/watch/replay/abc123/",
              "replay_available": true,
              "replay_available_until": 0,
              "replay_viewers_count": 0,
              "started_at": 0,
              "subscriptions_count": 12,
              "viewers_count": 0
            }
          ],
          "created_at": 1790841600,
          "estimated_duration": 3600,
          "id": 21,
          "internal_title": "",
          "jit_enabled": false,
          "ondemand_ended_at": 0,
          "ondemand_limited_availability": false,
          "ondemand_watch_start_at": 0,
          "published": true,
          "subscriptions_count": 12,
          "team_members": [
            {
              "created_at": 1790841600,
              "email": "sam@example.com",
              "firstname": "Sam",
              "id": 5,
              "lastname": "Presenter",
              "live_invitation_url": "",
              "role": "presenter",
              "test_invitation_url": ""
            }
          ],
          "title": "Getting started",
          "type": "live",
          "video": {},
          "yesterdays_replay_enabled": false
        }
      ],
      "id": 11,
      "internal_title": "",
      "language": "en",
      "maximum_number_of_subscribers": 100,
      "maximum_number_of_viewers": 95,
      "metadata_description": "",
      "metadata_image": "",
      "metadata_title": "",
      "ondemand": false,
      "registration_fields": [
        {
          "extra_field": false,
          "field_options": [],
          "input_type": "text_field",
          "label": "First name",
          "mandatory": true,
          "name": "firstname",
          "position": 1
        }
      ],
      "title": "Getting started",
      "url": "https://webinars.webinargeek.com/getting-started",
      "view_without_registration_url": ""
    }
  ]
}
```

### Register for a broadcast

Register one person for one broadcast. WebinarGeek emails them a confirmation with their link to watch, unless you turn that off. The webinar's own required form fields apply.

**Inputs**

- Broadcast (`broadcast_id`, text, required): The broadcast (one dated showing). Pick one, or give its id.
- First name (`firstname`, text, required): The person's first name.
- Email (`email`, text, required): The person's email address. Their link to watch is sent here.
- Last name (`surname`, text): The person's last name.
- Company (`company`, text): The company they work for.
- Job title (`job_title`, text): Their job title.
- Phone (`phone`, text): Their phone number, in any format.
- Country (`country`, text): Their country as a two-letter code, like NL or US.
- Time zone (`time_zone`, text): Their time zone, like Europe/Amsterdam. Times in their emails use it.
- Your own ID for them (`external_id`, text): An id from your CRM or database, to find the registration again later.
- Note (`custom_field`, text): Free text kept on the registration, such as a campaign name.
- Question for the presenter (`question_to_presenter`, text): A question to ask before the webinar. Kept only if the webinar has the 'question to presenter' registration field.
- Discount code (`webinar_discount_code`, text): For a paid webinar: an unexpired discount code made for it.
- Extra registration fields (`extra_fields`, object): Answers to the webinar's own extra form fields, each with the field's name, for example {"extra_field_123": "Acme"}.
- Consent (`consent_fields`, object): Privacy consents given, each with the consent's label and the text agreed to, for example {"Privacy policy": "I agree"}.
- Skip the confirmation email (`skip_confirmation_mail`, true/false): Turn on to register them without WebinarGeek emailing them. Left off, WebinarGeek sends its usual confirmation.
- Register for future broadcasts too (`auto_subscribe`, true/false): Also register them for broadcasts added to this webinar later.
- UTM source (`utm_source`, text): Where the sign-up came from.
- UTM medium (`utm_medium`, text): The marketing medium, like email.
- UTM campaign (`utm_campaign`, text): The campaign name.

**Outputs**

- `subscription` (object): The new registration

**Example output**

```json
{
  "subscription": {
    "assessment": {},
    "auto_subscribe": false,
    "broadcast": {
      "active_jit": false,
      "active_yesterdays_replay": false,
      "cancelled": false,
      "date": 1790848800,
      "duration": 0,
      "ended_at": 0,
      "enrichments": {},
      "has_ended": false,
      "id": 31,
      "live_viewers_count": 0,
      "public_replay_link": "https://webinars.webinargeek.com/watch/replay/abc123/",
      "replay_available": true,
      "replay_available_until": 0,
      "replay_viewers_count": 0,
      "started_at": 0,
      "subscriptions_count": 12,
      "viewers_count": 0
    },
    "browser_language": "",
    "calls_to_action": [],
    "captions_language": "",
    "city": "",
    "company": "Acme",
    "confirmation_link": "https://webinars.webinargeek.com/webinar/subscribed/abc123/",
    "consent_fields": {},
    "country": "NL",
    "created_at": 1790848800,
    "custom_field": "",
    "eligible_to_watch": false,
    "email": "jo@example.com",
    "email_verified": false,
    "email_verified_at": 0,
    "episode": {
      "estimated_duration": 3600,
      "id": 21,
      "internal_title": "",
      "subscriptions_count": 12,
      "title": "Getting started",
      "type": "live"
    },
    "evaluation_form_answers": [],
    "external_id": "crm-123",
    "extra_fields": {},
    "firstname": "Jo",
    "house_number": "",
    "id": 301,
    "job_title": "",
    "messages": [],
    "payment_to_watch_completed": false,
    "payments": [],
    "phone": "",
    "poll_votes": [],
    "postcode": "",
    "province": "",
    "questions": [],
    "quiz_answers": [],
    "registration_ip": "",
    "registration_source": "api",
    "street": "",
    "surname": "Bloggs",
    "time_zone": "Europe/Amsterdam",
    "unsubscribed": false,
    "unsubscribed_at": 0,
    "unsubscription_source": "",
    "utm_campaign": "",
    "utm_content": "",
    "utm_medium": "",
    "utm_source": "",
    "utm_term": "",
    "watch_duration": 0,
    "watch_duration_replay": 0,
    "watch_end": 0,
    "watch_end_replay": 0,
    "watch_link": "https://webinars.webinargeek.com/watch/abc123/",
    "watch_start": 0,
    "watch_start_replay": 0,
    "watched": false,
    "watched_live": false,
    "watched_replay": false,
    "watched_true_set_at": 0,
    "webinar": {
      "id": 11,
      "internal_title": "",
      "ondemand": false,
      "title": "Getting started",
      "url": "https://webinars.webinargeek.com/getting-started"
    }
  }
}
```

### Unsubscribe a registration

Cancel a registration for a broadcast: the person can no longer watch and gets no more emails. Registering them again makes a new registration.

**Inputs**

- Registration ID (`subscription_id`, text, required): The registration's id, from 'List registrations', 'Register for a broadcast' or an earlier step.

**Outputs**

- `subscription` (object): The registration, now unsubscribed

**Example output**

```json
{
  "subscription": {
    "assessment": {},
    "auto_subscribe": false,
    "broadcast": {
      "active_jit": false,
      "active_yesterdays_replay": false,
      "cancelled": false,
      "date": 1790848800,
      "duration": 0,
      "ended_at": 0,
      "enrichments": {},
      "has_ended": false,
      "id": 31,
      "live_viewers_count": 0,
      "public_replay_link": "https://webinars.webinargeek.com/watch/replay/abc123/",
      "replay_available": true,
      "replay_available_until": 0,
      "replay_viewers_count": 0,
      "started_at": 0,
      "subscriptions_count": 12,
      "viewers_count": 0
    },
    "browser_language": "",
    "calls_to_action": [],
    "captions_language": "",
    "city": "",
    "company": "Acme",
    "confirmation_link": "https://webinars.webinargeek.com/webinar/subscribed/abc123/",
    "consent_fields": {},
    "country": "NL",
    "created_at": 1790848800,
    "custom_field": "",
    "eligible_to_watch": false,
    "email": "jo@example.com",
    "email_verified": false,
    "email_verified_at": 0,
    "episode": {
      "estimated_duration": 3600,
      "id": 21,
      "internal_title": "",
      "subscriptions_count": 12,
      "title": "Getting started",
      "type": "live"
    },
    "evaluation_form_answers": [],
    "external_id": "crm-123",
    "extra_fields": {},
    "firstname": "Jo",
    "house_number": "",
    "id": 301,
    "job_title": "",
    "messages": [],
    "payment_to_watch_completed": false,
    "payments": [],
    "phone": "",
    "poll_votes": [],
    "postcode": "",
    "province": "",
    "questions": [],
    "quiz_answers": [],
    "registration_ip": "",
    "registration_source": "api",
    "street": "",
    "surname": "Bloggs",
    "time_zone": "Europe/Amsterdam",
    "unsubscribed": true,
    "unsubscribed_at": 1790900000,
    "unsubscription_source": "",
    "utm_campaign": "",
    "utm_content": "",
    "utm_medium": "",
    "utm_source": "",
    "utm_term": "",
    "watch_duration": 0,
    "watch_duration_replay": 0,
    "watch_end": 0,
    "watch_end_replay": 0,
    "watch_link": "https://webinars.webinargeek.com/watch/abc123/",
    "watch_start": 0,
    "watch_start_replay": 0,
    "watched": false,
    "watched_live": false,
    "watched_replay": false,
    "watched_true_set_at": 0,
    "webinar": {
      "id": 11,
      "internal_title": "",
      "ondemand": false,
      "title": "Getting started",
      "url": "https://webinars.webinargeek.com/getting-started"
    }
  }
}
```
