Description
Returns data about an organization.
The current user must have administrator rights.
URL
https://api.skriv.com/v1/organization/get/orgId
| Field | Type | Description |
|---|---|---|
| orgId | int | ID of the requested organization. |
Response
| Field | Type | Description |
|---|---|---|
| id | int | Organization ID |
| dateCreation | datetime | Creation date |
| lastActivity | datetime | Date of the last access of the current user on this organization |
| name | string | Organization name |
| description | string | Textual description of the organization |
| color | enum | Organization color: 'red', 'pink', 'purple', 'deeppurple', 'indigo', 'blue', 'lightblue', 'cyan', 'teal', 'green', 'lightgreen', 'lime', 'yellow', 'amber', 'orange', 'deeporange', 'brown', 'gray', 'bluegray', 'black' |
| type | enum | Organization type: 'pro', 'business' or 'enterprise' |
| isDemo | bool | true if the organization was automatically created as a demonstration organization, false otherwise |
| publicKey | string | The public key associated with the organization |
| slackWebhook | string | Slack webhook |
| slackChannel | string | Slack channel |
| txt | assoc | Strings used to adapt displayed wordings (see below |
| workdays | set | Set of week workdays: 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', 'sunday' |
| mustAnalyzeComments | bool | true if comments written on projects are analyzed (AI feature), false otherwise |
| analyzerSensitivity | enum | AI analyzer sensitivity: 'low', 'medium', 'high' |
| defaultTemplateId | int | Optional. Default template ID |
| defaultCategoryId | int | Optional. Default category ID |
| creatorId | int | Creator ID |
Texts
Skriv allows to define many terms displayed in the interface.
This associative array contains the strings used in this organization. Keys are the default texts, values are the defined texts.
| Field | Type |
|---|---|
| Todo-list | string |
| Project | string |
| Projects | string |
| Roadmap | string |
| Category | string |
| Categories | string |
| Template | string |
| Templates | string |
| Milestone | string |
| Milestones | string |
| Deadline | string |
| Value | string |
| units | string |