API Reference

Search…
API Reference
The Seam API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Request/Response Format

All request submitting parameters must set their Content-Type to application/json. Nonconforming requests will not be accepted.
You can set your request content-type by adding the Content-Type: application/json header to your Seam API request.
The default response format is JSON. Successful requests will return a 200 OK HTTP status.
Some general information about responses:
Dates are returned in ISO8601 format: YYYY-MM-DDTHH:MM:SS.
Resource IDs are returned as integers or uuids.
post
https://api.getseam.com/v1
/devices/DEVICE_ID/actions/ACTION_NAME
Perform an Action
HTTPS/SSL
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail (see Authentication Section).

Errors
Seam uses conventional HTTP response codes to indicate the success or failure of an API request.
In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a resource is not authorized for writes, etc.). Codes in the 5xx range indicate an error with Seam's servers (these are rare).
Below are a few examples of such errors:
Status Code
Meaning
400
Bad Request -- Your request is invalid.
401
Unauthorized -- Couldn't authenticate your request
403
Invalid scope -- User hasn’t authorized necessary scope
500
Internal Server Error -- Server error
Key Terminology
Authentication
Last modified 6mo ago
Copy link
Contents
Request/Response Format