Skip to main content
POST
Create an employee group category

Authorizations

Authorization
string
header
required

Use an API key or OAuth access token. Enter only the token in the authorization dialog; requests send it as Authorization: Bearer <TOKEN>.

Create an API key in your workspace's Settings → API keys. Keys start with wm_api_ and only work in the workspace where they were created. Read-only keys can read data; creating, updating, or deleting data requires a read-write key.

OAuth access tokens are issued for connected Windmill applications.

Both token types use the authenticated user's workspace permissions. Each endpoint's permission requirements and the sharing settings of the requested items still apply.

Path Parameters

companyId
string
required

Company ID. A URL slug is also accepted. The caller must have access to this company.

Required string length: 1 - 128
Example:

"company-acme"

Body

application/json

Category name must be unique among active company categories, ignoring case.

name
string
required

Category name, trimmed, 1–100 characters. Must be unique among active company categories, ignoring case.

Required string length: 1 - 100
Example:

"Teams"

icon
Category icon · object
required

Emoji/color or standard glyph/color object. The icon object rejects unknown fields.

Example:
description
string | null

Optional category description, trimmed, up to 500 characters. Null or empty clears the saved description.

Maximum string length: 500
Example:

"Organizational teams."

Response

The new category ID.

Identifier of the newly created group or category.

id
string
required

Identifier of the newly created employee group or category.

Example:

"11111111-1111-4111-8111-111111111111"