Skip to main content
GET
Get group member import progress

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"

importId
string<uuid>
required

UUID of a member import for this group.

Example:

"33333333-3333-4333-8333-333333333333"

Response

Import progress and row errors.

Processed row counts and at most 50 row failures. Counts can change while the job runs.

importId
string<uuid>
required

UUID of the asynchronous member import.

Example:

"33333333-3333-4333-8333-333333333333"

status
enum<string>
required

Current import or referenced-resource status. See the containing response for its meaning.

Available options:
VALIDATED,
IMPORTING,
COMPLETED,
FAILED
Example:

"COMPLETED"

imported
number
required

Number of completed import rows, including rows whose employee was already a member.

Example:

1

rejected
number
required

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

Example:

0

errors
Import row error · object[]
required

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

Example: