- Documentation
- Sandbox
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
string | false | |||
password | string | false | ||
currentPassword | string | false | ||
lang | choice | false | ["cs_CZ","de_DE","en_US","es_ES","fr_FR","it_IT","ja_JP","nl_NL","pl_PL","pt_BR","ru_RU"] | |
currentOrganization | string | false | ||
timezone | choice | false | ||
country | string | false | ||
intercomInteraction | boolean | false | ||
multiFactorAuthentication | object (MultiFactorAuthenticationType) | false | ||
multiFactorAuthentication[enforced] | boolean | true |
Status Code | Description |
---|---|
200 |
|
401 |
|
Name | Requirement | Type | Description |
---|---|---|---|
organization_id |
Name | Information | ||||||
---|---|---|---|---|---|---|---|
circle |
|
||||||
role |
|
||||||
member |
|
||||||
privilege |
|
||||||
activated |
|
||||||
assigned |
|
||||||
suspended |
|
||||||
autocomplete |
|
||||||
lastLoginAfter |
|
||||||
lastLoginBefore |
|
||||||
sort |
|
||||||
page |
|
||||||
count |
|
Status Code | Description |
---|---|
200 |
|
401 |
|
Name | Requirement | Type | Description |
---|---|---|---|
organization_id |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
firstName | string | false | ||
lastName | string | false | ||
string | false | |||
phone | string | false | ||
avatar | string | false | ||
privilege | choice | true | ["owner","admin","member","inactive","api"] | |
locations | string | false | ||
skills | string | false | ||
circles[] | array of objects (CircleSelectorType) | false |
Status Code | Description |
---|---|
201 |
|
400 |
|
401 |
|
Name | Requirement | Type | Description |
---|---|---|---|
organization_id |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
members[] | array of objects (MemberSelectorType) | true | ||
action | choice | true | ["updatePrivilege","updateStatus","sendInvitations"] | |
value | choice | true | ["admin","member","inactive","restore","suspend","delete","send"] |
Status Code | Description |
---|---|
201 |
|
400 |
|
401 |
|
Name | Requirement | Type | Description |
---|---|---|---|
organization_id |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
content | string | true | ||
privilege | choice | true | ["owner","admin","member","inactive","api"] | |
circles[] | array of objects (CircleSelectorType) | false |
Status Code | Description |
---|---|
201 |
|
400 |
|
401 |
|
Name | Requirement | Type | Description |
---|---|---|---|
organization_id | |||
member_id |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
firstName | string | false | ||
lastName | string | false | ||
initials | string | false | ||
biography | string | false | ||
phone | string | false | ||
avatar | string | false | ||
string | false | Allowed only for inactive members (visitor access). | ||
privilege | choice | false | ["owner","admin","member","inactive","api"] | |
suspended | boolean | false | ||
translationShow | boolean | false | ||
activateNotificationsWhenJoinCircle | boolean | false | ||
translationLanguage | choice | false | ["ar","bg","bn","ca","cs","da","de","el","en","es","et","fa","fi","fr","he","hi","hr","hu","id","it","ja","ko","lt","lv","ms","nl","no","pl","pt","ro","ru","sk","sl","sq","sr","sv","ta","th","tl","tr","uk","ur","vi","zh-Hans","zh-Hant"] | |
locations[] | array of strings | false | ||
skills[] | array of strings | false | ||
experiments | string | false | ||
globalNotifications | string | false | ||
hiddenPromotion | integer | false |
Status Code | Description |
---|---|
200 |
|
400 |
|
401 |
|
Name | Requirement | Type | Description |
---|---|---|---|
organization_id | |||
member_id |
Name | Information | ||||
---|---|---|---|---|---|
activityType |
|
||||
maxTime |
|
||||
count |
|
Status Code | Description |
---|---|
200 |
|
401 |
|
Name | Requirement | Type | Description |
---|---|---|---|
organization_id | |||
member_id |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
id | string | true | ||
type | choice | true | ["circle","member","role","publication"] |
Status Code | Description |
---|---|
204 |
|
400 |
|
401 |
|
Name | Requirement | Type | Description |
---|---|---|---|
organization_id | |||
member_id |
Name | Information | ||||
---|---|---|---|---|---|
types |
|
||||
taskType |
|
Status Code | Description |
---|---|
200 |
|
401 |
|
Name | Requirement | Type | Description |
---|---|---|---|
organization_id | |||
member_id |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
id | string | true | ||
type | choice | true | ["action","attachment","board","checklist","circle","member","metric","objective","policy","project","publication","role","task","tension"] |
Status Code | Description |
---|---|
204 |
|
400 |
|
401 |
|
Name | Requirement | Type | Description |
---|---|---|---|
organization_id | |||
member_id |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
fullTimeEquivalent | float | true | ||
times[] | array of objects (TimeSpentRoleType) | true | ||
times[][role] | string | true | ||
times[][timeSpent] | float | true |
Status Code | Description |
---|---|
201 |
|
400 |
|
401 |
|
Name | Requirement | Type | Description |
---|---|---|---|
organization_id | |||
member_id |
Name | Information | ||||||
---|---|---|---|---|---|---|---|
circle |
|
||||||
page |
|
||||||
count |
|
Status Code | Description |
---|---|
200 |
|
401 |
|
Name | Requirement | Type | Description |
---|---|---|---|
organization_id | |||
member_id |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
circle | string | true | ||
types | object (NotificationTypesType) | true | ||
types[meetingReport] | boolean | false | ||
types[publication] | boolean | true | ||
types[scheduledMeeting] | boolean | true | ||
types[assignation] | boolean | true |
Status Code | Description |
---|---|
201 |
|
400 |
|
401 |
|
Name | Requirement | Type | Description |
---|---|---|---|
organization_id | |||
member_id |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
data[] | array of objects (NotificationDTOType) | true | ||
data[][id] | string | true | ||
data[][circle] | string | true | ||
data[][types] | object (NotificationTypesType) | true | ||
data[][types][meetingReport] | boolean | false | ||
data[][types][publication] | boolean | true | ||
data[][types][scheduledMeeting] | boolean | true | ||
data[][types][assignation] | boolean | true |
Status Code | Description |
---|---|
200 |
|
400 |
|
401 |
|
Name | Requirement | Type | Description |
---|---|---|---|
organization_id | |||
member_id | |||
id |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
circle | string | true | ||
types | object (NotificationTypesType) | true | ||
types[meetingReport] | boolean | false | ||
types[publication] | boolean | true | ||
types[scheduledMeeting] | boolean | true | ||
types[assignation] | boolean | true |
Status Code | Description |
---|---|
200 |
|
400 |
|
401 |
|
Name | Requirement | Type | Description |
---|---|---|---|
organization_id |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
entityId | [a-f0-9]{24} | true | Entity type ID | |
entityType | (publication|publication-revision) | true | Entity type |
Status Code | Description |
---|---|
201 |
|
400 |
|
401 |
|
Documentation auto-generated on Tue, 19 Mar 24 11:16:14 +0100