Skip to main content
GET
/
projects
/
{projectId}
Get project details
curl --request GET \
  --url https://api.lettermint.co/v1/projects/{projectId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "smtp_enabled": true,
  "token_generated_at": "2023-11-07T05:31:56Z",
  "token_last_used_at": "2023-11-07T05:31:56Z",
  "token_last_used_ip": "<string>",
  "routes": [
    {
      "id": "<string>",
      "project_id": "<string>",
      "slug": "<string>",
      "name": "<string>",
      "route_type": "transactional",
      "is_default": true,
      "inbound_address": "<string>",
      "inbound_domain": "<string>",
      "inbound_domain_verified_at": "2023-11-07T05:31:56Z",
      "inbound_spam_threshold": 123,
      "project": {},
      "webhooks_count": 123,
      "suppressed_recipients_count": 123,
      "statistics": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "routes_count": 123,
  "domains": [
    {
      "id": "<string>",
      "domain": "<string>",
      "status_changed_at": "2023-11-07T05:31:56Z",
      "dns_records": [
        {
          "id": "<string>",
          "type": "TXT",
          "hostname": "<string>",
          "fqdn": "<string>",
          "content": "<string>",
          "status": "active",
          "verified_at": "<string>",
          "last_checked_at": "2023-11-07T05:31:56Z"
        }
      ],
      "projects": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "domains_count": 123,
  "team_members": [
    {
      "id": "<string>",
      "user": {
        "id": "<string>",
        "name": "<string>",
        "email": "<string>",
        "avatar": "<string>"
      },
      "role": "<string>",
      "joined_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "team_members_count": 123,
  "last_28_days": {
    "messages_transactional": 123,
    "messages_broadcast": 123,
    "messages_inbound": 123,
    "deliverability": 123
  },
  "created_at": "<string>",
  "updated_at": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
projectId
string
required

Query Parameters

​
include
string

Available includes are routes, routesCount, routesExists, domains, domainsCount, domainsExists, teamMembers, teamMembersCount, teamMembersExists, messageStats, messageStatsCount, messageStatsExists. You can include multiple options by separating them with a comma.

Response

200 - application/json

ProjectData

​
id
string
required
​
name
string
required
​
smtp_enabled
boolean
required
​
token_generated_at
string<date-time> | null
required
​
token_last_used_at
string<date-time> | null
required
​
token_last_used_ip
string | null
required
​
created_at
string
required
​
updated_at
string
required
​
routes
RouteData · object[]
​
routes_count
integer
​
domains
DomainData · object[]
​
domains_count
integer
​
team_members
TeamMemberData · object[]
​
team_members_count
integer
​
last_28_days
object | null