Skip to main content
POST
/
v2
/
insights
/
routings
/
form-responses
Get routing form responses
curl --request POST \
  --url https://api.cal.com/v2/insights/routings/form-responses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scope": "user",
  "startDate": "2024-01-01",
  "endDate": "2024-01-31",
  "offset": 0,
  "limit": 50,
  "selectedTeamId": 12,
  "columnFilters": [
    {
      "id": "createdAt",
      "value": {
        "type": "dr",
        "data": {
          "startDate": "2024-01-01",
          "endDate": "2024-01-31",
          "preset": "custom"
        }
      }
    }
  ],
  "sorting": [
    {
      "id": "createdAt",
      "desc": true
    }
  ]
}
'
import requests

url = "https://api.cal.com/v2/insights/routings/form-responses"

payload = {
    "scope": "user",
    "startDate": "2024-01-01",
    "endDate": "2024-01-31",
    "offset": 0,
    "limit": 50,
    "selectedTeamId": 12,
    "columnFilters": [
        {
            "id": "createdAt",
            "value": {
                "type": "dr",
                "data": {
                    "startDate": "2024-01-01",
                    "endDate": "2024-01-31",
                    "preset": "custom"
                }
            }
        }
    ],
    "sorting": [
        {
            "id": "createdAt",
            "desc": True
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    scope: 'user',
    startDate: '2024-01-01',
    endDate: '2024-01-31',
    offset: 0,
    limit: 50,
    selectedTeamId: 12,
    columnFilters: [
      {
        id: 'createdAt',
        value: {
          type: 'dr',
          data: {startDate: '2024-01-01', endDate: '2024-01-31', preset: 'custom'}
        }
      }
    ],
    sorting: [{id: 'createdAt', desc: true}]
  })
};

fetch('https://api.cal.com/v2/insights/routings/form-responses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cal.com/v2/insights/routings/form-responses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'scope' => 'user',
    'startDate' => '2024-01-01',
    'endDate' => '2024-01-31',
    'offset' => 0,
    'limit' => 50,
    'selectedTeamId' => 12,
    'columnFilters' => [
        [
                'id' => 'createdAt',
                'value' => [
                                'type' => 'dr',
                                'data' => [
                                                                'startDate' => '2024-01-01',
                                                                'endDate' => '2024-01-31',
                                                                'preset' => 'custom'
                                ]
                ]
        ]
    ],
    'sorting' => [
        [
                'id' => 'createdAt',
                'desc' => true
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cal.com/v2/insights/routings/form-responses"

	payload := strings.NewReader("{\n  \"scope\": \"user\",\n  \"startDate\": \"2024-01-01\",\n  \"endDate\": \"2024-01-31\",\n  \"offset\": 0,\n  \"limit\": 50,\n  \"selectedTeamId\": 12,\n  \"columnFilters\": [\n    {\n      \"id\": \"createdAt\",\n      \"value\": {\n        \"type\": \"dr\",\n        \"data\": {\n          \"startDate\": \"2024-01-01\",\n          \"endDate\": \"2024-01-31\",\n          \"preset\": \"custom\"\n        }\n      }\n    }\n  ],\n  \"sorting\": [\n    {\n      \"id\": \"createdAt\",\n      \"desc\": true\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.cal.com/v2/insights/routings/form-responses")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"scope\": \"user\",\n  \"startDate\": \"2024-01-01\",\n  \"endDate\": \"2024-01-31\",\n  \"offset\": 0,\n  \"limit\": 50,\n  \"selectedTeamId\": 12,\n  \"columnFilters\": [\n    {\n      \"id\": \"createdAt\",\n      \"value\": {\n        \"type\": \"dr\",\n        \"data\": {\n          \"startDate\": \"2024-01-01\",\n          \"endDate\": \"2024-01-31\",\n          \"preset\": \"custom\"\n        }\n      }\n    }\n  ],\n  \"sorting\": [\n    {\n      \"id\": \"createdAt\",\n      \"desc\": true\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.cal.com/v2/insights/routings/form-responses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"scope\": \"user\",\n  \"startDate\": \"2024-01-01\",\n  \"endDate\": \"2024-01-31\",\n  \"offset\": 0,\n  \"limit\": 50,\n  \"selectedTeamId\": 12,\n  \"columnFilters\": [\n    {\n      \"id\": \"createdAt\",\n      \"value\": {\n        \"type\": \"dr\",\n        \"data\": {\n          \"startDate\": \"2024-01-01\",\n          \"endDate\": \"2024-01-31\",\n          \"preset\": \"custom\"\n        }\n      }\n    }\n  ],\n  \"sorting\": [\n    {\n      \"id\": \"createdAt\",\n      \"desc\": true\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "data": {
    "total": 10,
    "data": [
      {
        "id": 1,
        "uuid": "form_123",
        "formId": "form_123",
        "formName": "Contact Sales",
        "formTeamId": 10,
        "formUserId": 101,
        "bookingUid": "booking_uid",
        "bookingId": 1,
        "bookingStatus": "ACCEPTED",
        "bookingStatusOrder": 1,
        "bookingCreatedAt": "2024-01-01T00:00:00.000Z",
        "bookingUserId": 101,
        "bookingUserName": "Alice Doe",
        "bookingUserEmail": "alice@example.com",
        "bookingUserAvatarUrl": "https://example.com/avatar.png",
        "bookingAssignmentReason": "round_robin",
        "bookingStartTime": "2024-01-01T09:00:00.000Z",
        "bookingEndTime": "2024-01-01T09:30:00.000Z",
        "eventTypeId": 200,
        "eventTypeParentId": null,
        "eventTypeSchedulingType": "ROUND_ROBIN",
        "createdAt": "2024-01-01T00:00:00.000Z",
        "utm_source": "google",
        "utm_medium": "cpc",
        "utm_campaign": "spring_launch",
        "utm_term": "calendar scheduling",
        "utm_content": "hero_cta",
        "bookingAttendees": [
          {
            "name": "Jane Doe",
            "timeZone": "Europe/London",
            "email": "jane@example.com",
            "phoneNumber": null
          }
        ],
        "fields": [
          {
            "fieldId": "company-size",
            "valueString": "Enterprise",
            "valueNumber": 100,
            "valueStringArray": [
              "Enterprise",
              "Mid Market"
            ]
          }
        ]
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
scope
enum<string>
required
Available options:
user,
team,
org
Example:

"user"

​
startDate
string
required

Inclusive start date for routing insights

Example:

"2024-01-01"

​
endDate
string
required

Inclusive end date for routing insights

Example:

"2024-01-31"

​
offset
number
required
Example:

0

​
limit
number
required
Required range: x <= 100
Example:

50

​
selectedTeamId
number

Team ID for team-scoped routing insights

Example:

12

​
columnFilters
object[]

Data-table column filters (discriminated union by type: ss, ms, t, n, dr). Date range filters use id=createdAt.

Example:
[
  {
    "id": "createdAt",
    "value": {
      "type": "dr",
      "data": {
        "startDate": "2024-01-01",
        "endDate": "2024-01-31",
        "preset": "custom"
      }
    }
  }
]
​
sorting
array
Example:
[{ "id": "createdAt", "desc": true }]

Response

200 - application/json
​
status
enum<string>
required
Available options:
success,
error
Example:

"success"

​
data
object
required