Skip to content
MailDock Docs

/mail/contacts

GET
/mail/contacts
curl --request GET \
  --url 'https://example.com/api/v1/mail/contacts?limit=10' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
q
string
<= 100 characters
limit
integer
default: 10 >= 1 <= 50

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
Array<object>
object
address
required
string
name
required
Any of:
string
count
required
integer
>= -9007199254740991 <= 9007199254740991
lastUsed
required
Any of:
string
Examplegenerated
[
  {
    "address": "example",
    "name": "example",
    "count": 1,
    "lastUsed": "example"
  }
]