Employees

get_employees

Get list of employees for the authenticated user's organization with pagination

get_employees

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_employees",
    "arguments": {
        "page": 1,
        "limit": 10,
        "search": "string",
        "relations": [
          "string"
        ],
        "where": {
          "isActive": true,
          "isArchived": true
        }
      }
  }
}

const result = await client.callTool({
  "name": "get_employees",
  "arguments": {
    "page": 1,
    "limit": 10,
    "search": "string",
    "relations": [
      "string"
    ],
    "where": {
      "isActive": true,
      "isArchived": true
    }
  }
});

result = await session.call_tool("get_employees", arguments={
  "page": 1,
  "limit": 10,
  "search": "string",
  "relations": [
    "string"
  ],
  "where": {
    "isActive": true,
    "isArchived": true
  }
})

Request Body

{
  "page": 1,
  "limit": 10,
  "search": "string",
  "relations": [
    "string"
  ],
  "where": {
    "isActive": true,
    "isArchived": true
  }
}

Body

application/json

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

searchstring

Search term for employee name or email

relationsArray<string>

Relations to include (e.g., ["user", "contact"])

whereobject

Additional filters

Show child attributes

isActiveboolean

isArchivedboolean

get_employee_count

Get employee count in the authenticated user's organization

get_employee_count

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_employee_count",
    "arguments": {
        "where": {
          "isActive": true,
          "isArchived": true
        }
      }
  }
}

const result = await client.callTool({
  "name": "get_employee_count",
  "arguments": {
    "where": {
      "isActive": true,
      "isArchived": true
    }
  }
});

result = await session.call_tool("get_employee_count", arguments={
  "where": {
    "isActive": true,
    "isArchived": true
  }
})

Request Body

{
  "where": {
    "isActive": true,
    "isArchived": true
  }
}

Body

application/json

whereobject

Additional filters

Show child attributes

isActiveboolean

isArchivedboolean

get_employees_pagination

Get employees by pagination in the authenticated user's organization

get_employees_pagination

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_employees_pagination",
    "arguments": {
        "page": 1,
        "limit": 10,
        "search": "string",
        "relations": [
          "string"
        ],
        "where": {
          "isActive": true,
          "isArchived": true
        }
      }
  }
}

const result = await client.callTool({
  "name": "get_employees_pagination",
  "arguments": {
    "page": 1,
    "limit": 10,
    "search": "string",
    "relations": [
      "string"
    ],
    "where": {
      "isActive": true,
      "isArchived": true
    }
  }
});

result = await session.call_tool("get_employees_pagination", arguments={
  "page": 1,
  "limit": 10,
  "search": "string",
  "relations": [
    "string"
  ],
  "where": {
    "isActive": true,
    "isArchived": true
  }
})

Request Body

{
  "page": 1,
  "limit": 10,
  "search": "string",
  "relations": [
    "string"
  ],
  "where": {
    "isActive": true,
    "isArchived": true
  }
}

Body

application/json

pagenumber1

Page number

limitnumber10

Items per page

searchstring

Search term for employee name or email

relationsArray<string>

Relations to include

whereobject

Additional filters

Show child attributes

isActiveboolean

isArchivedboolean

get_working_employees

Get all working employees in the authenticated user's organization

get_working_employees

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_working_employees",
    "arguments": {
        "forRange": {
          "startDate": "2024-01-15T09:30:00Z",
          "endDate": "2024-01-15T09:30:00Z"
        }
      }
  }
}

const result = await client.callTool({
  "name": "get_working_employees",
  "arguments": {
    "forRange": {
      "startDate": "2024-01-15T09:30:00Z",
      "endDate": "2024-01-15T09:30:00Z"
    }
  }
});

result = await session.call_tool("get_working_employees", arguments={
  "forRange": {
    "startDate": "2024-01-15T09:30:00Z",
    "endDate": "2024-01-15T09:30:00Z"
  }
})

Request Body

{
  "forRange": {
    "startDate": "2024-01-15T09:30:00Z",
    "endDate": "2024-01-15T09:30:00Z"
  }
}

Body

application/json

forRangeobject

Date range for filtering

Show child attributes

startDatestring<date-time>

Start date in ISO format

endDatestring<date-time>

End date in ISO format

get_working_employees_count

Get working employees count in the authenticated user's organization

get_working_employees_count

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_working_employees_count",
    "arguments": {
        "forRange": {
          "startDate": "2024-01-15T09:30:00Z",
          "endDate": "2024-01-15T09:30:00Z"
        }
      }
  }
}

const result = await client.callTool({
  "name": "get_working_employees_count",
  "arguments": {
    "forRange": {
      "startDate": "2024-01-15T09:30:00Z",
      "endDate": "2024-01-15T09:30:00Z"
    }
  }
});

result = await session.call_tool("get_working_employees_count", arguments={
  "forRange": {
    "startDate": "2024-01-15T09:30:00Z",
    "endDate": "2024-01-15T09:30:00Z"
  }
})

Request Body

{
  "forRange": {
    "startDate": "2024-01-15T09:30:00Z",
    "endDate": "2024-01-15T09:30:00Z"
  }
}

Body

application/json

forRangeobject

Date range for filtering

Show child attributes

startDatestring<date-time>

Start date in ISO format

endDatestring<date-time>

End date in ISO format

get_organization_members

Get members of the authenticated user's organization

get_organization_members

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_organization_members",
    "arguments": {
        "organizationTeamId": "550e8400-e29b-41d4-a716-446655440000",
        "organizationProjectId": "550e8400-e29b-41d4-a716-446655440000",
        "page": 1,
        "limit": 10
      }
  }
}

const result = await client.callTool({
  "name": "get_organization_members",
  "arguments": {
    "organizationTeamId": "550e8400-e29b-41d4-a716-446655440000",
    "organizationProjectId": "550e8400-e29b-41d4-a716-446655440000",
    "page": 1,
    "limit": 10
  }
});

result = await session.call_tool("get_organization_members", arguments={
  "organizationTeamId": "550e8400-e29b-41d4-a716-446655440000",
  "organizationProjectId": "550e8400-e29b-41d4-a716-446655440000",
  "page": 1,
  "limit": 10
})

Parameters

organizationTeamIdstring<uuid>

Filter by organization team ID

organizationProjectIdstring<uuid>

Filter by organization project ID

pagenumber1

Page number

limitnumber10

Items per page

get_employee

Get a specific employee by ID

get_employee

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_employee",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_employee",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_employee", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "relations": [
    "string"
  ]
})

Parameters

idstring<uuid>required

The employee ID

relationsArray<string>

Relations to include (e.g., ["user", "contact", "tasks"])

get_employee_statistics

Get statistics for an employee in the authenticated user's organization

get_employee_statistics

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_employee_statistics",
    "arguments": {
        "employeeId": "550e8400-e29b-41d4-a716-446655440000",
        "startDate": "string",
        "endDate": "string"
      }
  }
}

const result = await client.callTool({
  "name": "get_employee_statistics",
  "arguments": {
    "employeeId": "550e8400-e29b-41d4-a716-446655440000",
    "startDate": "string",
    "endDate": "string"
  }
});

result = await session.call_tool("get_employee_statistics", arguments={
  "employeeId": "550e8400-e29b-41d4-a716-446655440000",
  "startDate": "string",
  "endDate": "string"
})

Parameters

employeeIdstring<uuid>required

The employee ID

startDatestring

Start date for statistics (ISO format)

endDatestring

End date for statistics (ISO format)

get_current_employee

Get the current authenticated employee profile

get_current_employee

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_current_employee",
    "arguments": {
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_current_employee",
  "arguments": {
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_current_employee", arguments={
  "relations": [
    "string"
  ]
})

Parameters

relationsArray<string>

Relations to include (e.g., ["user", "contact", "tasks"])

create_employee

Create a new employee in the authenticated user's organization

create_employee

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_employee",
    "arguments": {
        "employee_data": {
          "userId": "string"
        }
      }
  }
}

const result = await client.callTool({
  "name": "create_employee",
  "arguments": {
    "employee_data": {
      "userId": "string"
    }
  }
});

result = await session.call_tool("create_employee", arguments={
  "employee_data": {
    "userId": "string"
  }
})

Request Body

{
  "employee_data": {
    "userId": "string"
  }
}

Body

application/json

employee_dataobjectrequired

The data for creating the employee

Show child attributes

userIdstringrequired

The userId (required)

[key: string]any

update_employee

Update an existing employee

update_employee

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_employee",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "employee_data": {}
      }
  }
}

const result = await client.callTool({
  "name": "update_employee",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "employee_data": {}
  }
});

result = await session.call_tool("update_employee", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "employee_data": {}
})

Parameters

idstring<uuid>required

The employee ID

employee_dataobjectrequired

The data for updating the employee

update_employee_profile

Update the current authenticated employee's profile

update_employee_profile

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_employee_profile",
    "arguments": {
        "employee_data": {}
      }
  }
}

const result = await client.callTool({
  "name": "update_employee_profile",
  "arguments": {
    "employee_data": {}
  }
});

result = await session.call_tool("update_employee_profile", arguments={
  "employee_data": {}
})

Parameters

employee_dataobjectrequired

The data for updating the employee profile

soft_delete_employee

Soft delete an employee (archive)

soft_delete_employee

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "soft_delete_employee",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "soft_delete_employee",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("soft_delete_employee", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

idstring<uuid>required

The employee ID

restore_employee

Restore a soft deleted employee

restore_employee

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "restore_employee",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "restore_employee",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("restore_employee", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

idstring<uuid>required

The employee ID

bulk_create_employees

Create multiple employees in bulk for the authenticated user's organization

bulk_create_employees

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "bulk_create_employees",
    "arguments": {
        "employees": [
          {
            "userId": "string"
          }
        ]
      }
  }
}

const result = await client.callTool({
  "name": "bulk_create_employees",
  "arguments": {
    "employees": [
      {
        "userId": "string"
      }
    ]
  }
});

result = await session.call_tool("bulk_create_employees", arguments={
  "employees": [
    {
      "userId": "string"
    }
  ]
})

Request Body

{
  "employees": [
    {
      "userId": "string"
    }
  ]
}

Body

application/json

employeesArray<object>required

Array of employee data to create

Show child attributes

Employee data

userIdstringrequired

The userId (required)

[key: string]any

Stack Overflow Website Demo