Skip to main content
GET
/
v2
/
mail
List Mail
curl --request GET \
  --url https://api.example.com/v2/mail \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "received": "2023-12-25",
    "file_url": "<string>",
    "sender": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
start_date
string<date> | null
​
end_date
string<date> | null
​
region
enum<string> | null
Available options:
AL,
AK,
AZ,
AR,
CA,
CO,
CT,
DE,
DC,
FL,
GA,
HI,
ID,
IL,
IN,
IA,
KS,
KY,
LA,
ME,
MD,
MA,
MI,
MN,
MS,
MO,
MT,
NE,
NV,
NH,
NJ,
NM,
NY,
NC,
ND,
OH,
OK,
OR,
PA,
RI,
SC,
SD,
TN,
TX,
UT,
VT,
VA,
WA,
WV,
WI,
WY
​
legal_entity_public_id
string | null
​
user_or_platform_public_id
string | null
​
platform_public_id
string | null

Response

Successful Response

​
id
string
required
​
type
enum<string>
required
Available options:
registered-agent,
external-mail
​
received
string<date>
required
​
file_url
string
required
​
region
enum<string> | null
Available options:
AL,
AK,
AZ,
AR,
CA,
CO,
CT,
DE,
DC,
FL,
GA,
HI,
ID,
IL,
IN,
IA,
KS,
KY,
LA,
ME,
MD,
MA,
MI,
MN,
MS,
MO,
MT,
NE,
NV,
NH,
NJ,
NM,
NY,
NC,
ND,
OH,
OK,
OR,
PA,
RI,
SC,
SD,
TN,
TX,
UT,
VT,
VA,
WA,
WV,
WI,
WY
​
sender
string | null