Team

Download schema

Get team details

GET

https://api.lettermint.co/v1

/team

Bearer

Returns basic team information with optional includes for related resources.

Get team details › query Parameters

include

string[]

Enum values:

features

addons

Get team details › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get team details › Responses

200

TeamData

TeamData

id

string · required

name

string · required

type

TeamType · enum · required

Enum values:

personal

business

plan

Plan · enum · required

Enum values:

free

starter

growth

pro

included_volume

integer · required

Number of emails included in the team's monthly plan.

verified_at

string | null · date-time · required

created_at

string · date-time · required

features

string[]

TeamAddonData[]

domains_count

integer

projects_count

integer

members_count

integer

Update team settings

PUT

https://api.lettermint.co/v1

/team

Bearer

Updates editable team properties (name).

Update team settings › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Update team settings › Request Body

UpdateTeamData

name

string | null · maxLength: 255

Update team settings › Responses

TeamData · required

message

string · const · required

Const value: Team settings updated successfully.

Get team usage statistics

GET

https://api.lettermint.co/v1

/team/usage

Bearer

Returns current and historical email usage data with billing information. Historical usage includes up to 12 most recent periods.

Get team usage statistics › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get team usage statistics › Responses

200

TeamUsageDetailData

TeamUsageDetailData

TeamUsagePeriodData · required

TeamUsagePeriodData[] · required

Get reusable team roles

GET

https://api.lettermint.co/v1

/team/roles

Bearer

Owner is returned for display but cannot be assigned through the Team API.

Get reusable team roles › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get reusable team roles › Responses

TeamRoleData[] · required

Get team members

GET

https://api.lettermint.co/v1

/team/members

Bearer

Returns role assignments for teams using reusable roles.

Get team members › query Parameters

page[size]

integer

The number of results that will be returned per page.

Default: 30

page[cursor]

string

The cursor to start the pagination from.

Get team members › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get team members › Responses

Paginated set of TeamMemberData

TeamMemberData[] · required

path

string | null · required

Base path for paginator generated URLs.

per_page

integer · min: 0 · required

Number of items shown per page.

next_cursor

string | null · required

The "cursor" that points to the next set of items.

next_page_url

string | null · uri · required

prev_cursor

string | null · required

The "cursor" that points to the previous set of items.

prev_page_url

string | null · uri · required

Get a team member

GET

https://api.lettermint.co/v1

/team/members/{userId}

Bearer

Use the user ID returned by the team-member list.

Get a team member › path Parameters

userId

string · required

Get a team member › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get a team member › Responses

TeamMemberData

TeamMemberData

id

string · required

name

string · required

email

string · required

object · required

TeamMemberProjectAccessData · required

joined_at

string | null · date-time · required

Replace a team member's assignment

PUT

https://api.lettermint.co/v1

/team/members/{userId}/assignment

Bearer

Replaces the member's non-Owner role and complete project scope atomically. Use the user's ID returned by GET /team/members.

Replace a team member's assignment › path Parameters

userId

string · required

Replace a team member's assignment › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Replace a team member's assignment › Request Body

UpdateTeamMemberAssignmentData

role_id

string · uuid · required

object · required

Replace a team member's assignment › Responses

TeamMemberData

TeamMemberData

id

string · required

name

string · required

email

string · required

object · required

TeamMemberProjectAccessData · required

joined_at

string | null · date-time · required

PUT/team/members/{userId}/assignment

curl https://api.lettermint.co/v1/team/members/:userId/assignment \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "role_id": "00000000-0000-0000-0000-000000000000",
  "project_access": {
    "scope": "all",
    "project_ids": [
      "string"
    ]
  }
}'

Example Request Body

{
  "role_id": "00000000-0000-0000-0000-000000000000",
  "project_access": {
    "scope": "all",
    "project_ids": [
      "string"
    ]
  }
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "email": "email",
  "role": {
    "id": "id",
    "name": "name"
  },
  "project_access": {
    "scope": "all",
    "projects": [
      {
        "id": "id",
        "name": "name"
      }
    ]
  },
  "joined_at": "2024-08-25T15:00:00Z"
}

json

application/json

Generic Stats

Lettermint Team API

Team

Download schema

Get team details

GET

https://api.lettermint.co/v1

/team

Bearer

Returns basic team information with optional includes for related resources.

Get team details › query Parameters

include

string[]

Enum values:

features

addons

Get team details › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get team details › Responses

200

TeamData

TeamData

id

string · required

name

string · required

type

TeamType · enum · required

Enum values:

personal

business

plan

Plan · enum · required

Enum values:

free

starter

growth

pro

included_volume

integer · required

Number of emails included in the team's monthly plan.

verified_at

string | null · date-time · required

created_at

string · date-time · required

features

string[]

TeamAddonData[]

domains_count

integer

projects_count

integer

members_count

integer

Update team settings

PUT

https://api.lettermint.co/v1

/team

Bearer

Updates editable team properties (name).

Update team settings › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Update team settings › Request Body

UpdateTeamData

name

string | null · maxLength: 255

Update team settings › Responses

TeamData · required

message

string · const · required

Const value: Team settings updated successfully.

Get team usage statistics

GET

https://api.lettermint.co/v1

/team/usage

Bearer

Returns current and historical email usage data with billing information. Historical usage includes up to 12 most recent periods.

Get team usage statistics › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get team usage statistics › Responses

200

TeamUsageDetailData

TeamUsageDetailData

TeamUsagePeriodData · required

TeamUsagePeriodData[] · required

Get reusable team roles

GET

https://api.lettermint.co/v1

/team/roles

Bearer

Owner is returned for display but cannot be assigned through the Team API.

Get reusable team roles › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get reusable team roles › Responses

TeamRoleData[] · required

Get team members

GET

https://api.lettermint.co/v1

/team/members

Bearer

Returns role assignments for teams using reusable roles.

Get team members › query Parameters

page[size]

integer

The number of results that will be returned per page.

Default: 30

page[cursor]

string

The cursor to start the pagination from.

Get team members › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get team members › Responses

Paginated set of TeamMemberData

TeamMemberData[] · required

path

string | null · required

Base path for paginator generated URLs.

per_page

integer · min: 0 · required

Number of items shown per page.

next_cursor

string | null · required

The "cursor" that points to the next set of items.

next_page_url

string | null · uri · required

prev_cursor

string | null · required

The "cursor" that points to the previous set of items.

prev_page_url

string | null · uri · required

Get a team member

GET

https://api.lettermint.co/v1

/team/members/{userId}

Bearer

Use the user ID returned by the team-member list.

Get a team member › path Parameters

userId

string · required

Get a team member › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get a team member › Responses

TeamMemberData

TeamMemberData

id

string · required

name

string · required

email

string · required

object · required

TeamMemberProjectAccessData · required

joined_at

string | null · date-time · required

Replace a team member's assignment

PUT

https://api.lettermint.co/v1

/team/members/{userId}/assignment

Bearer

Replaces the member's non-Owner role and complete project scope atomically. Use the user's ID returned by GET /team/members.

Replace a team member's assignment › path Parameters

userId

string · required

Replace a team member's assignment › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Replace a team member's assignment › Request Body

UpdateTeamMemberAssignmentData

role_id

string · uuid · required

object · required

Replace a team member's assignment › Responses

TeamMemberData

TeamMemberData

id

string · required

name

string · required

email

string · required

object · required

TeamMemberProjectAccessData · required

joined_at

string | null · date-time · required

PUT/team/members/{userId}/assignment

curl https://api.lettermint.co/v1/team/members/:userId/assignment \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "role_id": "00000000-0000-0000-0000-000000000000",
  "project_access": {
    "scope": "all",
    "project_ids": [
      "string"
    ]
  }
}'

Example Request Body

{
  "role_id": "00000000-0000-0000-0000-000000000000",
  "project_access": {
    "scope": "all",
    "project_ids": [
      "string"
    ]
  }
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "email": "email",
  "role": {
    "id": "id",
    "name": "name"
  },
  "project_access": {
    "scope": "all",
    "projects": [
      {
        "id": "id",
        "name": "name"
      }
    ]
  },
  "joined_at": "2024-08-25T15:00:00Z"
}

json

application/json

Generic Stats