Discovery needs no key. Ratings and market analysis are Pro.
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 Organizations API
version: '1.0'
description: 'Operations tagged Organizations across 2 of this provider''s published API definitions: wekan-meteor3-openapi.yml, wekan-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Organizations
paths:
/api/admin/orgs:
get:
operationId: get_admin_orgs
summary: List organizations with their feature toggles (GlobalAdmin)
description: 'Only the global admin can call this. Returns every organization
with its identifying fields and the per-org feature toggles shown as columns
in Admin Panel > People > Organizations.'
tags:
- Organizations
security:
- UserSecurity: []
responses:
'200':
description: 200 response
content:
application/json:
schema:
type: array
items:
type: object
properties:
_id:
type: string
orgDisplayName:
type: string
orgShortName:
type: string
orgSharedTemplates:
type: boolean
orgPropagateMembersToBoards:
type: boolean
orgSyncMembersFromAuth:
type: boolean
/api/admin/orgs/{org}/features:
put:
operationId: update_admin_org_features
summary: Set feature toggles on one organization (GlobalAdmin)
description: 'Only the global admin can call this. The request body may
contain any of `orgSharedTemplates`, `orgPropagateMembersToBoards` and
`orgSyncMembersFromAuth` (booleans); only those whitelisted fields are
`$set` on the organization. Returns the updated organization.'
tags:
- Organizations
parameters:
- name: org
in: path
description: 'the ID of the organization
'
required: true
schema:
type: string
security:
- UserSecurity: []
responses:
'200':
description: 200 response
content:
application/json:
schema:
type: Object
/api/admin/orgs/features:
put:
operationId: update_all_admin_org_features
summary: Set one feature toggle on all organizations (GlobalAdmin)
description: 'Only the global admin can call this. The request body is
`{ field, value }` where `field` is one of `orgSharedTemplates`,
`orgPropagateMembersToBoards` or `orgSyncMembersFromAuth` and `value` is a
boolean. The field is `$set` on ALL organizations. Returns the number of
organizations updated.'
tags:
- Organizations
security:
- UserSecurity: []
responses:
'200':
description: 200 response
content:
application/json:
schema:
type: object
properties:
updated:
type: number
components:
securitySchemes:
UserSecurity:
type: apiKey
in: header
name: Authorization
x-refined-from:
- wekan-meteor3-openapi.yml
- wekan-openapi.yml