Skip to main content

Cal.com Data Source

Cal.com is an open-source scheduling platform that exposes event types, bookings, schedules, calendars, and availability through its REST API v2. Follow the instructions below to create a new data flow that ingests data from a Cal.com source in Nexla.
cal_com_api.png

Cal.com

Create a New Data Flow

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Cal.com connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Cal.com account, and click Next; or, create a new Cal.com credential for use in this flow.

  3. In Nexla, Cal.com data sources can be created using pre-built endpoint templates, which expedite source setup for common Cal.com endpoints. Each template is designed specifically for the corresponding Cal.com endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Cal.com sources can also be configured manually, allowing you to ingest data from Cal.com endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Cal.com endpoints. Each template is designed specifically for the corresponding Cal.com endpoint, making data source setup easy and efficient.

Endpoint Settings

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    List Event Types

    This endpoint returns all event types configured in your Cal.com account. Event types define the services that clients can book (for example, a 30-minute intro call or a 60-minute consultation). Use this endpoint to sync your event-type catalog into a warehouse, populate downstream selectors, or feed scheduling automations.

    • No configuration is required for this endpoint beyond selecting it. All event types accessible to the authenticated user are returned automatically.
    • The template sends the cal-api-version: 2024-06-14 header on each request, which selects the stable v2 contract for the /v2/event-types endpoint.

    Capture the id field returned for each event type — it is required as the Event Type ID input for the Get Available Slots source endpoint and for the Create a Booking destination. For complete details, see the Cal.com Get all event types reference.

    Get My Profile

    This endpoint retrieves the profile of the user that owns the API key. Use it to confirm which Cal.com account a credential is bound to, to capture timezone and locale settings, or to enrich downstream records with the booking owner's identity.

    • No configuration is required for this endpoint beyond selecting it. The authenticated user's full profile is returned as a single record.
    • The endpoint returns a single object (not an array). The path to data is set to $.data, so the profile is treated as the record.

    Cal.com uses this same endpoint as the credential test target — a successful response confirms that the API key is valid and that Cal.com can identify the authenticated user. For complete details, see the Cal.com Get my profile reference.

    List Schedules

    This endpoint returns all availability schedules configured in your Cal.com account. Schedules define recurring working hours and overrides that drive what time slots are bookable for each event type. Use this endpoint to audit availability windows, sync schedules into a workforce-management tool, or detect drift between intended and actual availability.

    • No configuration is required for this endpoint beyond selecting it. All schedules accessible to the authenticated user are returned automatically.
    • The template sends the cal-api-version: 2024-06-11 header on each request, which selects the stable v2 contract for the /v2/schedules endpoint.

    Each schedule includes its timezone, weekly availability ranges, and any date overrides — useful for building schedule-comparison reports across team members.

    List Calendars

    This endpoint returns all external calendars (Google Calendar, Office 365, Apple Calendar, and so on) connected to your Cal.com account. Use it to inventory which calendars are providing busy-time conflicts and which are receiving new bookings.

    • No configuration is required for this endpoint beyond selecting it. All connected calendars are returned automatically.
    • The path to data is set to $.data.connectedCalendars[*].calendars[*], which flattens the nested Cal.com response so that each calendar — regardless of which integration it belongs to — becomes its own Nexset record.

    Each record includes the calendar's external ID, provider, and whether it is marked as the destination for new Cal.com bookings. For complete details, see the Cal.com Get all calendars reference.

    List Bookings

    This endpoint returns all bookings in your Cal.com account. Use it to sync booking data into a warehouse for reporting, feed bookings into a CRM, or build downstream automations against meeting history.

    • No configuration is required for this endpoint beyond selecting it. All bookings accessible to the authenticated user are returned, automatically paginated by Nexla.
    • This endpoint is paginated using Cal.com's offset-style pagination. The template uses skip as the offset parameter and take as the page size, with an expected page size of 100. Nexla advances the offset and stops automatically when an empty page is returned.
    • The template sends the cal-api-version: 2026-02-25 header on each request, which selects the latest v2 contract for the /v2/bookings endpoint.

    Capture the uid field returned for each booking — it is required as the Booking UID input for the Get a Booking source endpoint and for the Cancel a Booking, Reschedule a Booking, and Confirm a Booking destinations. For complete details, see the Cal.com Get all bookings reference.

    List Conferencing Providers

    This endpoint returns all conferencing providers (Zoom, Google Meet, Microsoft Teams, and so on) connected to your Cal.com account. Use it to audit which video providers are available for bookings or to confirm that a desired provider is configured before assigning it to a new event type.

    • No configuration is required for this endpoint beyond selecting it. All connected conferencing applications are returned automatically.

    Get a Booking

    This endpoint retrieves the full record for a single booking by its UID. Use it to enrich an existing dataset of booking UIDs with the latest details, or to feed downstream systems that operate on individual meetings.

    • Enter the booking UID in the Booking UID field. This field is required. Booking UIDs can be obtained from the List Bookings endpoint or from upstream Nexla data flows.
    • The endpoint returns a single booking object (not an array). The path to data is set to $.data, so the booking is treated as the record.
    • The template sends the cal-api-version: 2026-02-25 header on each request, which selects the latest v2 contract for the /v2/bookings/{'{uid}'} endpoint.

    Pair this endpoint with List Bookings as an upstream source to fetch full booking details for every booking returned by a paginated list. For complete details, see the Cal.com Get a booking reference.

    Get Available Slots

    This endpoint returns available time slots for a specific event type within a date range and timezone. Use it to surface bookable times in a custom UI, to feed an AI scheduling assistant, or as a pre-flight check before programmatically creating a booking.

    • Enter the event type ID in the Event Type ID field. This field is required. Event type IDs can be obtained from the List Event Types endpoint.
    • Enter the start of the availability window in the Start Datetime field, in ISO 8601 format (for example, 2026-06-01T00:00:00Z). This field is required.
    • Enter the end of the availability window in the End Datetime field, in ISO 8601 format (for example, 2026-06-08T00:00:00Z). This field is required.
    • Enter the IANA timezone identifier in which slots should be evaluated in the Time Zone field (for example, America/New_York or Europe/London). This field is required.
    • The template sends the cal-api-version: 2024-09-04 header on each request, which selects the stable v2 contract for the /v2/slots endpoint.

    Keep the date window narrow — Cal.com computes slot availability against all attached schedules and connected calendars, and a wider window means a slower response. For complete details, see the Cal.com Get available slots reference.

    List Webhooks

    This endpoint returns all webhook subscriptions registered for the authenticated user. Use it to audit which downstream listeners are subscribed to your Cal.com scheduling events, or to detect orphaned subscriptions left over from prior integrations.

    • No configuration is required for this endpoint beyond selecting it. All webhooks owned by the authenticated user are returned automatically.

    Pair this endpoint with the Create a Webhook destination to programmatically reconcile your set of webhook subscriptions against an upstream system of record. For complete details, see the Cal.com Get all webhooks reference.

    List Out-of-Office Entries

    This endpoint returns all out-of-office entries for the authenticated user. Out-of-office entries block availability for date ranges and optionally redirect bookings to another teammate. Use this endpoint to audit upcoming OOO coverage, sync OOO into a workforce-management tool, or build reports on team availability.

    • No configuration is required for this endpoint beyond selecting it. All out-of-office entries owned by the authenticated user are returned automatically.

Endpoint Testing

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually

Cal.com data sources can be manually configured to ingest data from any valid Cal.com API v2 endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates — for example, team-specific endpoints, organization-scoped endpoints, or any endpoint that requires a custom cal-api-version header.

With manual configuration, you can also create more complex Cal.com sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom request parameters.

API Method

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Cal.com API from the Method pulldown menu. For Cal.com data sources, the most common method is:

    • GET: For retrieving data from Cal.com endpoints such as event types, bookings, schedules, and slots

API Endpoint URL

  1. Enter the URL of the Cal.com API endpoint from which this source will fetch data in the Set API URL field. All Cal.com v2 API URLs use the base https://api.cal.com/v2/ followed by the resource path (for example, https://api.cal.com/v2/event-types or https://api.cal.com/v2/bookings).

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL.

Date/Time Macros (API URL)

Optional

The API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that adapt to different time periods between ingestion runs.

Macros are particularly useful for Cal.com endpoints that accept date-range query parameters, such as /v2/slots (which requires a start and end window) or /v2/bookings (which can be filtered by afterStart or beforeEnd).

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime

    • {now-1} – The datetime one time unit before the current datetime

    • {now+1} – The datetime one time unit after the current datetime

    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now+7) to indicate the datetime seven time units after the current datetime, useful for fetching the next week of Cal.com slots

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. Cal.com endpoints generally expect ISO 8601 timestamps, so select the matching format. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now+7} with Day selected, Nexla converts {now+7} to the datetime seven days after the current datetime.

Lookup-Based Macros (API URL)

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that adapt based on existing data.

Lookup-based macros are useful when chaining Cal.com endpoints — for example, using event-type IDs from a List Event Types source to drive a /v2/slots source, or using booking UIDs from a List Bookings source to drive a /v2/bookings/{'{uid}'} source.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data

Optional

If only a subset of the data returned by the Cal.com API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful because Cal.com v2 wraps all payloads in a top-level envelope that includes a status field alongside the actual data payload.

For example, when calling /v2/bookings, Cal.com returns an object like { "status": "success", "data": [ ... ] }. By entering the path to the relevant data, you can configure Nexla to treat each element of the returned array as a record.

Path to Data is essential when API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (for example, $.data[*] to access an array of items within the Cal.com response envelope).
    Path to Data Examples for Cal.com:

    For list endpoints that return an array (such as /v2/bookings, /v2/event-types, /v2/schedules), use $.data[*].

    For single-object endpoints (such as /v2/me, /v2/bookings/{'{uid}'}), use $.data.

    For /v2/calendars, which returns a doubly nested array of connected calendars, use $.data.connectedCalendars[*].calendars[*].

Autogenerate Path Suggestions

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve important contextual information that applies to all records but isn't part of the main data array.

For example, Cal.com v2 list responses include a top-level status field (and sometimes pagination metadata) alongside the data array. If you have set the path to data to $.data[*], you can also capture the envelope-level fields by configuring a metadata path.

Metadata paths are particularly useful for preserving response context such as the Cal.com status field or any pagination indicators that apply to all records in the response.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata.

Request Headers

Optional
  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (for example, header1:value1,header2:value2).

    Cal.com v2 endpoints version their contracts using the cal-api-version header. To pin a request to a specific contract version, add a header such as cal-api-version:2026-02-25. Each Cal.com endpoint documents its current version in the Cal.com API v2 reference.

    You do not need to include the Authorization header — Nexla adds the Authorization: Bearer ${'{API_KEY}'} header automatically based on your Cal.com credential.

Endpoint Testing

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Cal.com data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.