---
title: API Keys
description: Use API Keys to authenticate requests to the public API of Collaboard on behalf of the API Key owner.
---

[Skip to content](https://help.collaboard.app/api-key#main-content)

English

Show submenu for translations

![logo-type\_black 2.svg\]](https://help.collaboard.app/hubfs/logo-type_black%202.svg)

Open main navigation

Close main navigation

- English
  
  Show submenu for translations
- [Go to collaboard.app](https://www.collaboard.app/)

[Go to collaboard.app](https://www.collaboard.app/?hsLang=en)

 Hello. How can we help you?

- There are no suggestions because the search field is empty.

1. [Collaboard Help Center](https://help.collaboard.app/?hsLang=en)
2. [Administration](https://help.collaboard.app/administration?hsLang=en)
3. [Integrations](https://help.collaboard.app/administration?hsLang=en#integrations)

# API Keys

## Use API Keys to authenticate requests to the public API of Collaboard on behalf of the API Key owner.

### Introduction

Whenever a third-party application needs to authenticate to Collaboard on behalf of a user, API Keys may be used.  
An API Key is a private key that

- is generated on demand by a user
- is tied to the user who created it
- has a defined expiration date

**Please note** API Keys enable authentication to all Collaboard app features on your behalf. Please exercise care when using API Keys! Do not save the key anywhere but at its intended destination.

### Create and use an API Key

1. Navigate to your Collaboard profile and create the API Key.
   
   ![](https://help.collaboard.app/hubfs/image-png-Jun-26-2023-12-52-40-0838-PM.png)  
   You can specify the name to your liking and the expiration date up to one year.  
   The key will show one-time only! If you miss copying it, you will need to create a new key and delete the old key. Deletions can be done any time.
2. Copy-paste the key to the settings of e.g. a Collaboard integration running in a third party app:
   
   ![](https://help.collaboard.app/hubfs/image-png-Jun-26-2023-11-13-53-2191-AM.png)  
   *Example taken from the Collaboard integration with Rocket.Chat.*
3. An authorization token will be obtained and the app can use the authorization token to issue API requests on your behalf, thus log you in to Collaboard behind the scenes.

### Use cases

API Keys support the following use cases:

**Use a Collaboard integration from your account of a third party app**  
By using an API Key authentication will happen in the background. You can just use the Collaboard integration without disturbance. This works until the API Key expires.  
Good news: you can just create a new one.  
*Example: Rocket.Chat*

**Establish a SCIM connection**

If you opt to authenticate with a real time token, you will first need to create an API Key that will then be used to get an auth token.

 

 

- [Getting started](https://help.collaboard.app/getting-started?hsLang=en#main-content)

    - [Register / Login](https://help.collaboard.app/getting-started?hsLang=en#register-login)
    - [Start with your first project](https://help.collaboard.app/getting-started?hsLang=en#start-with-your-first-project)
- [Working with Collaboard](https://help.collaboard.app/working-with-collaboard?hsLang=en#main-content)

    - [Board navigation](https://help.collaboard.app/working-with-collaboard?hsLang=en#board-navigation)
    - [Standard Object Options](https://help.collaboard.app/working-with-collaboard?hsLang=en#standard-object-options)
    - [Sticky Notes](https://help.collaboard.app/working-with-collaboard?hsLang=en#sticky-notes)
    - [Media](https://help.collaboard.app/working-with-collaboard?hsLang=en#media)
    - [Shape & Line](https://help.collaboard.app/working-with-collaboard?hsLang=en#shape-line)
    - [Other Objects](https://help.collaboard.app/working-with-collaboard?hsLang=en#other-objects)
    - [Quick Links](https://help.collaboard.app/working-with-collaboard?hsLang=en#quick-links)
    - [Facilitation and collaboration](https://help.collaboard.app/working-with-collaboard?hsLang=en#facilitation-and-collaboration)
    - [Project interaction](https://help.collaboard.app/working-with-collaboard?hsLang=en#project-interaction)
    - [Export](https://help.collaboard.app/working-with-collaboard?hsLang=en#export)
    - [Settings](https://help.collaboard.app/working-with-collaboard?hsLang=en#settings)
    - [Accessibility](https://help.collaboard.app/working-with-collaboard?hsLang=en#accessibility)
    - [Import](https://help.collaboard.app/working-with-collaboard?hsLang=en#import)
    - [Templates](https://help.collaboard.app/working-with-collaboard?hsLang=en#templates)
- [Plans & Billing](https://help.collaboard.app/plans-billing?hsLang=en#main-content)

    - [Manage your subscription and plan](https://help.collaboard.app/plans-billing?hsLang=en#manage-your-subscription-and-plan)
- [Administration](https://help.collaboard.app/administration?hsLang=en#main-content)

    - [Account Administration](https://help.collaboard.app/administration?hsLang=en#account-administration)
    - [Project Administration](https://help.collaboard.app/administration?hsLang=en#project-administration)
    - [User Management](https://help.collaboard.app/administration?hsLang=en#user-management)
    - [Spaces](https://help.collaboard.app/administration?hsLang=en#spaces)
    - [Integrations](https://help.collaboard.app/administration?hsLang=en#integrations)
    - [Settings](https://help.collaboard.app/administration?hsLang=en#settings)
- [Support & FAQ](https://help.collaboard.app/support-faq?hsLang=en#main-content)

    - [Announcements and Release Notes](https://help.collaboard.app/support-faq?hsLang=en#announcements-and-release-notes)
    - [General](https://help.collaboard.app/support-faq?hsLang=en#general)
    - [FAQ](https://help.collaboard.app/support-faq?hsLang=en#faq)
- [Video Trainings](https://help.collaboard.app/video-trainings?hsLang=en)

[![Collaboard](https://help.collaboard.app/hs-fs/hubfs/coll-logo.png?width=300&height=165&name=coll-logo.png "Collaboard")](http://collaboard.app)

collaboard.app Help Center

Copyright © 2026, Collaboard by IBV Informatik, Beratungs und Vertriebs AG