Team members

Team members are the people in the workspace. For fields and response details, see the API reference.

Sample output on this page is the JSON envelope you get with --json. On a terminal the same data prints as a table or a key-value list. See Output formats.

List team members

Lists the members of the workspace. Pass --email to look one up without paging through the list.

neetorecord team-members list --email oliver@example.com

Flag	Type	Default	Description
`--email`	`string`		Filter by email address
`--page`	`int`	`0`	Page number
`--page-size`	`int`	`0`	Items per page (max 100)

{
  "data": [
    {
      "id": "aaaabbbb-cccc-dddd-eeee-ffff00001111",
      "email": "oliver@example.com",
      "first_name": "Oliver",
      "last_name": "Smith",
      "time_zone": "Asia/Kolkata",
      "profile_image_url": null,
      "active": true,
      "organization_role": "Admin"
    }
  ],
  "breadcrumbs": [
    { "label": "Show", "command": "neetorecord team-members show <id>" }
  ],
  "pagination": {
    "total_records": 24,
    "total_pages": 1,
    "current_page_number": 1,
    "page_size": 30
  }
}

Show a team member

Shows one member.

neetorecord team-members show aaaabbbb-cccc-dddd-eeee-ffff00001111

Required arguments

<id> - the team member id, as returned by team-members list.

{
  "data": {
    "team_member": {
      "id": "aaaabbbb-cccc-dddd-eeee-ffff00001111",
      "email": "oliver@example.com",
      "first_name": "Oliver",
      "last_name": "Smith",
      "time_zone": "Asia/Kolkata",
      "profile_image_url": null,
      "active": true,
      "organization_role": "Admin"
    }
  }
}

Invite team members

Invites one or more people to the workspace. Repeat --email to invite several at once.

neetorecord team-members create \
  --email oliver@example.com --email sam@example.com \
  --role Standard \
  --invited-by admin@example.com

Flag	Type	Required	Default	Description
`--email`	`stringArray`	Yes	`[]`	Email address to invite (repeatable)
`--invited-by`	`string`			Inviter name or email
`--role`	`string`	Yes		Organization role
`--send-invitation-email`	`bool`		`true`	Send invitation email

--role must match one of the roles configured on your workspace’s Roles page, and it is case sensitive. Pass --send-invitation-email=false to add people without emailing them.

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

Update a team member

Changes a member’s name, email, time zone, or role. Only the flags you pass are changed.

neetorecord team-members update aaaabbbb-cccc-dddd-eeee-ffff00001111 \
  --first-name Oliver --last-name Smith --role Admin

Required arguments

<id> - the team member id, as returned by 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
`--time-zone`	`string`	Time zone

The output is the updated team member, wrapped in data.

Remove a team member

Removes a member from the workspace.

neetorecord team-members delete aaaabbbb-cccc-dddd-eeee-ffff00001111

Required arguments

<id> - the team member id, as returned by team-members list.

Team member removed.

Removing the last admin of a workspace is rejected.

Getting Started

Commands

List team members

Show a team member

Invite team members

Update a team member

Remove a team member

​List team members

​Show a team member

​Invite team members

​Update a team member

​Remove a team member

List team members

Show a team member

Invite team members

Update a team member

Remove a team member