Get all users
curl --request GET \
--url https://api.cal.com/v2/organizations/{orgId}/usersimport requests
url = "https://api.cal.com/v2/organizations/{orgId}/users"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.cal.com/v2/organizations/{orgId}/users', 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/organizations/{orgId}/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.cal.com/v2/organizations/{orgId}/users"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.cal.com/v2/organizations/{orgId}/users")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cal.com/v2/organizations/{orgId}/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"status": "success",
"data": [
{
"id": 1,
"email": "john@example.com",
"timeZone": "America/New_York",
"weekStart": "Monday",
"hideBranding": false,
"createdDate": "2022-01-01T00:00:00Z",
"profile": {
"id": 1,
"organizationId": 1,
"userId": 1,
"username": "john_doe"
},
"username": "john_doe",
"name": "John Doe",
"emailVerified": "2022-01-01T00:00:00Z",
"bio": "I am a software developer",
"avatarUrl": "https://example.com/avatar.jpg",
"appTheme": "light",
"theme": "default",
"defaultScheduleId": 1,
"locale": "en-US",
"timeFormat": 12,
"brandColor": "#ffffff",
"darkBrandColor": "#000000",
"allowDynamicBooking": true,
"verified": true,
"invitedTo": 1,
"metadata": {
"key": "value"
}
}
]
}Users
Get all users
Required membership role: org admin. PBAC permission: organization.readMemberships. Learn more about API access control at https://cal.com/docs/api-reference/v2/access-control. If accessed using an OAuth access token, the ORG_MEMBERSHIP_READ scope is required.
GET
/
v2
/
organizations
/
{orgId}
/
users
Get all users
curl --request GET \
--url https://api.cal.com/v2/organizations/{orgId}/usersimport requests
url = "https://api.cal.com/v2/organizations/{orgId}/users"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.cal.com/v2/organizations/{orgId}/users', 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/organizations/{orgId}/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.cal.com/v2/organizations/{orgId}/users"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.cal.com/v2/organizations/{orgId}/users")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cal.com/v2/organizations/{orgId}/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"status": "success",
"data": [
{
"id": 1,
"email": "john@example.com",
"timeZone": "America/New_York",
"weekStart": "Monday",
"hideBranding": false,
"createdDate": "2022-01-01T00:00:00Z",
"profile": {
"id": 1,
"organizationId": 1,
"userId": 1,
"username": "john_doe"
},
"username": "john_doe",
"name": "John Doe",
"emailVerified": "2022-01-01T00:00:00Z",
"bio": "I am a software developer",
"avatarUrl": "https://example.com/avatar.jpg",
"appTheme": "light",
"theme": "default",
"defaultScheduleId": 1,
"locale": "en-US",
"timeFormat": 12,
"brandColor": "#ffffff",
"darkBrandColor": "#000000",
"allowDynamicBooking": true,
"verified": true,
"invitedTo": 1,
"metadata": {
"key": "value"
}
}
]
}Headers
For non-platform customers - value must be Bearer <token> where <token> is api key prefixed with cal_
For platform customers - OAuth client secret key
For platform customers - OAuth client ID
Path Parameters
Query Parameters
The number of items to return
Required range:
1 <= x <= 1000Example:
10
The number of items to skip
Required range:
x >= 0Example:
0
The email address or an array of email addresses to filter by
Example:
["user1@example.com", "user2@example.com"]
Filter by assigned attribute option ids. ids must be separated by a comma.
Minimum array length:
1Example:
"?assignedOptionIds=aaaaaaaa-bbbb-cccc-dddd-eeeeee1eee,aaaaaaaa-bbbb-cccc-dddd-eeeeee2eee"
Query operator used to filter assigned options, AND by default.
Available options:
OR, AND, NONE Example:
"NONE"
Filter by teamIds. Team ids must be separated by a comma.
Minimum array length:
1Example:
"?teamIds=100,200"
Was this page helpful?