logo

MarineTraffic Inbox API (2.0.0)

Download OpenAPI specification:Download

E-mail: customersupport@marinetraffic.com URL: https://www.kpler.com/company/contact-us License: Apache 2.0 Terms of Service

This is the document API and examples to demonstrate features of the MarineTraffic Inbox API specification.

Introduction

The MarineTraffic Inbox API is a RESTful API that allows you to interact with the MarineTraffic Inbox platform.

Requirements

  • Make sure you have an application following this guide

Attachments

Upload an attachment

  • Upload an attachment to the server
  • API rate limit is 20 requests per minute
SecurityOAuth2
Request
Request Body schema: multipart/form-data
file
required
string

The raw content of file to upload

disposition
string
Enum: "inline" "attachment" "link"
Responses
201

created

401

Unauthorized

403

Invalid scope

post/app_api/v1/attachments
Request samples 
Response samples 
application/json
{
  • "id": 0,
  • "original_file_url": "string",
  • "name": "string",
  • "disposition": "link",
  • "size": 0,
  • "content_type": "string"
}
Me
Get Myself Information
    

  • Get information of the current user
    • 

  • API rate limit is 10 requests per minute
    • 



SecurityOAuth2 
Responses 
200
successful


401
Unauthorized


get/app_api/v1/me
Request samples 
Response samples 
application/json
{
  • "id": 0,
  • "avatar": "string",
  • "name": "string",
  • "departments": "string",
  • "user_name": "string"
}
Emails
Send Email
    

  • Send email via api
    • 

  • API rate limit is 10 requests per minute
    • 



SecurityOAuth2 
Request 
Request Body schema: application/json
from
string
 
subject
string
 
body
string
 
body_type
string
 Enum: "plain_text" "html"  
action
string
 Enum: "normal" "reply" "forward" "replyall"  
object
 
object
 
object
 
attachments
Array of integers
array of attachment ids


 
Responses 
200
successful


401
Unauthorized


403
Invalid scope


post/app_api/v1/emails
Request samples 
application/json
{
  • "from": "hello@marinetraffic.com",
  • "body_type": "plain_text",
  • "subject": "hello",
  • "body": "Hi there",
  • "to": {
    },
  • "cc": {
    },
  • "action": "normal"
}
Response samples 
application/json
{
  • "message": "created"
}
Lines
Get Accessible Lines
    

  • Return list of lines which accessible
    • 

  • API rate limit is 30 requests per minute
    • 



SecurityOAuth2 
Responses 
200
successful


401
Unauthorized


get/app_api/v1/lines
Request samples 
Response samples 
application/json
[
  • {
    }
]
Address Book
Get address_books
    

  • Get list address_books
    • 

  • API rate limit is 60 requests per minute
    • 



SecurityOAuth2 
Request 
query Parameters
page
integer
 Default:  1
The page of list address_books


 
per_page
integer
 Default:  10
The number of records per page


 Enum: 10 20 30 40 50  
Responses 
200
It will return the list of address_books with page and per_page


401
unauthorized


get/app_api/v1/address_books
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get detail of AddressBook by ID
    

  • Get detail of AddressBook by ID
    • 

  • API rate limit is 300 requests per minute
    • 



SecurityOAuth2 
Request 
path Parameters
id
required
integer
 Default:  1
This is the id of address_book


 
Responses 
200
It returns the address_book


401
unauthorized


404
the record is not found


get/app_api/v1/address_books/{id}
Request samples 
Response samples 
application/json
{
  • "id": 1,
  • "contact_type": "contact",
  • "name": "chartdesk",
  • "salutation": "Dear Mr.MarineTrffic",
  • "job_title": "this is job_title",
  • "email_address_work_1": "email_address_work_1@marinetraffic.com",
  • "email_address_work_2": "email_address_work_2@marinetraffic.com",
  • "email_address_work_3": "email_address_work_3@marinetraffic.com",
  • "email_address_personal_1": "email_address_personal_1@marinetraffic.com",
  • "email_address_personal_2": "email_address_personal_2@marinetraffic.com",
  • "email_address_personal_3": "email_address_personal_3@marinetraffic.com",
  • "email_address_other_1": "email_address_other_1@marinetraffic.com",
  • "email_address_other_2": "email_address_other_2@marinetraffic.com",
  • "email_address_other_3": "email_address_other_3@marinetraffic.com",
  • "phone_mobile_1": "+380 48 7165731",
  • "phone_mobile_2": "+380 48 7165732",
  • "phone_mobile_3": "+380 48 7165733",
  • "phone_office_1": "+380 48 716573",
  • "phone_office_2": "+380 48 7165732",
  • "phone_office_3": "+380 48 7165733",
  • "phone_fax_1": "+380 48 7165731",
  • "phone_fax_2": "+380 48 7165732",
  • "phone_fax_3": "+380 48 7165733",
  • "phone_other_1": "+380 48 7165731",
  • "phone_other_2": "+380 48 7165732",
  • "phone_other_3": "+380 48 7165733",
  • "im": "string",
  • "company": 0,
  • "department": 0,
  • "post_address": "1, Leytenanta Shmidta Street UA-65012 Odessa",
  • "city": "string",
  • "state": "string",
  • "country": "VietNam",
  • "web_url": "https://marinetraffic.com/",
  • "notes": "First note Second note"
}