Team

Endpointhttps://api.lettermint.co/v1

Get team details

GET

https://api.lettermint.co/v1

/team

Returns basic team information with optional includes for related resources.

Get team details › query Parameters

include

string

Available includes are features, featuresCount, featuresExists. You can include multiple options by separating them with a comma.

Get team details › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get team details › Responses

200

TeamData

id

string · required

name

string · required

plan

string · enum · required

Enum values:

free

starter

growth

pro

tier

integer · enum · required

Enum values:

300

10000

50000

125000

500000

750000

1000000

1500000

verified_at

string | null · date-time · required

created_at

string · date-time · required

features

string[]

object[]

domains_count

integer

projects_count

integer

members_count

integer

Update team settings

PUT

https://api.lettermint.co/v1

/team

Updates editable team properties (name).

Update team settings › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Update team settings › Request Body

name

string | null · maxLength: 255

Update team settings › Responses

object · required

message

string · const · required

Const value: Team settings updated successfully.

Get team usage statistics

GET

https://api.lettermint.co/v1

/team/usage

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

object · required

object[] · required

Get team members

GET

https://api.lettermint.co/v1

/team/members

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

200

Paginated set of TeamMemberData

object[] · 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

Generic Domain

Get team details

GET

https://api.lettermint.co/v1

/team

Returns basic team information with optional includes for related resources.

Get team details › query Parameters

include

string

Available includes are features, featuresCount, featuresExists. You can include multiple options by separating them with a comma.

Get team details › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get team details › Responses

200

TeamData

id

string · required

name

string · required

plan

string · enum · required

Enum values:

free

starter

growth

pro

tier

integer · enum · required

Enum values:

300

10000

50000

125000

500000

750000

1000000

1500000

verified_at

string | null · date-time · required

created_at

string · date-time · required

features

string[]

object[]

domains_count

integer

projects_count

integer

members_count

integer

Update team settings

PUT

https://api.lettermint.co/v1

/team

Updates editable team properties (name).

Update team settings › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Update team settings › Request Body

name

string | null · maxLength: 255

Update team settings › Responses

object · required

message

string · const · required

Const value: Team settings updated successfully.

Get team usage statistics

GET

https://api.lettermint.co/v1

/team/usage

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

object · required

object[] · required

Get team members

GET

https://api.lettermint.co/v1

/team/members

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

200

Paginated set of TeamMemberData

object[] · 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