List Event Invitees | Calendly | Developer Documentation

import { CalendlyClient } from "calendly";
async function main() {
    const client = new CalendlyClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.scheduledEvents.listEventInvitees({
        uuid: "AAAAAAAAAAAAAAAA",
    });
}
main();

{
  "collection": [
    {
      "uri": "https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/AAAAAAAAAAAAAAAA",
      "email": "test@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "name": "John Doe",
      "status": "active",
      "questions_and_answers": [
        {
          "question": "Question with Radio Buttons answer type",
          "answer": "radio button answer",
          "position": 0
        },
        {
          "question": "Question with Multiple Lines answer type",
          "answer": "Multiple line\nAnswer",
          "position": 1
        },
        {
          "question": "Question with Checkboxes answer type",
          "answer": "Answer 1\nAnswer 2\nAnswer 3",
          "position": 2
        }
      ],
      "timezone": "America/New_York",
      "event": "https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA",
      "created_at": "2020-11-23T17:51:18.327602Z",
      "updated_at": "2020-11-23T17:51:18.341657Z",
      "tracking": {
        "utm_campaign": null,
        "utm_source": null,
        "utm_medium": null,
        "utm_content": null,
        "utm_term": null,
        "salesforce_uuid": null
      },
      "text_reminder_number": null,
      "rescheduled": false,
      "old_invitee": null,
      "new_invitee": null,
      "cancel_url": "https://calendly.com/cancellations/AAAAAAAAAAAAAAAA",
      "reschedule_url": "https://calendly.com/reschedulings/AAAAAAAAAAAAAAAA",
      "routing_form_submission": "https://api.calendly.com/routing_form_submissions/AAAAAAAAAAAAAAAA",
      "payment": {
        "external_id": "ch_AAAAAAAAAAAAAAAA",
        "provider": "stripe",
        "amount": 1234.56,
        "currency": "USD",
        "terms": "sample terms of payment (up to 1,024 characters)",
        "successful": true
      },
      "no_show": null,
      "reconfirmation": {
        "created_at": "2020-11-23T17:51:18.341657Z",
        "confirmed_at": "2020-11-23T20:01:18.341657Z"
      },
      "scheduling_method": null,
      "invitee_scheduled_by": null
    }
  ],
  "pagination": {
    "count": 20,
    "next_page": "https://calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees?count=1&page_token=sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi",
    "previous_page": "https://calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees?count=1&page_token=VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H",
    "next_page_token": "sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi",
    "previous_page_token": "VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H"
  }
}

Returns a list of Invitees for an event.

Required scopes

scheduled_events:read

Returns a list of Invitees for an event. <Info title="Required scopes"> > `scheduled_events:read` </Info>

Authentication

AuthorizationBearer

OAuth 2.0

AuthorizationBearer

Personal Access Token

Path parameters

uuidstringRequired

Query parameters

statusenumOptional

Indicates if the invitee "canceled" or still "active"

Allowed values:

sortstringOptionalDefaults to created_at:asc

Order results by the created_at field and direction specified: ascending (“asc”) or descending (“desc”)

emailstringOptionalformat: "email"

Indicates if the results should be filtered by email address

page_tokenstringOptional

The token to pass to get the next or previous portion of the collection

countintegerOptional1-100Defaults to 20

The number of rows to return

Response

collectionlist of objects

The set of event invitees matching the criteria

paginationobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error