Mailisk

Appearance

v1.0

Mailisk REST API​

Download OpenAPI Document

REST API for Mailisk

Contact​

Mailisk/support@mailisk.com

Servers​

https://api.mailisk.com

List all SMS numbers for user​

GET
/api/sms/numbers

Authorizations​

ApiKey
TypeAPI Key (header: X-Api-Key)

Responses​

application/json
JSON
{
"total_count": 0,
"data": [
{
"id": "string",
"organisation_id": "string",
"status": "string",
"country": "string",
"phone_number": "string",
"created_at": "string",
"updated_at": "string"
}
]
}

Playground​

Server
Authorization

Samples​

List all SMS messages for a number​

GET
/api/sms/{phone_number}/messages

Authorizations​

ApiKey
TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

phone_number*
Typestring
Required

Query Parameters

limit*
Typenumber
Required
minimum1
maximum100
default20
offset*
Typenumber
Required
minimum0
default0
body
Typestring
from_number
Typestring
from_date
Typestring
to_date
Typestring
wait
Typeboolean
defaultfalse

Responses​

application/json
JSON
{
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Get latest SMS message for a number​

GET
/api/sms/{phone_number}/latest

Authorizations​

ApiKey
TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

phone_number*
Typestring
Required

Responses​

application/json
JSON
{
"data": {
"id": "string",
"sms_phone_number_id": "string",
"body": "string",
"from_number": "string",
"to_number": "string",
"provider_message_id": "string",
"created_at": "string",
"direction": "string"
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Create a virtual inbound SMS message​

POST
/api/sms/virtual

Authorizations​

ApiKey
TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"from_number": "string",
"to_number": "string",
"body": "string"
}

Responses​

Playground​

Server
Authorization
Body

Samples​

Update namespace settings​

POST
/api/namespace/{namespace}/settings

Authorizations​

ApiKey
TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

namespace*
Typestring
Required

Request Body​

application/json
JSON
{
"retention_time": 0
}

Responses​

application/json
JSON
{
"id": "string",
"namespace": "string",
"shared": true,
"settings": {
"retention_time": 0
}
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

List all namespaces for user​

GET
/api/namespaces

Authorizations​

ApiKey
TypeAPI Key (header: X-Api-Key)

Responses​

application/json
JSON
{
"total_count": 0,
"data": [
{
"id": "string",
"namespace": "string",
"shared": true,
"shared_organisation_id": "string",
"settings": {
"retention_time": 0
}
}
]
}

Playground​

Server
Authorization

Samples​

Search emails in inbox​

GET
/api/emails/{namespace}/inbox

This endpoint returns the latest emails from a specific namespace's inbox

Authorizations​

ApiKey
TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

namespace*
Typestring
Required

Query Parameters

limit*

The maximum number of emails that can be returned in this request. Must be between 1 and 20

Typenumber
Required
Example10
minimum1
maximum20
default10
offset*

The number of emails to skip/ignore, useful for pagination

Typenumber
Required
Example0
minimum0
default0
from_timestamp

Filter emails by starting unix timestamp in seconds

Typenumber
Example1714857600
minimum0
to_timestamp

Filter emails by ending unix timestamp in seconds

Typenumber
Example1714857600
minimum0
to_addr_prefix

Filter emails by 'to' address. Address must start with this. Example: 'foo' would return for 'foobar@...' but not 'barfoo@...'

Typestring
Exampleexample
from_addr_includes

Filter emails by 'from' address. Address must contain this. Example: 'foo' would return for 'foobar@...' but not 'barfoo@...'

Typestring
Exampleexample
subject_includes

Filter emails by subject. This is case insensitive. Subject must include this. Example: 'password' would return for 'Password reset', 'Reset password notification' but not 'Reset'

Typestring
Exampleexample
wait

If this flag is true then the request will keep waiting till at least one response is returned

Typeboolean
Exampletrue

Responses​

application/json
JSON
{
"total_count": 0,
"options": {
},
"data": [
{
"id": "string",
"from": {
},
"to": [
{
}
],
"cc": [
{
}
],
"bcc": [
{
}
],
"subject": "string",
"html": "string",
"text": "string",
"received_date": "string",
"received_timestamp": 0,
"expires_timestamp": 0,
"spam_score": 0,
"headers": {
},
"attachments": [
{
}
]
}
]
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Get latest email from namespace​

GET
/api/emails/{namespace}/latest

Authorizations​

ApiKey
TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

namespace*
Typestring
Required

Responses​

application/json
JSON
{
"data": {
"id": "string",
"from": {
},
"to": [
{
}
],
"cc": [
{
}
],
"bcc": [
{
}
],
"subject": "string",
"html": "string",
"text": "string",
"received_date": "string",
"received_timestamp": 0,
"expires_timestamp": 0,
"spam_score": 0,
"headers": {
},
"attachments": [
{
}
]
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Get email attachment​

GET
/api/attachments/{id}

Authorizations​

ApiKey
TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Typestring
Required

Responses​

application/json
JSON
{
"data": {
"id": "string",
"filename": "string",
"content_type": "string",
"size": 0,
"expires_at": "string",
"download_url": "string"
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Get SMTP settings for namespace​

GET
/api/smtp/{namespace}

Authorizations​

ApiKey
TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

namespace*
Typestring
Required

Responses​

application/json
JSON
{
"data": {
"host": "string",
"port": 0,
"username": "string",
"password": "string"
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Get shared email by encoded ID​

GET
/api/share/email/{encodedEmailId}

Authorizations​

ApiKey
TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

encodedEmailId*
Typestring
Required

Responses​

application/json
JSON
{
"data": {
"id": "string",
"from": {
},
"to": [
{
}
],
"cc": [
{
}
],
"bcc": [
{
}
],
"subject": "string",
"html": "string",
"text": "string",
"received_date": "string",
"received_timestamp": 0,
"expires_timestamp": 0,
"spam_score": 0,
"headers": {
},
"attachments": [
{
}
]
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Get shared email attachment​

GET
/api/share/email/{encodedEmailId}/attachment/{attachmentId}

Authorizations​

ApiKey
TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

encodedEmailId*
Typestring
Required
attachmentId*
Typestring
Required

Responses​

application/json
JSON
{
"data": {
"id": "string",
"filename": "string",
"content_type": "string",
"size": 0,
"expires_at": "string",
"download_url": "string"
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​