Skip to main content
Now that you understand authentication, let’s make your first API requests to get familiar with the Team API.
Before making requests, you’ll need a Team API token. See API Tokens for detailed instructions on creating and managing tokens.

​
Get Team Details

Retrieve information about your team including name, plan, tier, and verification status. 
curl -X GET "https://api.lettermint.co/v1/team" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TEAM_TOKEN"
Response: 
{
  "id": "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
  "name": "Acme Corp",
  "plan": "starter",
  "tier": "10000",
  "verified_at": "2024-01-15T10:30:00.000Z",
  "created_at": "2024-01-01T00:00:00.000Z"
}

​
List Your Domains

Retrieve all verified domains in your team. This endpoint supports cursor-based pagination. 
curl -X GET "https://api.lettermint.co/v1/domains?page[size]=30" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TEAM_TOKEN"
Response: 
{
  "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. 
curl -X POST "https://api.lettermint.co/v1/projects" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TEAM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production App"
  }'
Success Response (201): 
{
  "data": {
    "id": "5f4e3d2c",
    "name": "Production App",
    "smtp_enabled": false,
    "created_at": "2024-01-20T15:45:00.000Z"
  },
  "message": "Project created successfully."
}
Validation Error (422): 
{
  "message": "The name field is required.",
  "errors": {
    "name": ["The name field is required."]
  }
}
API token activity log showing successful requests in the dashboard
Use descriptive names for your resources to make them easier to identify in the dashboard and API responses.

​
Next Steps