Documentation

API Reference

Create integrations, retrieve data, and automate your team with the Larmbox REST API.

Introduction

The Larmbox API can be used to create, retrieve, update, and delete resources within a team. The API is organized around REST. If you have any questions regarding the use of the API, please contact us.

The API is available to all teams. To use the API, you need to authenticate your requests by including your API key. You can create and manage your API keys in your team's settings, under the integrations tab.

The documentation for each endpoint includes a description of the endpoint, the parameters and request body it accepts, and examples of requests and responses. You may choose which programming language you prefer to view the examples in.

Please refer to the API Terms of Service for terms of use.

Base URL
https://api.larmbox.com
Client libraries
Request examples are shown in cURL.

Authentication

To authenticate your requests, you need to include your API key as a bearer token in the Authorization header. If the API key is missing or invalid, you will receive a 401 Unauthorized response.

API keys can be created and managed in your team's settings, under the integrations tab. You can have multiple API keys active at the same time.

Access to resources is determined by the permissions granted to the API key being used. If the API key does not have the required scope for the endpoint being accessed, you will receive a 403 Forbidden response.

GET/
curl --request GET \
  --url https://api.larmbox.com/ \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json'

Error Handling

The Larmbox API 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), and codes in the 5xx range indicate an error with Larmbox's servers.

HTTP Status Codes
200 - OK
The request was successful.
400 - Bad Request
The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized
No valid API key provided.
403 - Forbidden
The API key does not have the required scope to perform the request.
404 - Not Found
The requested resource does not exist.
429 - Too Many Requests
Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
500, 502, 503, 504 - Server Errors
Something went wrong on Larmbox's end.

Pagination

Endpoints that return a list of resources support pagination. Cursor based pagination is used, and the response includes a cursor field that can be used to fetch the next or previous page of results.

Add the before or after query parameter to the request to specify the cursor to use.

Rate Limiting

The Larmbox API uses a number of safeguards against bursts of incoming traffic to help maximize its stability. Users who send many requests in quick succession might see error responses that show up as status code 429. In general, normal use of the API shouldn’t generate these errors. As a rule of thumb, an average of more than 120 requests per minute for an extended period of time will trigger rate limiting.

Alarm

This is an object representing an alarm.

Attributes

id
string
Unique identifier of the alarm.
createdAt
string
Creation date of the alarm.
updatedAt
string
Last update date of the alarm.
sequence
number
Sequence number of the alarm.
title
object or null
Title of the alarm.
description
object or null
Description of the alarm.
concluded
boolean
Whether the alarm is concluded.
concludedAt
string or null
Date and time when the alarm was concluded. Automatically set to null when an alarm is resumed.
address
object or null
Whether the alarm is concluded.
location
object or null
Location of the alarm. Latitude and longitude.
members
array of object
List of member objects. Undefined if the key does not have permission to read members.
vehicles
array of object
List of vehicle objects. Undefined if the key does not have permission to read vehicles.
creator
object or null
Creator of the alarm.
tags
array of object
List of tag objects. Undefined if the key does not have permission to read tags.
media
array of object
List of media objects. Undefined if the key does not have permission to read media.
Endpoints
The alarm object
{
  "id": "alr_01jehaxsthfzasqb0cs1x19hgb00",
  "createdAt": "2021-01-01T00:00:00.000Z",
  "updatedAt": "2021-01-01T00:00:00.000Z",
  "sequence": 418,
  "title": "Title",
  "description": "Heavy smoke and flames are observed emanating from the second and third floors of the building.",
  "concluded": false,
  "concludedAt": "2021-01-01T00:00:00.000Z",
  "address": {
    "line1": "1 rue de la Paix",
    "line2": "Appartement 1",
    "postalCode": "75000",
    "city": "Paris",
    "province": "Île-de-France",
    "country": "FR"
  },
  "location": {
    "latitude": 60.1699,
    "longitude": 24.9384
  },
  "members": [
    {
      "id": "mem_01jehaxstgf8s8cg8zhp4x835x00",
      "name": "John Doe",
      "firstname": "John",
      "lastname": "Doe",
      "avatar": "John",
      "user": "John",
      "role": null,
      "response": {
        "id": "res_01jehaxstee7ba6ap2wg4zrf0a00",
        "eta": "2021-01-01T00:00:00.000Z"
      },
      "position": {
        "createdAt": "2021-01-01T00:00:00.000Z",
        "latitude": 60.1699,
        "longitude": 24.9384,
        "altitude": 24.9384,
        "speed": 80.4,
        "heading": 90
      }
    }
  ],
  "vehicles": [
    {
      "id": "veh_01jehaxstgf8s8cg8zhg946g4v00",
      "name": "Vehicle 1",
      "type": "firetruck",
      "active": true,
      "assignment": {
        "id": "asg_01jehaxstee7ba6ap2wnxejfva00",
        "status": "at_station"
      },
      "position": {
        "createdAt": "2021-01-01T00:00:00.000Z",
        "latitude": 60.1699,
        "longitude": 24.9384,
        "altitude": 7.3327,
        "speed": 80.4,
        "heading": 90
      }
    }
  ],
  "creator": {
    "type": "key",
    "key": {
      "id": "key_01jehaxstgf8s8cg8zh7q688re00",
      "name": "My Integration"
    },
    "member": {
      "id": "mem_01jehaxstgf8s8cg8zh80v1zzz00",
      "name": "John Doe",
      "firstname": "John",
      "lastname": "Doe",
      "avatar": "https://cdn.larmbox.com/production/user-content/3b147142d911dd80b97ae55e48f215e7dffee604caa93c4d9b72ccdd3ac0fe9b6b502c0f0c1dc145844d67f3fb6a5bd56ddd910856f5534cd4d174ce6d5b9733",
      "user": "usr_01jehaxstgf8s8cg8zhf9sa55m00"
    }
  },
  "tags": [
    {
      "id": "tag_01jehaxstffmasd13gr1rpk62500",
      "name": "Tag 1",
      "color": "#000000",
      "translations": [
        {
          "name": "Tagg 1",
          "locale": "sv"
        }
      ]
    }
  ],
  "media": [
    {
      "id": "med_01jehaxstgf8s8cg8zgxqre00500",
      "description": "Building on fire. Picture taken from the south side.",
      "creator": "mem_01jehaxstgf8s8cg8zh3fhawz400",
      "url": "https://cdn.larmbox.com/production/user-content/3b147142d911dd80b97ae55e48f215e7dffee604caa93c4d9b72ccdd3ac0fe9b6b502c0f0c1dc145844d67f3fb6a5bd56ddd910856f5534cd4d174ce6d5b9733.webp"
    }
  ]
}

Create an alarm

Creates a new alarm.

The following scopes are required to access this endpoint: alarms:create

Attributes

title
string or null
Title of the alarm.
description
string or null
Description of the alarm.
tags
array of string
Array of tag IDs to associate with the alarm.
address
object or string or null
Address of the alarm. If a string is provided, the address will be geocoded.
location
object or null
Location of the alarm. Latitude and longitude. If not provided, the address will be used to geocode the location.
POST/v1/alarms
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "alr_01jehaxsthfzasqb0cs1x19hgb00",
    "createdAt": "2021-01-01T00:00:00.000Z",
    "updatedAt": "2021-01-01T00:00:00.000Z",
    "sequence": 418,
    "title": "Title",
    "description": "Heavy smoke and flames are observed emanating from the second and third floors of the building.",
    "concluded": false,
    "concludedAt": "2021-01-01T00:00:00.000Z",
    "address": {
      "line1": "1 rue de la Paix",
      "line2": "Appartement 1",
      "postalCode": "75000",
      "city": "Paris",
      "province": "Île-de-France",
      "country": "FR"
    },
    "location": {
      "latitude": 60.1699,
      "longitude": 24.9384
    },
    "members": [
      {
        "id": "mem_01jehaxstgf8s8cg8zhp4x835x00",
        "name": "John Doe",
        "firstname": "John",
        "lastname": "Doe",
        "avatar": "John",
        "user": "John",
        "role": null,
        "response": {
          "id": "res_01jehaxstee7ba6ap2wg4zrf0a00",
          "eta": "2021-01-01T00:00:00.000Z"
        },
        "position": {
          "createdAt": "2021-01-01T00:00:00.000Z",
          "latitude": 60.1699,
          "longitude": 24.9384,
          "altitude": 24.9384,
          "speed": 80.4,
          "heading": 90
        }
      }
    ],
    "vehicles": [
      {
        "id": "veh_01jehaxstgf8s8cg8zhg946g4v00",
        "name": "Vehicle 1",
        "type": "firetruck",
        "active": true,
        "assignment": {
          "id": "asg_01jehaxstee7ba6ap2wnxejfva00",
          "status": "at_station"
        },
        "position": {
          "createdAt": "2021-01-01T00:00:00.000Z",
          "latitude": 60.1699,
          "longitude": 24.9384,
          "altitude": 7.3327,
          "speed": 80.4,
          "heading": 90
        }
      }
    ],
    "creator": {
      "type": "key",
      "key": {
        "id": "key_01jehaxstgf8s8cg8zh7q688re00",
        "name": "My Integration"
      },
      "member": {
        "id": "mem_01jehaxstgf8s8cg8zh80v1zzz00",
        "name": "John Doe",
        "firstname": "John",
        "lastname": "Doe",
        "avatar": "https://cdn.larmbox.com/production/user-content/3b147142d911dd80b97ae55e48f215e7dffee604caa93c4d9b72ccdd3ac0fe9b6b502c0f0c1dc145844d67f3fb6a5bd56ddd910856f5534cd4d174ce6d5b9733",
        "user": "usr_01jehaxstgf8s8cg8zhf9sa55m00"
      }
    },
    "tags": [
      {
        "id": "tag_01jehaxstffmasd13gr1rpk62500",
        "name": "Tag 1",
        "color": "#000000",
        "translations": [
          {
            "name": "Tagg 1",
            "locale": "sv"
          }
        ]
      }
    ],
    "media": [
      {
        "id": "med_01jehaxstgf8s8cg8zgxqre00500",
        "description": "Building on fire. Picture taken from the south side.",
        "creator": "mem_01jehaxstgf8s8cg8zh3fhawz400",
        "url": "https://cdn.larmbox.com/production/user-content/3b147142d911dd80b97ae55e48f215e7dffee604caa93c4d9b72ccdd3ac0fe9b6b502c0f0c1dc145844d67f3fb6a5bd56ddd910856f5534cd4d174ce6d5b9733.webp"
      }
    ]
  }
}

List all alarms

Retrieves a list of alarms.

The following scopes are required to access this endpoint: alarms:read

Query

after
string
Cursor for forwards pagination.
before
string
Cursor for backwards pagination.
search
string
Search query.
limit
string
Number of items to return. Defaults to 25. 100 items can be returned at most.
sort
string
Sort direction. Defaults to descending order.
concluded
boolean
If set, only returns alarms that match the concluded state.
GET/v1/alarms
Response
{
  "count": 10,
  "cursor": {
    "before": "dmVoXzAxaDU0bm10OGRyczM5Yzdka3F6ajhrenk3MDA=",
    "after": "dmVoXzAxaDU0bm55c3pnNGFnYmd3YTR4YzF4bnpqMDA="
  },
  "timestamp": 1733601192,
  "data": [
    {
      "id": "alr_01jehaxsthfzasqb0cs1x19hgb00",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "sequence": 418,
      "title": "Title",
      "description": "Heavy smoke and flames are observed emanating from the second and third floors of the building.",
      "concluded": false,
      "concludedAt": "2021-01-01T00:00:00.000Z",
      "address": {
        "line1": "1 rue de la Paix",
        "line2": "Appartement 1",
        "postalCode": "75000",
        "city": "Paris",
        "province": "Île-de-France",
        "country": "FR"
      },
      "location": {
        "latitude": 60.1699,
        "longitude": 24.9384
      },
      "members": [
        {
          "id": "mem_01jehaxstgf8s8cg8zhp4x835x00",
          "name": "John Doe",
          "firstname": "John",
          "lastname": "Doe",
          "avatar": "John",
          "user": "John",
          "role": null,
          "response": {
            "id": "res_01jehaxstee7ba6ap2wg4zrf0a00",
            "eta": "2021-01-01T00:00:00.000Z"
          },
          "position": {
            "createdAt": "2021-01-01T00:00:00.000Z",
            "latitude": 60.1699,
            "longitude": 24.9384,
            "altitude": 24.9384,
            "speed": 80.4,
            "heading": 90
          }
        }
      ],
      "vehicles": [
        {
          "id": "veh_01jehaxstgf8s8cg8zhg946g4v00",
          "name": "Vehicle 1",
          "type": "firetruck",
          "active": true,
          "assignment": {
            "id": "asg_01jehaxstee7ba6ap2wnxejfva00",
            "status": "at_station"
          },
          "position": {
            "createdAt": "2021-01-01T00:00:00.000Z",
            "latitude": 60.1699,
            "longitude": 24.9384,
            "altitude": 7.3327,
            "speed": 80.4,
            "heading": 90
          }
        }
      ],
      "creator": {
        "type": "key",
        "key": {
          "id": "key_01jehaxstgf8s8cg8zh7q688re00",
          "name": "My Integration"
        },
        "member": {
          "id": "mem_01jehaxstgf8s8cg8zh80v1zzz00",
          "name": "John Doe",
          "firstname": "John",
          "lastname": "Doe",
          "avatar": "https://cdn.larmbox.com/production/user-content/3b147142d911dd80b97ae55e48f215e7dffee604caa93c4d9b72ccdd3ac0fe9b6b502c0f0c1dc145844d67f3fb6a5bd56ddd910856f5534cd4d174ce6d5b9733",
          "user": "usr_01jehaxstgf8s8cg8zhf9sa55m00"
        }
      },
      "tags": [
        {
          "id": "tag_01jehaxstffmasd13gr1rpk62500",
          "name": "Tag 1",
          "color": "#000000",
          "translations": [
            {
              "name": "Tagg 1",
              "locale": "sv"
            }
          ]
        }
      ],
      "media": [
        {
          "id": "med_01jehaxstgf8s8cg8zgxqre00500",
          "description": "Building on fire. Picture taken from the south side.",
          "creator": "mem_01jehaxstgf8s8cg8zh3fhawz400",
          "url": "https://cdn.larmbox.com/production/user-content/3b147142d911dd80b97ae55e48f215e7dffee604caa93c4d9b72ccdd3ac0fe9b6b502c0f0c1dc145844d67f3fb6a5bd56ddd910856f5534cd4d174ce6d5b9733.webp"
        }
      ]
    }
  ]
}

Retrieve an alarm

Retrieves an alarm by ID.

The following scopes are required to access this endpoint: alarms:read

Parameters

id
required
string
GET/v1/alarms/{id}
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "alr_01jehaxsthfzasqb0cs1x19hgb00",
    "createdAt": "2021-01-01T00:00:00.000Z",
    "updatedAt": "2021-01-01T00:00:00.000Z",
    "sequence": 418,
    "title": "Title",
    "description": "Heavy smoke and flames are observed emanating from the second and third floors of the building.",
    "concluded": false,
    "concludedAt": "2021-01-01T00:00:00.000Z",
    "address": {
      "line1": "1 rue de la Paix",
      "line2": "Appartement 1",
      "postalCode": "75000",
      "city": "Paris",
      "province": "Île-de-France",
      "country": "FR"
    },
    "location": {
      "latitude": 60.1699,
      "longitude": 24.9384
    },
    "members": [
      {
        "id": "mem_01jehaxstgf8s8cg8zhp4x835x00",
        "name": "John Doe",
        "firstname": "John",
        "lastname": "Doe",
        "avatar": "John",
        "user": "John",
        "role": null,
        "response": {
          "id": "res_01jehaxstee7ba6ap2wg4zrf0a00",
          "eta": "2021-01-01T00:00:00.000Z"
        },
        "position": {
          "createdAt": "2021-01-01T00:00:00.000Z",
          "latitude": 60.1699,
          "longitude": 24.9384,
          "altitude": 24.9384,
          "speed": 80.4,
          "heading": 90
        }
      }
    ],
    "vehicles": [
      {
        "id": "veh_01jehaxstgf8s8cg8zhg946g4v00",
        "name": "Vehicle 1",
        "type": "firetruck",
        "active": true,
        "assignment": {
          "id": "asg_01jehaxstee7ba6ap2wnxejfva00",
          "status": "at_station"
        },
        "position": {
          "createdAt": "2021-01-01T00:00:00.000Z",
          "latitude": 60.1699,
          "longitude": 24.9384,
          "altitude": 7.3327,
          "speed": 80.4,
          "heading": 90
        }
      }
    ],
    "creator": {
      "type": "key",
      "key": {
        "id": "key_01jehaxstgf8s8cg8zh7q688re00",
        "name": "My Integration"
      },
      "member": {
        "id": "mem_01jehaxstgf8s8cg8zh80v1zzz00",
        "name": "John Doe",
        "firstname": "John",
        "lastname": "Doe",
        "avatar": "https://cdn.larmbox.com/production/user-content/3b147142d911dd80b97ae55e48f215e7dffee604caa93c4d9b72ccdd3ac0fe9b6b502c0f0c1dc145844d67f3fb6a5bd56ddd910856f5534cd4d174ce6d5b9733",
        "user": "usr_01jehaxstgf8s8cg8zhf9sa55m00"
      }
    },
    "tags": [
      {
        "id": "tag_01jehaxstffmasd13gr1rpk62500",
        "name": "Tag 1",
        "color": "#000000",
        "translations": [
          {
            "name": "Tagg 1",
            "locale": "sv"
          }
        ]
      }
    ],
    "media": [
      {
        "id": "med_01jehaxstgf8s8cg8zgxqre00500",
        "description": "Building on fire. Picture taken from the south side.",
        "creator": "mem_01jehaxstgf8s8cg8zh3fhawz400",
        "url": "https://cdn.larmbox.com/production/user-content/3b147142d911dd80b97ae55e48f215e7dffee604caa93c4d9b72ccdd3ac0fe9b6b502c0f0c1dc145844d67f3fb6a5bd56ddd910856f5534cd4d174ce6d5b9733.webp"
      }
    ]
  }
}

Update an alarm

Updates an alarm by ID.

The following scopes are required to access this endpoint: alarms:update

Parameters

id
required
string

Attributes

title
object or null
Title of the alarm.
description
object or null
Description of the alarm.
tags
array of string
Array of tag IDs to associate with the alarm.
concluded
boolean
Whether the alarm should be considered concluded.
address
object or string or null
Address of the alarm. If a string is provided, the address will be geocoded.
location
object or null
Location of the alarm. Latitude and longitude. If not provided, the address will be used to geocode the location.
PATCH/v1/alarms/{id}
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "alr_01jehaxsthfzasqb0cs1x19hgb00",
    "createdAt": "2021-01-01T00:00:00.000Z",
    "updatedAt": "2021-01-01T00:00:00.000Z",
    "sequence": 418,
    "title": "Title",
    "description": "Heavy smoke and flames are observed emanating from the second and third floors of the building.",
    "concluded": false,
    "concludedAt": "2021-01-01T00:00:00.000Z",
    "address": {
      "line1": "1 rue de la Paix",
      "line2": "Appartement 1",
      "postalCode": "75000",
      "city": "Paris",
      "province": "Île-de-France",
      "country": "FR"
    },
    "location": {
      "latitude": 60.1699,
      "longitude": 24.9384
    },
    "members": [
      {
        "id": "mem_01jehaxstgf8s8cg8zhp4x835x00",
        "name": "John Doe",
        "firstname": "John",
        "lastname": "Doe",
        "avatar": "John",
        "user": "John",
        "role": null,
        "response": {
          "id": "res_01jehaxstee7ba6ap2wg4zrf0a00",
          "eta": "2021-01-01T00:00:00.000Z"
        },
        "position": {
          "createdAt": "2021-01-01T00:00:00.000Z",
          "latitude": 60.1699,
          "longitude": 24.9384,
          "altitude": 24.9384,
          "speed": 80.4,
          "heading": 90
        }
      }
    ],
    "vehicles": [
      {
        "id": "veh_01jehaxstgf8s8cg8zhg946g4v00",
        "name": "Vehicle 1",
        "type": "firetruck",
        "active": true,
        "assignment": {
          "id": "asg_01jehaxstee7ba6ap2wnxejfva00",
          "status": "at_station"
        },
        "position": {
          "createdAt": "2021-01-01T00:00:00.000Z",
          "latitude": 60.1699,
          "longitude": 24.9384,
          "altitude": 7.3327,
          "speed": 80.4,
          "heading": 90
        }
      }
    ],
    "creator": {
      "type": "key",
      "key": {
        "id": "key_01jehaxstgf8s8cg8zh7q688re00",
        "name": "My Integration"
      },
      "member": {
        "id": "mem_01jehaxstgf8s8cg8zh80v1zzz00",
        "name": "John Doe",
        "firstname": "John",
        "lastname": "Doe",
        "avatar": "https://cdn.larmbox.com/production/user-content/3b147142d911dd80b97ae55e48f215e7dffee604caa93c4d9b72ccdd3ac0fe9b6b502c0f0c1dc145844d67f3fb6a5bd56ddd910856f5534cd4d174ce6d5b9733",
        "user": "usr_01jehaxstgf8s8cg8zhf9sa55m00"
      }
    },
    "tags": [
      {
        "id": "tag_01jehaxstffmasd13gr1rpk62500",
        "name": "Tag 1",
        "color": "#000000",
        "translations": [
          {
            "name": "Tagg 1",
            "locale": "sv"
          }
        ]
      }
    ],
    "media": [
      {
        "id": "med_01jehaxstgf8s8cg8zgxqre00500",
        "description": "Building on fire. Picture taken from the south side.",
        "creator": "mem_01jehaxstgf8s8cg8zh3fhawz400",
        "url": "https://cdn.larmbox.com/production/user-content/3b147142d911dd80b97ae55e48f215e7dffee604caa93c4d9b72ccdd3ac0fe9b6b502c0f0c1dc145844d67f3fb6a5bd56ddd910856f5534cd4d174ce6d5b9733.webp"
      }
    ]
  }
}

Log

The log object represents a log entry. Logs are used to keep track of changes to team settings, roles, tags and vehicles.

Attributes

id
string
Unique identifier for the log entry.
createdAt
string
Creation date of the log entry.
action
string
Action that was performed.
objectId
string or null
Unique identifier of the object that was modified.
changes
array of object
Changes that were made.
actor
object or null
Actor that performed the action.
descriptor
string or null
Text representation of the object that was modified. Usually the name property of the object.
Endpoints
The log object
{
  "id": "log_01jehaxsn0fqk8dfbmvyw7s7x500",
  "createdAt": "2021-01-01T00:00:00.000Z",
  "action": "ROLE_CREATE",
  "objectId": "",
  "changes": [
    {
      "key": "name",
      "from": "name",
      "to": "name"
    }
  ],
  "actor": {
    "type": "member",
    "key": {
      "id": "key_01jehaxsmzemm9c3z4mhtp7e9100",
      "name": "My Integration"
    },
    "member": {
      "id": "mem_01jehaxsmzemm9c3z4mp45egat00",
      "name": "John Doe",
      "firstname": "John",
      "lastname": "Doe",
      "avatar": "Doe",
      "user": "usr_01jehaxsn0fqk8dfbmvrc21qm600"
    }
  },
  "descriptor": "My Role"
}

List all logs

Retrieves a list of logs.

The following scopes are required to access this endpoint: logs:read

Query

after
string
Cursor for forwards pagination.
before
string
Cursor for backwards pagination.
search
string
Search query.
limit
string
Number of items to return. Defaults to 25. 100 items can be returned at most.
sort
string
Sort direction. Defaults to descending order.
GET/v1/logs
Response
{
  "count": 10,
  "cursor": {
    "before": "dmVoXzAxaDU0bm10OGRyczM5Yzdka3F6ajhrenk3MDA=",
    "after": "dmVoXzAxaDU0bm55c3pnNGFnYmd3YTR4YzF4bnpqMDA="
  },
  "timestamp": 1733601192,
  "data": [
    {
      "id": "log_01jehaxsn0fqk8dfbmvyw7s7x500",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "action": "ROLE_CREATE",
      "objectId": "",
      "changes": [
        {
          "key": "name",
          "from": "name",
          "to": "name"
        }
      ],
      "actor": {
        "type": "member",
        "key": {
          "id": "key_01jehaxsmzemm9c3z4mhtp7e9100",
          "name": "My Integration"
        },
        "member": {
          "id": "mem_01jehaxsmzemm9c3z4mp45egat00",
          "name": "John Doe",
          "firstname": "John",
          "lastname": "Doe",
          "avatar": "Doe",
          "user": "usr_01jehaxsn0fqk8dfbmvrc21qm600"
        }
      },
      "descriptor": "My Role"
    }
  ]
}

Retrieve a log

Retrieves a log entry by ID.

The following scopes are required to access this endpoint: logs:read

Parameters

id
required
string
GET/v1/logs/{id}
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "log_01jehaxsn0fqk8dfbmvyw7s7x500",
    "createdAt": "2021-01-01T00:00:00.000Z",
    "action": "ROLE_CREATE",
    "objectId": "",
    "changes": [
      {
        "key": "name",
        "from": "name",
        "to": "name"
      }
    ],
    "actor": {
      "type": "member",
      "key": {
        "id": "key_01jehaxsmzemm9c3z4mhtp7e9100",
        "name": "My Integration"
      },
      "member": {
        "id": "mem_01jehaxsmzemm9c3z4mp45egat00",
        "name": "John Doe",
        "firstname": "John",
        "lastname": "Doe",
        "avatar": "Doe",
        "user": "usr_01jehaxsn0fqk8dfbmvrc21qm600"
      }
    },
    "descriptor": "My Role"
  }
}

Stream

The stream object represents a stream entry, similar to a log entry. Streams are used to keep track of changes within a specific alarm.

Attributes

Endpoints

List alarm stream

Retrieves a list of alarm stream objects.

The following scopes are required to access this endpoint: alarms.stream:read

Parameters

alarm_id
required
string

Query

after
string
Cursor for forwards pagination.
before
string
Cursor for backwards pagination.
search
string
Search query.
limit
string
Number of items to return. Defaults to 25. 100 items can be returned at most.
sort
string
Sort direction. Defaults to descending order.
member
required
string
GET/v1/alarms/{alarm_id}/stream
Response
{
  "count": 10,
  "cursor": {
    "before": "dmVoXzAxaDU0bm10OGRyczM5Yzdka3F6ajhrenk3MDA=",
    "after": "dmVoXzAxaDU0bm55c3pnNGFnYmd3YTR4YzF4bnpqMDA="
  },
  "timestamp": 1733601192,
  "data": [
    {
      "id": "str_01jehaxsn0fqk8dfbmw189f7my00",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "action": "ROLE_CREATE",
      "objectId": "",
      "changes": [
        {
          "key": "name",
          "from": "name",
          "to": "name"
        }
      ],
      "actor": {
        "type": "member",
        "key": {
          "id": "key_01jehaxsmzemm9c3z4mhtp7e9100",
          "name": "My Integration"
        },
        "member": {
          "id": "mem_01jehaxsmzemm9c3z4mp45egat00",
          "name": "John Doe",
          "firstname": "John",
          "lastname": "Doe",
          "avatar": "Doe",
          "user": "usr_01jehaxsn0fqk8dfbmvrc21qm600"
        }
      },
      "descriptor": "My Role",
      "alarm": "alr_01jehaxsn0fqk8dfbmw5qg8s7300"
    }
  ]
}

Response

The response object represents a member response, usually created by a team member. It contains information about the response, such as the estimated time of arrival and the status of the response.

Attributes

id
string or null
Unique identifier for the response.
createdAt
string
Creation date of the response.
updatedAt
string
Last update date of the response.
eta
object or null
Estimated time of arrival.
status
object or null
Estimated time of arrival.
member
object
Member that responded to the alarm.
Endpoints
The response object
{
  "id": "res_01jehaxsrverf9w7756ms51qaz00",
  "createdAt": "2021-01-01T00:00:00.000Z",
  "updatedAt": "2021-01-01T00:00:00.000Z",
  "eta": "2021-01-01T00:00:00.000Z",
  "status": "2021-01-01T00:00:00.000Z",
  "member": {
    "id": "mem_01jehaxsrverf9w7756g6sg4dr00",
    "name": "John Doe",
    "firstname": "John",
    "lastname": "Doe",
    "avatar": "John"
  }
}

Create a response

Creates a new response.

The following scopes are required to access this endpoint: alarms.responses:create

Parameters

alarm_id
required
string

Attributes

member
required
string
Unique identifier for the member.
eta
required
object or null
Estimated time of arrival.
POST/v1/alarms/{alarm_id}/responses
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "res_01jehaxsrverf9w7756ms51qaz00",
    "createdAt": "2021-01-01T00:00:00.000Z",
    "updatedAt": "2021-01-01T00:00:00.000Z",
    "eta": "2021-01-01T00:00:00.000Z",
    "status": "2021-01-01T00:00:00.000Z",
    "member": {
      "id": "mem_01jehaxsrverf9w7756g6sg4dr00",
      "name": "John Doe",
      "firstname": "John",
      "lastname": "Doe",
      "avatar": "John"
    }
  }
}

List all responses

Retrieves a list of responses.

The following scopes are required to access this endpoint: alarms.responses:read

Parameters

alarm_id
required
string

Query

after
string
Cursor for forwards pagination.
before
string
Cursor for backwards pagination.
search
string
Search query.
limit
string
Number of items to return. Defaults to 25. 100 items can be returned at most.
sort
string
Sort direction. Defaults to descending order.
GET/v1/alarms/{alarm_id}/responses
Response
{
  "count": 10,
  "cursor": {
    "before": "dmVoXzAxaDU0bm10OGRyczM5Yzdka3F6ajhrenk3MDA=",
    "after": "dmVoXzAxaDU0bm55c3pnNGFnYmd3YTR4YzF4bnpqMDA="
  },
  "timestamp": 1733601192,
  "data": [
    {
      "id": "res_01jehaxsrverf9w7756ms51qaz00",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "eta": "2021-01-01T00:00:00.000Z",
      "status": "2021-01-01T00:00:00.000Z",
      "member": {
        "id": "mem_01jehaxsrverf9w7756g6sg4dr00",
        "name": "John Doe",
        "firstname": "John",
        "lastname": "Doe",
        "avatar": "John"
      }
    }
  ]
}

Retrieve a response

Retrieves a response by ID.

The following scopes are required to access this endpoint: alarms.responses:read

Parameters

alarm_id
required
string
id
required
string
GET/v1/alarms/{alarm_id}/responses/{id}
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "res_01jehaxsrverf9w7756ms51qaz00",
    "createdAt": "2021-01-01T00:00:00.000Z",
    "updatedAt": "2021-01-01T00:00:00.000Z",
    "eta": "2021-01-01T00:00:00.000Z",
    "status": "2021-01-01T00:00:00.000Z",
    "member": {
      "id": "mem_01jehaxsrverf9w7756g6sg4dr00",
      "name": "John Doe",
      "firstname": "John",
      "lastname": "Doe",
      "avatar": "John"
    }
  }
}

Update a response

Updates a response by ID.

The following scopes are required to access this endpoint: alarms.responses:update

Parameters

alarm_id
required
string
id
required
string

Attributes

eta
required
object or null
Estimated time of arrival.
position
required
boolean or null
Enable or disable position tracking.
PATCH/v1/alarms/{alarm_id}/responses/{id}
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "res_01jehaxsrverf9w7756ms51qaz00",
    "createdAt": "2021-01-01T00:00:00.000Z",
    "updatedAt": "2021-01-01T00:00:00.000Z",
    "eta": "2021-01-01T00:00:00.000Z",
    "status": "2021-01-01T00:00:00.000Z",
    "member": {
      "id": "mem_01jehaxsrverf9w7756g6sg4dr00",
      "name": "John Doe",
      "firstname": "John",
      "lastname": "Doe",
      "avatar": "John"
    }
  }
}

Delete a response

Deletes a response by ID.

The following scopes are required to access this endpoint: alarms.responses:delete

Parameters

alarm_id
required
string
id
required
string
DELETE/v1/alarms/{alarm_id}/responses/{id}
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "res_01jehaxss4fvgvnqphq027seq900"
  }
}

Assignment

The assignment object represents a vehicle response. Assignments are created when a vehicle is assigned to an alarm.

Attributes

id
string
Unique identifier for the vehicle.
createdAt
string
Creation date of the response.
updatedAt
string
Last update date of the response.
status
object or null
Creation date of the vehicle response.
vehicle
object
Vehicle that responded to the alarm.
Endpoints
The assignment object
{
  "id": "asg_01jehaxstyfxx845as6tse5q4r00",
  "createdAt": "2021-01-01T00:00:00.000Z",
  "updatedAt": "2021-01-01T00:00:00.000Z",
  "status": "2021-05-01T00:00:00.000Z",
  "vehicle": {
    "id": "veh_01jehaxstyfxx845as6p5k7c9k00",
    "name": "Vehicle 1",
    "type": "firetruck",
    "active": true,
    "position": {
      "createdAt": "2021-01-01T00:00:00.000Z",
      "latitude": 0,
      "longitude": 0,
      "altitude": 0,
      "speed": 0,
      "heading": 90
    }
  }
}

Create an assignment

Creates a new vehicle assignment.

The following scopes are required to access this endpoint: alarms.assignments:create

Parameters

alarm_id
required
string

Attributes

vehicle
required
string
Unique identifier for the vehicle.
POST/v1/alarms/{alarm_id}/assignments
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "asg_01jehaxstyfxx845as6tse5q4r00",
    "createdAt": "2021-01-01T00:00:00.000Z",
    "updatedAt": "2021-01-01T00:00:00.000Z",
    "status": "2021-05-01T00:00:00.000Z",
    "vehicle": {
      "id": "veh_01jehaxstyfxx845as6p5k7c9k00",
      "name": "Vehicle 1",
      "type": "firetruck",
      "active": true,
      "position": {
        "createdAt": "2021-01-01T00:00:00.000Z",
        "latitude": 0,
        "longitude": 0,
        "altitude": 0,
        "speed": 0,
        "heading": 90
      }
    }
  }
}

List all assignments

Retrieve a list of vehicle assignments.

The following scopes are required to access this endpoint: alarms.assignments:read

Parameters

alarm_id
required
string

Query

after
string
Cursor for forwards pagination.
before
string
Cursor for backwards pagination.
search
string
Search query.
limit
string
Number of items to return. Defaults to 25. 100 items can be returned at most.
sort
string
Sort direction. Defaults to descending order.
GET/v1/alarms/{alarm_id}/assignments
Response
{
  "count": 10,
  "cursor": {
    "before": "dmVoXzAxaDU0bm10OGRyczM5Yzdka3F6ajhrenk3MDA=",
    "after": "dmVoXzAxaDU0bm55c3pnNGFnYmd3YTR4YzF4bnpqMDA="
  },
  "timestamp": 1733601192,
  "data": [
    {
      "id": "asg_01jehaxstyfxx845as6tse5q4r00",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "status": "2021-05-01T00:00:00.000Z",
      "vehicle": {
        "id": "veh_01jehaxstyfxx845as6p5k7c9k00",
        "name": "Vehicle 1",
        "type": "firetruck",
        "active": true,
        "position": {
          "createdAt": "2021-01-01T00:00:00.000Z",
          "latitude": 0,
          "longitude": 0,
          "altitude": 0,
          "speed": 0,
          "heading": 90
        }
      }
    }
  ]
}

Retrieve an assignment

Retrieves a vehicle assignment by ID.

The following scopes are required to access this endpoint: alarms.assignments:read

Parameters

alarm_id
required
string
id
required
string
GET/v1/alarms/{alarm_id}/assignments/{id}
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "asg_01jehaxstyfxx845as6tse5q4r00",
    "createdAt": "2021-01-01T00:00:00.000Z",
    "updatedAt": "2021-01-01T00:00:00.000Z",
    "status": "2021-05-01T00:00:00.000Z",
    "vehicle": {
      "id": "veh_01jehaxstyfxx845as6p5k7c9k00",
      "name": "Vehicle 1",
      "type": "firetruck",
      "active": true,
      "position": {
        "createdAt": "2021-01-01T00:00:00.000Z",
        "latitude": 0,
        "longitude": 0,
        "altitude": 0,
        "speed": 0,
        "heading": 90
      }
    }
  }
}

Delete an assignment

Deletes a vehicle assignment by ID.

The following scopes are required to access this endpoint: alarms.assignments:delete

Parameters

alarm_id
required
string
id
required
string
DELETE/v1/alarms/{alarm_id}/assignments/{id}
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "asg_01jehaxstzf71t1tj6zpwfth6q00"
  }
}

Media

The media object represents a media file, such as an image or video. A media object can be attached to an alarm.

Attributes

id
string
Unique identifier of the media.
createdAt
string
Creation date of the media.
updatedAt
string
Last update date of the media.
description
object or null
Description of the media.
alarm
string
ID of the alarm the media is attached to.
creator
object or object or null
Creator of the media.
url
string
Absolute URL of the media.
Endpoints
The media object
{
  "id": "med_01jehaxsv8frea36nh4zzqjdvc00",
  "createdAt": "2021-01-01T00:00:00.000Z",
  "updatedAt": "2021-01-01T00:00:00.000Z",
  "description": "Building on fire. Picture taken from the south side.",
  "alarm": "alr_01jehaxsv8frea36nh50pvkw4d00",
  "creator": null,
  "url": "https://cdn.larmbox.com/production/user-content/3b147142d911dd80b97ae55e48f215e7dffee604caa93c4d9b72ccdd3ac0fe9b6b502c0f0c1dc145844d67f3fb6a5bd56ddd910856f5534cd4d174ce6d5b9733"
}

Create a media object

Creates a new media object.

The following scopes are required to access this endpoint: alarms.media:create

Parameters

alarm_id
required
string

Attributes

file
required
string
Base64 encoded file.
description
object or null
Description of the media object.
POST/v1/alarms/{alarm_id}/media
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "med_01jehaxsv8frea36nh4zzqjdvc00",
    "createdAt": "2021-01-01T00:00:00.000Z",
    "updatedAt": "2021-01-01T00:00:00.000Z",
    "description": "Building on fire. Picture taken from the south side.",
    "alarm": "alr_01jehaxsv8frea36nh50pvkw4d00",
    "creator": null,
    "url": "https://cdn.larmbox.com/production/user-content/3b147142d911dd80b97ae55e48f215e7dffee604caa93c4d9b72ccdd3ac0fe9b6b502c0f0c1dc145844d67f3fb6a5bd56ddd910856f5534cd4d174ce6d5b9733"
  }
}

List all media objects

Retrieves a list of media objects.

The following scopes are required to access this endpoint: alarms.media:read

Parameters

alarm_id
required
string

Query

after
string
Cursor for forwards pagination.
before
string
Cursor for backwards pagination.
search
string
Search query.
limit
string
Number of items to return. Defaults to 25. 100 items can be returned at most.
sort
string
Sort direction. Defaults to descending order.
GET/v1/alarms/{alarm_id}/media
Response
{
  "count": 10,
  "cursor": {
    "before": "dmVoXzAxaDU0bm10OGRyczM5Yzdka3F6ajhrenk3MDA=",
    "after": "dmVoXzAxaDU0bm55c3pnNGFnYmd3YTR4YzF4bnpqMDA="
  },
  "timestamp": 1733601192,
  "data": [
    {
      "id": "med_01jehaxsv8frea36nh4zzqjdvc00",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "description": "Building on fire. Picture taken from the south side.",
      "alarm": "alr_01jehaxsv8frea36nh50pvkw4d00",
      "creator": null,
      "url": "https://cdn.larmbox.com/production/user-content/3b147142d911dd80b97ae55e48f215e7dffee604caa93c4d9b72ccdd3ac0fe9b6b502c0f0c1dc145844d67f3fb6a5bd56ddd910856f5534cd4d174ce6d5b9733"
    }
  ]
}

Retrieve a media object

Retrieves a media object by ID.

The following scopes are required to access this endpoint: alarms.media:read

Parameters

alarm_id
required
string
id
required
string
GET/v1/alarms/{alarm_id}/media/{id}
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "med_01jehaxsv8frea36nh4zzqjdvc00",
    "createdAt": "2021-01-01T00:00:00.000Z",
    "updatedAt": "2021-01-01T00:00:00.000Z",
    "description": "Building on fire. Picture taken from the south side.",
    "alarm": "alr_01jehaxsv8frea36nh50pvkw4d00",
    "creator": null,
    "url": "https://cdn.larmbox.com/production/user-content/3b147142d911dd80b97ae55e48f215e7dffee604caa93c4d9b72ccdd3ac0fe9b6b502c0f0c1dc145844d67f3fb6a5bd56ddd910856f5534cd4d174ce6d5b9733"
  }
}

Update a media object

Updates a media object by ID.

The following scopes are required to access this endpoint: alarms.media:update

Parameters

alarm_id
required
string
id
required
string

Attributes

description
required
object or null
Description of the media object.
PATCH/v1/alarms/{alarm_id}/media/{id}
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "med_01jehaxsv8frea36nh4zzqjdvc00",
    "createdAt": "2021-01-01T00:00:00.000Z",
    "updatedAt": "2021-01-01T00:00:00.000Z",
    "description": "Building on fire. Picture taken from the south side.",
    "alarm": "alr_01jehaxsv8frea36nh50pvkw4d00",
    "creator": null,
    "url": "https://cdn.larmbox.com/production/user-content/3b147142d911dd80b97ae55e48f215e7dffee604caa93c4d9b72ccdd3ac0fe9b6b502c0f0c1dc145844d67f3fb6a5bd56ddd910856f5534cd4d174ce6d5b9733"
  }
}

Delete a media object

Deletes a media object by ID.

Parameters

alarm_id
required
string
id
required
string
DELETE/v1/alarms/{alarm_id}/media/{id}
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "med_01jehaxsvcfq0rz5nf6k8py4qv00"
  }
}

Team

The team object a team. A team is the overall organization.

Attributes

id
string
Unique identifier for the team.
createdAt
string
Date when the team was created.
name
string
Name of the team.
invite
string or null
Invite code for the team. Null if key does not have the team.invite:read scope.
avatar
string or null
Avatar of the team.
locale
string
Primary locale of the team.
locales
array of string
List of secondary locales supported by the team.
targetResponseTime
number
The target response time for the team in minutes.
plan
number or null
The subscription plan of the team. Null if the API key does not have the team.plan:read scope.
scope
array of string or null
The scope of the API key. Null if the API key does not have the team.scope:update scope.
Endpoints
The team object
{
  "id": "tea_01jehaxv53e4c8p8sxy2bbwjb600",
  "createdAt": "2021-01-01T00:00:00.000Z",
  "name": "My Team",
  "invite": "ABCDEF",
  "avatar": "https://cdn.larmbox.com/production/user-content/3b147142d911dd80b97ae55e48f215e7dffee604caa93c4d9b72ccdd3ac0fe9b6b502c0f0c1dc145844d67f3fb6a5bd56ddd910856f5534cd4d174ce6d5b9733",
  "locale": "en",
  "locales": [
    "sv",
    "fi"
  ],
  "targetResponseTime": 10,
  "plan": 3.99,
  "scope": [
    "team:read",
    "tags:read",
    "tags:create",
    "tags:update",
    "tags:delete"
  ]
}

Update a team

Updates a team by ID.

The following scopes are required to access this endpoint: team:update

Parameters

id
required
string

Attributes

name
string
Name of the team.
locale
string
Primary locale of the team.
locales
array of string
Secondary locales of the team.
targetResponseTime
number
Target response time of the team, in minutes.
address
object
Address of the team.
location
object
Address of the team.
scope
array of array
Address of the team.
PATCH/v1/teams/{id}
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "tea_01jehaxv53e4c8p8sxy2bbwjb600",
    "createdAt": "2021-01-01T00:00:00.000Z",
    "name": "My Team",
    "invite": "ABCDEF",
    "avatar": "https://cdn.larmbox.com/production/user-content/3b147142d911dd80b97ae55e48f215e7dffee604caa93c4d9b72ccdd3ac0fe9b6b502c0f0c1dc145844d67f3fb6a5bd56ddd910856f5534cd4d174ce6d5b9733",
    "locale": "en",
    "locales": [
      "sv",
      "fi"
    ],
    "targetResponseTime": 10,
    "plan": 3.99,
    "scope": [
      "team:read",
      "tags:read",
      "tags:create",
      "tags:update",
      "tags:delete"
    ]
  }
}

Retrieve a team

Retrieves a team by ID.

The following scopes are required to access this endpoint: team:read

Parameters

id
required
string
GET/v1/teams/{id}
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "tea_01jehaxv53e4c8p8sxy2bbwjb600",
    "createdAt": "2021-01-01T00:00:00.000Z",
    "name": "My Team",
    "invite": "ABCDEF",
    "avatar": "https://cdn.larmbox.com/production/user-content/3b147142d911dd80b97ae55e48f215e7dffee604caa93c4d9b72ccdd3ac0fe9b6b502c0f0c1dc145844d67f3fb6a5bd56ddd910856f5534cd4d174ce6d5b9733",
    "locale": "en",
    "locales": [
      "sv",
      "fi"
    ],
    "targetResponseTime": 10,
    "plan": 3.99,
    "scope": [
      "team:read",
      "tags:read",
      "tags:create",
      "tags:update",
      "tags:delete"
    ]
  }
}

Role

The role object represents a role that can be assigned to a team member. Roles are used to categorize team members.

Attributes

id
string
Unique identifier for the role.
createdAt
string
Date when the role was created.
name
string
Name of the role in the primary team language.
color
string
Role color, in hex format.
members
array of object
List of members that have this role.
translations
array of object
Role name translations for secondary team locales. If no translations exist, the role name will fallback to the primary language.
Endpoints
The role object
{
  "id": "rol_01jehaxstdfexagz72123wz39a00",
  "createdAt": "2021-01-01T00:00:00.000Z",
  "name": "Water Rescue",
  "color": "#ff0000",
  "members": [
    {
      "id": "mem_01jehaxstcfdwr0h44z5rc0sr400",
      "name": "John Doe",
      "firstname": "John",
      "lastname": "Doe",
      "avatar": "https://cdn.larmbox.com/production/user-content/3b147142d911dd80b97ae55e48f215e7dffee604caa93c4d9b72ccdd3ac0fe9b6b502c0f0c1dc145844d67f3fb6a5bd56ddd910856f5534cd4d174ce6d5b9733"
    }
  ],
  "translations": [
    {
      "name": "Dykare",
      "locale": "sv"
    }
  ]
}

Create a role

Creates a new role.

The following scopes are required to access this endpoint: roles:create

Attributes

name
required
string
Name of the role.
color
required
string
Role color, in hex format.
translations
array of object
Translated role names.
POST/v1/roles
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "rol_01jehaxstdfexagz72123wz39a00",
    "createdAt": "2021-01-01T00:00:00.000Z",
    "name": "Water Rescue",
    "color": "#ff0000",
    "members": [
      {
        "id": "mem_01jehaxstcfdwr0h44z5rc0sr400",
        "name": "John Doe",
        "firstname": "John",
        "lastname": "Doe",
        "avatar": "https://cdn.larmbox.com/production/user-content/3b147142d911dd80b97ae55e48f215e7dffee604caa93c4d9b72ccdd3ac0fe9b6b502c0f0c1dc145844d67f3fb6a5bd56ddd910856f5534cd4d174ce6d5b9733"
      }
    ],
    "translations": [
      {
        "name": "Dykare",
        "locale": "sv"
      }
    ]
  }
}

List all roles

Retrieve a list of roles.

The following scopes are required to access this endpoint: roles:read

Query

after
string
Cursor for forwards pagination.
before
string
Cursor for backwards pagination.
search
string
Search query.
limit
string
Number of items to return. Defaults to 25. 100 items can be returned at most.
sort
string
Sort direction. Defaults to descending order.
GET/v1/roles
Response
{
  "count": 10,
  "cursor": {
    "before": "dmVoXzAxaDU0bm10OGRyczM5Yzdka3F6ajhrenk3MDA=",
    "after": "dmVoXzAxaDU0bm55c3pnNGFnYmd3YTR4YzF4bnpqMDA="
  },
  "timestamp": 1733601192,
  "data": [
    {
      "id": "rol_01jehaxstdfexagz72123wz39a00",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "name": "Water Rescue",
      "color": "#ff0000",
      "members": [
        {
          "id": "mem_01jehaxstcfdwr0h44z5rc0sr400",
          "name": "John Doe",
          "firstname": "John",
          "lastname": "Doe",
          "avatar": "https://cdn.larmbox.com/production/user-content/3b147142d911dd80b97ae55e48f215e7dffee604caa93c4d9b72ccdd3ac0fe9b6b502c0f0c1dc145844d67f3fb6a5bd56ddd910856f5534cd4d174ce6d5b9733"
        }
      ],
      "translations": [
        {
          "name": "Dykare",
          "locale": "sv"
        }
      ]
    }
  ]
}

Retrieve a role

Retrieves a role by ID.

The following scopes are required to access this endpoint: roles:read

Parameters

id
required
string
GET/v1/roles/{id}
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "rol_01jehaxstdfexagz72123wz39a00",
    "createdAt": "2021-01-01T00:00:00.000Z",
    "name": "Water Rescue",
    "color": "#ff0000",
    "members": [
      {
        "id": "mem_01jehaxstcfdwr0h44z5rc0sr400",
        "name": "John Doe",
        "firstname": "John",
        "lastname": "Doe",
        "avatar": "https://cdn.larmbox.com/production/user-content/3b147142d911dd80b97ae55e48f215e7dffee604caa93c4d9b72ccdd3ac0fe9b6b502c0f0c1dc145844d67f3fb6a5bd56ddd910856f5534cd4d174ce6d5b9733"
      }
    ],
    "translations": [
      {
        "name": "Dykare",
        "locale": "sv"
      }
    ]
  }
}

Update a role

Updates a role by ID.

The following scopes are required to access this endpoint: roles:update

Parameters

id
required
string

Attributes

name
string
Name of the role in the primary team language.
color
string
Role color, in hex format.
translations
array of object
Role name translations for secondary team languages.
PATCH/v1/roles/{id}
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "rol_01jehaxstdfexagz72123wz39a00",
    "createdAt": "2021-01-01T00:00:00.000Z",
    "name": "Water Rescue",
    "color": "#ff0000",
    "members": [
      {
        "id": "mem_01jehaxstcfdwr0h44z5rc0sr400",
        "name": "John Doe",
        "firstname": "John",
        "lastname": "Doe",
        "avatar": "https://cdn.larmbox.com/production/user-content/3b147142d911dd80b97ae55e48f215e7dffee604caa93c4d9b72ccdd3ac0fe9b6b502c0f0c1dc145844d67f3fb6a5bd56ddd910856f5534cd4d174ce6d5b9733"
      }
    ],
    "translations": [
      {
        "name": "Dykare",
        "locale": "sv"
      }
    ]
  }
}

Delete a role

Deletes a role by ID.

The following scopes are required to access this endpoint: roles:delete

Parameters

id
required
string
DELETE/v1/roles/{id}
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "rol_01jehaxv4cf899se73yhwf00a200"
  }
}

Vehicle

The vehicle object represents a vehicle that can be used to respond to alarms. It contains information about the vehicle, such as the type of vehicle, status and location.

Attributes

id
string
Unique identifier for the vehicle.
createdAt
string
Creation date of the vehicle.
name
string
Name of the vehicle.
type
string
Type or class of vehicle.
active
boolean
Whether the vehicle is active or not. Inactive vehicles are excluded from alarms.
position
object or null
Last known position of the vehicle.
Endpoints
The vehicle object
{
  "id": "veh_01jehaxv86fkz9xgxz7pwgsrr900",
  "createdAt": "2021-05-01T00:00:00.000Z",
  "name": "ABC-123",
  "type": "ambulance",
  "active": true,
  "position": {
    "createdAt": "2021-05-01T00:00:00.000Z",
    "latitude": 60.1699,
    "longitude": 24.9384,
    "altitude": 104.12,
    "speed": 80.4,
    "heading": 90
  }
}

Create a vehicle

Creates a new vehicle.

The following scopes are required to access this endpoint: vehicles:create

Attributes

name
required
string
Name of the vehicle.
type
required
string
Type or class of vehicle.
active
boolean
Whether the vehicle is active or not. Inactive vehicles are excluded from alarms.
POST/v1/vehicles
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "veh_01jehaxv86fkz9xgxz7pwgsrr900",
    "createdAt": "2021-05-01T00:00:00.000Z",
    "name": "ABC-123",
    "type": "ambulance",
    "active": true,
    "position": {
      "createdAt": "2021-05-01T00:00:00.000Z",
      "latitude": 60.1699,
      "longitude": 24.9384,
      "altitude": 104.12,
      "speed": 80.4,
      "heading": 90
    }
  }
}

List all vehicles

Retrieve a list of vehicles.

The following scopes are required to access this endpoint: vehicles:read

Query

after
string
Cursor for forwards pagination.
before
string
Cursor for backwards pagination.
search
string
Search query.
limit
string
Number of items to return. Defaults to 25. 100 items can be returned at most.
sort
string
Sort direction. Defaults to descending order.
GET/v1/vehicles
Response
{
  "count": 10,
  "cursor": {
    "before": "dmVoXzAxaDU0bm10OGRyczM5Yzdka3F6ajhrenk3MDA=",
    "after": "dmVoXzAxaDU0bm55c3pnNGFnYmd3YTR4YzF4bnpqMDA="
  },
  "timestamp": 1733601192,
  "data": [
    {
      "id": "veh_01jehaxv86fkz9xgxz7pwgsrr900",
      "createdAt": "2021-05-01T00:00:00.000Z",
      "name": "ABC-123",
      "type": "ambulance",
      "active": true,
      "position": {
        "createdAt": "2021-05-01T00:00:00.000Z",
        "latitude": 60.1699,
        "longitude": 24.9384,
        "altitude": 104.12,
        "speed": 80.4,
        "heading": 90
      }
    }
  ]
}

Retrieve a vehicle

Retrieve avehicle by ID.

The following scopes are required to access this endpoint: vehicles:read

Parameters

id
required
string
GET/v1/vehicles/{id}
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "veh_01jehaxv86fkz9xgxz7pwgsrr900",
    "createdAt": "2021-05-01T00:00:00.000Z",
    "name": "ABC-123",
    "type": "ambulance",
    "active": true,
    "position": {
      "createdAt": "2021-05-01T00:00:00.000Z",
      "latitude": 60.1699,
      "longitude": 24.9384,
      "altitude": 104.12,
      "speed": 80.4,
      "heading": 90
    }
  }
}

Update a vehicle

Updates a vehicle by ID.

The following scopes are required to access this endpoint: vehicles:update

Parameters

id
required
string

Attributes

name
string
Name of the vehicle.
type
string
Type or class of vehicle.
active
boolean
Whether the vehicle is active or not. Inactive vehicles are excluded from alarms.
PATCH/v1/vehicles/{id}
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "veh_01jehaxv86fkz9xgxz7pwgsrr900",
    "createdAt": "2021-05-01T00:00:00.000Z",
    "name": "ABC-123",
    "type": "ambulance",
    "active": true,
    "position": {
      "createdAt": "2021-05-01T00:00:00.000Z",
      "latitude": 60.1699,
      "longitude": 24.9384,
      "altitude": 104.12,
      "speed": 80.4,
      "heading": 90
    }
  }
}

Delete a vehicle

Deletes a vehicle by ID.

The following scopes are required to access this endpoint: vehicles:delete

Parameters

id
required
string
DELETE/v1/vehicles/{id}
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "veh_01jehaxv8re2r8w5vdny312fwc00"
  }
}

Create a vehicle position

Creates a new position.

Parameters

id
required
string

Attributes

latitude
required
number
Position latitude value.
longitude
required
number
Position longitude value.
altitude
object or null
Reported altitude.
speed
object or null
Reported speed.
heading
object or null
Reported heading.
POST/v1/vehicles/{id}/positions
Response
{
  "timestamp": 1733601192
}

Tag

The tag object represents a tag that can be attached to an alarm. Tags are used to categorize alarms.

Attributes

id
string
Unique identifier for the tag.
createdAt
string
Date when the tag was created.
updatedAt
string
Date when the tag was last updated.
name
string
Tag name in the default language.
color
string
Tag color in hexadecimal format.
translations
array of object
List of permissions that the API key has.
Endpoints
The tag object
{
  "id": "tag_01jehaxv4ve9wvchqz1g73rtk600",
  "createdAt": "2021-01-01T00:00:00.000Z",
  "updatedAt": "2021-01-01T00:00:00.000Z",
  "name": "Tag",
  "color": "#000000",
  "translations": [
    {
      "name": "Tag",
      "locale": "sv"
    }
  ]
}

Create a tag

Creates a new tag.

The following scopes are required to access this endpoint: tags:create

Attributes

name
required
string
Name of the tag.
color
required
string
Tag color, in hex format.
translations
array of object
Translated tag names.
POST/v1/tags
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "tag_01jehaxv4ve9wvchqz1g73rtk600",
    "createdAt": "2021-01-01T00:00:00.000Z",
    "updatedAt": "2021-01-01T00:00:00.000Z",
    "name": "Tag",
    "color": "#000000",
    "translations": [
      {
        "name": "Tag",
        "locale": "sv"
      }
    ]
  }
}

List all tags

Retrieve a list of tags.

The following scopes are required to access this endpoint: tags:read

Query

after
string
Cursor for forwards pagination.
before
string
Cursor for backwards pagination.
search
string
Search query.
limit
string
Number of items to return. Defaults to 25. 100 items can be returned at most.
sort
string
Sort direction. Defaults to descending order.
GET/v1/tags
Response
{
  "count": 10,
  "cursor": {
    "before": "dmVoXzAxaDU0bm10OGRyczM5Yzdka3F6ajhrenk3MDA=",
    "after": "dmVoXzAxaDU0bm55c3pnNGFnYmd3YTR4YzF4bnpqMDA="
  },
  "timestamp": 1733601192,
  "data": [
    {
      "id": "tag_01jehaxv4ve9wvchqz1g73rtk600",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "name": "Tag",
      "color": "#000000",
      "translations": [
        {
          "name": "Tag",
          "locale": "sv"
        }
      ]
    }
  ]
}

Retrieve a tag

Retrieve a tag by ID.

The following scopes are required to access this endpoint: tags:read

Parameters

id
required
string
GET/v1/tags/{id}
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "tag_01jehaxv4ve9wvchqz1g73rtk600",
    "createdAt": "2021-01-01T00:00:00.000Z",
    "updatedAt": "2021-01-01T00:00:00.000Z",
    "name": "Tag",
    "color": "#000000",
    "translations": [
      {
        "name": "Tag",
        "locale": "sv"
      }
    ]
  }
}

Update a tag

Updates a tag by ID.

The following scopes are required to access this endpoint: tags:update

Parameters

id
required
string

Attributes

name
string
Name of the tag.
color
string
Tag color, in hex format.
translations
array of object
Translated tag names.
PATCH/v1/tags/{id}
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "tag_01jehaxv4ve9wvchqz1g73rtk600",
    "createdAt": "2021-01-01T00:00:00.000Z",
    "updatedAt": "2021-01-01T00:00:00.000Z",
    "name": "Tag",
    "color": "#000000",
    "translations": [
      {
        "name": "Tag",
        "locale": "sv"
      }
    ]
  }
}

Delete a tag

Deletes a tag by ID.

The following scopes are required to access this endpoint: tags:delete

Parameters

id
required
string
DELETE/v1/tags/{id}
Response
{
  "timestamp": 1733601192,
  "data": {
    "id": "tag_01jehaxv4yfc7bch1wk9r8vxj000"
  }
}