GET
/
v2
/
mail
[
  {
    "id": "<string>",
    "region": "AL",
    "type": "registered-agent",
    "received": "2023-12-25",
    "sender": "<string>",
    "file_url": "<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

Response

200
application/json

Successful Response

The response is of type PlatformMail · object[].