API Docs
HomeDocsWebsite
  • Home
  • Introduction
    • Authorization
      • Authorize
      • Get a Token
      • Third-Party Login
    • Field Types and Validation
      • Field Types
      • Validation
    • Query Manipulation
      • Constraints
      • Result Control
      • Value Filters
    • Entity Permissions
      • Restricted Scope
  • API reference
    • Infoboard
      • InfoboardChannels
      • InfoboardPosts
      • InfoboardPostSeenUsers
      • InfoboardPostReadUsers
      • InfoboardComments
      • InfoboardDepartmentSettings
    • Manual
      • ManualChapters
      • ManualEntries
      • ManualEntrySeenUsers
    • Calendar
      • Calendars
      • CalendarEvents
    • Filemanager
      • FilemanagerDirectories
      • FilemanagerFiles
    • Files
    • Forms
      • Forms
      • FormFields
      • FormFieldTypes
      • FormFieldValidations
      • FormFieldValidationTypes
      • FormMessages
      • FormMessageFields
    • Layouts
      • Layouts
      • LayoutRows
      • LayoutColumns
      • LayoutColumnLayoutElements
    • Tasks 2.0
      • TaskTemplates
      • TaskFields
      • TaskAssignments
      • TaskExecutions
      • TaskProgressFields
    • Departments
    • Roles
    • Permissions
    • Users
    • EntityPermissions
    • Notifications
    • Reactions
    • Icons
    • Folders
    • SharedItems
    • UrlContext
  • Resources
    • Release Notes
      • v2.106.0
      • v2.102.0
Powered by GitBook
On this page
  • Model Definition
  • Alias
  • Relations
  • List
  • Show
  • [Adm.] List
  • [Adm.] Show
  • [Adm.] Create
  • [Adm.] Update
  • [Adm.] Delete
  1. API reference
  2. Infoboard

InfoboardChannels

PreviousInfoboardNextInfoboardPosts

Last updated 1 month ago

InfoboardChannels function as subspaces within the Infoboard. Access to each InfoboardChannel is controlled through , which define the that are members of the channel.

An can be assigned an infoboard_channel_id, making it visible only to the granted access via . Additionally, in channels can further restrict access to individual within the channel via the departments relation.

It is also possible to assign permissions such as write, comment and administrate for the individual of the assigned via .

Model Definition

Alias

infoboardChannel

Relations

Key
Relation
Type
Relation Field(s)

user

Belongs to

user_id

folder

Belongs to

folder_id

icon

Belongs to

icon_id

entityPermissions

Morph many

infoboardPosts

Has many

infoboard_post.infoboard_channel_id

List

Get a list of all InfoboardChannels the current authenticated is allowed to view.

Definition

GET /api/infoboard/channels

Example Request

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/infoboard/channels', [
    'headers' => ['Authorization' => "Bearer {accessToken}"]
]);

Example Response Body

[
  {
    "id": 1,
    "user_id": 1,
    "folder_id": null,
    "icon_id": 10,
    "title": "Non curabitur gravida arcu ac",
    "color": "#ffffff",
    "sort_number": 1,
    "created_at": "2025-03-17 12:00:00",
    "updated_at": "2025-03-17 12:00:00",
    "deleted_at": null
  },
  {
    "id": 2,
    "user_id": 1,
    "folder_id": null,
    "icon_id": 20,
    "title": "Placerat duis ultricies lacus sed",
    "color": "#000000",
    "sort_number": 2,
    "created_at": "2025-03-17 13:00:00",
    "updated_at": "2025-03-17 13:00:00",
    "deleted_at": null
  }
]

Show

Show a single InfoboardChannel by id.

Definition

GET /api/infoboard/channels/{``id}

Example Request

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/infoboard/channels/1', [
    'headers' => ['Authorization' => "Bearer {accessToken}"]
]);

Example Response

{
  "id": 1,
  "user_id": 1,
  "folder_id": null,
  "icon_id": 10,
  "title": "Non curabitur gravida arcu ac",
  "color": "#ffffff",
  "sort_number": 1,
  "created_at": "2025-03-17 12:00:00",
  "updated_at": "2025-03-17 12:00:00",
  "deleted_at": null
}

[Adm.] List

Get a list of all InfoboardChannels.

Definition

GET ``/api/administration/infoboard/channels

Example Request

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/administration/infoboard/channels', [
    'headers' => ['Authorization' => "Bearer {accessToken}"]
]);

Example Response Body

[
  {
    "id": 1,
    "user_id": 1,
    "folder_id": null,
    "icon_id": 10,
    "title": "Non curabitur gravida arcu ac",
    "color": "#ffffff",
    "sort_number": 1,
    "created_at": "2025-03-17 12:00:00",
    "updated_at": "2025-03-17 12:00:00",
    "deleted_at": null
  },
  {
    "id": 2,
    "user_id": 1,
    "folder_id": null,
    "icon_id": 20,
    "title": "Placerat duis ultricies lacus sed",
    "color": "#000000",
    "sort_number": 2,
    "created_at": "2025-03-17 13:00:00",
    "updated_at": "2025-03-17 13:00:00",
    "deleted_at": null
  }
]

[Adm.] Show

Get a single InfoboardChannel by id.

Definition

GET ``/api/administration/infoboard/channels/{id}

Example Request

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/administration/infoboard/channels/1', [
    'headers' => ['Authorization' => "Bearer {accessToken}"]
]);

Example Response Body

{
  "id": 1,
  "user_id": 1,
  "folder_id": null,
  "icon_id": 10,
  "title": "Non curabitur gravida arcu ac",
  "color": "#ffffff",
  "sort_number": 1,
  "created_at": "2025-03-17 12:00:00",
  "updated_at": "2025-03-17 12:00:00",
  "deleted_at": null
}

[Adm.] Create

Create a new InfoboardChannel.

Definition

POST /api/administration/infoboard/channels

Request Keys

Key
Type
Default
Description

folder_id

integer

-

icon_id

integer

-

title*

string

-

The title of the InfoboardChannel.

color

string

-

The color as a HEX string.

sort_number

integer

Current highest +1

Keys with * are required.

Example Request

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('POST', '/api/administration/infoboard/channels', [
    'headers' => ['Authorization' => "Bearer {accessToken}"],
    'json' => [
        'icon_id' => 30,
        'title' => 'Sagittis purus sit amet volutpat',
        'color' => '#cccccc'
    ]
]);

Example Response Body

{
  "status": "success",
  "data": {
    "id": 3,
    "user_id": 1,
    "folder_id": null,
    "icon_id": 30,
    "title": "Sagittis purus sit amet volutpat",
    "color": "#cccccc",
    "sort_number": 3,
    "created_at": "2025-03-17 14:00:00",
    "updated_at": "2025-03-17 14:00:00",
    "deleted_at": null
  }
}

[Adm.] Update

Update an existing InfoboardChannel by id.

Definition

PUT /api/administration/infoboard/channels/{id}

Request Keys

Key
Type
Description

folder_id

integer

icon_id

integer

title

string

The title of the InfoboardChannel.

color

string

The color as a HEX string.

sort_number

integer

Example Request

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('PUT', '/api/administration/infoboard/channels/3', [
    'headers' => ['Authorization' => "Bearer {accessToken}"],
    'json' => [
        'icon_id' => 40,
        'color' => '#dddddd'
    ]
]);

Example Response Body

{
  "status": "success",
  "data": {
    "id": 3,
    "user_id": 1,
    "folder_id": null,
    "icon_id": 40,
    "title": "Sagittis purus sit amet volutpat",
    "color": "#dddddd",
    "sort_number": 3,
    "created_at": "2025-03-17 14:00:00",
    "updated_at": "2025-03-17 15:00:00",
    "deleted_at": null
  }
}

[Adm.] Delete

Delete an existing InfoboardChannel by id.

Definition

DELETE /api/administration/infoboard/channels/{id}

Example Request

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('DELETE', '/api/administration/infoboard/channels/3', [
    'headers' => ['Authorization' => "Bearer {accessToken}"]
]);

Example Response Body

{
  "status": "success",
  "data": null
}

The ID of the InfoboardChannel is assigned to.

The ID of the or the InfoboardChannel

The index of the InfoboardChannel related to the .

The ID of the InfoboardChannel is assigned to.

The ID of the or the InfoboardChannel

The index of the InfoboardChannel related to the .

EntityPermissions
Departments
InfoboardPost
Departments
EntityPermissions
InfoboardPosts
Departments
Roles
Departments
EntityPermissions
User
User
Folder
Icon
EntityPermissions
InfoboardPost
Folder
Icon
Folder
Folder
Icon
Folder