user.md

User

Usage

import Api from "mondayapi";
const api = new Api("MONDAY API KEY");
const limit = 50;
api.user.listByBoard(limit, ["id"]);

API

Defined in /src/api/user.ts

me

Name	Type	Optional
fields	UserField[]	False

getByIds

Name	Type	Optional
userIds	UserField["id"][]	False
fields	UserField[]	False

getByEmails

Name	Type	Optional
userEmails	UserField["email"][]	False
fields	UserField[]	False

list

Name	Type	Optional
limit	number	False
fields	UserField[]	False

addToBoard

Name	Type	Optional
args	AddUserToBoardArgs	False
fields	UserField[]	False

addToWorkspace

Name	Type	Optional
args	AddUserToWorkspaceArgs["id"][]	False
fields	UserField[]	False

removeFromWorkspace

Name	Type	Optional
userIds	UserField["id"][]	False
workspaceId	WorkspaceField["id"]	False
fields	UserField[]	False