Get caller identity and projects

curl --request GET \
  --url https://api.example.com/api/v1/business/whoami

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/business/whoami",
  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.example.com/api/v1/business/whoami"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/business/whoami")

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

{
  "identity": {
    "id": "<string>",
    "email": "<string>",
    "full_name": "<string>",
    "photo_url": "<string>",
    "role": "super_admin",
    "teams": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "role": "owner"
      }
    ]
  },
  "active_workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "projects": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "owner_id": "<string>",
      "root_website": "<string>",
      "project_type": "STANDARD",
      "project_scope": "domain",
      "is_default": true,
      "created_date": "2023-11-07T05:31:56Z",
      "updated_date": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Identity & Project

Get caller identity and projects

Tells you who is calling: their identity, the HQ teams they belong to, and the projects in the workspace they are currently in.

Example: “Who am I? Show my account identity”

Usage: call this first, before anything else. It takes no input and it hands you the project ids you need to scope every other call to a specific project.

Response: your profile (name, email, role, teams), the active workspace id, and the list of projects in that workspace with each project’s id, name, and website.

GET

api

business

whoami

Get caller identity and projects

curl --request GET \
  --url https://api.example.com/api/v1/business/whoami

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/business/whoami",
  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.example.com/api/v1/business/whoami"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/business/whoami")

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

{
  "identity": {
    "id": "<string>",
    "email": "<string>",
    "full_name": "<string>",
    "photo_url": "<string>",
    "role": "super_admin",
    "teams": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "role": "owner"
      }
    ]
  },
  "active_workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "projects": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "owner_id": "<string>",
      "root_website": "<string>",
      "project_type": "STANDARD",
      "project_scope": "domain",
      "is_default": true,
      "created_date": "2023-11-07T05:31:56Z",
      "updated_date": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Headers

X-Workspace-Id

string<uuid> | null

Overrides the key's workspace

X-API-Key

string | null

User API key

Response

Successful Response

identity

MeResponse · object

required

Show child attributes

active_workspace_id

string<uuid> | null

The user's active workspace, scoping the projects below.

projects

ProjectSummary · object[]

Projects in the active workspace; empty when no workspace is resolved.

Show child attributes

⌘I

Getting Started

Identity & Project

Tasks

Agent Runs

Playbooks

Grids

Knowledge Base & Brand Kit

Pages

Integrations & Attachments

Get caller identity and projects

Headers

Response