User V4

Create platform user

Creates a new platform user with automatically generated availability schedule and meeting type. The user will be associated with your company and ready for bookings immediately. Basic information for availability (weekly schedule, timezone) and meeting type (name, duration, slug) can be provided in the request. If not provided, default values are used: availability defaults to business hours (9-17 Mon-Fri) in Europe/Berlin timezone, and meeting type defaults to “30min Meeting” with 30-minute duration. The response includes IDs for the created user, availability, and meeting type, plus a ready-to-use public booking URL. The defaultAvailabilityId can be used to update availability via PATCH, and meeting types can be fetched and modified or new ones created.

POST

user

curl --request POST \
  --url https://api.example.com/v4/user \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-meetergo-api-user-id: <api-key>' \
  --form email=jsmith@example.com \
  --form 'givenName=<string>' \
  --form 'familyName=<string>' \
  --form 'slug=<string>' \
  --form timezone=America/New_York \
  --form 'availability={
  "name": "<string>",
  "timezone": "<string>"
}' \
  --form 'meetingType={
  "name": "<string>",
  "duration": 2,
  "slug": "<string>"
}'

import requests

url = "https://api.example.com/v4/user"

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\njsmith@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"givenName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"familyName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timezone\"\r\n\r\nAmerica/New_York\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"availability\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"timezone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"meetingType\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"duration\": 2,\r\n  \"slug\": \"<string>\"\r\n}\r\n-----011000010111000001101001--"
headers = {
    "x-meetergo-api-user-id": "<api-key>",
    "Content-Type": "multipart/form-data"
}

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

print(response.text)

const form = new FormData();
form.append('email', 'jsmith@example.com');
form.append('givenName', '<string>');
form.append('familyName', '<string>');
form.append('slug', '<string>');
form.append('timezone', 'America/New_York');
form.append('availability', '{
  "name": "<string>",
  "timezone": "<string>"
}');
form.append('meetingType', '{
  "name": "<string>",
  "duration": 2,
  "slug": "<string>"
}');

const options = {method: 'POST', headers: {'x-meetergo-api-user-id': '<api-key>'}};

options.body = form;

fetch('https://api.example.com/v4/user', 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.example.com/v4/user",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\njsmith@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"givenName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"familyName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timezone\"\r\n\r\nAmerica/New_York\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"availability\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"timezone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"meetingType\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"duration\": 2,\r\n  \"slug\": \"<string>\"\r\n}\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "x-meetergo-api-user-id: <api-key>"
  ],
]);

$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.example.com/v4/user"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\njsmith@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"givenName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"familyName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timezone\"\r\n\r\nAmerica/New_York\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"availability\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"timezone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"meetingType\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"duration\": 2,\r\n  \"slug\": \"<string>\"\r\n}\r\n-----011000010111000001101001--")

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

	req.Header.Add("x-meetergo-api-user-id", "<api-key>")

	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.example.com/v4/user")
  .header("x-meetergo-api-user-id", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\njsmith@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"givenName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"familyName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timezone\"\r\n\r\nAmerica/New_York\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"availability\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"timezone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"meetingType\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"duration\": 2,\r\n  \"slug\": \"<string>\"\r\n}\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v4/user")

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

request = Net::HTTP::Post.new(url)
request["x-meetergo-api-user-id"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\njsmith@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"givenName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"familyName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timezone\"\r\n\r\nAmerica/New_York\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"availability\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"timezone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"meetingType\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"duration\": 2,\r\n  \"slug\": \"<string>\"\r\n}\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "userId": "550e8400-e29b-41d4-a716-446655440000",
  "availabilityId": "660e8400-e29b-41d4-a716-446655440001",
  "meetingTypeId": "770e8400-e29b-41d4-a716-446655440002",
  "bookingUrl": "https://book.customdomain.com/john-doe/30min-meeting",
  "companyId": "880e8400-e29b-41d4-a716-446655440003"
}

Authorizations

x-meetergo-api-user-id

string

header

required

User ID to act on behalf of. Platform API Keys only (required with an API Key unless the endpoint states otherwise). Requests authenticated with a Personal Access Token are rejected if this header names another user.

Body

multipart/form-data

string<email>

required

The email address of the user

givenName

string

The first name of the user. Defaults to the email prefix

familyName

string

The last name of the user. Defaults to empty string

slug

string

Optional unique slug for the user (minimum 5 characters). Defaults to creating slug via the email.

Minimum string length: 5

timezone

string

User timezone. Defaults to "Europe/Berlin"

Example:

"America/New_York"

availability

object

Availability configuration. Creates default availability if not specified

Show child attributes

meetingType

object

Meeting type configuration. Creates default meeting type if not specified

Show child attributes

Response

201 - application/json

Platform user created successfully with auto-generated availability and meeting type. Returns user ID, availability ID, meeting type ID, company ID, and public booking URL that customers can use immediately.

userId

string

required

Unique ID of the created platform user

Example:

"550e8400-e29b-41d4-a716-446655440000"

availabilityId

string

required

ID of the created availability schedule

Example:

"660e8400-e29b-41d4-a716-446655440001"

meetingTypeId

string

required

ID of the created meeting type

Example:

"770e8400-e29b-41d4-a716-446655440002"

bookingUrl

string

required

Public URL where customers can book appointments

Example:

"https://book.customdomain.com/john-doe/30min-meeting"

companyId

string

required

ID of the company this user belongs to

Example:

"880e8400-e29b-41d4-a716-446655440003"

Get current user informationRetrieves detailed information about the currently authenticated user including their availability schedules, meeting types, and company association.

Create platform user

curl --request POST \
  --url https://api.example.com/v4/user \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-meetergo-api-user-id: <api-key>' \
  --form email=jsmith@example.com \
  --form 'givenName=<string>' \
  --form 'familyName=<string>' \
  --form 'slug=<string>' \
  --form timezone=America/New_York \
  --form 'availability={
  "name": "<string>",
  "timezone": "<string>"
}' \
  --form 'meetingType={
  "name": "<string>",
  "duration": 2,
  "slug": "<string>"
}'

import requests

url = "https://api.example.com/v4/user"

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\njsmith@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"givenName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"familyName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timezone\"\r\n\r\nAmerica/New_York\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"availability\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"timezone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"meetingType\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"duration\": 2,\r\n  \"slug\": \"<string>\"\r\n}\r\n-----011000010111000001101001--"
headers = {
    "x-meetergo-api-user-id": "<api-key>",
    "Content-Type": "multipart/form-data"
}

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

print(response.text)

const form = new FormData();
form.append('email', 'jsmith@example.com');
form.append('givenName', '<string>');
form.append('familyName', '<string>');
form.append('slug', '<string>');
form.append('timezone', 'America/New_York');
form.append('availability', '{
  "name": "<string>",
  "timezone": "<string>"
}');
form.append('meetingType', '{
  "name": "<string>",
  "duration": 2,
  "slug": "<string>"
}');

const options = {method: 'POST', headers: {'x-meetergo-api-user-id': '<api-key>'}};

options.body = form;

fetch('https://api.example.com/v4/user', 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.example.com/v4/user",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\njsmith@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"givenName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"familyName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timezone\"\r\n\r\nAmerica/New_York\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"availability\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"timezone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"meetingType\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"duration\": 2,\r\n  \"slug\": \"<string>\"\r\n}\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "x-meetergo-api-user-id: <api-key>"
  ],
]);

$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.example.com/v4/user"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\njsmith@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"givenName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"familyName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timezone\"\r\n\r\nAmerica/New_York\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"availability\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"timezone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"meetingType\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"duration\": 2,\r\n  \"slug\": \"<string>\"\r\n}\r\n-----011000010111000001101001--")

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

	req.Header.Add("x-meetergo-api-user-id", "<api-key>")

	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.example.com/v4/user")
  .header("x-meetergo-api-user-id", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\njsmith@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"givenName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"familyName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timezone\"\r\n\r\nAmerica/New_York\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"availability\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"timezone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"meetingType\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"duration\": 2,\r\n  \"slug\": \"<string>\"\r\n}\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v4/user")

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

request = Net::HTTP::Post.new(url)
request["x-meetergo-api-user-id"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\njsmith@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"givenName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"familyName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timezone\"\r\n\r\nAmerica/New_York\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"availability\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"timezone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"meetingType\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"duration\": 2,\r\n  \"slug\": \"<string>\"\r\n}\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "userId": "550e8400-e29b-41d4-a716-446655440000",
  "availabilityId": "660e8400-e29b-41d4-a716-446655440001",
  "meetingTypeId": "770e8400-e29b-41d4-a716-446655440002",
  "bookingUrl": "https://book.customdomain.com/john-doe/30min-meeting",
  "companyId": "880e8400-e29b-41d4-a716-446655440003"
}

availability

availability-exception

Meeting Type V4

Booking Availability V4

Queue V4

Queue User Group V4

Meeting Type Template V4

One Time Booking Link V4

Provisional Booking V4

Handoff V4

Booking Link V4

Booking V4

Attendee V4

Appointment V4

Attendee Pending V4

Personal Page V4

User V4

Calendar Auth V4

Calendar Connections V4

Create platform user

Authorizations

Body

Response