Company
Add a user to a company
Adds an existing PlantPredict user (or invites a new one by email) to the given company. The caller must be an admin of the target company. Newly invited users receive an email with onboarding instructions.
POST
/
Company
/
{companyId}
/
User
Add a user to a company
curl --request POST \
--url https://api.plantpredict.terabase.energy/Company/{companyId}/User \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"jobTitle": "API Demo",
"firstName": "Name 1",
"lastName": "Name 2",
"email": "user-email@company.comco",
"roles": [
{
"role": {
"name": "user"
}
}
]
}
]
'import requests
url = "https://api.plantpredict.terabase.energy/Company/{companyId}/User"
payload = [
{
"jobTitle": "API Demo",
"firstName": "Name 1",
"lastName": "Name 2",
"email": "user-email@company.comco",
"roles": [{ "role": { "name": "user" } }]
}
]
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([
{
jobTitle: 'API Demo',
firstName: 'Name 1',
lastName: 'Name 2',
email: 'user-email@company.comco',
roles: [{role: {name: 'user'}}]
}
])
};
fetch('https://api.plantpredict.terabase.energy/Company/{companyId}/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.plantpredict.terabase.energy/Company/{companyId}/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 => json_encode([
[
'jobTitle' => 'API Demo',
'firstName' => 'Name 1',
'lastName' => 'Name 2',
'email' => 'user-email@company.comco',
'roles' => [
[
'role' => [
'name' => 'user'
]
]
]
]
]),
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.plantpredict.terabase.energy/Company/{companyId}/User"
payload := strings.NewReader("[\n {\n \"jobTitle\": \"API Demo\",\n \"firstName\": \"Name 1\",\n \"lastName\": \"Name 2\",\n \"email\": \"user-email@company.comco\",\n \"roles\": [\n {\n \"role\": {\n \"name\": \"user\"\n }\n }\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.plantpredict.terabase.energy/Company/{companyId}/User")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"jobTitle\": \"API Demo\",\n \"firstName\": \"Name 1\",\n \"lastName\": \"Name 2\",\n \"email\": \"user-email@company.comco\",\n \"roles\": [\n {\n \"role\": {\n \"name\": \"user\"\n }\n }\n ]\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plantpredict.terabase.energy/Company/{companyId}/User")
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 {\n \"jobTitle\": \"API Demo\",\n \"firstName\": \"Name 1\",\n \"lastName\": \"Name 2\",\n \"email\": \"user-email@company.comco\",\n \"roles\": [\n {\n \"role\": {\n \"name\": \"user\"\n }\n }\n ]\n }\n]"
response = http.request(request)
puts response.read_body{
"message": "The request is invalid.",
"modelState": {
"latitude": [
"The field Latitude must be between -90 and 90."
]
}
}"Project not found.""An error has occurred."Authorizations
Pass Authorization: Bearer <token> on every request. See the Authentication section of the API description for how to fetch a token.
Path Parameters
Response
User added
⌘I
Add a user to a company
curl --request POST \
--url https://api.plantpredict.terabase.energy/Company/{companyId}/User \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"jobTitle": "API Demo",
"firstName": "Name 1",
"lastName": "Name 2",
"email": "user-email@company.comco",
"roles": [
{
"role": {
"name": "user"
}
}
]
}
]
'import requests
url = "https://api.plantpredict.terabase.energy/Company/{companyId}/User"
payload = [
{
"jobTitle": "API Demo",
"firstName": "Name 1",
"lastName": "Name 2",
"email": "user-email@company.comco",
"roles": [{ "role": { "name": "user" } }]
}
]
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([
{
jobTitle: 'API Demo',
firstName: 'Name 1',
lastName: 'Name 2',
email: 'user-email@company.comco',
roles: [{role: {name: 'user'}}]
}
])
};
fetch('https://api.plantpredict.terabase.energy/Company/{companyId}/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.plantpredict.terabase.energy/Company/{companyId}/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 => json_encode([
[
'jobTitle' => 'API Demo',
'firstName' => 'Name 1',
'lastName' => 'Name 2',
'email' => 'user-email@company.comco',
'roles' => [
[
'role' => [
'name' => 'user'
]
]
]
]
]),
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.plantpredict.terabase.energy/Company/{companyId}/User"
payload := strings.NewReader("[\n {\n \"jobTitle\": \"API Demo\",\n \"firstName\": \"Name 1\",\n \"lastName\": \"Name 2\",\n \"email\": \"user-email@company.comco\",\n \"roles\": [\n {\n \"role\": {\n \"name\": \"user\"\n }\n }\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.plantpredict.terabase.energy/Company/{companyId}/User")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"jobTitle\": \"API Demo\",\n \"firstName\": \"Name 1\",\n \"lastName\": \"Name 2\",\n \"email\": \"user-email@company.comco\",\n \"roles\": [\n {\n \"role\": {\n \"name\": \"user\"\n }\n }\n ]\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plantpredict.terabase.energy/Company/{companyId}/User")
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 {\n \"jobTitle\": \"API Demo\",\n \"firstName\": \"Name 1\",\n \"lastName\": \"Name 2\",\n \"email\": \"user-email@company.comco\",\n \"roles\": [\n {\n \"role\": {\n \"name\": \"user\"\n }\n }\n ]\n }\n]"
response = http.request(request)
puts response.read_body{
"message": "The request is invalid.",
"modelState": {
"latitude": [
"The field Latitude must be between -90 and 90."
]
}
}"Project not found.""An error has occurred."