Copy page

Team API

Quickstart

Now that you understand authentication, let's make your first API requests to get familiar with the Team API.

Get Team Details

Retrieve information about your team including name, plan, included monthly volume, and verification status.

Response:

Code
{
  "id": "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
  "name": "Acme Corp",
  "plan": "starter",
  "included_volume": 10000,
  "tier": 10000,
  "verified_at": "2024-01-15T10:30:00.000Z",
  "created_at": "2024-01-01T00:00:00.000Z"
}

tier is a deprecated compatibility alias for included_volume.

List Your Domains

Retrieve all verified domains in your team. This endpoint supports cursor-based pagination.

Response:

Code
{
  "data": [
    {
      "id": "1a2b3c4d",
      "domain": "example.com",
      "verified_at": "2024-01-15T10:30:00.000Z",
      "created_at": "2024-01-10T00:00:00.000Z"
    }
  ],
  "next_cursor": "eyJpZCI6MTUsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0",
  "next_page_url": "https://api.lettermint.co/v1/domains?page[cursor]=eyJpZCI...",
  "per_page": 30
}

Create a New Project

Create a new project within your team. Projects are used to organize your email sending and contain routes.

Set short_token to true when the generated project token needs to work with printers or older devices that reject long token values. It is optional and defaults to false.

Success Response (201):

Code
{
  "data": {
    "id": "5f4e3d2c",
    "name": "Production App",
    "smtp_enabled": false,
    "default_route_id": "7e6d5c4b",
    "created_at": "2024-01-20T15:45:00.000Z"
  },
  "message": "Project created successfully.",
  "api_token": "lm_example_project_token"
}

Validation Error (422):

Code
{
  "message": "The name field is required.",
  "errors": {
    "name": ["The name field is required."]
  }
}

Next Steps

• Manage member access - Assign roles and project access from an integration
• Reference - Learn about abilities, rate limits, and error handling
• Use Cases & Best Practices - Explore common workflows and production guidance
• API Reference - View complete Team API documentation