Skip to main content

​
Base URL

https://dashboard.hologram.io/api/1

​
Authentication

Hologram supports HTTP Basic authentication using API keys. Set the username to apikey and use your API key as the password.

​
Using cURL

curl --verbose GET \
  'https://dashboard.hologram.io/api/1/users/me' \
  -u apikey:YOUR_API_KEY

​
Using authorization header

You can also base64 encode apikey:YOUR_API_KEY and include it in the Authorization header: 
curl --verbose GET \
  'https://dashboard.hologram.io/api/1/users/me' \
  --header "Authorization: Basic BASE64_ENCODED_CREDENTIALS"

​
API access levels

  • Read Access: Available to Editor roles and higher.
  • Write Access: Varies by endpoint based on role access, generally limited to Admin and Manager roles.
Users without appropriate permissions will receive 403 errors for restricted operations.

​
Requests

Request bodies can be provided in either JSON or form-urlencoded formats: 
curl --request POST \
  --header "Content-Type: application/json" \
  --header "Authorization: Basic YOUR_ENCODED_CREDENTIALS" \
  --data '{"deviceid": 56668, "body": "Hello device!"}' \
  'https://dashboard.hologram.io/api/1/sms/incoming'

​
Form-urlencoded format

curl --request POST \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --header "Authorization: Basic YOUR_ENCODED_CREDENTIALS" \
  --data 'deviceid=56668&body=Hello%20device!' \
  'https://dashboard.hologram.io/api/1/sms/incoming'

​
Responses

Important: All Hologram dates and times are in UTC.

​
Response format

All API responses are JSON objects that include the following fields.
​
success
boolean
required
Indicates whether the request was successful.
​
data
object or array
Contains the requested data or information about the operation performed. Only present when success is true.
​
error
string
Information about why the request failed. Only present when success is false.

​
Limited responses

Most GET responses will also include the following fields if a limit is included as part of the query string:

​
Rate limiting

In order to provide a consistent quality of service to all of our customers, we enforce a rate limit on all API requests. If you exceed the rate limit you will receive a HTTP 429 response with a JSON response body like this: 
{
  "success":false,
  "error":"API rate limit exceeded"
}
If you receive this response, you should refrain from making requests for 5-10 seconds and then retry the request.

​
Generating an API key

Find your account API key in the Hologram Dashboard under the Settings section in the main menu, then opening the API page. Your API can be used to access all organizations you are a member of.

​
Organization IDs

Many endpoints accept an orgid parameter to filter for devices within a specific organization. Learn how to find your organization’s in our Help Center guide.
Caution: Keep your API key secure and never store it in publicly accessible places like GitHub repositories.

​
Support

For API support, questiosn, or additional assistance, please contact our support team.