Download OpenAPI specification:Download
The organization service implements a the organization logic in GroupAlarm.
Update an existing organization with passed organization payload
organization payload
object (AvailableUsersCount) AvailableUsersCount payload | |
object (AvailableUsersCount) AvailableUsersCount payload | |
avatarURL | string AvatarURL |
creationDate | any CreationDate of the organization |
dataRetentionPeriod | integer <int64> DataRetentionPeriod stores the number of months the organization wants to keep its data |
description | string user defined description |
enforcesTwoFactorAuth | boolean 2FA |
hasChildren | boolean defines if it's the parent of any other organization |
id | integer <int64> ID of this organization |
language | string IETF BCP 47 language tag for the organization (e.g. 'de' or 'en-GB') |
object (OrganizationLocation) OrganizationLocation describes the location payload | |
name | string user defined name |
ownerIDs | Array of integers <int64> [ items <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 | any TrialEndDate contains the timestamp when the organization's trial period expires |
{- "availableUsers": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "availableUsersTotal": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "avatarURL": "string",
- "creationDate": null,
- "dataRetentionPeriod": 0,
- "description": "string",
- "enforcesTwoFactorAuth": true,
- "hasChildren": true,
- "id": 0,
- "language": "string",
- "location": {
- "address": "string",
- "latitude": 0.1,
- "longitude": 0.1
}, - "name": "string",
- "ownerIDs": [
- 0
], - "parentID": 0,
- "state": "string",
- "tags": [
- "string"
], - "timezone": "string",
- "trialEndDate": null
}
{- "availableUsers": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "availableUsersTotal": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "avatarURL": "string",
- "creationDate": null,
- "dataRetentionPeriod": 0,
- "description": "string",
- "enforcesTwoFactorAuth": true,
- "hasChildren": true,
- "id": 0,
- "language": "string",
- "location": {
- "address": "string",
- "latitude": 0.1,
- "longitude": 0.1
}, - "name": "string",
- "ownerIDs": [
- 0
], - "parentID": 0,
- "state": "string",
- "tags": [
- "string"
], - "timezone": "string",
- "trialEndDate": null
}
Create an organization with passed organization payload
organization payload
object (AvailableUsersCount) AvailableUsersCount payload | |
object (AvailableUsersCount) AvailableUsersCount payload | |
avatarURL | string AvatarURL |
creationDate | any CreationDate of the organization |
dataRetentionPeriod | integer <int64> DataRetentionPeriod stores the number of months the organization wants to keep its data |
description | string user defined description |
enforcesTwoFactorAuth | boolean 2FA |
hasChildren | boolean defines if it's the parent of any other organization |
id | integer <int64> ID of this organization |
language | string IETF BCP 47 language tag for the organization (e.g. 'de' or 'en-GB') |
object (OrganizationLocation) OrganizationLocation describes the location payload | |
name | string user defined name |
ownerIDs | Array of integers <int64> [ items <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 | any TrialEndDate contains the timestamp when the organization's trial period expires |
{- "availableUsers": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "availableUsersTotal": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "avatarURL": "string",
- "creationDate": null,
- "dataRetentionPeriod": 0,
- "description": "string",
- "enforcesTwoFactorAuth": true,
- "hasChildren": true,
- "id": 0,
- "language": "string",
- "location": {
- "address": "string",
- "latitude": 0.1,
- "longitude": 0.1
}, - "name": "string",
- "ownerIDs": [
- 0
], - "parentID": 0,
- "state": "string",
- "tags": [
- "string"
], - "timezone": "string",
- "trialEndDate": null
}
{- "availableUsers": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "availableUsersTotal": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "avatarURL": "string",
- "creationDate": null,
- "dataRetentionPeriod": 0,
- "description": "string",
- "enforcesTwoFactorAuth": true,
- "hasChildren": true,
- "id": 0,
- "language": "string",
- "location": {
- "address": "string",
- "latitude": 0.1,
- "longitude": 0.1
}, - "name": "string",
- "ownerIDs": [
- 0
], - "parentID": 0,
- "state": "string",
- "tags": [
- "string"
], - "timezone": "string",
- "trialEndDate": null
}
Get specific organization by its ID
organizationID required | integer id of the requested organization |
{- "availableUsers": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "availableUsersTotal": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "avatarURL": "string",
- "creationDate": null,
- "dataRetentionPeriod": 0,
- "description": "string",
- "enforcesTwoFactorAuth": true,
- "hasChildren": true,
- "id": 0,
- "language": "string",
- "location": {
- "address": "string",
- "latitude": 0.1,
- "longitude": 0.1
}, - "name": "string",
- "ownerIDs": [
- 0
], - "parentID": 0,
- "state": "string",
- "tags": [
- "string"
], - "timezone": "string",
- "trialEndDate": null
}
Get paginated children of specific organization by its ID
organizationID required | integer id of the requested organization |
limit | integer max. amount of entries in list |
offset | integer amount of entries to skip |
{- "childs": [
- {
- "availableUsers": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "availableUsersTotal": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "avatarURL": "string",
- "creationDate": null,
- "dataRetentionPeriod": 0,
- "description": "string",
- "enforcesTwoFactorAuth": true,
- "hasChildren": true,
- "id": 0,
- "language": "string",
- "location": {
- "address": "string",
- "latitude": 0.1,
- "longitude": 0.1
}, - "name": "string",
- "ownerIDs": [
- 0
], - "parentID": 0,
- "state": "string",
- "tags": [
- "string"
], - "timezone": "string",
- "trialEndDate": null
}
], - "path": [
- {
- "availableUsers": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "availableUsersTotal": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "avatarURL": "string",
- "creationDate": null,
- "dataRetentionPeriod": 0,
- "description": "string",
- "enforcesTwoFactorAuth": true,
- "hasChildren": true,
- "id": 0,
- "language": "string",
- "location": {
- "address": "string",
- "latitude": 0.1,
- "longitude": 0.1
}, - "name": "string",
- "ownerIDs": [
- 0
], - "parentID": 0,
- "state": "string",
- "tags": [
- "string"
], - "timezone": "string",
- "trialEndDate": null
}
], - "totalChilds": 0
}
Get the organization tree for the given organization
organizationID required | integer id of the requested organization |
{- "children": [
- { }
], - "id": 0,
- "name": "string",
- "parentID": 0
}
Get available users and aggregated available users of the given organization and its child organizations
organizationID required | integer id of the requested organization |
{- "countInRoot": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "countTotal": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}
}
Send an empty body to remove the avatar.
organizationID required | integer id of the organization |
"string"
Get organization's availability history of the last 14 days
organizationID required | integer id of the requested organization |
limit | integer max. amount of entries in list |
offset | integer amount of entries to skip |
{- "end_date": null,
- "entries": [
- {
- "creation_date": null,
- "id": 0,
- "organization_id": 0,
- "update_date": null,
- "users_available": [
- 0
], - "users_in_event": [
- 0
], - "users_not_available": [
- 0
]
}
], - "start_date": null
}
Inserts or updates an organizations location
organizationID required | integer id of the organization |
location payload of the organization
address | string |
latitude | number <double> |
longitude | number <double> |
{- "address": "string",
- "latitude": 0.1,
- "longitude": 0.1
}
Invites an existing user as new owner to an organization
organizationID required | integer |
string |
{- "email": "string"
}
{- "email": "string",
- "organizationID": 0,
- "userID": 0
}
Gets the topmost parent organization the given user is the owner of
organizationID required | integer id of the organization |
userID required | integer id of the user |
{- "availableUsers": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "availableUsersTotal": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "avatarURL": "string",
- "creationDate": null,
- "dataRetentionPeriod": 0,
- "description": "string",
- "enforcesTwoFactorAuth": true,
- "hasChildren": true,
- "id": 0,
- "language": "string",
- "location": {
- "address": "string",
- "latitude": 0.1,
- "longitude": 0.1
}, - "name": "string",
- "ownerIDs": [
- 0
], - "parentID": 0,
- "state": "string",
- "tags": [
- "string"
], - "timezone": "string",
- "trialEndDate": null
}
Get all defined quick actions for this organization
organizationID required | integer id of the organization |
[- {
- "category": "string",
- "color": "string",
- "icon": "string",
- "id": 0,
- "name": "string",
- "one_click": true,
- "organization_id": 0,
- "resource": "string",
- "resource_id": 0
}
]
Replaces all defined organization quick actions with the passed ones
organizationID required | integer id of the organization |
new quick-actions for this organization
category | string |
color | string |
icon | string |
id | integer <int64> |
name | string |
one_click | boolean |
organization_id | integer <int64> |
resource | string |
resource_id | integer <int64> |
[- {
- "category": "string",
- "color": "string",
- "icon": "string",
- "id": 0,
- "name": "string",
- "one_click": true,
- "organization_id": 0,
- "resource": "string",
- "resource_id": 0
}
]
Returns a list of all accessible organizations for the current user
[- {
- "availableUsers": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "availableUsersTotal": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "avatarURL": "string",
- "creationDate": null,
- "dataRetentionPeriod": 0,
- "description": "string",
- "enforcesTwoFactorAuth": true,
- "hasChildren": true,
- "id": 0,
- "language": "string",
- "location": {
- "address": "string",
- "latitude": 0.1,
- "longitude": 0.1
}, - "name": "string",
- "ownerIDs": [
- 0
], - "parentID": 0,
- "state": "string",
- "tags": [
- "string"
], - "timezone": "string",
- "trialEndDate": null
}
]
Returns a paginated list of accessible top-level organizations for the current user
limit | integer [ 1 .. 50 ] Default: 10 max. amount of entries in list |
offset | integer Default: 0 amount of entries to skip |
all | boolean Default: false returns all entries, ignoring limit and offset parameters |
{- "organizations": [
- {
- "availableUsers": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "availableUsersTotal": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "avatarURL": "string",
- "creationDate": null,
- "dataRetentionPeriod": 0,
- "description": "string",
- "enforcesTwoFactorAuth": true,
- "hasChildren": true,
- "id": 0,
- "language": "string",
- "location": {
- "address": "string",
- "latitude": 0.1,
- "longitude": 0.1
}, - "name": "string",
- "ownerIDs": [
- 0
], - "parentID": 0,
- "state": "string",
- "tags": [
- "string"
], - "timezone": "string",
- "trialEndDate": null
}
], - "totalOrganizations": 0
}