Get an agent mailbox

GET/api/v2/agent-mailboxes/:id

The mailbox's settings and live state: its autonomy level (effective_autonomy is suggest while the kill switch is on), injection mode, allowlists, and how many automatic sends it has made today.

Needs an API key with the read scope. Scopes

Parameters

Path

idstringrequired

The agent mailbox id, or me with a key made for one mailbox.

Notes

Use me as the id with a key made for one mailbox.

curl -X GET "https://api.koltrix.com/api/v2/agent-mailboxes/me" \
  -H "Authorization: Bearer $KOLTRIX_API_KEY"

const res = await fetch("https://api.koltrix.com/api/v2/agent-mailboxes/me", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.KOLTRIX_API_KEY}`,
  },
});

console.log(res.status, await res.json());

import os, requests

res = requests.get(
    "https://api.koltrix.com/api/v2/agent-mailboxes/me",
    headers={
        "Authorization": f"Bearer {os.environ['KOLTRIX_API_KEY']}",
    },
)
print(res.status_code, res.json())

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.koltrix.com/api/v2/agent-mailboxes/me", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KOLTRIX_API_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode, string(out))
}

<?php

$ch = curl_init("https://api.koltrix.com/api/v2/agent-mailboxes/me");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("KOLTRIX_API_KEY"),
    ],
]);

$response = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), " ", $response;

Success.

{
  "id": "0b6f2c1e-1111-4222-8333-444455556666",
  "email": "[email protected]",
  "name": "Support triager",
  "purpose": "Sorts support mail and drafts first replies",
  "recipe": "support_triager",
  "status": "active",
  "autonomy": "suggest",
  "effective_autonomy": "suggest",
  "injection_mode": "quarantine",
  "allowed_senders": [],
  "allowed_recipients": [],
  "auto": {
    "daily_cap": 0,
    "quiet_hours": {
      "enabled": false,
      "start": "20:00",
      "end": "08:00",
      "timezone": "UTC"
    }
  },
  "sends_today": 0,
  "last_action": null,
  "created_at": "2026-11-05T09:00:00Z"
}

The API key is missing, malformed, unknown or revoked.

{
  "error": "invalid or revoked api key"
}

The key is valid but does not have the read scope.

{
  "error": "missing permission: read"
}

No such record in this workspace.

{
  "error": "agent mailbox not found"
}

More than 60 requests a minute on this key. Wait Retry-After seconds. No code field.

Retry-After: 60

{
  "error": "rate limit exceeded — 60 requests per minute per API key"
}

Try it below with your own key. Every sample reads the key from KOLTRIX_API_KEY.

Try it

Send this request from your browser.

Input

What you send

API key

Stays in this browser tab (sessionStorage) and goes only to api.koltrix.com. Create one under Settings → API keys.

Requests are real. Koltrix has no test mode, so use a dedicated key with only the permissions you need and revoke it when you are done.

idstringrequired

GEThttps://api.koltrix.com/api/v2/agent-mailboxes/me

Output

What comes back

The response appears here.
Press Send request.