Create User
POST
/
v1
/
users
Create User
curl --request POST \
--url https://api.siit.io/v1/users \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "<string>",
"birthday_date": "2023-12-25",
"city": "<string>",
"country": "<string>",
"employee_number": "<string>",
"first_name": "<string>",
"hire_date": "2023-12-25",
"job_leave_date": "2023-12-25",
"job_start_date": "2023-12-25",
"job_title": "<string>",
"last_name": "<string>",
"last_working_date": "2023-12-25",
"metadata": {},
"preferred_language": "<string>",
"probation_end_date": "2023-12-25",
"work_phone": "<string>",
"department": "<string>",
"legal_entity": "<string>",
"office_location": "<string>",
"report_to": "<string>",
"teams": [
"<string>"
]
}
'import requests
url = "https://api.siit.io/v1/users"
payload = {
"email": "<string>",
"birthday_date": "2023-12-25",
"city": "<string>",
"country": "<string>",
"employee_number": "<string>",
"first_name": "<string>",
"hire_date": "2023-12-25",
"job_leave_date": "2023-12-25",
"job_start_date": "2023-12-25",
"job_title": "<string>",
"last_name": "<string>",
"last_working_date": "2023-12-25",
"metadata": {},
"preferred_language": "<string>",
"probation_end_date": "2023-12-25",
"work_phone": "<string>",
"department": "<string>",
"legal_entity": "<string>",
"office_location": "<string>",
"report_to": "<string>",
"teams": ["<string>"]
}
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({
email: '<string>',
birthday_date: '2023-12-25',
city: '<string>',
country: '<string>',
employee_number: '<string>',
first_name: '<string>',
hire_date: '2023-12-25',
job_leave_date: '2023-12-25',
job_start_date: '2023-12-25',
job_title: '<string>',
last_name: '<string>',
last_working_date: '2023-12-25',
metadata: {},
preferred_language: '<string>',
probation_end_date: '2023-12-25',
work_phone: '<string>',
department: '<string>',
legal_entity: '<string>',
office_location: '<string>',
report_to: '<string>',
teams: ['<string>']
})
};
fetch('https://api.siit.io/v1/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.siit.io/v1/users",
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([
'email' => '<string>',
'birthday_date' => '2023-12-25',
'city' => '<string>',
'country' => '<string>',
'employee_number' => '<string>',
'first_name' => '<string>',
'hire_date' => '2023-12-25',
'job_leave_date' => '2023-12-25',
'job_start_date' => '2023-12-25',
'job_title' => '<string>',
'last_name' => '<string>',
'last_working_date' => '2023-12-25',
'metadata' => [
],
'preferred_language' => '<string>',
'probation_end_date' => '2023-12-25',
'work_phone' => '<string>',
'department' => '<string>',
'legal_entity' => '<string>',
'office_location' => '<string>',
'report_to' => '<string>',
'teams' => [
'<string>'
]
]),
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.siit.io/v1/users"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"birthday_date\": \"2023-12-25\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"employee_number\": \"<string>\",\n \"first_name\": \"<string>\",\n \"hire_date\": \"2023-12-25\",\n \"job_leave_date\": \"2023-12-25\",\n \"job_start_date\": \"2023-12-25\",\n \"job_title\": \"<string>\",\n \"last_name\": \"<string>\",\n \"last_working_date\": \"2023-12-25\",\n \"metadata\": {},\n \"preferred_language\": \"<string>\",\n \"probation_end_date\": \"2023-12-25\",\n \"work_phone\": \"<string>\",\n \"department\": \"<string>\",\n \"legal_entity\": \"<string>\",\n \"office_location\": \"<string>\",\n \"report_to\": \"<string>\",\n \"teams\": [\n \"<string>\"\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.siit.io/v1/users")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"birthday_date\": \"2023-12-25\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"employee_number\": \"<string>\",\n \"first_name\": \"<string>\",\n \"hire_date\": \"2023-12-25\",\n \"job_leave_date\": \"2023-12-25\",\n \"job_start_date\": \"2023-12-25\",\n \"job_title\": \"<string>\",\n \"last_name\": \"<string>\",\n \"last_working_date\": \"2023-12-25\",\n \"metadata\": {},\n \"preferred_language\": \"<string>\",\n \"probation_end_date\": \"2023-12-25\",\n \"work_phone\": \"<string>\",\n \"department\": \"<string>\",\n \"legal_entity\": \"<string>\",\n \"office_location\": \"<string>\",\n \"report_to\": \"<string>\",\n \"teams\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.siit.io/v1/users")
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 \"email\": \"<string>\",\n \"birthday_date\": \"2023-12-25\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"employee_number\": \"<string>\",\n \"first_name\": \"<string>\",\n \"hire_date\": \"2023-12-25\",\n \"job_leave_date\": \"2023-12-25\",\n \"job_start_date\": \"2023-12-25\",\n \"job_title\": \"<string>\",\n \"last_name\": \"<string>\",\n \"last_working_date\": \"2023-12-25\",\n \"metadata\": {},\n \"preferred_language\": \"<string>\",\n \"probation_end_date\": \"2023-12-25\",\n \"work_phone\": \"<string>\",\n \"department\": \"<string>\",\n \"legal_entity\": \"<string>\",\n \"office_location\": \"<string>\",\n \"report_to\": \"<string>\",\n \"teams\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"result": {
"birthday_date": "2023-12-25",
"city": "<string>",
"country": "<string>",
"employee_number": "<string>",
"first_name": "<string>",
"hire_date": "2023-12-25",
"job_leave_date": "2023-12-25",
"job_start_date": "2023-12-25",
"job_title": "<string>",
"last_name": "<string>",
"last_working_date": "2023-12-25",
"metadata": {},
"preferred_language": "<string>",
"probation_end_date": "2023-12-25",
"work_phone": "<string>",
"uid": "<string>",
"admin_permalink_url": "<string>",
"archived_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"department": "<string>",
"department_uid": "<string>",
"emails": [
"<string>"
],
"full_name": "<string>",
"legal_entity": "<string>",
"legal_entity_uid": "<string>",
"microsoft_entra_ids": [
"<string>"
],
"microsoft_entra_group_ids": [
"<string>"
],
"office_location": "<string>",
"office_location_uid": "<string>",
"report_to": "<string>",
"report_to_uid": "<string>",
"slack_user_id": "<string>",
"status": "employee",
"team_uids": [
"<string>"
],
"teams": [
"<string>"
],
"timezone": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
}Introduction
Note: fields that are disabled or restricted to the current user cannot be set on creation.Usage
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Request body for creating or updating a User. Pass UIDs (not objects) for relationship fields.
date formatted as ISO 8601 (e.g. "2020-12-15")
Available options:
contract, expat, fulltime, intern, parttime, temporary ISO3166 alpha-2 country code (e.g: "PT")
Available options:
female, male, non_binary, other, prefer_not_to_disclose date formatted as ISO 8601 (e.g. "2020-12-15")
date formatted as ISO 8601 (e.g. "2020-12-15")
date formatted as ISO 8601 (e.g. "2020-12-15")
date formatted as ISO 8601 (e.g. "2020-12-15")
Arbitrary key/value pairs attached to the User (max 10 keys, string values of at most 255 characters). Passed keys are merged into the existing metadata: absent keys are preserved, passing a key with an empty or null value removes it, and passing metadata as an empty string removes all keys.
Show child attributes
Show child attributes
A language in IETF format (en-US, pt-PT, fr-FR...)
date formatted as ISO 8601 (e.g. "2020-12-15")
The department this user belongs to. Pass the UID of the related object.
The legal entity this user belongs to. Pass the UID of the related object.
The office location of this user. Pass the UID of the related object.
The manager of this user. Pass the UID of the related object.
Teams this user belongs to. Pass an array of UIDs of the related objects.
Response
201 - application/json
Successful
Show child attributes
Show child attributes
⌘I
Create User
curl --request POST \
--url https://api.siit.io/v1/users \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "<string>",
"birthday_date": "2023-12-25",
"city": "<string>",
"country": "<string>",
"employee_number": "<string>",
"first_name": "<string>",
"hire_date": "2023-12-25",
"job_leave_date": "2023-12-25",
"job_start_date": "2023-12-25",
"job_title": "<string>",
"last_name": "<string>",
"last_working_date": "2023-12-25",
"metadata": {},
"preferred_language": "<string>",
"probation_end_date": "2023-12-25",
"work_phone": "<string>",
"department": "<string>",
"legal_entity": "<string>",
"office_location": "<string>",
"report_to": "<string>",
"teams": [
"<string>"
]
}
'import requests
url = "https://api.siit.io/v1/users"
payload = {
"email": "<string>",
"birthday_date": "2023-12-25",
"city": "<string>",
"country": "<string>",
"employee_number": "<string>",
"first_name": "<string>",
"hire_date": "2023-12-25",
"job_leave_date": "2023-12-25",
"job_start_date": "2023-12-25",
"job_title": "<string>",
"last_name": "<string>",
"last_working_date": "2023-12-25",
"metadata": {},
"preferred_language": "<string>",
"probation_end_date": "2023-12-25",
"work_phone": "<string>",
"department": "<string>",
"legal_entity": "<string>",
"office_location": "<string>",
"report_to": "<string>",
"teams": ["<string>"]
}
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({
email: '<string>',
birthday_date: '2023-12-25',
city: '<string>',
country: '<string>',
employee_number: '<string>',
first_name: '<string>',
hire_date: '2023-12-25',
job_leave_date: '2023-12-25',
job_start_date: '2023-12-25',
job_title: '<string>',
last_name: '<string>',
last_working_date: '2023-12-25',
metadata: {},
preferred_language: '<string>',
probation_end_date: '2023-12-25',
work_phone: '<string>',
department: '<string>',
legal_entity: '<string>',
office_location: '<string>',
report_to: '<string>',
teams: ['<string>']
})
};
fetch('https://api.siit.io/v1/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.siit.io/v1/users",
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([
'email' => '<string>',
'birthday_date' => '2023-12-25',
'city' => '<string>',
'country' => '<string>',
'employee_number' => '<string>',
'first_name' => '<string>',
'hire_date' => '2023-12-25',
'job_leave_date' => '2023-12-25',
'job_start_date' => '2023-12-25',
'job_title' => '<string>',
'last_name' => '<string>',
'last_working_date' => '2023-12-25',
'metadata' => [
],
'preferred_language' => '<string>',
'probation_end_date' => '2023-12-25',
'work_phone' => '<string>',
'department' => '<string>',
'legal_entity' => '<string>',
'office_location' => '<string>',
'report_to' => '<string>',
'teams' => [
'<string>'
]
]),
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.siit.io/v1/users"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"birthday_date\": \"2023-12-25\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"employee_number\": \"<string>\",\n \"first_name\": \"<string>\",\n \"hire_date\": \"2023-12-25\",\n \"job_leave_date\": \"2023-12-25\",\n \"job_start_date\": \"2023-12-25\",\n \"job_title\": \"<string>\",\n \"last_name\": \"<string>\",\n \"last_working_date\": \"2023-12-25\",\n \"metadata\": {},\n \"preferred_language\": \"<string>\",\n \"probation_end_date\": \"2023-12-25\",\n \"work_phone\": \"<string>\",\n \"department\": \"<string>\",\n \"legal_entity\": \"<string>\",\n \"office_location\": \"<string>\",\n \"report_to\": \"<string>\",\n \"teams\": [\n \"<string>\"\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.siit.io/v1/users")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"birthday_date\": \"2023-12-25\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"employee_number\": \"<string>\",\n \"first_name\": \"<string>\",\n \"hire_date\": \"2023-12-25\",\n \"job_leave_date\": \"2023-12-25\",\n \"job_start_date\": \"2023-12-25\",\n \"job_title\": \"<string>\",\n \"last_name\": \"<string>\",\n \"last_working_date\": \"2023-12-25\",\n \"metadata\": {},\n \"preferred_language\": \"<string>\",\n \"probation_end_date\": \"2023-12-25\",\n \"work_phone\": \"<string>\",\n \"department\": \"<string>\",\n \"legal_entity\": \"<string>\",\n \"office_location\": \"<string>\",\n \"report_to\": \"<string>\",\n \"teams\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.siit.io/v1/users")
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 \"email\": \"<string>\",\n \"birthday_date\": \"2023-12-25\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"employee_number\": \"<string>\",\n \"first_name\": \"<string>\",\n \"hire_date\": \"2023-12-25\",\n \"job_leave_date\": \"2023-12-25\",\n \"job_start_date\": \"2023-12-25\",\n \"job_title\": \"<string>\",\n \"last_name\": \"<string>\",\n \"last_working_date\": \"2023-12-25\",\n \"metadata\": {},\n \"preferred_language\": \"<string>\",\n \"probation_end_date\": \"2023-12-25\",\n \"work_phone\": \"<string>\",\n \"department\": \"<string>\",\n \"legal_entity\": \"<string>\",\n \"office_location\": \"<string>\",\n \"report_to\": \"<string>\",\n \"teams\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"result": {
"birthday_date": "2023-12-25",
"city": "<string>",
"country": "<string>",
"employee_number": "<string>",
"first_name": "<string>",
"hire_date": "2023-12-25",
"job_leave_date": "2023-12-25",
"job_start_date": "2023-12-25",
"job_title": "<string>",
"last_name": "<string>",
"last_working_date": "2023-12-25",
"metadata": {},
"preferred_language": "<string>",
"probation_end_date": "2023-12-25",
"work_phone": "<string>",
"uid": "<string>",
"admin_permalink_url": "<string>",
"archived_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"department": "<string>",
"department_uid": "<string>",
"emails": [
"<string>"
],
"full_name": "<string>",
"legal_entity": "<string>",
"legal_entity_uid": "<string>",
"microsoft_entra_ids": [
"<string>"
],
"microsoft_entra_group_ids": [
"<string>"
],
"office_location": "<string>",
"office_location_uid": "<string>",
"report_to": "<string>",
"report_to_uid": "<string>",
"slack_user_id": "<string>",
"status": "employee",
"team_uids": [
"<string>"
],
"teams": [
"<string>"
],
"timezone": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
}