Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Wekan REST Integrations API
version: v12.65
description: 'The REST API allows you to control and extend Wekan with ease.
If you are an end-user and not a dev or a tester, create an issue to request new APIs.
> All API calls in the documentation are made using `curl`. However, you are free to use Java / Python / PHP / Golang / Ruby / Swift / Objective-C / Rust / Scala / C# or any other programming languages.
# Production Security Concerns
When calling a production Wekan server, ensure it is running via HTTPS and has a valid SSL Certificate. The login method requires you to post your username and password in plaintext, which is why we highly suggest only calling the REST login api over HTTPS. Also, few things to note:
* Only call via HTTPS
* Implement a timed authorization token expiration strategy
* Ensure the calling user only has permissions for what they are calling and no more'
tags:
- name: Integrations
paths:
/api/boards/{board}/integrations:
get:
operationId: get_board_integrations
tags:
- Integrations
parameters:
- name: board
in: path
description: the board value
required: true
schema:
type: string
security:
- UserSecurity: []
responses:
'200':
description: 200 response
summary: Get board integrations
x-summary-source: derived
post:
operationId: post_board_integrations
tags:
- Integrations
parameters:
- name: board
in: path
description: the board value
required: true
schema:
type: string
security:
- UserSecurity: []
responses:
'200':
description: 200 response
summary: Post board integrations
x-summary-source: derived
/api/boards/{board}/integrations/{int}:
get:
operationId: get_board_int
tags:
- Integrations
parameters:
- name: board
in: path
description: the board value
required: true
schema:
type: string
- name: int
in: path
description: the int value
required: true
schema:
type: string
security:
- UserSecurity: []
responses:
'200':
description: 200 response
summary: Get board int
x-summary-source: derived
put:
operationId: put_board_int
tags:
- Integrations
parameters:
- name: board
in: path
description: the board value
required: true
schema:
type: string
- name: int
in: path
description: the int value
required: true
schema:
type: string
security:
- UserSecurity: []
responses:
'200':
description: 200 response
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
notificationDelivery:
type: string
description: the notificationDelivery value
required:
- notificationDelivery
application/json:
schema:
type: object
properties:
notificationDelivery:
type: string
description: the notificationDelivery value
required:
- notificationDelivery
summary: Put board int
x-summary-source: derived
delete:
operationId: delete_board_int
tags:
- Integrations
parameters:
- name: board
in: path
description: the board value
required: true
schema:
type: string
- name: int
in: path
description: the int value
required: true
schema:
type: string
security:
- UserSecurity: []
responses:
'200':
description: 200 response
summary: Delete board int
x-summary-source: derived
/api/boards/{board}/integrations/{int}/activities:
delete:
operationId: delete_board_int_activities
tags:
- Integrations
parameters:
- name: board
in: path
description: the board value
required: true
schema:
type: string
- name: int
in: path
description: the int value
required: true
schema:
type: string
security:
- UserSecurity: []
responses:
'200':
description: 200 response
summary: Delete board int activities
x-summary-source: derived
post:
operationId: post_board_int_activities
tags:
- Integrations
parameters:
- name: board
in: path
description: the board value
required: true
schema:
type: string
- name: int
in: path
description: the int value
required: true
schema:
type: string
security:
- UserSecurity: []
responses:
'200':
description: 200 response
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
activities:
type: string
description: the activities value
required:
- activities
application/json:
schema:
type: object
properties:
activities:
type: string
description: the activities value
required:
- activities
summary: Post board int activities
x-summary-source: derived
components:
securitySchemes:
UserSecurity:
type: apiKey
in: header
name: Authorization