Skip to content

Scheduling infrastructure for absolutely everyone.

revert: "fix: Broken API docs (#20664)" (#20667)

Keith Williams007349a180d3
diff --git a/docs/api-reference/v2/openapi.json b/docs/api-reference/v2/openapi.json
index 9973d103c98..492334a1a30 100644
--- a/docs/api-reference/v2/openapi.json
+++ b/docs/api-reference/v2/openapi.json
@@ -2197,6 +2197,340 @@
"tags": ["Orgs / Orgs"]
}
},
+ "/v2/organizations/{orgId}/routing-forms": {
+ "get": {
+ "operationId": "OrganizationsRoutingFormsController_getOrganizationRoutingForms",
+ "summary": "Get organization routing forms",
+ "parameters": [
+ {
+ "name": "Authorization",
+ "in": "header",
+ "description": "value must be `Bearer <token>` where `<token>` is api key prefixed with cal_",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "orgId",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "number"
+ }
+ },
+ {
+ "name": "skip",
+ "required": false,
+ "in": "query",
+ "description": "Number of responses to skip",
+ "schema": {
+ "type": "number"
+ }
+ },
+ {
+ "name": "take",
+ "required": false,
+ "in": "query",
+ "description": "Number of responses to take",
+ "schema": {
+ "type": "number"
+ }
+ },
+ {
+ "name": "sortCreatedAt",
+ "required": false,
+ "in": "query",
+ "description": "Sort by creation time",
+ "schema": {
+ "enum": ["asc", "desc"],
+ "type": "string"
+ }
+ },
+ {
+ "name": "sortUpdatedAt",
+ "required": false,
+ "in": "query",
+ "description": "Sort by update time",
+ "schema": {
+ "enum": ["asc", "desc"],
+ "type": "string"
+ }
+ },
+ {
+ "name": "afterCreatedAt",
+ "required": false,
+ "in": "query",
+ "description": "Filter by responses created after this date",
+ "schema": {
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ {
+ "name": "beforeCreatedAt",
+ "required": false,
+ "in": "query",
+ "description": "Filter by responses created before this date",
+ "schema": {
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ {
+ "name": "afterUpdatedAt",
+ "required": false,
+ "in": "query",
+ "description": "Filter by responses created after this date",
+ "schema": {
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ {
+ "name": "beforeUpdatedAt",
+ "required": false,
+ "in": "query",
+ "description": "Filter by responses updated before this date",
+ "schema": {
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ {
+ "name": "routedToBookingUid",
+ "required": false,
+ "in": "query",
+ "description": "Filter by responses routed to a specific booking",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "teamIds",
+ "required": false,
+ "in": "query",
+ "description": "Filter by teamIds",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetRoutingFormsOutput"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Orgs / Routing forms"]
+ }
+ },
+ "/v2/organizations/{orgId}/routing-forms/{routingFormId}/responses": {
+ "get": {
+ "operationId": "OrganizationsRoutingFormsResponsesController_getRoutingFormResponses",
+ "summary": "Get routing form responses",
+ "parameters": [
+ {
+ "name": "Authorization",
+ "in": "header",
+ "description": "value must be `Bearer <token>` where `<token>` is api key prefixed with cal_",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "orgId",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "number"
+ }
+ },
+ {
+ "name": "routingFormId",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "skip",
+ "required": false,
+ "in": "query",
+ "description": "Number of responses to skip",
+ "schema": {
+ "type": "number"
+ }
+ },
+ {
+ "name": "take",
+ "required": false,
+ "in": "query",
+ "description": "Number of responses to take",
+ "schema": {
+ "type": "number"
+ }
+ },
+ {
+ "name": "sortCreatedAt",
+ "required": false,
+ "in": "query",
+ "description": "Sort by creation time",
+ "schema": {
+ "enum": ["asc", "desc"],
+ "type": "string"
+ }
+ },
+ {
+ "name": "sortUpdatedAt",
+ "required": false,
+ "in": "query",
+ "description": "Sort by update time",
+ "schema": {
+ "enum": ["asc", "desc"],
+ "type": "string"
+ }
+ },
+ {
+ "name": "afterCreatedAt",
+ "required": false,
+ "in": "query",
+ "description": "Filter by responses created after this date",
+ "schema": {
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ {
+ "name": "beforeCreatedAt",
+ "required": false,
+ "in": "query",
+ "description": "Filter by responses created before this date",
+ "schema": {
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ {
+ "name": "afterUpdatedAt",
+ "required": false,
+ "in": "query",
+ "description": "Filter by responses created after this date",
+ "schema": {
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ {
+ "name": "beforeUpdatedAt",
+ "required": false,
+ "in": "query",
+ "description": "Filter by responses updated before this date",
+ "schema": {
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ {
+ "name": "routedToBookingUid",
+ "required": false,
+ "in": "query",
+ "description": "Filter by responses routed to a specific booking",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetRoutingFormResponsesOutput"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Orgs / Routing forms"]
+ }
+ },
+ "/v2/organizations/{orgId}/routing-forms/{routingFormId}/responses/{responseId}": {
+ "patch": {
+ "operationId": "OrganizationsRoutingFormsResponsesController_updateRoutingFormResponse",
+ "summary": "Update routing form response",
+ "parameters": [
+ {
+ "name": "Authorization",
+ "in": "header",
+ "description": "value must be `Bearer <token>` where `<token>` is api key prefixed with cal_",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "orgId",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "number"
+ }
+ },
+ {
+ "name": "routingFormId",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "responseId",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "number"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateRoutingFormResponseInput"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateRoutingFormResponseOutput"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Orgs / Routing forms"]
+ }
+ },
"/v2/organizations/{orgId}/schedules": {
"get": {
"operationId": "OrganizationsSchedulesController_getOrganizationSchedules",
@@ -3061,22 +3395,232 @@
}
],
"responses": {
- "200": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetTeamEventTypeOutput"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Orgs / Teams / Event Types"]
+ },
+ "patch": {
+ "operationId": "OrganizationsEventTypesController_updateTeamEventType",
+ "summary": "Update a team event type",
+ "parameters": [
+ {
+ "name": "Authorization",
+ "in": "header",
+ "description": "For non-platform customers - value must be `Bearer <token>` where `<token>` is api key prefixed with cal_",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "x-cal-secret-key",
+ "in": "header",
+ "description": "For platform customers - OAuth client secret key",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "x-cal-client-id",
+ "in": "header",
+ "description": "For platform customers - OAuth client ID",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "teamId",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "number"
+ }
+ },
+ {
+ "name": "eventTypeId",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "number"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateTeamEventTypeInput_2024_06_14"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateTeamEventTypeOutput"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Orgs / Teams / Event Types"]
+ },
+ "delete": {
+ "operationId": "OrganizationsEventTypesController_deleteTeamEventType",
+ "summary": "Delete a team event type",
+ "parameters": [
+ {
+ "name": "Authorization",
+ "in": "header",
+ "description": "For non-platform customers - value must be `Bearer <token>` where `<token>` is api key prefixed with cal_",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "x-cal-secret-key",
+ "in": "header",
+ "description": "For platform customers - OAuth client secret key",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "x-cal-client-id",
+ "in": "header",
+ "description": "For platform customers - OAuth client ID",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "teamId",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "number"
+ }
+ },
+ {
+ "name": "eventTypeId",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "number"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DeleteTeamEventTypeOutput"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Orgs / Teams / Event Types"]
+ }
+ },
+ "/v2/organizations/{orgId}/teams/{teamId}/event-types/{eventTypeId}/create-phone-call": {
+ "post": {
+ "operationId": "OrganizationsEventTypesController_createPhoneCall",
+ "summary": "Create a phone call",
+ "parameters": [
+ {
+ "name": "Authorization",
+ "in": "header",
+ "description": "For non-platform customers - value must be `Bearer <token>` where `<token>` is api key prefixed with cal_",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "x-cal-secret-key",
+ "in": "header",
+ "description": "For platform customers - OAuth client secret key",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "x-cal-client-id",
+ "in": "header",
+ "description": "For platform customers - OAuth client ID",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "eventTypeId",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "number"
+ }
+ },
+ {
+ "name": "orgId",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "number"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreatePhoneCallInput"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
"description": "",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/GetTeamEventTypeOutput"
+ "$ref": "#/components/schemas/CreatePhoneCallOutput"
}
}
}
}
},
"tags": ["Orgs / Teams / Event Types"]
- },
- "patch": {
- "operationId": "OrganizationsEventTypesController_updateTeamEventType",
- "summary": "Update a team event type",
+ }
+ },
+ "/v2/organizations/{orgId}/teams/event-types": {
+ "get": {
+ "operationId": "OrganizationsEventTypesController_getTeamsEventTypes",
+ "summary": "Get all team event types",
"parameters": [
{
"name": "Authorization",
@@ -3106,7 +3650,7 @@
}
},
{
- "name": "teamId",
+ "name": "orgId",
"required": true,
"in": "path",
"schema": {
@@ -3114,41 +3658,45 @@
}
},
{
- "name": "eventTypeId",
- "required": true,
- "in": "path",
+ "name": "take",
+ "required": false,
+ "in": "query",
+ "description": "The number of items to return",
+ "example": 10,
"schema": {
"type": "number"
}
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/UpdateTeamEventTypeInput_2024_06_14"
- }
+ },
+ {
+ "name": "skip",
+ "required": false,
+ "in": "query",
+ "description": "The number of items to skip",
+ "example": 0,
+ "schema": {
+ "type": "number"
}
}
- },
+ ],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/UpdateTeamEventTypeOutput"
+ "$ref": "#/components/schemas/GetTeamEventTypesOutput"
}
}
}
}
},
"tags": ["Orgs / Teams / Event Types"]
- },
- "delete": {
- "operationId": "OrganizationsEventTypesController_deleteTeamEventType",
- "summary": "Delete a team event type",
+ }
+ },
+ "/v2/organizations/{orgId}/teams/{teamId}/memberships": {
+ "get": {
+ "operationId": "OrganizationsTeamsMembershipsController_getAllOrgTeamMemberships",
+ "summary": "Get all memberships",
"parameters": [
{
"name": "Authorization",
@@ -3178,7 +3726,7 @@
}
},
{
- "name": "teamId",
+ "name": "orgId",
"required": true,
"in": "path",
"schema": {
@@ -3186,12 +3734,32 @@
}
},
{
- "name": "eventTypeId",
+ "name": "teamId",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
+ },
+ {
+ "name": "take",
+ "required": false,
+ "in": "query",
+ "description": "The number of items to return",
+ "example": 10,
+ "schema": {
+ "type": "number"
+ }
+ },
+ {
+ "name": "skip",
+ "required": false,
+ "in": "query",
+ "description": "The number of items to skip",
+ "example": 0,
+ "schema": {
+ "type": "number"
+ }
}
],
"responses": {
@@ -3200,19 +3768,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/DeleteTeamEventTypeOutput"
+ "$ref": "#/components/schemas/OrgTeamMembershipsOutputResponseDto"
}
}
}
}
},
- "tags": ["Orgs / Teams / Event Types"]
- }
- },
- "/v2/organizations/{orgId}/teams/{teamId}/event-types/{eventTypeId}/create-phone-call": {
+ "tags": ["Orgs / Teams / Memberships"]
+ },
"post": {
- "operationId": "OrganizationsEventTypesController_createPhoneCall",
- "summary": "Create a phone call",
+ "operationId": "OrganizationsTeamsMembershipsController_createOrgTeamMembership",
+ "summary": "Create a membership",
"parameters": [
{
"name": "Authorization",
@@ -3242,7 +3808,7 @@
}
},
{
- "name": "eventTypeId",
+ "name": "orgId",
"required": true,
"in": "path",
"schema": {
@@ -3250,7 +3816,7 @@
}
},
{
- "name": "orgId",
+ "name": "teamId",
"required": true,
"in": "path",
"schema": {
@@ -3263,7 +3829,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/CreatePhoneCallInput"
+ "$ref": "#/components/schemas/CreateOrgTeamMembershipDto"
}
}
}
@@ -3274,19 +3840,19 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/CreatePhoneCallOutput"
+ "$ref": "#/components/schemas/OrgTeamMembershipOutputResponseDto"
}
}
}
}
},
- "tags": ["Orgs / Teams / Event Types"]
+ "tags": ["Orgs / Teams / Memberships"]
}
},
- "/v2/organizations/{orgId}/teams/event-types": {
+ "/v2/organizations/{orgId}/teams/{teamId}/memberships/{membershipId}": {
"get": {
- "operationId": "OrganizationsEventTypesController_getTeamsEventTypes",
- "summary": "Get all team event types",
+ "operationId": "OrganizationsTeamsMembershipsController_getOrgTeamMembership",
+ "summary": "Get a membership",
"parameters": [
{
"name": "Authorization",
@@ -3324,21 +3890,17 @@
}
},
{
- "name": "take",
- "required": false,
- "in": "query",
- "description": "The number of items to return",
- "example": 10,
+ "name": "teamId",
+ "required": true,
+ "in": "path",
"schema": {
"type": "number"
}
},
{
- "name": "skip",
- "required": false,
- "in": "query",
- "description": "The number of items to skip",
- "example": 0,
+ "name": "membershipId",
+ "required": true,
+ "in": "path",
"schema": {
"type": "number"
}
@@ -3350,19 +3912,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/GetTeamEventTypesOutput"
+ "$ref": "#/components/schemas/OrgTeamMembershipOutputResponseDto"
}
}
}
}
},
- "tags": ["Orgs / Teams / Event Types"]
- }
- },
- "/v2/organizations/{orgId}/teams/{teamId}/memberships": {
- "get": {
- "operationId": "OrganizationsTeamsMembershipsController_getAllOrgTeamMemberships",
- "summary": "Get all memberships",
+ "tags": ["Orgs / Teams / Memberships"]
+ },
+ "delete": {
+ "operationId": "OrganizationsTeamsMembershipsController_deleteOrgTeamMembership",
+ "summary": "Delete a membership",
"parameters": [
{
"name": "Authorization",
@@ -3408,21 +3968,9 @@
}
},
{
- "name": "take",
- "required": false,
- "in": "query",
- "description": "The number of items to return",
- "example": 10,
- "schema": {
- "type": "number"
- }
- },
- {
- "name": "skip",
- "required": false,
- "in": "query",
- "description": "The number of items to skip",
- "example": 0,
+ "name": "membershipId",
+ "required": true,
+ "in": "path",
"schema": {
"type": "number"
}
@@ -3434,7 +3982,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/OrgTeamMembershipsOutputResponseDto"
+ "$ref": "#/components/schemas/OrgTeamMembershipOutputResponseDto"
}
}
}
@@ -3442,9 +3990,9 @@
},
"tags": ["Orgs / Teams / Memberships"]
},
- "post": {
- "operationId": "OrganizationsTeamsMembershipsController_createOrgTeamMembership",
- "summary": "Create a membership",
+ "patch": {
+ "operationId": "OrganizationsTeamsMembershipsController_updateOrgTeamMembership",
+ "summary": "Update a membership",
"parameters": [
{
"name": "Authorization",
@@ -3488,6 +4036,14 @@
"schema": {
"type": "number"
}
+ },
+ {
+ "name": "membershipId",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "number"
+ }
}
],
"requestBody": {
@@ -3495,13 +4051,13 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/CreateOrgTeamMembershipDto"
+ "$ref": "#/components/schemas/UpdateOrgTeamMembershipDto"
}
}
}
},
"responses": {
- "201": {
+ "200": {
"description": "",
"content": {
"application/json": {
@@ -3515,60 +4071,121 @@
"tags": ["Orgs / Teams / Memberships"]
}
},
- "/v2/organizations/{orgId}/teams/{teamId}/memberships/{membershipId}": {
+ "/v2/organizations/{orgId}/teams/{teamId}/routing-forms": {
"get": {
- "operationId": "OrganizationsTeamsMembershipsController_getOrgTeamMembership",
- "summary": "Get a membership",
+ "operationId": "OrganizationsTeamsRoutingFormsController_getTeamRoutingForms",
+ "summary": "Get team routing forms",
"parameters": [
{
"name": "Authorization",
"in": "header",
- "description": "For non-platform customers - value must be `Bearer <token>` where `<token>` is api key prefixed with cal_",
+ "description": "value must be `Bearer <token>` where `<token>` is api key prefixed with cal_",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "orgId",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "number"
+ }
+ },
+ {
+ "name": "teamId",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "number"
+ }
+ },
+ {
+ "name": "skip",
+ "required": false,
+ "in": "query",
+ "description": "Number of responses to skip",
+ "schema": {
+ "type": "number"
+ }
+ },
+ {
+ "name": "take",
+ "required": false,
+ "in": "query",
+ "description": "Number of responses to take",
+ "schema": {
+ "type": "number"
+ }
+ },
+ {
+ "name": "sortCreatedAt",
"required": false,
+ "in": "query",
+ "description": "Sort by creation time",
"schema": {
+ "enum": ["asc", "desc"],
"type": "string"
}
},
{
- "name": "x-cal-secret-key",
- "in": "header",
- "description": "For platform customers - OAuth client secret key",
+ "name": "sortUpdatedAt",
"required": false,
+ "in": "query",
+ "description": "Sort by update time",
"schema": {
+ "enum": ["asc", "desc"],
"type": "string"
}
},
{
- "name": "x-cal-client-id",
- "in": "header",
- "description": "For platform customers - OAuth client ID",
+ "name": "afterCreatedAt",
"required": false,
+ "in": "query",
+ "description": "Filter by responses created after this date",
"schema": {
+ "format": "date-time",
"type": "string"
}
},
{
- "name": "orgId",
- "required": true,
- "in": "path",
+ "name": "beforeCreatedAt",
+ "required": false,
+ "in": "query",
+ "description": "Filter by responses created before this date",
+ "schema": {
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ {
+ "name": "afterUpdatedAt",
+ "required": false,
+ "in": "query",
+ "description": "Filter by responses created after this date",
"schema": {
- "type": "number"
+ "format": "date-time",
+ "type": "string"
}
},
{
- "name": "teamId",
- "required": true,
- "in": "path",
+ "name": "beforeUpdatedAt",
+ "required": false,
+ "in": "query",
+ "description": "Filter by responses updated before this date",
"schema": {
- "type": "number"
+ "format": "date-time",
+ "type": "string"
}
},
{
- "name": "membershipId",
- "required": true,
- "in": "path",
+ "name": "routedToBookingUid",
+ "required": false,
+ "in": "query",
+ "description": "Filter by responses routed to a specific booking",
"schema": {
- "type": "number"
+ "type": "string"
}
}
],
@@ -3578,41 +4195,33 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/OrgTeamMembershipOutputResponseDto"
+ "$ref": "#/components/schemas/GetRoutingFormsOutput"
}
}
}
}
},
- "tags": ["Orgs / Teams / Memberships"]
- },
- "delete": {
- "operationId": "OrganizationsTeamsMembershipsController_deleteOrgTeamMembership",
- "summary": "Delete a membership",
+ "tags": ["Orgs / Teams / Routing forms"]
+ }
+ },
+ "/v2/organizations/{orgId}/teams/{teamId}/routing-forms/{routingFormId}/responses": {
+ "get": {
+ "operationId": "OrganizationsTeamsRoutingFormsResponsesController_getRoutingFormResponses",
+ "summary": "Get organization team routing form responses",
"parameters": [
{
"name": "Authorization",
"in": "header",
- "description": "For non-platform customers - value must be `Bearer <token>` where `<token>` is api key prefixed with cal_",
- "required": false,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "x-cal-secret-key",
- "in": "header",
- "description": "For platform customers - OAuth client secret key",
- "required": false,
+ "description": "value must be `Bearer <token>` where `<token>` is api key prefixed with cal_",
+ "required": true,
"schema": {
"type": "string"
}
},
{
- "name": "x-cal-client-id",
- "in": "header",
- "description": "For platform customers - OAuth client ID",
- "required": false,
+ "name": "routingFormId",
+ "required": true,
+ "in": "path",
"schema": {
"type": "string"
}
@@ -3634,113 +4243,112 @@
}
},
{
- "name": "membershipId",
- "required": true,
- "in": "path",
+ "name": "skip",
+ "required": false,
+ "in": "query",
+ "description": "Number of responses to skip",
"schema": {
"type": "number"
}
- }
- ],
- "responses": {
- "200": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/OrgTeamMembershipOutputResponseDto"
- }
- }
+ },
+ {
+ "name": "take",
+ "required": false,
+ "in": "query",
+ "description": "Number of responses to take",
+ "schema": {
+ "type": "number"
}
- }
- },
- "tags": ["Orgs / Teams / Memberships"]
- },
- "patch": {
- "operationId": "OrganizationsTeamsMembershipsController_updateOrgTeamMembership",
- "summary": "Update a membership",
- "parameters": [
+ },
{
- "name": "Authorization",
- "in": "header",
- "description": "For non-platform customers - value must be `Bearer <token>` where `<token>` is api key prefixed with cal_",
+ "name": "sortCreatedAt",
"required": false,
+ "in": "query",
+ "description": "Sort by creation time",
"schema": {
+ "enum": ["asc", "desc"],
"type": "string"
}
},
{
- "name": "x-cal-secret-key",
- "in": "header",
- "description": "For platform customers - OAuth client secret key",
+ "name": "sortUpdatedAt",
"required": false,
+ "in": "query",
+ "description": "Sort by update time",
"schema": {
+ "enum": ["asc", "desc"],
"type": "string"
}
},
{
- "name": "x-cal-client-id",
- "in": "header",
- "description": "For platform customers - OAuth client ID",
+ "name": "afterCreatedAt",
"required": false,
+ "in": "query",
+ "description": "Filter by responses created after this date",
"schema": {
+ "format": "date-time",
"type": "string"
}
},
{
- "name": "orgId",
- "required": true,
- "in": "path",
+ "name": "beforeCreatedAt",
+ "required": false,
+ "in": "query",
+ "description": "Filter by responses created before this date",
"schema": {
- "type": "number"
+ "format": "date-time",
+ "type": "string"
}
},
{
- "name": "teamId",
- "required": true,
- "in": "path",
+ "name": "afterUpdatedAt",
+ "required": false,
+ "in": "query",
+ "description": "Filter by responses created after this date",
"schema": {
- "type": "number"
+ "format": "date-time",
+ "type": "string"
}
},
{
- "name": "membershipId",
- "required": true,
- "in": "path",
+ "name": "beforeUpdatedAt",
+ "required": false,
+ "in": "query",
+ "description": "Filter by responses updated before this date",
"schema": {
- "type": "number"
+ "format": "date-time",
+ "type": "string"
}
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/UpdateOrgTeamMembershipDto"
- }
+ },
+ {
+ "name": "routedToBookingUid",
+ "required": false,
+ "in": "query",
+ "description": "Filter by responses routed to a specific booking",
+ "schema": {
+ "type": "string"
}
}
- },
+ ],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/OrgTeamMembershipOutputResponseDto"
+ "$ref": "#/components/schemas/GetRoutingFormResponsesOutput"
}
}
}
}
},
- "tags": ["Orgs / Teams / Memberships"]
+ "tags": ["Orgs / Teams / Routing forms / Responses"]
}
},
- "/v2/organizations/{orgId}/teams/{teamId}/routing-forms/{routingFormId}/responses": {
- "get": {
- "operationId": "OrganizationsTeamsRoutingFormsResponsesController_getRoutingFormResponses",
- "summary": "Get routing form responses",
+ "/v2/organizations/{orgId}/teams/{teamId}/routing-forms/{routingFormId}/responses/{responseId}": {
+ "patch": {
+ "operationId": "OrganizationsTeamsRoutingFormsResponsesController_updateRoutingFormResponse",
+ "summary": "Update routing form response",
"parameters": [
{
"name": "Authorization",
@@ -3751,6 +4359,14 @@
"type": "string"
}
},
+ {
+ "name": "teamId",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "number"
+ }
+ },
{
"name": "routingFormId",
"required": true,
@@ -3758,15 +4374,33 @@
"schema": {
"type": "string"
}
+ },
+ {
+ "name": "responseId",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "number"
+ }
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateRoutingFormResponseInput"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/GetRoutingFormResponsesOutput"
+ "$ref": "#/components/schemas/UpdateRoutingFormResponseOutput"
}
}
}
@@ -17462,6 +18096,111 @@
"required": ["id", "formId", "formFillerId", "routedToBookingUid", "response", "createdAt"]
},
"GetRoutingFormResponsesOutput": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "example": "success",
+ "enum": ["success", "error"]
+ },
+ "data": {
+ "$ref": "#/components/schemas/RoutingFormResponseOutput"
+ }
+ },
+ "required": ["status", "data"]
+ },
+ "UpdateRoutingFormResponseInput": {
+ "type": "object",
+ "properties": {
+ "response": {
+ "type": "object",
+ "description": "The updated response data"
+ }
+ }
+ },
+ "UpdateRoutingFormResponseOutput": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "example": "success",
+ "enum": ["success", "error"]
+ },
+ "data": {
+ "$ref": "#/components/schemas/RoutingFormResponseOutput"
+ }
+ },
+ "required": ["status", "data"]
+ },
+ "RoutingFormOutput": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "example": "My Form"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true,
+ "example": "This is the description."
+ },
+ "position": {
+ "type": "number",
+ "example": 0
+ },
+ "createdAt": {
+ "type": "string",
+ "example": "2024-03-28T10:00:00.000Z"
+ },
+ "updatedAt": {
+ "type": "string",
+ "example": "2024-03-28T10:00:00.000Z"
+ },
+ "userId": {
+ "type": "number",
+ "example": 2313
+ },
+ "teamId": {
+ "type": "number",
+ "nullable": true,
+ "example": 4214321
+ },
+ "disabled": {
+ "type": "boolean",
+ "example": false
+ },
+ "id": {
+ "type": "string"
+ },
+ "routes": {
+ "type": "object",
+ "nullable": true
+ },
+ "fields": {
+ "type": "object",
+ "nullable": true
+ },
+ "settings": {
+ "type": "object",
+ "nullable": true
+ }
+ },
+ "required": [
+ "name",
+ "description",
+ "position",
+ "createdAt",
+ "updatedAt",
+ "userId",
+ "teamId",
+ "disabled",
+ "id",
+ "routes",
+ "fields",
+ "settings"
+ ]
+ },
+ "GetRoutingFormsOutput": {
"type": "object",
"properties": {
"status": {
@@ -17472,7 +18211,7 @@
"data": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/RoutingFormResponseOutput"
+ "$ref": "#/components/schemas/RoutingFormOutput"
}
}
},