WhoAmI

WhoAmI

curl --request POST \
  --url https://edge.sterndesk.com/rpc/rpc.v1.RootService/WhoAmI \
  --header 'Authorization: Bearer <token>' \
  --header 'Connect-Protocol-Version: <connect-protocol-version>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "echo": "<string>"
}
'

import requests

url = "https://edge.sterndesk.com/rpc/rpc.v1.RootService/WhoAmI"

payload = { "echo": "<string>" }
headers = {
    "Connect-Protocol-Version": "<connect-protocol-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Connect-Protocol-Version': '<connect-protocol-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({echo: '<string>'})
};

fetch('https://edge.sterndesk.com/rpc/rpc.v1.RootService/WhoAmI', 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://edge.sterndesk.com/rpc/rpc.v1.RootService/WhoAmI",
  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([
    'echo' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Connect-Protocol-Version: <connect-protocol-version>",
    "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://edge.sterndesk.com/rpc/rpc.v1.RootService/WhoAmI"

	payload := strings.NewReader("{\n  \"echo\": \"<string>\"\n}")

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

	req.Header.Add("Connect-Protocol-Version", "<connect-protocol-version>")
	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://edge.sterndesk.com/rpc/rpc.v1.RootService/WhoAmI")
  .header("Connect-Protocol-Version", "<connect-protocol-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"echo\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://edge.sterndesk.com/rpc/rpc.v1.RootService/WhoAmI")

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

request = Net::HTTP::Post.new(url)
request["Connect-Protocol-Version"] = '<connect-protocol-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"echo\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "primaryEmail": "<string>",
  "emailVerified": true,
  "givenName": "<string>",
  "familyName": "<string>",
  "backendVersion": "<string>",
  "impersonatorEmail": "<string>",
  "organizationId": "<string>",
  "organizationName": "<string>",
  "organizationRole": "<string>",
  "organizationIsSetupBasic": true,
  "organization": {
    "id": "<string>",
    "name": "<string>",
    "role": "<string>",
    "isSetupBasic": true,
    "slug": "<string>"
  },
  "isSetupBasic": true,
  "primaryPhoneE164": "<string>",
  "secondaryPhoneE164": "<string>",
  "preferences": {
    "notShowGettingStarted": true
  },
  "echo": "<string>"
}

{
  "code": "not_found",
  "message": "<string>",
  "details": [
    {
      "type": "<string>",
      "value": "<string>",
      "debug": {}
    }
  ]
}

POST

rpc

rpc.v1.RootService

WhoAmI

curl --request POST \
  --url https://edge.sterndesk.com/rpc/rpc.v1.RootService/WhoAmI \
  --header 'Authorization: Bearer <token>' \
  --header 'Connect-Protocol-Version: <connect-protocol-version>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "echo": "<string>"
}
'

import requests

url = "https://edge.sterndesk.com/rpc/rpc.v1.RootService/WhoAmI"

payload = { "echo": "<string>" }
headers = {
    "Connect-Protocol-Version": "<connect-protocol-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Connect-Protocol-Version': '<connect-protocol-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({echo: '<string>'})
};

fetch('https://edge.sterndesk.com/rpc/rpc.v1.RootService/WhoAmI', 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://edge.sterndesk.com/rpc/rpc.v1.RootService/WhoAmI",
  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([
    'echo' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Connect-Protocol-Version: <connect-protocol-version>",
    "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://edge.sterndesk.com/rpc/rpc.v1.RootService/WhoAmI"

	payload := strings.NewReader("{\n  \"echo\": \"<string>\"\n}")

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

	req.Header.Add("Connect-Protocol-Version", "<connect-protocol-version>")
	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://edge.sterndesk.com/rpc/rpc.v1.RootService/WhoAmI")
  .header("Connect-Protocol-Version", "<connect-protocol-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"echo\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://edge.sterndesk.com/rpc/rpc.v1.RootService/WhoAmI")

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

request = Net::HTTP::Post.new(url)
request["Connect-Protocol-Version"] = '<connect-protocol-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"echo\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "primaryEmail": "<string>",
  "emailVerified": true,
  "givenName": "<string>",
  "familyName": "<string>",
  "backendVersion": "<string>",
  "impersonatorEmail": "<string>",
  "organizationId": "<string>",
  "organizationName": "<string>",
  "organizationRole": "<string>",
  "organizationIsSetupBasic": true,
  "organization": {
    "id": "<string>",
    "name": "<string>",
    "role": "<string>",
    "isSetupBasic": true,
    "slug": "<string>"
  },
  "isSetupBasic": true,
  "primaryPhoneE164": "<string>",
  "secondaryPhoneE164": "<string>",
  "preferences": {
    "notShowGettingStarted": true
  },
  "echo": "<string>"
}

{
  "code": "not_found",
  "message": "<string>",
  "details": [
    {
      "type": "<string>",
      "value": "<string>",
      "debug": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Personal API key, sent as Authorization: Bearer <key>.

Headers

Connect-Protocol-Version

number

required

Define the version of the Connect protocol

Example:

1

Connect-Timeout-Ms

number

Define the timeout, in ms

Example:

1000

Body

application/json

request for information about the current authenticated user

echo

string

a message that will be returned to the user for debugging and development

Required string length: 1 - 128

Response

Success

response with information about the current authenticated user

string

user id of the current authenticated user

primaryEmail

string

email of the currently logged-in user

emailVerified

boolean

if an email has been verified

givenName

string | null

given name of the currently logged-in user (if any)

familyName

string | null

family name of the currently logged-in user (if any)

backendVersion

string

version of the backend, handy for debugging

impersonatorEmail

string | null

if the current user is impersonating someone, the impersonator's email is set here.

organizationId

string | null

deprecated

id of the organization the user is a member of (if any)

organizationName

string | null

deprecated

name of the organization the user is a member of (if any)

organizationRole

string | null

deprecated

role of the user in the organization (if any)

organizationIsSetupBasic

boolean | null

deprecated

whether the user's organization has been set up with the basic configuration.

organization

organization · object

info of the active organization. This replaces the separate fields above.

Show child attributes

isSetupBasic

boolean

if the user has been setup with basic information

primaryPhoneE164

string | null

primary phone nr in e164 format

secondaryPhoneE164

string | null

secondary phone nr in e164 format

preferences

preferences · object

user's preferences

Show child attributes

echo

string

the input echo returned to the user for debugging and development

Overview

Endpoints

Authorizations

Headers

Body

Response