Get organization team workflows

curl --request GET \
  --url https://api.cal.com/v2/organizations/{orgId}/teams/{teamId}/workflows

{
  "status": "success",
  "data": [
    {
      "id": 101,
      "name": "Platform Test Workflow",
      "type": "event-type",
      "activation": {
        "isActiveOnAllEventTypes": false,
        "activeOnEventTypeIds": [
          698191,
          698192
        ]
      },
      "trigger": {
        "type": "beforeEvent",
        "offset": {
          "value": 24,
          "unit": "hour"
        }
      },
      "steps": [
        {
          "id": 67244,
          "stepNumber": 1,
          "recipient": "const",
          "template": "reminder",
          "sender": "Cal.com Notifications",
          "message": {
            "subject": "Reminder: Your Meeting {EVENT_NAME} - {EVENT_DATE_ddd, MMM D, YYYY h:mma} with Cal.com",
            "html": "<p>Reminder for {EVENT_NAME}.</p>",
            "text": "Reminder for {EVENT_NAME}."
          },
          "action": "email_host",
          "email": 31214,
          "phone": "<string>",
          "phoneRequired": true,
          "includeCalendarEvent": true
        }
      ],
      "userId": 2313,
      "teamId": 4214321,
      "createdAt": "2024-05-12T10:00:00.000Z",
      "updatedAt": "2024-05-12T11:30:00.000Z"
    }
  ]
}

GET

organizations

{orgId}

teams

{teamId}

workflows

Get organization team workflows

curl --request GET \
  --url https://api.cal.com/v2/organizations/{orgId}/teams/{teamId}/workflows

{
  "status": "success",
  "data": [
    {
      "id": 101,
      "name": "Platform Test Workflow",
      "type": "event-type",
      "activation": {
        "isActiveOnAllEventTypes": false,
        "activeOnEventTypeIds": [
          698191,
          698192
        ]
      },
      "trigger": {
        "type": "beforeEvent",
        "offset": {
          "value": 24,
          "unit": "hour"
        }
      },
      "steps": [
        {
          "id": 67244,
          "stepNumber": 1,
          "recipient": "const",
          "template": "reminder",
          "sender": "Cal.com Notifications",
          "message": {
            "subject": "Reminder: Your Meeting {EVENT_NAME} - {EVENT_DATE_ddd, MMM D, YYYY h:mma} with Cal.com",
            "html": "<p>Reminder for {EVENT_NAME}.</p>",
            "text": "Reminder for {EVENT_NAME}."
          },
          "action": "email_host",
          "email": 31214,
          "phone": "<string>",
          "phoneRequired": true,
          "includeCalendarEvent": true
        }
      ],
      "userId": 2313,
      "teamId": 4214321,
      "createdAt": "2024-05-12T10:00:00.000Z",
      "updatedAt": "2024-05-12T11:30:00.000Z"
    }
  ]
}

Headers

Authorization

string

For non-platform customers - value must be Bearer <token> where <token> is api key prefixed with cal_

x-cal-secret-key

string

For platform customers - OAuth client secret key

x-cal-client-id

string

For platform customers - OAuth client ID

Path Parameters

orgId

number

required

teamId

number

required

Query Parameters

take

number

default:250

Maximum number of items to return

Required range: 1 <= x <= 250

skip

number

default:0

Number of items to skip

Required range: x >= 0

Response

200 - application/json

status

enum<string>

required

Indicates the status of the response

Available options:

success,

error

Example:

"success"

data

object[]

required

List of workflows

Show child attributes

data.id

number

required

Unique identifier of the workflow

Example:

101

data.name

string

required

Name of the workflow

Example:

"Platform Test Workflow"

data.type

enum<string>

default:event-type

required

type of the workflow

Available options:

event-type

Example:

"event-type"

data.activation

object

required

Activation settings for the workflow

Show child attributes

data.activation.isActiveOnAllEventTypes

boolean

default:false

Whether the workflow is active for all event types associated with the team/user

Example:

false

data.activation.activeOnEventTypeIds

number[]

List of Event Type IDs the workflow is specifically active on (if not active on all)

Example:

[698191, 698192]

data.trigger

object

required

Trigger configuration

Show child attributes

data.trigger.type

enum<string>

required

Trigger type for the workflow

Available options:

beforeEvent,

eventCancelled,

newEvent,

afterEvent,

rescheduleEvent,

afterHostsCalVideoNoShow,

afterGuestsCalVideoNoShow,

bookingRejected,

bookingRequested,

bookingPaymentInitiated,

bookingPaid,

bookingNoShowUpdated

Example:

"beforeEvent"

data.trigger.offset

object

Offset details (present for BEFORE_EVENT/AFTER_EVENT)

Show child attributes

data.trigger.offset.value

number

required

Time value for offset

Example:

24

data.trigger.offset.unit

enum<string>

required

Unit for the offset time

Available options:

hour,

minute,

day

Example:

"hour"

data.steps

object[]

required

Steps comprising the workflow

Show child attributes

data.steps.id

number

required

Unique identifier of the step

Example:

67244

data.steps.stepNumber

number

required

Step number in the workflow sequence

Example:

1

data.steps.recipient

enum<string>

required

Intended recipient type

Available options:

const,

attendee,

email,

phone_number

Example:

"const"

data.steps.template

enum<string>

required

Template type used

Available options:

reminder,

custom,

rescheduled,

completed,

rating,

cancelled

Example:

"reminder"

data.steps.sender

string

required

Displayed sender name used for this step

Example:

"Cal.com Notifications"

data.steps.message

object

required

Message content for this step

Show child attributes

data.steps.message.subject

string

required

Subject of the message

Example:

"Reminder: Your Meeting {EVENT_NAME} - {EVENT_DATE_ddd, MMM D, YYYY h:mma} with Cal.com"

data.steps.message.html

string

HTML content of the message

Example:

"<p>Reminder for {EVENT_NAME}.</p>"

data.steps.message.text

string

Text content of the message (used for SMS/WhatsApp)

Example:

"Reminder for {EVENT_NAME}."

data.steps.action

enum<string>

required

Action to perform

Available options:

email_host,

email_attendee,

email_address,

sms_attendee,

sms_number,

whatsapp_attendee,

whatsapp_number,

cal_ai_phone_call

Example:

"email_host"

data.steps.email

string

Verified Email if action is EMAIL_ADDRESS

Example:

31214

data.steps.phone

string

Verified Phone if action is SMS_NUMBER or WHATSAPP_NUMBER

data.steps.phoneRequired

boolean

default:false

whether or not the attendees are required to provide their phone numbers when booking

Example:

true

data.steps.includeCalendarEvent

object

Whether a calendar event (.ics) was included (for email actions)

Example:

true

data.userId

number

ID of the user who owns the workflow (if not team-owned)

Example:

2313

data.teamId

number

ID of the team owning the workflow

Example:

4214321

data.createdAt

object

Timestamp of creation

Example:

"2024-05-12T10:00:00.000Z"

data.updatedAt

object

Timestamp of last update

Example:

"2024-05-12T11:30:00.000Z"

Get schedules of a team member Create organization team workflow for event-types

⌘I

Getting Started

Platform / Managed Users

Platform / Webhooks

Orgs / Attributes

Orgs / Attributes / Options

Orgs / Bookings

Orgs / Delegation Credentials

Orgs / Memberships

Orgs / Roles

Orgs / Roles / Permissions

Orgs / Routing forms

Orgs / Schedules

Orgs / Teams

Orgs / Teams / Bookings

Orgs / Teams / Conferencing

Orgs / Teams / Event Types

Orgs / Teams / Event Types / Private Links

Orgs / Teams / Invite

Orgs / Teams / Memberships

Orgs / Teams / Roles

Orgs / Teams / Roles / Permissions

Orgs / Teams / Routing forms

Orgs / Teams / Routing forms / Responses

Orgs / Teams / Schedules

Orgs / Teams / Stripe

Orgs / Teams / Users / Schedules

Orgs / Teams / Workflows

Orgs / Users

Orgs / Users / Bookings

Orgs / Users / OOO

Orgs / Users / Schedules

Orgs / Webhooks

Api Keys

Bookings

Bookings / Guests

Cal Unified Calendars

Calendars

Conferencing

Destination Calendars

Event Types

Event Types / Webhooks

Event Types Private Links

Managed Orgs

Me

OAuth Clients

Organization Team Verified Resources

Routing forms

Schedules

Selected Calendars

Slots

Stripe

Teams

Teams / Event Types

Teams / Memberships

Teams / Schedules

Teams Verified Resources

Verified Resources

Webhooks

Headers

Path Parameters

Query Parameters

Response