Mason Platform APIs

The Mason Platform API is a series of REST routes that enable customers to perform operations against their fleet of devices using common internet standards of HTTP and OAuth.

Quick links

• Authorization Headers
• Pagination Parameters
• HTTP Status Codes
• Groups API
• Devices API
• Connectivity Usage API
• Connectivity SIM API

Authorization

All public Mason Platform APIs are authenticated, meaning you must supply an Authorization header on every request.

The Authorization header should include an API key with scopes that match the required scopes of the resource you are trying to access or update.

Visit our guide for creating an API key if you have not made one before

Sample request(s)

$ curl -H "Authorization: basic $API_KEY" api.bymason.com/v1/default/device  

Pagination

Some of Mason's Platform API responses are paged by default, typically when we expect the resource that is being accessed to have many entries.

If a resource is paged, you can control the pagination logic using the following query parameters

Pagination Parameters

limit can be combined with before and after params

When resources are paged, the following response attributes will be added to the response body you would normally see if the response is not paged.

Example Response (JSON)

{
    ...,
    "prevPage": "BEFORE_KEY",
    "nextPage": "AFTER_KEY"
}

Errors

The following explains how errors are formatted in Mason Platform APIs

Error JSON

For responses other than 200, the following format is expected:

{
  "type": <error_type_category>,
  "message": <error_message>
}

Example:

{
  "type": "authentication_error",
  "message": ""Required authorization token not found"
}

HTTP Status Codes

The Mason API will return the following status codes