Member Management API

Owned by Meredith Apfelbaum
Nov 09, 2023
13 min read

User API

Active911 attempts to make interacting with your account as easy as possible though our web portal. However, we understand that there are circumstances where clients may prefer to perform certain operations using API calls, rather than through the web portal.

The User API is a public API that allows an authenticated user to perform a select number of operations. These endpoints all require an access token passed in the authorization header, which is used to verify the user’s identity and permission levels.

For technical documentation on how to generate an access token, see: https://active911.atlassian.net/wiki/spaces/ACTIVE911/pages/2001174540

API Endpoints

Unless otherwise stated, all endpoints are rate limited at 25 requests per minute. Each endpoint requires an access token, named a911Access, to be passed in the Authorization header. For convenience, an optional refresh token can be passed in as a cookie, named a911Auth, and if your access token is expired it will be refreshed and returned to you.

To utilize these endpoints, the access token that is provided must correspond to a member with the necessary permissions in the agency in which the action is being performed.

  1. Retrieve a list of Your Agencies

  2. Create a Member

  3. Bulk Create Members

  4. Delete a Member

Retrieve a list of your Agencies

Most Requests require knowing the agency and member ID being modified. This can be found by retrieving the agency data as outlined in this call. This call will return a list of all agencies you have view_agency permission for, along with details of each agency member.

GET

agency-service.active911.com/v2/agencies

Headers

Value Sample
Details

Authorization

a911Access {Access-Token}

Required for all requests

Cookie optional

a911Auth={Refresh-Token}

To auto-refresh access token

Response Data

Attribute
Description
Type

success

Whether the request succeeded

boolean

result

An Array of agencies you are a member of

JSON

message

Error message if the request failed

string

code

HTTP response code

number

token

The potentially refreshed access token

string

Sample Request

CURL Request
curl --location 'https://agency-service.active911.com/v2/agencies' \ --header 'Authorization: a911Access eyJhbGciOiJSUzUxMiJ9.eyJleHAiOjE2OTgyNTc4ODg3ODksInN1YiI6ImY0MTY1NDFiLWE5ZWItNDkwNy1hYTE3LWZhYTQwMDFiZWNhNiIsInNjb3BlIjoiYWNjZXNzIiwiaWF0IjoxNjk4MjU2MDg4fQ.iX0hiXcQX-XFt3sPTDjeZbG_zYED3LrB4nhU9P4O5dWXRi_4E364QAv-yAdyBmev_IV3d0m7A5IXP9WKj6hT9mi4U9xkPxrBcspcbWLpb2PP_4ME3mgvUbT9VSG5sop0t49JBgZVUSqGiU4MRjqJGOAkvY-ZVYcx6uzFpB6lBnNUcjotA-YhsR8wQixGoI-F66t6hlADCPrdhw04Y2o-xwctk7fMmrj6bj2KjOeDx46amUO0URE5qMNZtAoYJ9Kwc9R6lp9ecimDsV2PdlGlf4851bXBUEgIcentuBJedmpDdgPXOrdvgDnUegVyUyyqQBs8CXNpIINNEkQG5jcyUw' \ --header 'Cookie: a911Auth=eyJhbGciOiJSUzUxMiJ9.eyJleHAiOjE3Mjk4MTI5NTcyMDUsInN1YiI6ImY0MTY1NDFiLWE5ZWItNDkwNy1hYTE3LWZhYTQwMDFiZWNhNiIsInN1IjowLCJpYXQiOjE2OTgyNTYwMDV9.B7TXCdNi_ZvUX7JwQPLqjYfCtB_ibgdf0EcC0bgXr7LCSS1_GE13u1aXDpf0ED7wV6eW8fxNUxok7dQZ7wC0FinGWScseJ1SckHmX3VHUccpE2GHzlIwdG3mLnhr6KPViOfJ9w5cvkFaHMrpXOw8WFNv6CxiahiylE3RIBNNdkrLkKYUCwYVpznITferhCQAq80Tz8ormQd3l8Aja49DK3O_okKN4zIDUNqC868xMZUqybiDQBud-ydvBTXKyszbzEW75TTe3G-082GUv32Wj7xdbmKXd7gC0rsPQuw6B38AxTmVTabw-Xnp5wHDTSPIXtSDw-dkXCAwv__YIQpFHw'
Sample Response
{ "success": true, "result": [ { "name": "Agency 1", "id": "3e597c4a-877f-4c62-9f62-21e8635907e2" }, { "name": "Agency 2", "id": "4s36dc4a-a2mk-4d3g-6a4g-3d5h4k8d5ad4" } ], "message": "", "code": "HTTP_API_SUCCESS", "token": "eyJhbGciOiJSUzUxMiJ9.eyJleHAiOjE2OTg3NjkwNzg3MzIsInN1YiI6ImY0MTY1NDFiLWE5ZWItNDkwNy1hYTE3LWZhYTQwMDFiZWNhNiIsInNjb3BlIjoiYWNjZXNzIiwic3UiOjAsImlhdCI6MTY5ODc2NzI3OH0.peBOkgiclZt1XjcRWGHCg-28oRsRtNTU-5Y7dhdN68Lhs0wxOhDz89zP1t_o3W34PRO4Q5LnBj1rq_u6-qaYFykUGItasb3DONqBUo2E2z1QM9hOVowuyfkyig9UfTEU_U28vGqlBTCwSrRtDTrzd8i1j79iwV3HU3VQZuhuKrTJWmVWSIpWE1zrCiIDvB_9_owwi0r3hxQa13usdHCiJitMlEz4EzTWXqOG5j1mVSX47rsCl9PUMEnJZx0QvztszvpkRBdZdAq01LkIjFpxtLkeGT4kJPhKIL33k4FopW7P9QnPy8o22FUfZSI1xhwKEdnGx-FVtLR8TXOkEpy8dA" }

Create a Member

Creates a new member in your agency and sends out an invitation to the member email. requires edit_agency permission.

agency-service.active911.com/v2/agency/:agencyId/member/create

Headers

Header
Value Sample
Details

Authorization

a911Access {Access-Token}

Required for all requests

Cookie optional

a911Auth={Refresh-Token}

To auto-refresh access token

POST Body

Attribute
Description
Type
Attribute
Description
Type

name

The Member’s name

string

email

The Member’s email

string

phone optional

The Member’s phone number

string

permissions

The permissions the Member should have
Note: see expand below for possible values

string []

Member Permission Options

These represent the different permissions that can be assigned to any user in our system. A single user can have zero or more of these permissions per agency.

Permission

Description

Permission

Description

create_alerts

Allow user to create alarms and send them out to all members

edit_agency

Allow user to edit agency settings

edit_assignments

Allow user to edit assignments

edit_devices

Allow user to add, edit, and delete devices from the Devices tab

edit_events

Allow user to edit schedule

edit_family

Allow user to edit family settings/data

edit_locations

Allow user to add, edit, and delete location items from the Locations tab. This includes hydrants, staging areas, stations, etc.

edit_pagegroups

Allow user to create and manage pagegroups

edit_permissions

Allow user to add and delete other users and edit their permissions. Warning: This permission allows a user to grant themselves complete control, and also to pass that control to whomever they choose.

edit_staffing

Allow user to edit staffing

override_assignments

Allow user to override other’s assignments

view_agency

Allow user to view agency statistics and alert email address

view_alerts

Allow user to view past and current alerts/alarms. This includes response details and personnel.

view_assignments

Allow user to view assignments

view_devices

Allow user to view devices in the Devices tab, including phone number and device ID. Warning: Access to device IDs will allow user to connect cell phones to incoming alarms.

view_events

Allow user to view schedule

view_family

Allow user to view family setting/data

Response Data

Attribute
Description
Type

success

Whether the request succeeded

boolean

result

The new Member data as a JSON array

JSON

message

Error message if the request failed

string

code

HTTP response code

number

token

The potentially refreshed access token

string

Sample Request

CURL Request
curl --location 'https://agency-service.active911.com/v2/agency/3e597c4a-877f-4c62-9f62-21e8635907e2/member/create \ --header 'Authorization: a911Access eyJhbGciOiJSUzUxMiJ9.eyJleHAiOjE2OTgyNTc4ODg3ODksInN1YiI6ImY0MTY1NDFiLWE5ZWItNDkwNy1hYTE3LWZhYTQwMDFiZWNhNiIsInNjb3BlIjoiYWNjZXNzIiwiaWF0IjoxNjk4MjU2MDg4fQ.iX0hiXcQX-XFt3sPTDjeZbG_zYED3LrB4nhU9P4O5dWXRi_4E364QAv-yAdyBmev_IV3d0m7A5IXP9WKj6hT9mi4U9xkPxrBcspcbWLpb2PP_4ME3mgvUbT9VSG5sop0t49JBgZVUSqGiU4MRjqJGOAkvY-ZVYcx6uzFpB6lBnNUcjotA-YhsR8wQixGoI-F66t6hlADCPrdhw04Y2o-xwctk7fMmrj6bj2KjOeDx46amUO0URE5qMNZtAoYJ9Kwc9R6lp9ecimDsV2PdlGlf4851bXBUEgIcentuBJedmpDdgPXOrdvgDnUegVyUyyqQBs8CXNpIINNEkQG5jcyUw' \ --header 'Cookie: a911Auth=eyJhbGciOiJSUzUxMiJ9.eyJleHAiOjE3Mjk4MTI5NTcyMDUsInN1YiI6ImY0MTY1NDFiLWE5ZWItNDkwNy1hYTE3LWZhYTQwMDFiZWNhNiIsInN1IjowLCJpYXQiOjE2OTgyNTYwMDV9.B7TXCdNi_ZvUX7JwQPLqjYfCtB_ibgdf0EcC0bgXr7LCSS1_GE13u1aXDpf0ED7wV6eW8fxNUxok7dQZ7wC0FinGWScseJ1SckHmX3VHUccpE2GHzlIwdG3mLnhr6KPViOfJ9w5cvkFaHMrpXOw8WFNv6CxiahiylE3RIBNNdkrLkKYUCwYVpznITferhCQAq80Tz8ormQd3l8Aja49DK3O_okKN4zIDUNqC868xMZUqybiDQBud-ydvBTXKyszbzEW75TTe3G-082GUv32Wj7xdbmKXd7gC0rsPQuw6B38AxTmVTabw-Xnp5wHDTSPIXtSDw-dkXCAwv__YIQpFHw' \ --header 'Content-Type: application/json' \ --data-raw '{ "name": "newUser", "email": "newUser10@example.com", "phone": "1234567890", "permissions": [ "edit_billing", "edit_agency" ] }'
Sample Response

Bulk Create Members

Creates new members in your agency and sends out invitations to the members' email. Requires edit_agency permission.

agency-service.active911.com/v2/agency/:agencyId/member/bulkCreate

Headers

Header
Value Sample
Details

Authorization

a911Access {Access-Token}

Required for all requests

Cookie optional

a911Auth={Refresh-Token}

To auto-refresh access token

POST Body

Attribute
Description
Type
Attribute
Description
Type

members

The list of Members to create

JSON array of objects matching the following format:

Response Body

Attribute
Description
Type

success

Whether the request succeeded

boolean

result

The new Member data as a JSON array

JSON

message

Error message if the request failed

string

code

HTTP response code

number

token

The potentially refreshed access token

string

Sample Request

CURL Request
Sample Response

Delete a Member

Removes a member from your agency. Requires edit_agency permission.

agency-service.active911.com/v2/agency/:agencyid/member/delete/:memberId

Headers

Header
Value Sample
Details

Authorization

a911Access {Access-Token}

Required for all requests

Cookie optional

a911Auth={Refresh-Token}

To auto-refresh access token

Response Body

Attribute
Description
Type

success

Whether the request succeeded

boolean

result

The new Member data as a JSON array

JSON

message

Error message if the request failed

string

code

HTTP response code

number

token

The potentially refreshed access token

string

Sample Request

CURL Request
Sample Response