Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,9 @@ navigation:
# path: pages/get-started/what-is-agentmail.mdx
- section: Core Concepts
contents:
- page: Organizations
icon: fa-solid fa-building
path: pages/core-concepts/organizations.mdx
- page: Inboxes
icon: fa-solid fa-inbox
path: pages/core-concepts/inboxes.mdx
Expand Down Expand Up @@ -245,6 +248,7 @@ navigation:
python: agentmail
typescript: agentmail
layout:
- organizations
- inboxes
- threads
- messages
Expand Down
64 changes: 64 additions & 0 deletions fern/pages/core-concepts/organizations.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
title: Organizations
subtitle: The top-level container for all your AgentMail resources.
slug: organizations
description: Learn how Organizations serve as the root entity that contains all your Inboxes, Domains, and API keys.
---

## What is an Organization?

An `Organization` is the top-level entity in AgentMail that acts as a container for all your resources. When you sign up for AgentMail, an organization is automatically created for you.

Your organization holds:
- **Inboxes**: All the email accounts your agents use
- **Domains**: Custom domains you've configured for sending emails
- **API Keys**: Credentials for programmatic access
- **Pods**: Groups of inboxes for organization

## Retrieving Your Organization

You can retrieve your organization details programmatically:

<CodeBlocks>

```python
from agentmail import AgentMail

# Initialize the client
client = AgentMail(api_key="YOUR_API_KEY")

# Get your organization details
org = client.organizations.get()

print(f"Organization ID: {org.organization_id}")
print(f"Created at: {org.created_at}")
```

```typescript
import { AgentMailClient } from "agentmail";

// Initialize the client
const client = new AgentMailClient({ apiKey: "YOUR_API_KEY" });

// Get your organization details
const org = await client.organizations.get();

console.log(`Organization ID: ${org.organizationId}`);
console.log(`Created at: ${org.createdAt}`);
```

</CodeBlocks>

## Organization Response

The `get` endpoint returns the following fields:

| Field | Type | Description |
|-------|------|-------------|
| `organization_id` | string | Unique identifier for your organization |
| `created_at` | datetime | When the organization was created |
| `updated_at` | datetime | When the organization was last updated |

<Tip>
We're actively building more organization-level features. Stay tuned for upcoming updates!
</Tip>
Loading