getPeople

getPeople

Retrieve and filter people data from Teamwork projects, including users, collaborators, and contacts, based on user type, date, search terms, or specific IDs within Teamwork MCP.

Instructions

Get all people from Teamwork

Input Schema

Name	Required	Description
`companyIds`	No	Filter by company IDs
`includeClients`	No	Include client users
`includeCollaborators`	No	Include collaborator users
`lastLoginAfter`	No	Filter by users who logged in after this date-time
`orderBy`	No	Order by field
`orderMode`	No	Order mode
`page`	No	Page number
`pageSize`	No	Number of items per page
`projectIds`	No	Filter by project IDs
`searchTerm`	No	Filter by name or email
`teamIds`	No	Filter by team IDs
`updatedAfter`	No	Filter by users updated after this date-time (format: ISO 8601)
`userType`	No	Filter by user type

Input Schema (JSON Schema)

{
  "properties": {
    "companyIds": {
      "description": "Filter by company IDs",
      "items": {
        "type": "integer"
      },
      "type": "array"
    },
    "includeClients": {
      "description": "Include client users",
      "type": "boolean"
    },
    "includeCollaborators": {
      "description": "Include collaborator users",
      "type": "boolean"
    },
    "lastLoginAfter": {
      "description": "Filter by users who logged in after this date-time",
      "type": "string"
    },
    "orderBy": {
      "description": "Order by field",
      "enum": [
        "name",
        "namecaseinsensitive",
        "company"
      ],
      "type": "string"
    },
    "orderMode": {
      "description": "Order mode",
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string"
    },
    "page": {
      "description": "Page number",
      "type": "integer"
    },
    "pageSize": {
      "description": "Number of items per page",
      "type": "integer"
    },
    "projectIds": {
      "description": "Filter by project IDs",
      "items": {
        "type": "integer"
      },
      "type": "array"
    },
    "searchTerm": {
      "description": "Filter by name or email",
      "type": "string"
    },
    "teamIds": {
      "description": "Filter by team IDs",
      "items": {
        "type": "integer"
      },
      "type": "array"
    },
    "updatedAfter": {
      "description": "Filter by users updated after this date-time (format: ISO 8601)",
      "type": "string"
    },
    "userType": {
      "description": "Filter by user type",
      "enum": [
        "account",
        "collaborator",
        "contact"
      ],
      "type": "string"
    }
  },
  "type": "object"
}

Teamwork MCP

Instructions

Input Schema

Input Schema (JSON Schema)

Other Tools from Teamwork MCP

Related Tools

MCP directory API