Organization API specification (3.4.0)

Download OpenAPI specification:Download

The organization service implements a the organization logic in GroupAlarm.

Authentication

API_Token

To use this API, you need an API-Token from the RBAC settings of your GroupAlarm organization. Place the token inside the HTTP-Header API-Token for every request, otherwise the API will return an "401 Unauthorized" error for your request.

Security Scheme Type	API Key
Header parameter name:	API-TOKEN

Personal-Access-Token

To use this API, you need a Personal Access Token from your profile settings. Place the token inside the HTTP-Header Personal-Access-Token for every request, otherwise the API will return an "401 Unauthorized" error for your request.

Security Scheme Type	API Key
Header parameter name:	Personal-Access-Token

organization

UpdateOrganization

Update an existing organization with passed organization payload

Request Body schema: application/json

organization payload

availableUsers	object (AvailableUsersCount) AvailableUsersCount payload
availableUsersTotal	object (AvailableUsersCount) AvailableUsersCount payload
avatarURL	string AvatarURL
creationDate	string <date-time> CreationDate of the organization
description	string user defined description
hasChildren	boolean defines if it's the parent of any other organization
id	integer <int64> ID of this organization
location	object (OrganizationLocation) OrganizationLocation describes the location payload
name	string user defined name
ownerIDs	Array of integers <int64> user id of the organization owner/creator
parentID	integer <int64> optional: ID of the parent organization
state	string (OrganizationState) OrganizationState represents the current state of an organization, like trial, active, inactive
tags	Array of strings Tags are used for internal purposes only
timezone	string Canonical name of the timezone in the IANA time zone database (e.g. 'Europe/Berlin')
trialEndDate	string <date-time> TrialEndDate contains the timestamp when the organization's trial period expires

Responses

200

updated organization payload

400

passed organization payload is missing or in a wrong format

500

database error

put /organization

https://app.groupalarm.com/api/v1/organization

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"availableUsers": 
{"countAvailable": 0,
"countInEvent": 0,
"countNotAvailable": 0
},
"availableUsersTotal": 
{"countAvailable": 0,
"countInEvent": 0,
"countNotAvailable": 0
},
"avatarURL": "string",
"creationDate": "2021-03-03T10:35:35Z",
"description": "string",
"hasChildren": true,
"id": 0,
"location": 
{"address": "string",
"latitude": 0,
"longitude": 0
},
"name": "string",
"ownerIDs": 
[0
],
"parentID": 0,
"state": "string",
"tags": 
["string"
],
"timezone": "string",
"trialEndDate": "2021-03-03T10:35:35Z"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"availableUsers": 
{"countAvailable": 0,
"countInEvent": 0,
"countNotAvailable": 0
},
"availableUsersTotal": 
{"countAvailable": 0,
"countInEvent": 0,
"countNotAvailable": 0
},
"avatarURL": "string",
"creationDate": "2021-03-03T10:35:35Z",
"description": "string",
"hasChildren": true,
"id": 0,
"location": 
{"address": "string",
"latitude": 0,
"longitude": 0
},
"name": "string",
"ownerIDs": 
[0
],
"parentID": 0,
"state": "string",
"tags": 
["string"
],
"timezone": "string",
"trialEndDate": "2021-03-03T10:35:35Z"
}

CreateOrganization

Create an organization with passed organization payload

Request Body schema: application/json

organization payload

availableUsers	object (AvailableUsersCount) AvailableUsersCount payload
availableUsersTotal	object (AvailableUsersCount) AvailableUsersCount payload
avatarURL	string AvatarURL
creationDate	string <date-time> CreationDate of the organization
description	string user defined description
hasChildren	boolean defines if it's the parent of any other organization
id	integer <int64> ID of this organization
location	object (OrganizationLocation) OrganizationLocation describes the location payload
name	string user defined name
ownerIDs	Array of integers <int64> user id of the organization owner/creator
parentID	integer <int64> optional: ID of the parent organization
state	string (OrganizationState) OrganizationState represents the current state of an organization, like trial, active, inactive
tags	Array of strings Tags are used for internal purposes only
timezone	string Canonical name of the timezone in the IANA time zone database (e.g. 'Europe/Berlin')
trialEndDate	string <date-time> TrialEndDate contains the timestamp when the organization's trial period expires

Responses

201

created organization payload

400

passed organization payload is missing or in a wrong format

500

database error

post /organization

https://app.groupalarm.com/api/v1/organization

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"availableUsers": 
{"countAvailable": 0,
"countInEvent": 0,
"countNotAvailable": 0
},
"availableUsersTotal": 
{"countAvailable": 0,
"countInEvent": 0,
"countNotAvailable": 0
},
"avatarURL": "string",
"creationDate": "2021-03-03T10:35:35Z",
"description": "string",
"hasChildren": true,
"id": 0,
"location": 
{"address": "string",
"latitude": 0,
"longitude": 0
},
"name": "string",
"ownerIDs": 
[0
],
"parentID": 0,
"state": "string",
"tags": 
["string"
],
"timezone": "string",
"trialEndDate": "2021-03-03T10:35:35Z"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"availableUsers": 
{"countAvailable": 0,
"countInEvent": 0,
"countNotAvailable": 0
},
"availableUsersTotal": 
{"countAvailable": 0,
"countInEvent": 0,
"countNotAvailable": 0
},
"avatarURL": "string",
"creationDate": "2021-03-03T10:35:35Z",
"description": "string",
"hasChildren": true,
"id": 0,
"location": 
{"address": "string",
"latitude": 0,
"longitude": 0
},
"name": "string",
"ownerIDs": 
[0
],
"parentID": 0,
"state": "string",
"tags": 
["string"
],
"timezone": "string",
"trialEndDate": "2021-03-03T10:35:35Z"
}

GetOrganization

Get specific organization by its ID

path Parameters

organizationID

required

int64

id of the requested organization

Responses

200

requested organization payload

400

passed organization id is missing or in a wrong format

500

database error

get /organization/{organizationID}

https://app.groupalarm.com/api/v1/organization/{organizationID}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"availableUsers": 
{"countAvailable": 0,
"countInEvent": 0,
"countNotAvailable": 0
},
"availableUsersTotal": 
{"countAvailable": 0,
"countInEvent": 0,
"countNotAvailable": 0
},
"avatarURL": "string",
"creationDate": "2021-03-03T10:35:36Z",
"description": "string",
"hasChildren": true,
"id": 0,
"location": 
{"address": "string",
"latitude": 0,
"longitude": 0
},
"name": "string",
"ownerIDs": 
[0
],
"parentID": 0,
"state": "string",
"tags": 
["string"
],
"timezone": "string",
"trialEndDate": "2021-03-03T10:35:36Z"
}

avatar

UploadAvatar

Uploads an Avatar for the Organization

path Parameters

organizationID

required

int64

id of the organization

Request Body schema: application/json

blob of the image

any

Responses

200

upload complete

400

data is invalid

500

database error

post /organization/{organizationID}/avatar

https://app.groupalarm.com/api/v1/organization/{organizationID}/avatar

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

children

GetChildren

Get paginated children of specific organization by its ID

path Parameters

organizationID

required

int64

id of the requested organization

query Parameters

limit	int64 max. amount of entries in list
offset	int64 amount of entries to skip

Responses

200

Paginated child organizations for the fiven ID

500

database error

get /organization/{organizationID}/children

https://app.groupalarm.com/api/v1/organization/{organizationID}/children

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"childs": 
[
{"availableUsers": 
{"countAvailable": 0,
"countInEvent": 0,
"countNotAvailable": 0
},
"availableUsersTotal": 
{"countAvailable": 0,
"countInEvent": 0,
"countNotAvailable": 0
},
"avatarURL": "string",
"creationDate": "2021-03-03T10:35:36Z",
"description": "string",
"hasChildren": true,
"id": 0,
"location": 
{"address": "string",
"latitude": 0,
"longitude": 0
},
"name": "string",
"ownerIDs": 
[0
],
"parentID": 0,
"state": "string",
"tags": 
["string"
],
"timezone": "string",
"trialEndDate": "2021-03-03T10:35:36Z"
}
],
"path": 
[
{"availableUsers": 
{"countAvailable": 0,
"countInEvent": 0,
"countNotAvailable": 0
},
"availableUsersTotal": 
{"countAvailable": 0,
"countInEvent": 0,
"countNotAvailable": 0
},
"avatarURL": "string",
"creationDate": "2021-03-03T10:35:36Z",
"description": "string",
"hasChildren": true,
"id": 0,
"location": 
{"address": "string",
"latitude": 0,
"longitude": 0
},
"name": "string",
"ownerIDs": 
[0
],
"parentID": 0,
"state": "string",
"tags": 
["string"
],
"timezone": "string",
"trialEndDate": "2021-03-03T10:35:36Z"
}
],
"totalChilds": 0
}

availability-history

GetAvailabilityHistory

Get organization's availability history of the last 14 days

query Parameters

limit	int64 max. amount of entries in list
offset	int64 amount of entries to skip

Responses

200

availability history of the last 14 days

400

invalid organizationID

401

missing jwt token or failed rbac check

500

internal error

get /organization/{organizationID}/history

https://app.groupalarm.com/api/v1/organization/{organizationID}/history

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"end_date": "2021-03-03T10:35:36Z",
"entries": 
[
{"creation_date": "2021-03-03T10:35:36Z",
"id": 0,
"organization_id": 0,
"update_date": "2021-03-03T10:35:36Z",
"users_available": 
[0
],
"users_in_event": 
[0
],
"users_not_available": 
[0
]
}
],
"start_date": "2021-03-03T10:35:36Z"
}

WebsocketConnection

Open a secure websocket connection to receive immediate updates about availability changes

Responses

200

upgrade to websocket connection

400

invalid organizationID

get /organization/{organizationID}/history/ws

https://app.groupalarm.com/api/v1/organization/{organizationID}/history/ws

location

UpsertOrganizationLocation

Inserts or updates an organizations location

path Parameters

organizationID

required

int64

id of the organization

Request Body schema: application/json

location payload of the organization

address	string
latitude	number <double>
longitude	number <double>

Responses

200

upsert complete

400

data is invalid

500

database error

put /organization/{organizationID}/location

https://app.groupalarm.com/api/v1/organization/{organizationID}/location

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"address": "string",
"latitude": 0,
"longitude": 0
}

DeleteOrganizationLocation

Deletes an organizations location

path Parameters

organizationID

required

int64

id of the organization

Responses

200

delete successful

400

data is invalid

500

database error

delete /organization/{organizationID}/location

https://app.groupalarm.com/api/v1/organization/{organizationID}/location

owner

AddOwnerWithEmail

Update an existing organization by adding a new owner

path Parameters

organizationID

required

int64

id of the organization

Request Body schema: application/json

email address of the user

string

Responses

200

updated organization owners

400

data is invalid

403

user is not allowed to update owners

500

database error

put /organization/{organizationID}/owner

https://app.groupalarm.com/api/v1/organization/{organizationID}/owner

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

"string"