Team members

A team member is a user in your workspace. For fields and response details, see the API reference. These commands act with your own permissions, so adding, updating, or removing someone needs an organization role that allows it.

List team members

This command shows active team members in your workspace. Use this when you want to see who already has access, or pass --email with one exact address to turn an email into an ID.

neetoform team-members list --json

Sort with --sort (created_at, updated_at, email, first_name or last_name) and --order (asc or desc, default asc). --order without --sort sorts by created_at.

Flag	Type	Default	Description
`--email`	`string`		Filter by email address
`--order`	`string`		Sort direction: asc (default) or desc
`--page`	`int`	`0`	Page number
`--page-size`	`int`	`0`	Items per page (max 100)
`--sort`	`string`		Sort field: created_at, updated_at, email, first_name or last_name

Sample output (--json)

{
  "data": [
    {
      "id": "13c02be6-8bd4-4dda-b9e6-07df53feb8a4",
      "email": "oliver@example.com",
      "first_name": "Oliver",
      "last_name": "Smith",
      "time_zone": "Asia/Kolkata",
      "profile_image_url": "https://acme.neetoform.com/uploads/oliver.png",
      "active": true,
      "organization_role": "Admin"
    },
    {
      "id": "5f8a2d90-1c47-4b6e-9a03-c81de5476b22",
      "email": "sam@example.com",
      "first_name": "Sam",
      "last_name": "Smith",
      "time_zone": "America/New_York",
      "profile_image_url": null,
      "active": true,
      "organization_role": "Standard"
    }
  ],
  "breadcrumbs": [
    {
      "label": "Show",
      "command": "neetoform team-members show <id>"
    }
  ],
  "pagination": {
    "current_page_number": 1,
    "total_pages": 1,
    "total_records": 2,
    "page_size": 30
  }
}

Show a team member

This command shows details for one team member ID. Use this when you want to inspect a member’s email, role, time zone, and active status after finding their ID from team-members list.

neetoform team-members show 13c02be6-8bd4-4dda-b9e6-07df53feb8a4 --json

Required arguments:

<id> - The team member’s UUID, from neetoform team-members list

Sample output (--json)

{
  "data": {
    "team_member": {
      "id": "13c02be6-8bd4-4dda-b9e6-07df53feb8a4",
      "email": "oliver@example.com",
      "first_name": "Oliver",
      "last_name": "Smith",
      "time_zone": "Asia/Kolkata",
      "profile_image_url": "https://acme.neetoform.com/uploads/oliver.png",
      "active": true,
      "organization_role": "Admin"
    }
  }
}

Add team members

This command invites team members to your workspace. Use this when you want to add colleagues by email and assign an organization role. An address that already belongs to the workspace is reactivated instead, and its role is overwritten.

neetoform team-members create \
  --emails oliver@example.com,sam@example.com \
  --role Standard

Flag	Type	Required	Default	Description
`--emails`	`string`	Yes		Comma-separated email addresses to invite
`--invited-by`	`string`			Email of an admin to send the invitation as
`--role`	`string`	Yes		Organization role name for the invited members; e.g. Admin, Standard, Editor, Reviewer (case-sensitive, must match a role in your workspace)
`--send-invitation-email`	`bool`		`true`	Send invitation email

Sample output (--json)

{
  "data": {
    "message": "Users added successfully"
  }
}

--role matches a role in your workspace exactly, including case. The Roles page in workspace settings lists the ones you have; Admin and Standard always exist. Pass --invited-by with the email of an admin to send the invitation as that admin. Pass --send-invitation-email=false to add people without emailing them. The response carries a message rather than the new records, so --quiet prints that message as JSON. To get the id of someone you just invited, run neetoform team-members list --email <address>.

Update a team member

This command updates a team member’s profile or role. Use this when correcting names, email, time zone, or organization role. Only the fields you pass change.

neetoform team-members update 13c02be6-8bd4-4dda-b9e6-07df53feb8a4 \
  --time-zone America/New_York \
  --role Admin \
  --json

Required arguments:

<id> - The team member’s UUID, from neetoform team-members list

Flag	Type	Description
`--email`	`string`	New email address
`--first-name`	`string`	First name
`--last-name`	`string`	Last name
`--role`	`string`	Organization role name; e.g. Admin, Standard, Editor, Reviewer (case-sensitive, must match a role in your workspace)
`--time-zone`	`string`	Time zone

Sample output (--json)

{
  "data": {
    "team_member": {
      "id": "13c02be6-8bd4-4dda-b9e6-07df53feb8a4",
      "email": "oliver@example.com",
      "first_name": "Oliver",
      "last_name": "Smith",
      "time_zone": "America/New_York",
      "profile_image_url": "https://acme.neetoform.com/uploads/oliver.png",
      "active": true,
      "organization_role": "Admin"
    }
  }
}

--time-zone takes an IANA name such as Asia/Kolkata. --role matches a workspace role exactly, as it does on create.

Delete a team member

This command removes a team member from your workspace. Use this when someone should no longer have access. The member is deactivated, and the forms and submissions they created stay in the workspace.

neetoform team-members delete 13c02be6-8bd4-4dda-b9e6-07df53feb8a4

Required arguments:

<id> - The team member’s UUID, from neetoform team-members list

Sample output

Team member removed.

The workspace must keep at least one admin, so removing the last one is rejected.

List deactivated team members

This command lists team members who were removed from the workspace. Use this when you want to find someone to bring back, or to turn an email into an ID for reactivate.

neetoform deactivated-team-members list --json

Flag	Type	Required	Default	Description
`--page`	`int`		`0`	Page number
`--page-size`	`int`		`0`	Items per page (max 100)

Sample output (--json)

{
  "data": [
    {
      "id": "3c4d5e6f-7a8b-4c9d-0e1f-2a3b4c5d6e7f",
      "email": "sam@example.com",
      "first_name": "Sam",
      "last_name": "Smith",
      "time_zone": "Asia/Kolkata",
      "profile_image_url": null,
      "active": false,
      "organization_role": "Standard"
    }
  ],
  "breadcrumbs": [
    {
      "label": "Reactivate",
      "command": "neetoform deactivated-team-members reactivate <id>"
    }
  ],
  "pagination": {
    "current_page_number": 1,
    "total_pages": 1,
    "total_records": 1,
    "page_size": 30
  }
}

For fields and response details, see the API reference.

Reactivate a team member

This command gives a deactivated team member access again. Use this when someone returns to the team. The member gets their previous role back.

neetoform deactivated-team-members reactivate 3c4d5e6f-7a8b-4c9d-0e1f-2a3b4c5d6e7f

Required arguments:

<id> - The deactivated team member’s UUID, from neetoform deactivated-team-members list

For fields and response details, see the API reference.

List roles

This command lists the organization roles in your workspace. Use this to find the exact role name to pass to --role on team-members create and team-members update.

neetoform roles list --json

Flag	Type	Required	Default	Description
`--page`	`int`		`0`	Page number
`--page-size`	`int`		`0`	Items per page (max 100)

For fields and response details, see the API reference.

Getting started

Commands

List team members

Show a team member

Add team members

Update a team member

Delete a team member

List deactivated team members

Reactivate a team member

List roles

​List team members

​Show a team member

​Add team members

​Update a team member

​Delete a team member

​List deactivated team members

​Reactivate a team member

​List roles

List team members

Show a team member

Add team members

Update a team member

Delete a team member

List deactivated team members

Reactivate a team member

List roles