Skip to main content
POST
Upload and review a group member CSV

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"

groupId
string
required

Opaque employee group identifier in this company.

Example:

"group-engineering"

Body

multipart/form-data

Multipart CSV upload in the "file" field, up to 10 MiB.

file
file
required

CSV file with an email header, up to 10 MiB and 5000 data rows.

Response

Upload ID, validated rows and errors.

Review results plus the upload ID used to submit this import.

total
number
required

Total CSV data rows reviewed, excluding the header.

Example:

1

accepted
number
required

Number of CSV rows that currently resolve to an active employee in the company.

Example:

1

rejected
number
required

Number of rejected CSV rows; in job status, the number of processed rows that failed.

Example:

0

ready
Accepted row preview · object[]
required

First 50 accepted CSV rows, with matched employee summaries. This is a preview rather than the full import.

errors
Import row error · object[]
required

First 50 rejected or failed rows. The rejected count can exceed the length of this preview.

Example:
uploadId
string<uuid>
required

UUID returned by upload review. The upload is scoped to the company, group, and uploading employee.

Example:

"22222222-2222-4222-8222-222222222222"